org.alfresco.repo.web.filter.beans
Class NullFilter

java.lang.Object
  extended by org.alfresco.repo.web.filter.beans.NullFilter
All Implemented Interfaces:
org.alfresco.repo.management.subsystems.ActivateableBean, DependencyInjectedFilter

public class NullFilter
extends java.lang.Object
implements DependencyInjectedFilter, org.alfresco.repo.management.subsystems.ActivateableBean

A Benign filter that does nothing more than invoke the filter chain. Allows strategic points of the filter chain to be configured in and out according to the authentication subsystem in use.


Constructor Summary
NullFilter()
           
 
Method Summary
 void doFilter(javax.servlet.ServletContext context, javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain)
          The doFilter method of the Filter is called by the container each time a request/response pair is passed through the chain due to a client request for a resource at the end of the chain.
 boolean isActive()
           
 void setActive(boolean active)
          Activates or deactivates the bean
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

NullFilter

public NullFilter()
Method Detail

setActive

public void setActive(boolean active)
Activates or deactivates the bean

Parameters:
active - true if the bean is active and initialization should complete

isActive

public boolean isActive()
Specified by:
isActive in interface org.alfresco.repo.management.subsystems.ActivateableBean

doFilter

public void doFilter(javax.servlet.ServletContext context,
                     javax.servlet.ServletRequest request,
                     javax.servlet.ServletResponse response,
                     javax.servlet.FilterChain chain)
              throws java.io.IOException,
                     javax.servlet.ServletException
Description copied from interface: DependencyInjectedFilter
The doFilter method of the Filter is called by the container each time a request/response pair is passed through the chain due to a client request for a resource at the end of the chain. The FilterChain passed in to this method allows the Filter to pass on the request and response to the next entity in the chain.

A typical implementation of this method would follow the following pattern:-
1. Examine the request
2. Optionally wrap the request object with a custom implementation to filter content or headers for input filtering
3. Optionally wrap the response object with a custom implementation to filter content or headers for output filtering
4. a) Either invoke the next entity in the chain using the FilterChain object ( chain.doFilter()),
4. b) or not pass on the request/response pair to the next entity in the filter chain to block the request processing
5. Directly set headers on the response after invocation of the next entity in the filter chain.

Specified by:
doFilter in interface DependencyInjectedFilter
Throws:
java.io.IOException
javax.servlet.ServletException


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.