Class AbstractFilterRegistrationBean<T extends javax.servlet.Filter>

Field Detail

• REQUEST_WRAPPER_FILTER_MAX_ORDER

  @Deprecated
  protected static final int REQUEST_WRAPPER_FILTER_MAX_ORDER

  Deprecated.

  since 2.1.0 in favor of OrderedFilter.REQUEST_WRAPPER_FILTER_MAX_ORDER
  Filters that wrap the servlet request should be ordered less than or equal to this.

  See Also:

  Constant Field Values

Method Detail

• setServletRegistrationBeans

  public void setServletRegistrationBeans​(Collection<? extends ServletRegistrationBean<?>> servletRegistrationBeans)

  Set ServletRegistrationBeans that the filter will be registered against.

  Parameters:

  servletRegistrationBeans - the Servlet registration beans

• getServletRegistrationBeans

  public Collection<ServletRegistrationBean<?>> getServletRegistrationBeans()

  Return a mutable collection of the ServletRegistrationBean that the filter will be registered against. ServletRegistrationBeans.

  Returns:

  the Servlet registration beans

  See Also:

  setServletNames(java.util.Collection<java.lang.String>), setUrlPatterns(java.util.Collection<java.lang.String>)

• addServletRegistrationBeans

  public void addServletRegistrationBeans​(ServletRegistrationBean<?>... servletRegistrationBeans)

  Add ServletRegistrationBeans for the filter.

  Parameters:

  servletRegistrationBeans - the servlet registration beans to add

  See Also:

  setServletRegistrationBeans(java.util.Collection<? extends org.springframework.boot.web.servlet.ServletRegistrationBean<?>>)

• setServletNames

  public void setServletNames​(Collection<String> servletNames)

  Set servlet names that the filter will be registered against. This will replace any previously specified servlet names.

  Parameters:

  servletNames - the servlet names

  See Also:

  setServletRegistrationBeans(java.util.Collection<? extends org.springframework.boot.web.servlet.ServletRegistrationBean<?>>), setUrlPatterns(java.util.Collection<java.lang.String>)

• getServletNames

  public Collection<String> getServletNames()

  Return a mutable collection of servlet names that the filter will be registered against.

  Returns:

  the servlet names

• addServletNames

  public void addServletNames​(String... servletNames)

  Add servlet names for the filter.

  Parameters:

  servletNames - the servlet names to add

• setUrlPatterns

  public void setUrlPatterns​(Collection<String> urlPatterns)

  Set the URL patterns that the filter will be registered against. This will replace any previously specified URL patterns.

  Parameters:

  urlPatterns - the URL patterns

  See Also:

  setServletRegistrationBeans(java.util.Collection<? extends org.springframework.boot.web.servlet.ServletRegistrationBean<?>>), setServletNames(java.util.Collection<java.lang.String>)

• getUrlPatterns

  public Collection<String> getUrlPatterns()

  Return a mutable collection of URL patterns, as defined in the Servlet specification, that the filter will be registered against.

  Returns:

  the URL patterns

• addUrlPatterns

  public void addUrlPatterns​(String... urlPatterns)

  Add URL patterns, as defined in the Servlet specification, that the filter will be registered against.

  Parameters:

  urlPatterns - the URL patterns

• setDispatcherTypes

  public void setDispatcherTypes​(javax.servlet.DispatcherType first,
                                 javax.servlet.DispatcherType... rest)

  Convenience method to set dispatcher types using the specified elements.

  Parameters:

  first - the first dispatcher type

  rest - additional dispatcher types

• setDispatcherTypes

  public void setDispatcherTypes​(EnumSet<javax.servlet.DispatcherType> dispatcherTypes)

  Sets the dispatcher types that should be used with the registration. If not specified the types will be deduced based on the value of DynamicRegistrationBean.isAsyncSupported().

  Parameters:

  dispatcherTypes - the dispatcher types

• setMatchAfter

  public void setMatchAfter​(boolean matchAfter)

  Set if the filter mappings should be matched after any declared filter mappings of the ServletContext. Defaults to false indicating the filters are supposed to be matched before any declared filter mappings of the ServletContext.

  Parameters:

  matchAfter - if filter mappings are matched after

• isMatchAfter

  public boolean isMatchAfter()

  Return if filter mappings should be matched after any declared Filter mappings of the ServletContext.

  Returns:

  if filter mappings are matched after

• getDescription

  protected String getDescription()

  Description copied from class: RegistrationBean
  Return a description of the registration. For example "Servlet resourceServlet"

  Specified by:

  getDescription in class RegistrationBean

  Returns:

  a description of the registration

• addRegistration

  protected javax.servlet.FilterRegistration.Dynamic addRegistration​(String description,
                                                                     javax.servlet.ServletContext servletContext)

  Specified by:

  addRegistration in class DynamicRegistrationBean<javax.servlet.FilterRegistration.Dynamic>

• configure

  protected void configure​(javax.servlet.FilterRegistration.Dynamic registration)

  Configure registration settings. Subclasses can override this method to perform additional configuration if required.

  Overrides:

  configure in class DynamicRegistrationBean<javax.servlet.FilterRegistration.Dynamic>

  Parameters:

  registration - the registration

• getFilter

  public abstract T getFilter()

  Return the Filter to be registered.

  Returns:

  the filter

• toString

  public String toString()

  Overrides:

  toString in class Object