Java Doc for DelegatingFilterProxy.java in  » J2EE » spring-framework-2.0.6 » org » springframework » web » filter » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » J2EE » spring framework 2.0.6 » org.springframework.web.filter 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.springframework.web.filter.GenericFilterBean
      org.springframework.web.filter.DelegatingFilterProxy

DelegatingFilterProxy
public class DelegatingFilterProxy extends GenericFilterBean (Code)
Proxy for a standard Servlet 2.3 Filter, delegating to a Spring-managed bean that implements the Filter interface. Supports a "targetBeanName" filter init-param in web.xml, specifying the name of the target bean in the Spring application context.

web.xml will usually contain a DelegatingFilterProxy definition, with the specified filter-name corresponding to a bean name in Spring's root application context. All calls to the filter proxy will then be delegated to that bean in the Spring context, which is required to implement the standard Servlet 2.3 Filter interface.

This approach is particularly useful for Filter implementation with complex setup needs, allowing to apply the full Spring bean definition machinery to Filter instances. Alternatively, consider standard Filter setup in combination with looking up service beans from the Spring root application context.

NOTE: The lifecycle methods defined by the Servlet Filter interface will by default not be delegated to the target bean, relying on the Spring application context to manage the lifecycle of that bean. Specifying the "targetFilterLifecycle" filter init-param as "true" will enforce invocation of the Filter.init and Filter.destroy lifecycle methods on the target bean, letting the servlet container manage the filter lifecycle.

This class is inspired by Acegi Security's FilterToBeanProxy class, written by Ben Alex.
author:
   Juergen Hoeller
since:
   1.2
See Also:   DelegatingFilterProxy.setTargetBeanName
See Also:   DelegatingFilterProxy.setTargetFilterLifecycle
See Also:   javax.servlet.Filter.doFilter
See Also:   javax.servlet.Filter.init
See Also:   javax.servlet.Filter.destroy





Method Summary
public  voiddestroy()
    
protected  voiddestroyDelegate(Filter delegate)
     Destroy the Filter delegate.
public  voiddoFilter(ServletRequest request, ServletResponse response, FilterChain filterChain)
    
protected  StringgetTargetBeanName()
     Return the name of the target bean in the Spring application context.
protected  FilterinitDelegate(WebApplicationContext wac)
     Initialize the Filter delegate, defined as bean the given Spring application context.
protected  voidinitFilterBean()
    
protected  booleanisTargetFilterLifecycle()
     Return whether to invoke the Filter.init and Filter.destroy lifecycle methods on the target bean.
public  voidsetTargetBeanName(String targetBeanName)
     Set the name of the target bean in the Spring application context.
public  voidsetTargetFilterLifecycle(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.




Method Detail
destroy
public void destroy()(Code)



destroyDelegate
protected void destroyDelegate(Filter delegate)(Code)
Destroy the Filter delegate. Default implementation simply calls Filter.destroy on it.
Parameters:
  delegate - the Filter delegate (never null)
See Also:   DelegatingFilterProxy.isTargetFilterLifecycle()
See Also:   javax.servlet.Filter.destroy



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



getTargetBeanName
protected String getTargetBeanName()(Code)
Return the name of the target bean in the Spring application context.



initDelegate
protected Filter initDelegate(WebApplicationContext wac) throws ServletException(Code)
Initialize the Filter delegate, defined as bean the given Spring application context.

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.
Parameters:
  wac - the root application context the initialized delegate Filter
throws:
  ServletException - if thrown by the Filter
See Also:   DelegatingFilterProxy.getTargetBeanName()
See Also:   DelegatingFilterProxy.isTargetFilterLifecycle()
See Also:   DelegatingFilterProxy.getFilterConfig()
See Also:   javax.servlet.Filter.init(javax.servlet.FilterConfig)




initFilterBean
protected void initFilterBean() throws ServletException(Code)



isTargetFilterLifecycle
protected boolean isTargetFilterLifecycle()(Code)
Return whether to invoke the Filter.init and Filter.destroy lifecycle methods on the target bean.



setTargetBeanName
public void setTargetBeanName(String targetBeanName)(Code)
Set the name of the target bean in the Spring application context. The target bean must implement the standard Servlet 2.3 Filter interface.

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




setTargetFilterLifecycle
public void setTargetFilterLifecycle(boolean targetFilterLifecycle)(Code)
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.




Fields inherited from org.springframework.web.filter.GenericFilterBean
final protected Log logger(Code)(Java Doc)

Methods inherited from org.springframework.web.filter.GenericFilterBean
final protected void addRequiredProperty(String property)(Code)(Java Doc)
public void afterPropertiesSet() throws ServletException(Code)(Java Doc)
public void destroy()(Code)(Java Doc)
final public FilterConfig getFilterConfig()(Code)(Java Doc)
final protected String getFilterName()(Code)(Java Doc)
final protected ServletContext getServletContext()(Code)(Java Doc)
final public void init(FilterConfig filterConfig) throws ServletException(Code)(Java Doc)
protected void initBeanWrapper(BeanWrapper bw) throws BeansException(Code)(Java Doc)
protected void initFilterBean() throws ServletException(Code)(Java Doc)
final public void setBeanName(String beanName)(Code)(Java Doc)
final public void setFilterConfig(FilterConfig filterConfig)(Code)(Java Doc)
final public void setServletContext(ServletContext servletContext)(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.