org.restlet.data
Class CookieSetting

java.lang.Object
  org.restlet.data.Parameter
      org.restlet.data.Cookie
          org.restlet.data.CookieSetting

All Implemented Interfaces:

Comparable<Parameter>

public final class CookieSetting
extends Cookie

Cookie setting provided by a server.

Author:

Jerome Louvel (contact@noelios.com)

Constructor Summary

CookieSetting()
Default constructor.

CookieSetting(int version, String name, String value)
Preferred constructor.

CookieSetting(int version, String name, String value, String path, String domain)
Preferred constructor.

CookieSetting(String name, String value)
Preferred constructor.

Method Summary

boolean	equals(Object obj)
String	getComment() Returns the comment for the user.
String	getDescription() Returns the description of this REST element.
int	getMaxAge() Returns the maximum age in seconds. Use 0 to immediately discard an existing cookie. Use -1 to discard the cookie at the end of the session (default).
int	hashCode()
boolean	isSecure() Indicates if cookie should only be transmitted by secure means.
void	setComment(String comment) Sets the comment for the user.
void	setMaxAge(int maxAge) Sets the maximum age in seconds. Use 0 to immediately discard an existing cookie. Use -1 to discard the cookie at the end of the session (default).
void	setSecure(boolean secure) Indicates if cookie should only be transmitted by secure means.

Methods inherited from class org.restlet.data.Cookie

getDomain, getPath, getVersion, setDomain, setPath, setVersion

Methods inherited from class org.restlet.data.Parameter

compareTo, encode, encode, getName, getValue, setName, setValue, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CookieSetting

public CookieSetting()

Default constructor.

CookieSetting

public CookieSetting(int version,
                     String name,
                     String value)

Preferred constructor.

Parameters:

version - The cookie's version.

name - The cookie's name.

value - The cookie's value.

CookieSetting

public CookieSetting(int version,
                     String name,
                     String value,
                     String path,
                     String domain)

Preferred constructor.

Parameters:

version - The cookie's version.

name - The cookie's name.

value - The cookie's value.

path - The cookie's path.

domain - The cookie's domain name.

CookieSetting

public CookieSetting(String name,
                     String value)

Preferred constructor.

Parameters:

name - The cookie's name.

value - The cookie's value.

Method Detail

equals

public boolean equals(Object obj)

Overrides:

equals in class Cookie

getComment

public String getComment()

Returns the comment for the user.

Returns:

The comment for the user.

getDescription

public String getDescription()

Returns the description of this REST element.

Returns:

The description of this REST element.

getMaxAge

public int getMaxAge()

Returns the maximum age in seconds.
Use 0 to immediately discard an existing cookie.
Use -1 to discard the cookie at the end of the session (default).

Returns:

The maximum age in seconds.

hashCode

public int hashCode()

Overrides:

hashCode in class Cookie

isSecure

public boolean isSecure()

Indicates if cookie should only be transmitted by secure means.

Returns:

True if cookie should only be transmitted by secure means.

setComment

public void setComment(String comment)

Sets the comment for the user.

Parameters:

comment - The comment for the user.

setMaxAge

public void setMaxAge(int maxAge)

Sets the maximum age in seconds.
Use 0 to immediately discard an existing cookie.
Use -1 to discard the cookie at the end of the session (default).

Parameters:

maxAge - The maximum age in seconds.

setSecure

public void setSecure(boolean secure)

Indicates if cookie should only be transmitted by secure means.

Parameters:

secure - True if cookie should only be transmitted by secure means.