Java Doc for FilterPlugin.java in  » Content-Management-System » riotfamily » org » riotfamily » common » 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 » Content Management System » riotfamily » org.riotfamily.common.web.filter 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.riotfamily.common.web.filter.FilterPlugin

All known Subclasses:   org.riotfamily.pages.mapping.FolderFilterPlugin,  org.riotfamily.riot.security.session.AccessControlFilterPlugin,
FilterPlugin
abstract public class FilterPlugin implements ServletContextAware,InitializingBean,DisposableBean,Ordered(Code)
Class that can be plugged into a PluginFilter to filter request and response objects like a javax.servlet.Filter servlet filter .

Note that plugins are only invoked once per request, so they won't be called for included or forwarded requests.


author:
   Felix Gnass [fgnass at neteye dot de]
since:
   6.4




Method Summary
final public  voidafterPropertiesSet()
     Retrieves the PluginFilter with the specified name from the ServletContext and registers the plugin.
final public  voiddestroy()
     Removes the plugin from the filter and invokes FilterPlugin.destroyPlugin() .
protected  voiddestroyPlugin()
     Subclasses may override this to perform custom cleanup operations when the bean is destroyed.
abstract public  voiddoFilter(HttpServletRequest request, HttpServletResponse response, PluginChain pluginChain)
     Subclasses must implement this method to filter the request/response.
public  intgetOrder()
     Returns the order in which this plugin will be invoked.
final protected  ServletContextgetServletContext()
     Returns the ServletContext.
protected  voidinitPlugin()
     Subclasses may override this to perform custom initialization.
public  voidsetFilterName(String filterName)
     Sets the name of the filter where the plugin should be registered.
public  voidsetIgnoreFilterNotPresent(boolean ignoreFilterNotPresent)
     Sets whether errors caused by a missing filter should be ignored.
public  voidsetOrder(int order)
     Sets the order in which this plugin will be invoked.
final public  voidsetServletContext(ServletContext servletContext)
    



Method Detail
afterPropertiesSet
final public void afterPropertiesSet() throws Exception(Code)
Retrieves the PluginFilter with the specified name from the ServletContext and registers the plugin.



destroy
final public void destroy() throws Exception(Code)
Removes the plugin from the filter and invokes FilterPlugin.destroyPlugin() .



destroyPlugin
protected void destroyPlugin()(Code)
Subclasses may override this to perform custom cleanup operations when the bean is destroyed. The default implementation is empty.



doFilter
abstract public void doFilter(HttpServletRequest request, HttpServletResponse response, PluginChain pluginChain) throws IOException, ServletException(Code)
Subclasses must implement this method to filter the request/response. The contract is the same as for javax.servlet.FilterFilter.doFilter .



getOrder
public int getOrder()(Code)
Returns the order in which this plugin will be invoked.



getServletContext
final protected ServletContext getServletContext()(Code)
Returns the ServletContext.



initPlugin
protected void initPlugin()(Code)
Subclasses may override this to perform custom initialization. All properties of this plugin will have been set before this method is invoked. The default implementation is empty.



setFilterName
public void setFilterName(String filterName)(Code)
Sets the name of the filter where the plugin should be registered.



setIgnoreFilterNotPresent
public void setIgnoreFilterNotPresent(boolean ignoreFilterNotPresent)(Code)
Sets whether errors caused by a missing filter should be ignored.



setOrder
public void setOrder(int order)(Code)
Sets the order in which this plugin will be invoked. The default value is Integer.MAX_VALE.



setServletContext
final public void setServletContext(ServletContext servletContext)(Code)



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.