org.apache.wicket.jmx
Interface CookieValuePersisterSettingsMBean

All Known Implementing Classes:
CookieValuePersisterSettings

public interface CookieValuePersisterSettingsMBean

Cookie persister settings.

Author:
eelcohillenius

Method Summary
 String getComment()
          Gets the cookie comment.
 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(String comment)
          Sets the cookie comment.
 void setDomain(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.
 

Method Detail

getComment

String getComment()
Gets the cookie comment.

Returns:
the cookie comment

getDomain

String getDomain()
Gets the cookie domain name.

Returns:
the cookie domain name

getMaxAge

int getMaxAge()
Gets the max age. After

Returns:
the max age

getSecure

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

getVersion

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

setComment

void setComment(String comment)
Sets the cookie comment.

Parameters:
comment - the cookie comment

setDomain

void setDomain(String domain)
Sets the cookie domain name.

Parameters:
domain - the cookie domain name

setMaxAge

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

Parameters:
maxAge - the max age in secs.

setSecure

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

setVersion

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-2011 Apache Software Foundation. All Rights Reserved.