类 FilterRegistrationBean

字段详细资料

• REQUEST_WRAPPER_FILTER_MAX_ORDER

  public static final int REQUEST_WRAPPER_FILTER_MAX_ORDER

  Filters that wrap the servlet request should be ordered less than or equal to this.

  另请参阅:

  常量字段值

构造器详细资料

• FilterRegistrationBean

  public FilterRegistrationBean()

  Create a new FilterRegistrationBean instance.

• FilterRegistrationBean

  public FilterRegistrationBean​(javax.servlet.Filter filter,
                                ServletRegistrationBean... servletRegistrationBeans)

  Create a new FilterRegistrationBean instance to be registered with the specified ServletRegistrationBeans.

  参数:

  filter - the filter to register

  servletRegistrationBeans - associate ServletRegistrationBeans

方法详细资料

• getFilter

  public javax.servlet.Filter getFilter()

  Return the Filter to be registered.

  返回:

  the filter

• setFilter

  public void setFilter​(javax.servlet.Filter filter)

  Set the filter to be registered.

  参数:

  filter - the filter

• setServletRegistrationBeans

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

  Set ServletRegistrationBeans that the filter will be registered against.

  参数:

  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.

  返回:

  the Servlet registration beans

  另请参阅:

  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.

  参数:

  servletRegistrationBeans - the servlet registration beans to add

  另请参阅:

  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.

  参数:

  servletNames - the servlet names

  另请参阅:

  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.

  返回:

  the servlet names

• addServletNames

  public void addServletNames​(String... servletNames)

  Add servlet names for the filter.

  参数:

  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.

  参数:

  urlPatterns - the URL patterns

  另请参阅:

  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 that the filter will be registered against.

  返回:

  the URL patterns

• addUrlPatterns

  public void addUrlPatterns​(String... urlPatterns)

  Add URL patterns that the filter will be registered against.

  参数:

  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.

  参数:

  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 RegistrationBean.isAsyncSupported().

  参数:

  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.

  参数:

  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.

  返回:

  if filter mappings are matched after

• onStartup

  public void onStartup​(javax.servlet.ServletContext servletContext)
                 throws javax.servlet.ServletException

  从接口复制的说明: ServletContextInitializer
  Configure the given ServletContext with any servlets, filters, listeners context-params and attributes necessary for initialization.

  参数:

  servletContext - the ServletContext to initialize

  抛出:

  javax.servlet.ServletException - if any call against the given ServletContext throws a ServletException

• configure

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

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

  参数:

  registration - the registration