wicket.markup.html.form.persistence
Class CookieValuePersisterSettings

java.lang.Object
  extended by wicket.markup.html.form.persistence.CookieValuePersisterSettings

public class CookieValuePersisterSettings
extends java.lang.Object

This class provides default values that are used by the CookieValuePersister class when it creates cookies.

Author:
Juergen Donnerstag

Constructor Summary
CookieValuePersisterSettings()
           
 
Method Summary
 java.lang.String getComment()
          Gets the cookie comment.
 java.lang.String getDomain()
          Gets the cookie domain name.
 int getMaxAge()
          Gets the max age.
 boolean getSecure()
          Returns true if the browser is sending cookies only over a secure protocol, or false if the browser can send cookies using any protocol.
 int getVersion()
          Returns the version of the protocol this cookie complies with.
 void setComment(java.lang.String comment)
          Sets the cookie comment.
 void setDomain(java.lang.String domain)
          Sets the cookie domain name.
 void setMaxAge(int maxAge)
          Sets the maximum age of the cookie in seconds.
 void setSecure(boolean secure)
          Indicates to the browser whether the cookie should only be sent using a secure protocol, such as HTTPS or SSL.
 void setVersion(int version)
          Sets the version of the cookie protocol this cookie complies with.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CookieValuePersisterSettings

public CookieValuePersisterSettings()
Method Detail

getMaxAge

public int getMaxAge()
Gets the max age. After

Returns:
the max age

setMaxAge

public void setMaxAge(int maxAge)
Sets the maximum age of the cookie in seconds.

Parameters:
maxAge - the max age in secs.

getComment

public java.lang.String getComment()
Gets the cookie comment.

Returns:
the cookie comment

setComment

public void setComment(java.lang.String comment)
Sets the cookie comment.

Parameters:
comment - the cookie comment

getDomain

public java.lang.String getDomain()
Gets the cookie domain name.

Returns:
the cookie domain name

setDomain

public void setDomain(java.lang.String domain)
Sets the cookie domain name.

Parameters:
domain - the cookie domain name

getSecure

public boolean getSecure()
Returns true if the browser is sending cookies only over a secure protocol, or false if the browser can send cookies using any protocol.

Returns:
whether this cookie is secure

setSecure

public void setSecure(boolean secure)
Indicates to the browser whether the cookie should only be sent using a secure protocol, such as HTTPS or SSL.

Parameters:
secure - if true, sends the cookie from the browser to the server using only when using a secure protocol; if false, sent on any protocol

getVersion

public int getVersion()
Returns the version of the protocol this cookie complies with. Version 1 complies with RFC 2109, and version 0 complies with the original cookie specification drafted by Netscape. Cookies provided by a browser use and identify the browser's cookie version.

Returns:
0 if the cookie complies with the original Netscape specification; 1 if the cookie complies with RFC 2109

setVersion

public void setVersion(int version)
Sets the version of the cookie protocol this cookie complies with. Version 0 complies with the original Netscape cookie specification. Version 1 complies with RFC 2109.
Since RFC 2109 is still somewhat new, consider version 1 as experimental; do not use it yet on production sites.

Parameters:
version - 0 if the cookie should comply with the original Netscape specification; 1 if the cookie should comply with RFC 2109


Copyright © 2004-2007 Wicket developers. All Rights Reserved.