类 DelegatingFilterProxy

构造器详细资料

• DelegatingFilterProxy

  public DelegatingFilterProxy()

  Create a new DelegatingFilterProxy. For traditional (pre-Servlet 3.0) use in web.xml.

  另请参阅:

  setTargetBeanName(String)

• DelegatingFilterProxy

  public DelegatingFilterProxy​(Filter delegate)

  Create a new DelegatingFilterProxy with the given Filter delegate. Bypasses entirely the need for interacting with a Spring application context, specifying the target bean name, etc.

  For use in Servlet 3.0+ environments where instance-based registration of filters is supported.

  参数:

  delegate - the Filter instance that this proxy will delegate to and manage the lifecycle for (must not be null).

  另请参阅:

  doFilter(ServletRequest, ServletResponse, FilterChain), invokeDelegate(Filter, ServletRequest, ServletResponse, FilterChain), destroy(), GenericFilterBean.setEnvironment(org.springframework.core.env.Environment)

• DelegatingFilterProxy

  public DelegatingFilterProxy​(String targetBeanName)

  Create a new DelegatingFilterProxy that will retrieve the named target bean from the Spring WebApplicationContext found in the ServletContext (either the 'root' application context or the context named by setContextAttribute(java.lang.String)).

  For use in Servlet 3.0+ environments where instance-based registration of filters is supported.

  The target bean must implement the standard Servlet Filter.

  参数:

  targetBeanName - name of the target filter bean to look up in the Spring application context (must not be null).

  另请参阅:

  findWebApplicationContext(), GenericFilterBean.setEnvironment(org.springframework.core.env.Environment)

• DelegatingFilterProxy

  public DelegatingFilterProxy​(String targetBeanName,
                               WebApplicationContext wac)

  Create a new DelegatingFilterProxy that will retrieve the named target bean from the given Spring WebApplicationContext.

  For use in Servlet 3.0+ environments where instance-based registration of filters is supported.

  The target bean must implement the standard Servlet Filter interface.

  The given WebApplicationContext may or may not be refreshed when passed in. If it has not, and if the context implements ConfigurableApplicationContext, a refresh() will be attempted before retrieving the named target bean.

  This proxy's Environment will be inherited from the given WebApplicationContext.

  参数:

  targetBeanName - name of the target filter bean in the Spring application context (must not be null).

  wac - the application context from which the target filter will be retrieved; if null, an application context will be looked up from ServletContext as a fallback.

  另请参阅:

  findWebApplicationContext(), GenericFilterBean.setEnvironment(org.springframework.core.env.Environment)

方法详细资料

• setContextAttribute

  public void setContextAttribute​(String contextAttribute)

  Set the name of the ServletContext attribute which should be used to retrieve the WebApplicationContext from which to load the delegate Filter bean.

• getContextAttribute

  public String getContextAttribute()

  Return the name of the ServletContext attribute which should be used to retrieve the WebApplicationContext from which to load the delegate Filter bean.

• setTargetBeanName

  public void setTargetBeanName​(String targetBeanName)

  Set the name of the target bean in the Spring application context. The target bean must implement the standard Servlet Filter interface.

  By default, the filter-name as specified for the DelegatingFilterProxy in web.xml will be used.

• getTargetBeanName

  protected String getTargetBeanName()

  Return the name of the target bean in the Spring application context.

• setTargetFilterLifecycle

  public void setTargetFilterLifecycle​(boolean targetFilterLifecycle)

  Set whether to invoke the Filter.init and Filter.destroy lifecycle methods on the target bean.

  Default is "false"; target beans usually rely on the Spring application context for managing their lifecycle. Setting this flag to "true" means that the servlet container will control the lifecycle of the target Filter, with this proxy delegating the corresponding calls.

• isTargetFilterLifecycle

  protected boolean isTargetFilterLifecycle()

  Return whether to invoke the Filter.init and Filter.destroy lifecycle methods on the target bean.

• initFilterBean

  protected void initFilterBean()
                         throws ServletException

  从类复制的说明: GenericFilterBean
  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.

  覆盖:

  initFilterBean 在类中 GenericFilterBean

  抛出:

  ServletException - if subclass initialization fails

  另请参阅:

  GenericFilterBean.getFilterName(), GenericFilterBean.getServletContext()

• doFilter

  public void doFilter​(ServletRequest request,
                       ServletResponse response,
                       FilterChain filterChain)
                throws ServletException,
                       IOException

  抛出:

  ServletException

  IOException

• destroy

  public void destroy()

  从类复制的说明: GenericFilterBean
  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

  覆盖:

  destroy 在类中 GenericFilterBean

• findWebApplicationContext

  protected WebApplicationContext findWebApplicationContext()

  Return the WebApplicationContext passed in at construction time, if available. Otherwise, attempt to retrieve a WebApplicationContext from the ServletContext attribute with the configured name if set. Otherwise look up a WebApplicationContext under the well-known "root" application context attribute. The WebApplicationContext must have already been loaded and stored in the ServletContext before this filter gets initialized (or invoked).

  Subclasses may override this method to provide a different WebApplicationContext retrieval strategy.

  返回:

  the WebApplicationContext for this proxy, or null if not found

  另请参阅:

  DelegatingFilterProxy(String, WebApplicationContext), getContextAttribute(), WebApplicationContextUtils.getWebApplicationContext(javax.servlet.ServletContext), WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE

• initDelegate

  protected Filter initDelegate​(WebApplicationContext wac)
                         throws ServletException

  Initialize the Filter delegate, defined as bean the given Spring application context.

  The default implementation fetches the bean from the application context and calls the standard Filter.init method on it, passing in the FilterConfig of this Filter proxy.

  参数:

  wac - the root application context

  返回:

  the initialized delegate Filter

  抛出:

  ServletException - if thrown by the Filter

  另请参阅:

  getTargetBeanName(), isTargetFilterLifecycle(), GenericFilterBean.getFilterConfig(), Filter.init(javax.servlet.FilterConfig)

• invokeDelegate

  protected void invokeDelegate​(Filter delegate,
                                ServletRequest request,
                                ServletResponse response,
                                FilterChain filterChain)
                         throws ServletException,
                                IOException

  Actually invoke the delegate Filter with the given request and response.

  参数:

  delegate - the delegate Filter

  request - the current HTTP request

  response - the current HTTP response

  filterChain - the current FilterChain

  抛出:

  ServletException - if thrown by the Filter

  IOException - if thrown by the Filter

• destroyDelegate

  protected void destroyDelegate​(Filter delegate)

  Destroy the Filter delegate. Default implementation simply calls Filter.destroy on it.

  参数:

  delegate - the Filter delegate (never null)

  另请参阅:

  isTargetFilterLifecycle(), Filter.destroy()