类 GenericFilterBean

字段详细资料

• logger

  protected final Log logger

  Logger available to subclasses.

构造器详细资料

• GenericFilterBean

  public GenericFilterBean()

方法详细资料

• setBeanName

  public void setBeanName​(String beanName)

  Stores the bean name as defined in the Spring bean factory.

  Only relevant in case of initialization as bean, to have a name as fallback to the filter name usually provided by a FilterConfig instance.

  指定者:

  setBeanName 在接口中 BeanNameAware

  参数:

  beanName - the name of the bean in the factory. Note that this name is the actual bean name used in the factory, which may differ from the originally specified name: in particular for inner bean names, the actual bean name might have been made unique through appending "#..." suffixes. Use the BeanFactoryUtils.originalBeanName(String) method to extract the original bean name (without suffix), if desired.

  另请参阅:

  BeanNameAware, getFilterName()

• setEnvironment

  public void setEnvironment​(Environment environment)

  Set the Environment that this filter runs in.

  Any environment set here overrides the StandardServletEnvironment provided by default.

  This Environment object is used only for resolving placeholders in resource paths passed into init-parameters for this filter. If no init-params are used, this Environment can be essentially ignored.

  指定者:

  setEnvironment 在接口中 EnvironmentAware

• getEnvironment

  public Environment getEnvironment()

  Return the Environment associated with this filter.

  If none specified, a default environment will be initialized via createEnvironment().

  指定者:

  getEnvironment 在接口中 EnvironmentCapable

  从以下版本开始:

  4.3.9

• createEnvironment

  protected Environment createEnvironment()

  Create and return a new StandardServletEnvironment.

  Subclasses may override this in order to configure the environment or specialize the environment type returned.

  从以下版本开始:

  4.3.9

• setServletContext

  public void setServletContext​(ServletContext servletContext)

  Stores the ServletContext that the bean factory runs in.

  Only relevant in case of initialization as bean, to have a ServletContext as fallback to the context usually provided by a FilterConfig instance.

  指定者:

  setServletContext 在接口中 ServletContextAware

  参数:

  servletContext - the ServletContext object to be used by this object

  另请参阅:

  ServletContextAware, getServletContext()

• afterPropertiesSet

  public void afterPropertiesSet()
                          throws ServletException

  Calls the initFilterBean() method that might contain custom initialization of a subclass.

  Only relevant in case of initialization as bean, where the standard init(FilterConfig) method won't be called.

  指定者:

  afterPropertiesSet 在接口中 InitializingBean

  抛出:

  ServletException

  另请参阅:

  initFilterBean(), init(javax.servlet.FilterConfig)

• destroy

  public void destroy()

  Subclasses may override this to perform custom filter shutdown.

  Note: This method will be called from standard filter destruction as well as filter bean destruction in a Spring application context.

  This default implementation is empty.

  指定者:

  destroy 在接口中 DisposableBean

  指定者:

  destroy 在接口中 Filter

• addRequiredProperty

  protected final void addRequiredProperty​(String property)

  Subclasses can invoke this method to specify that this property (which must match a JavaBean property they expose) is mandatory, and must be supplied as a config parameter. This should be called from the constructor of a subclass.

  This method is only relevant in case of traditional initialization driven by a FilterConfig instance.

  参数:

  property - name of the required property

• init

  public final void init​(FilterConfig filterConfig)
                  throws ServletException

  Standard way of initializing this filter. Map config parameters onto bean properties of this filter, and invoke subclass initialization.

  指定者:

  init 在接口中 Filter

  参数:

  filterConfig - the configuration for this filter

  抛出:

  ServletException - if bean properties are invalid (or required properties are missing), or if subclass initialization fails.

  另请参阅:

  initFilterBean()

• initBeanWrapper

  protected void initBeanWrapper​(BeanWrapper bw)
                          throws BeansException

  Initialize the BeanWrapper for this GenericFilterBean, possibly with custom editors.

  This default implementation is empty.

  参数:

  bw - the BeanWrapper to initialize

  抛出:

  BeansException - if thrown by BeanWrapper methods

  另请参阅:

  PropertyEditorRegistry.registerCustomEditor(java.lang.Class<?>, java.beans.PropertyEditor)

• initFilterBean

  protected void initFilterBean()
                         throws ServletException

  Subclasses may override this to perform custom initialization. All bean properties of this filter will have been set before this method is invoked.

  Note: This method will be called from standard filter initialization as well as filter bean initialization in a Spring application context. Filter name and ServletContext will be available in both cases.

  This default implementation is empty.

  抛出:

  ServletException - if subclass initialization fails

  另请参阅:

  getFilterName(), getServletContext()

• getFilterConfig

  @Nullable
  public FilterConfig getFilterConfig()

  Make the FilterConfig of this filter available, if any. Analogous to GenericServlet's getServletConfig().

  Public to resemble the getFilterConfig() method of the Servlet Filter version that shipped with WebLogic 6.1.

  返回:

  the FilterConfig instance, or null if none available

  另请参阅:

  GenericServlet.getServletConfig()

• getFilterName

  @Nullable
  protected String getFilterName()

  Make the name of this filter available to subclasses. Analogous to GenericServlet's getServletName().

  Takes the FilterConfig's filter name by default. If initialized as bean in a Spring application context, it falls back to the bean name as defined in the bean factory.

  返回:

  the filter name, or null if none available

  另请参阅:

  GenericServlet.getServletName(), FilterConfig.getFilterName(), setBeanName(java.lang.String)

• getServletContext

  protected ServletContext getServletContext()

  Make the ServletContext of this filter available to subclasses. Analogous to GenericServlet's getServletContext().

  Takes the FilterConfig's ServletContext by default. If initialized as bean in a Spring application context, it falls back to the ServletContext that the bean factory runs in.

  返回:

  the ServletContext instance

  抛出:

  IllegalStateException - if no ServletContext is available

  另请参阅:

  GenericServlet.getServletContext(), FilterConfig.getServletContext(), setServletContext(javax.servlet.ServletContext)