Java Doc for CookieInterceptor.java in  » Web-Framework » struts-2.0.11 » org » apache » struts2 » interceptor » 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 » Web Framework » struts 2.0.11 » org.apache.struts2.interceptor 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.apache.struts2.interceptor.CookieInterceptor

CookieInterceptor
public class CookieInterceptor extends AbstractInterceptor (Code)
The aim of this interceptor is to set values in the stack/action based on cookie name/value of interest.

If an asterik is present in cookiesName parameter, it will be assume that all cookies name are to be injected into struts' action, even though cookiesName is comma-separated by other values, eg (cookie1,*,cookie2).

If cookiesName is left empty it will assume that no cookie will be injected into Struts' action.

If an asterik is present in cookiesValue parameter, it will assume that all cookies name irrespective of its value will be injected into Struts' action so long as the cookie name matches those specified in cookiesName parameter.

If cookiesValue is left empty it will assume that all cookie that match the cookieName parameter will be injected into Struts' action.

The action could implements CookiesAware in order to have a Map of filtered cookies set into it.

  • cookiesName (mandatory) - Name of cookies to be injected into the action. If more than one cookie name is desired it could be comma-separated. If all cookies name is desired, it could simply be *, an asterik. When many cookies name are comma-separated either of the cookie that match the name in the comma-separated list will be qualified.
  • cookiesValue (mandatory) - Value of cookies that if its name matches cookieName attribute and its value matched this, will be injected into Struts' action. If more than one cookie name is desired it could be comma-separated. If left empty, it will assume any value would be ok. If more than one value is specified (comma-separated) it will assume a match if either value is matched.
    populateCookieValueIntoStack - this method will decide if this cookie value is qualified to be populated into the value stack (hence into the action itself) injectIntoCookiesAwareAction - this method will inject selected cookies (as a java.util.Map) into action that implements CookiesAware .
 
 <!--
 This example will inject cookies named either 'cookie1' or 'cookie2' whose
 value could be either 'cookie1value' or 'cookie2value' into Struts' action.
 -->
 <action ... >
 <interceptor-ref name="cookie">
 <param name="cookiesName">cookie1, cookie2</param>
 <param name="cookiesValue">cookie1value, cookie2value</param>
 </interceptor-ref>
 ....
 </action>
 <!--
 This example will inject cookies named either 'cookie1' or 'cookie2'
 regardless of their value into Struts' action.
 -->
 <action ... >
 <interceptor-ref name="cookie">
 <param name="cookiesName">cookie1, cookie2</param>
 <param name="cookiesValue">*</param>
 <interceptor-ref>
 ...
 </action>
 <!--
 This example will inject cookies named either 'cookie1' with value
 'cookie1value' or 'cookie2' with value 'cookie2value' into Struts'
 action.
 -->
 <action ... >
 <interceptor-ref name="cookie">
 <param name="cookiesName">cookie1</param>
 <param name="cookiesValue">cookie1value</param>
 </interceptor-ref>
 <interceptor-ref name="cookie">
 <param name="cookiesName"<cookie2</param>
 <param name="cookiesValue">cookie2value</param>
 </interceptor-ref>
 ....
 </action>
 <!--
 This example will inject any cookies regardless of its value into
 Struts' action.
 -->
 <action ... >
 <interceptor-ref name="cookie">
 <param name="cookiesName">*</param>
 <param name="cookiesValue">*</param>
 </interceptor-ref>
 ...
 </action>
 
 

See Also:   CookiesAware




Method Summary
protected  voidinjectIntoCookiesAwareAction(Object action, Map cookiesMap)
     Hook that set the cookiesMap into action that implements CookiesAware .
public  Stringintercept(ActionInvocation invocation)
    
protected  voidpopulateCookieValueIntoStack(String cookieName, String cookieValue, Map cookiesMap, ValueStack stack)
     Hook that populate cookie value into value stack (hence the action) if the criteria is satisfied (if the cookie value matches with those configured).
public  voidsetCookiesName(String cookiesName)
     Set the cookiesName which if matche will allow the cookie to be injected into action, could be comma-separated string.
public  voidsetCookiesValue(String cookiesValue)
     Set the cookiesValue which if matched (together with matching cookiesName) will caused the cookie to be injected into action, could be comma-separated string.



Method Detail
injectIntoCookiesAwareAction
protected void injectIntoCookiesAwareAction(Object action, Map cookiesMap)(Code)
Hook that set the cookiesMap into action that implements CookiesAware .
Parameters:
  action -
Parameters:
  cookiesMap -



intercept
public String intercept(ActionInvocation invocation) throws Exception(Code)



populateCookieValueIntoStack
protected void populateCookieValueIntoStack(String cookieName, String cookieValue, Map cookiesMap, ValueStack stack)(Code)
Hook that populate cookie value into value stack (hence the action) if the criteria is satisfied (if the cookie value matches with those configured).
Parameters:
  cookieName -
Parameters:
  cookieValue -
Parameters:
  cookiesMap -
Parameters:
  stack -



setCookiesName
public void setCookiesName(String cookiesName)(Code)
Set the cookiesName which if matche will allow the cookie to be injected into action, could be comma-separated string.
Parameters:
  cookiesName -



setCookiesValue
public void setCookiesValue(String cookiesValue)(Code)
Set the cookiesValue which if matched (together with matching cookiesName) will caused the cookie to be injected into action, could be comma-separated string.
Parameters:
  cookiesValue -



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