Java Doc for CookieGenerator.java in  » J2EE » spring-framework-2.0.6 » org » springframework » web » util » 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.util 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.springframework.web.util.CookieGenerator

All known Subclasses:   org.springframework.web.servlet.i18n.CookieLocaleResolver,  org.springframework.web.servlet.theme.CookieThemeResolver,
CookieGenerator
public class CookieGenerator (Code)
Helper class for cookie generation, carrying cookie descriptor settings as bean properties and being able to add and remove cookie to/from a given response.

Can serve as base class for components that generate specific cookies, like CookieLocaleResolcer and CookieThemeResolver.
author:
   Juergen Hoeller
since:
   1.1.4
See Also:   CookieGenerator.addCookie
See Also:   CookieGenerator.removeCookie
See Also:   org.springframework.web.servlet.i18n.CookieLocaleResolver
See Also:   org.springframework.web.servlet.theme.CookieThemeResolver



Field Summary
final public static  intDEFAULT_COOKIE_MAX_AGE
     Default maximum age of cookies: maximum integer value, i.e.
final public static  StringDEFAULT_COOKIE_PATH
     Default path that cookies will be visible to: "/", i.e.
final protected  Loglogger
    


Method Summary
public  voidaddCookie(HttpServletResponse response, String cookieValue)
     Add a cookie with the given value to the response, using the cookie descriptor settings of this generator.
protected  CookiecreateCookie(String cookieValue)
     Create a cookie with the given value, using the cookie descriptor settings of this generator (except for "cookieMaxAge").
public  StringgetCookieDomain()
     Return the domain for cookies created by this generator, if any.
public  intgetCookieMaxAge()
     Return the maximum age for cookies created by this generator.
public  StringgetCookieName()
     Return the given name for cookies created by this generator.
public  StringgetCookiePath()
     Return the path for cookies created by this generator.
public  booleanisCookieSecure()
     Return whether the cookie should only be sent using a secure protocol, such as HTTPS (SSL).
public  voidremoveCookie(HttpServletResponse response)
     Remove the cookie that this generator describes from the response.
public  voidsetCookieDomain(String cookieDomain)
     Use the given domain for cookies created by this generator.
public  voidsetCookieMaxAge(int cookieMaxAge)
     Use the given maximum age (in seconds) for cookies created by this generator. Useful special value: -1 ...
public  voidsetCookieName(String cookieName)
     Use the given name for cookies created by this generator.
public  voidsetCookiePath(String cookiePath)
     Use the given path for cookies created by this generator.
public  voidsetCookieSecure(boolean cookieSecure)
     Set whether the cookie should only be sent using a secure protocol, such as HTTPS (SSL).

Field Detail
DEFAULT_COOKIE_MAX_AGE
final public static int DEFAULT_COOKIE_MAX_AGE(Code)
Default maximum age of cookies: maximum integer value, i.e. forever.



DEFAULT_COOKIE_PATH
final public static String DEFAULT_COOKIE_PATH(Code)
Default path that cookies will be visible to: "/", i.e. the entire server.



logger
final protected Log logger(Code)





Method Detail
addCookie
public void addCookie(HttpServletResponse response, String cookieValue)(Code)
Add a cookie with the given value to the response, using the cookie descriptor settings of this generator.

Delegates to createCookie for cookie creation.
Parameters:
  response - the HTTP response to add the cookie to
Parameters:
  cookieValue - the value of the cookie to add
See Also:   CookieGenerator.setCookieName
See Also:   CookieGenerator.setCookieDomain
See Also:   CookieGenerator.setCookiePath
See Also:   CookieGenerator.setCookieMaxAge
See Also:   CookieGenerator.createCookie




createCookie
protected Cookie createCookie(String cookieValue)(Code)
Create a cookie with the given value, using the cookie descriptor settings of this generator (except for "cookieMaxAge").
Parameters:
  cookieValue - the value of the cookie to crate the cookie
See Also:   CookieGenerator.setCookieName
See Also:   CookieGenerator.setCookieDomain
See Also:   CookieGenerator.setCookiePath



getCookieDomain
public String getCookieDomain()(Code)
Return the domain for cookies created by this generator, if any.



getCookieMaxAge
public int getCookieMaxAge()(Code)
Return the maximum age for cookies created by this generator.



getCookieName
public String getCookieName()(Code)
Return the given name for cookies created by this generator.



getCookiePath
public String getCookiePath()(Code)
Return the path for cookies created by this generator.



isCookieSecure
public boolean isCookieSecure()(Code)
Return whether the cookie should only be sent using a secure protocol, such as HTTPS (SSL).



removeCookie
public void removeCookie(HttpServletResponse response)(Code)
Remove the cookie that this generator describes from the response. Will generate a cookie with empty value and max age 0.

Delegates to createCookie for cookie creation.
Parameters:
  response - the HTTP response to remove the cookie from
See Also:   CookieGenerator.setCookieName
See Also:   CookieGenerator.setCookieDomain
See Also:   CookieGenerator.setCookiePath
See Also:   CookieGenerator.createCookie




setCookieDomain
public void setCookieDomain(String cookieDomain)(Code)
Use the given domain for cookies created by this generator. The cookie is only visible to servers in this domain.



setCookieMaxAge
public void setCookieMaxAge(int cookieMaxAge)(Code)
Use the given maximum age (in seconds) for cookies created by this generator. Useful special value: -1 ... not persistent, deleted when client shuts down



setCookieName
public void setCookieName(String cookieName)(Code)
Use the given name for cookies created by this generator.



setCookiePath
public void setCookiePath(String cookiePath)(Code)
Use the given path for cookies created by this generator. The cookie is only visible to URLs in this path and below.



setCookieSecure
public void setCookieSecure(boolean cookieSecure)(Code)
Set whether the cookie should only be sent using a secure protocol, such as HTTPS (SSL). This is an indication to the receiving browser, not processed by the HTTP server itself. Default is "false".



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.