Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> acegisecurity >> [ securechannel overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.acegisecurity.securechannel
Class ChannelProcessingFilter  

java.lang.Object
  org.acegisecurity.securechannel.ChannelProcessingFilter

All Implemented Interfaces:

javax.servlet.Filter, org.springframework.beans.factory.InitializingBean

---

public class ChannelProcessingFilter

extends java.lang.Object

implements org.springframework.beans.factory.InitializingBean, javax.servlet.Filter

Ensures a web request is delivered over the required channel.

Internally uses a org.acegisecurity.intercept.web.FilterInvocation to represent the request, so that the FilterInvocation-related property editors and lookup classes can be used.

Delegates the actual channel security decisions and necessary actions to the configured ChannelDecisionManager. If a response is committed by the ChannelDecisionManager, the filter chain will not proceed.

Do not use this class directly. Instead configure web.xml to use the org.acegisecurity.util.FilterToBeanProxy.

Version:

$Id: ChannelProcessingFilter.java,v 1.5 2005/11/17 00:55:50 benalex Exp $

---

Field Summary
private  ChannelDecisionManager	channelDecisionManager
private  org.acegisecurity.intercept.web.FilterInvocationDefinitionSource	filterInvocationDefinitionSource
private static org.apache.commons.logging.Log	logger

 

Constructor Summary

ChannelProcessingFilter()

 

Method Summary
void	afterPropertiesSet()           Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
void	destroy()           Called by the web container to indicate to a filter that it is being taken out of service.
void	doFilter(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.
ChannelDecisionManager	getChannelDecisionManager()
org.acegisecurity.intercept.web.FilterInvocationDefinitionSource	getFilterInvocationDefinitionSource()
void	init(javax.servlet.FilterConfig filterConfig)           Called by the web container to indicate to a filter that it is being placed into service.
void	setChannelDecisionManager(ChannelDecisionManager channelDecisionManager)
void	setFilterInvocationDefinitionSource(org.acegisecurity.intercept.web.FilterInvocationDefinitionSource filterInvocationDefinitionSource)

 

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

logger

private static final org.apache.commons.logging.Log logger

---

channelDecisionManager

private ChannelDecisionManager channelDecisionManager

---

filterInvocationDefinitionSource

private org.acegisecurity.intercept.web.FilterInvocationDefinitionSource filterInvocationDefinitionSource

Constructor Detail

ChannelProcessingFilter

public ChannelProcessingFilter()

Method Detail

setChannelDecisionManager

public void setChannelDecisionManager(ChannelDecisionManager channelDecisionManager)

---

getChannelDecisionManager

public ChannelDecisionManager getChannelDecisionManager()

---

setFilterInvocationDefinitionSource

public void setFilterInvocationDefinitionSource(org.acegisecurity.intercept.web.FilterInvocationDefinitionSource filterInvocationDefinitionSource)

---

getFilterInvocationDefinitionSource

public org.acegisecurity.intercept.web.FilterInvocationDefinitionSource getFilterInvocationDefinitionSource()

---

afterPropertiesSet

public void afterPropertiesSet()
                        throws java.lang.Exception

Description copied from interface: org.springframework.beans.factory.InitializingBean

Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).

This method allows the bean instance to perform initialization only possible when all bean properties have been set and to throw an exception in the event of misconfiguration.

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

---

destroy

public void destroy()

Description copied from interface: javax.servlet.Filter

Called by the web container to indicate to a filter that it is being taken out of service. This method is only called once all threads within the filter's doFilter method have exited or after a timeout period has passed. After the web container calls this method, it will not call the doFilter method again on this instance of the filter.

This method gives the filter an opportunity to clean up any resources that are being held (for example, memory, file handles, threads) and make sure that any persistent state is synchronized with the filter's current state in memory.

Specified by:

destroy in interface javax.servlet.Filter

---

doFilter

public void doFilter(javax.servlet.ServletRequest request,
                     javax.servlet.ServletResponse response,
                     javax.servlet.FilterChain chain)
              throws java.io.IOException,
                     javax.servlet.ServletException

Description copied from interface: javax.servlet.Filter

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 javax.servlet.Filter

---

init

public void init(javax.servlet.FilterConfig filterConfig)
          throws javax.servlet.ServletException

Description copied from interface: javax.servlet.Filter

Called by the web container to indicate to a filter that it is being placed into service. The servlet container calls the init method exactly once after instantiating the filter. The init method must complete successfully before the filter is asked to do any filtering work.

The web container cannot place the filter into service if the init method either
1.Throws a ServletException
2.Does not return within a time period defined by the web container

Specified by:

init in interface javax.servlet.Filter

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> acegisecurity >> [ securechannel overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---