Cwikius-Spring/spring-security
1
0
Fork 0
mirror of https://github.com/spring-projects/spring-security.git synced 2025-06-26 13:53:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve javadoc formatting

Browse Source
This commit is contained in:
Carlos Sanchez 2006-07-05 16:00:51 +00:00
parent 27de814d54
commit 41f7bb3755
1 changed files with 13 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
core/src/main/java/org/acegisecurity/util/FilterToBeanProxy.java
View File

@ -28,32 +28,40 @@ import java.util.Map;
import javax.servlet.Filter; import javax.servlet.Filter;
import javax.servlet.FilterChain; import javax.servlet.FilterChain;
import javax.servlet.FilterConfig; import javax.servlet.FilterConfig;
import javax.servlet.ServletContext;
import javax.servlet.ServletException; import javax.servlet.ServletException;
import javax.servlet.ServletRequest; import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse; import javax.servlet.ServletResponse;
/** /**
* Delegates <code>Filter</code> requests to a Spring-managed bean.<p>This class acts as a proxy on behalf of a * <p>Delegates <code>Filter</code> requests to a Spring-managed bean.</p>
*
* <p>This class acts as a proxy on behalf of a
* target <code>Filter</code> that is defined in the Spring bean context. It is necessary to specify which target * target <code>Filter</code> that is defined in the Spring bean context. It is necessary to specify which target
* <code>Filter</code> should be proxied as a filter initialization parameter.</p> * <code>Filter</code> should be proxied as a filter initialization parameter.</p>
* <p>On filter initialisation, the class will use Spring's {@link *
* <p>On filter initialisation, the class will use Spring's {@link
* WebApplicationContextUtils#getWebApplicationContext(ServletContext sc)} method to obtain an * WebApplicationContextUtils#getWebApplicationContext(ServletContext sc)} method to obtain an
* <code>ApplicationContext</code> instance. It will expect to find the target <code>Filter</code> in this * <code>ApplicationContext</code> instance. It will expect to find the target <code>Filter</code> in this
* <code>ApplicationContext</code>.</p> * <code>ApplicationContext</code>.</p>
* <p>To use this filter, it is necessary to specify <b>one</b> of the following filter initialization parameters:</p> *
* <p>To use this filter, it is necessary to specify <b>one</b> of the following filter initialization parameters:
* <ul> * <ul>
* <li><code>targetClass</code> indicates the class of the target <code>Filter</code> defined in the bean * <li><code>targetClass</code> indicates the class of the target <code>Filter</code> defined in the bean
* context. The only requirements are that this target class implements the <code>javax.servlet.Filter</code> * context. The only requirements are that this target class implements the <code>javax.servlet.Filter</code>
* interface and at least one instance is available in the <code>ApplicationContext</code>.</li> * interface and at least one instance is available in the <code>ApplicationContext</code>.</li>
* <li><code>targetBean</code> indicates the bean name of the target class.</li> * <li><code>targetBean</code> indicates the bean name of the target class.</li>
* </ul> * </ul>
* If both initialization parameters are specified, <code>targetBean</code> takes priority.<P>An additional * If both initialization parameters are specified, <code>targetBean</code> takes priority.</p>
*
* <p>An additional
* initialization parameter, <code>init</code>, is also supported. If set to "<code>lazy</code>" the initialization * initialization parameter, <code>init</code>, is also supported. If set to "<code>lazy</code>" the initialization
* will take place on the first HTTP request, rather than at filter creation time. This makes it possible to use * will take place on the first HTTP request, rather than at filter creation time. This makes it possible to use
* <code>FilterToBeanProxy</code> with the Spring <code>ContextLoaderServlet</code>. Where possible you should not use * <code>FilterToBeanProxy</code> with the Spring <code>ContextLoaderServlet</code>. Where possible you should not use
* this initialization parameter, instead using <code>ContextLoaderListener</code>.</p> * this initialization parameter, instead using <code>ContextLoaderListener</code>.</p>
* <p>A final optional initialization parameter, <code>lifecycle</code>, determines whether the servlet container *
* <p>A final optional initialization parameter, <code>lifecycle</code>, determines whether the servlet container
* or the IoC container manages the lifecycle of the proxied filter. When possible you should write your filters to be * or the IoC container manages the lifecycle of the proxied filter. When possible you should write your filters to be
* managed via the IoC container interfaces such as {@link org.springframework.beans.factory.InitializingBean} and * managed via the IoC container interfaces such as {@link org.springframework.beans.factory.InitializingBean} and
* {@link org.springframework.beans.factory.DisposableBean}. If you cannot control the filters you wish to proxy (eg * {@link org.springframework.beans.factory.DisposableBean}. If you cannot control the filters you wish to proxy (eg