Java Doc for GenericFilterBean.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

All known Subclasses:   org.springframework.web.filter.OncePerRequestFilter,  org.springframework.web.filter.DelegatingFilterProxy,
GenericFilterBean
abstract public class GenericFilterBean implements Filter,BeanNameAware,ServletContextAware,InitializingBean,DisposableBean(Code)
Simple base implementation of javax.servlet.Filter which treats its config parameters (init-param entries within the filter tag in web.xml) as bean properties.

A handy superclass for any type of filter. Type conversion of config parameters is automatic, with the corresponding setter method getting invoked with the converted value. It is also possible for subclasses to specify required properties. Parameters without matching bean property setter will simply be ignored.

This filter leaves actual filtering to subclasses, which have to implement the javax.servlet.Filter.doFilter method.

This generic filter base class has no dependency on the Spring org.springframework.context.ApplicationContext concept. Filters usually don't load their own context but rather access service beans from the Spring root application context, accessible via the filter's GenericFilterBean.getServletContext() ServletContext (see org.springframework.web.context.support.WebApplicationContextUtils ).
author:
   Juergen Hoeller
since:
   06.12.2003
See Also:   GenericFilterBean.addRequiredProperty
See Also:   GenericFilterBean.initFilterBean
See Also:   GenericFilterBean.doFilter



Field Summary
final protected  Loglogger
    


Method Summary
final protected  voidaddRequiredProperty(String property)
     Subclasses can invoke this method to specify that this property (which must match a JavaBean property they expose) is mandatory, and must be supplied as a config parameter.
public  voidafterPropertiesSet()
     Calls the initFilterBean() method that might contain custom initialization of a subclass.
public  voiddestroy()
     Subclasses may override this to perform custom filter shutdown.
final public  FilterConfiggetFilterConfig()
     Make the FilterConfig of this filter available, if any.
final protected  StringgetFilterName()
     Make the name of this filter available to subclasses.
final protected  ServletContextgetServletContext()
     Make the ServletContext of this filter available to subclasses.
final public  voidinit(FilterConfig filterConfig)
     Standard way of initializing this filter.
protected  voidinitBeanWrapper(BeanWrapper bw)
     Initialize the BeanWrapper for this GenericFilterBean, possibly with custom editors.
protected  voidinitFilterBean()
     Subclasses may override this to perform custom initialization.
final public  voidsetBeanName(String beanName)
     Stores the bean name as defined in the Spring bean factory.
final public  voidsetFilterConfig(FilterConfig filterConfig)
     Alternative way of initializing this filter.
final public  voidsetServletContext(ServletContext servletContext)
     Stores the ServletContext that the bean factory runs in.

Field Detail
logger
final protected Log logger(Code)
Logger available to subclasses





Method Detail
addRequiredProperty
final protected void addRequiredProperty(String property)(Code)
Subclasses can invoke this method to specify that this property (which must match a JavaBean property they expose) is mandatory, and must be supplied as a config parameter. This should be called from the constructor of a subclass.

This method is only relevant in case of traditional initialization driven by a FilterConfig instance.
Parameters:
  property - name of the required property




afterPropertiesSet
public void afterPropertiesSet() throws ServletException(Code)
Calls the initFilterBean() method that might contain custom initialization of a subclass.

Only relevant in case of initialization as bean, where the standard init(FilterConfig) method won't be called.
See Also:   GenericFilterBean.initFilterBean()
See Also:   GenericFilterBean.init(javax.servlet.FilterConfig)




destroy
public void destroy()(Code)
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.




getFilterConfig
final public FilterConfig getFilterConfig()(Code)
Make the FilterConfig of this filter available, if any. Analogous to GenericServlet's getServletConfig().

Public to resemble the getFilterConfig() method of the Servlet Filter version that shipped with WebLogic 6.1. the FilterConfig instance, or null if none available
See Also:   javax.servlet.GenericServlet.getServletConfig




getFilterName
final protected String getFilterName()(Code)
Make the name of this filter available to subclasses. Analogous to GenericServlet's getServletName().

Takes the FilterConfig's filter name by default. If initialized as bean in a Spring application context, it falls back to the bean name as defined in the bean factory. the filter name, or null if none available
See Also:   javax.servlet.GenericServlet.getServletName
See Also:   javax.servlet.FilterConfig.getFilterName
See Also:   GenericFilterBean.setBeanName




getServletContext
final protected ServletContext getServletContext()(Code)
Make the ServletContext of this filter available to subclasses. Analogous to GenericServlet's getServletContext().

Takes the FilterConfig's ServletContext by default. If initialized as bean in a Spring application context, it falls back to the ServletContext that the bean factory runs in. the ServletContext instance, or null if none available
See Also:   javax.servlet.GenericServlet.getServletContext
See Also:   javax.servlet.FilterConfig.getServletContext
See Also:   GenericFilterBean.setServletContext




init
final public void init(FilterConfig filterConfig) throws ServletException(Code)
Standard way of initializing this filter. Map config parameters onto bean properties of this filter, and invoke subclass initialization.
Parameters:
  filterConfig - the configuration for this filter
throws:
  ServletException - if bean properties are invalid (or requiredproperties are missing), or if subclass initialization fails.
See Also:   GenericFilterBean.initFilterBean



initBeanWrapper
protected void initBeanWrapper(BeanWrapper bw) throws BeansException(Code)
Initialize the BeanWrapper for this GenericFilterBean, possibly with custom editors.

This default implementation is empty.
Parameters:
  bw - the BeanWrapper to initialize
throws:
  BeansException - if thrown by BeanWrapper methods
See Also:   org.springframework.beans.BeanWrapper.registerCustomEditor




initFilterBean
protected void initFilterBean() throws ServletException(Code)
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.
throws:
  ServletException - if subclass initialization fails
See Also:   GenericFilterBean.getFilterName()
See Also:   GenericFilterBean.getServletContext()




setBeanName
final public void setBeanName(String beanName)(Code)
Stores the bean name as defined in the Spring bean factory.

Only relevant in case of initialization as bean, to have a name as fallback to the filter name usually provided by a FilterConfig instance.
See Also:   org.springframework.beans.factory.BeanNameAware
See Also:   GenericFilterBean.getFilterName()




setFilterConfig
final public void setFilterConfig(FilterConfig filterConfig)(Code)
Alternative way of initializing this filter. Used by Servlet Filter version that shipped with WebLogic 6.1.
Parameters:
  filterConfig - the configuration for this filter
throws:
  BeanInitializationException - wrapping a ServletExceptionthrown by the init method
See Also:   GenericFilterBean.init(javax.servlet.FilterConfig)



setServletContext
final public void setServletContext(ServletContext servletContext)(Code)
Stores the ServletContext that the bean factory runs in.

Only relevant in case of initialization as bean, to have a ServletContext as fallback to the context usually provided by a FilterConfig instance.
See Also:   org.springframework.web.context.ServletContextAware
See Also:   GenericFilterBean.getServletContext()




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.