Cookie (OpenAM Server Only 6.5.5 Documentation)

java.lang.Object
- org.forgerock.caf.http.Cookie

All Implemented Interfaces:

JwtSessionCookie
```
public class Cookie
extends Object
implements JwtSessionCookie
```
This class creates an API which bridges the differences between the Servlet 2.5 and 3.0 Cookie APIs, as the Servlet 2.5 API does not support HttpOnly cookies and provides no methods to create a HttpOnly cookie.

Since:

1.5.0

See Also:

Cookie

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addCookie(Cookie cookie, javax.servlet.http.HttpServletResponse resp)` Adds the provided cookie to the provided `HttpServletResponse` as a 'Set-Cookie' header.
`static void`	`addCookies(Collection<Cookie> cookies, javax.servlet.http.HttpServletResponse resp)` Adds the provided cookies to the provided `HttpServletResponse` as a 'Set-Cookie' header.
`String`	`getComment()` Returns the comment describing the purpose of this cookie, or `null` if the cookie has no comment.
`static Set<Cookie>`	`getCookies(javax.servlet.http.HttpServletRequest request)` Gets all of the `Cookie`s from the provided `HttpServletRequest`.
`String`	`getDomain()` Gets the domain name of this Cookie.
`int`	`getMaxAge()` Gets the maximum age in seconds of this Cookie.
`String`	`getName()` Returns the name of the cookie.
`String`	`getPath()` Returns the path on the server to which the browser returns this cookie.
`String`	`getValue()` Gets the current value of this Cookie.
`int`	`getVersion()` Returns the version of the protocol this cookie complies with.
`boolean`	`isHttpOnly()` Checks whether this Cookie has been marked as HttpOnly.
`boolean`	`isSecure()` Returns `true` if the browser is sending cookies only over a secure protocol, or `false` if the browser can send cookies using any protocol.
`static Cookie`	`newCookie(String name, String value)` Creates a new `Cookie` with the provided name and value.
`void`	`setComment(String purpose)` Specifies a comment that describes a cookie's purpose.
`void`	`setDomain(String domain)` Specifies the domain within which this cookie should be presented.
`void`	`setHttpOnly(boolean isHttpOnly)` Marks or unmarks this Cookie as HttpOnly.
`void`	`setMaxAge(int expiry)` Sets the maximum age in seconds for this Cookie.
`void`	`setPath(String uri)` Specifies a path for the cookie to which the client should return the cookie.
`void`	`setSecure(boolean isSecure)` Indicates to the browser whether the cookie should only be sent using a secure protocol, such as HTTPS or SSL.
`void`	`setValue(String value)` Assigns a new value to this Cookie.
`void`	`setVersion(int version)` Sets the version of the cookie protocol that this Cookie complies with.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getName
```
public final String getName()
```
    Returns the name of the cookie. The name cannot be changed after creation.
    
    Returns:
    
    The name of the cookie.
  - getValue
```
public final String getValue()
```
    Gets the current value of this Cookie.
    
    Specified by:
    
    getValue in interface JwtSessionCookie
    
    Returns:
    
    The current value of this Cookie.
  - setValue
```
public final void setValue(String value)
```
    Assigns a new value to this Cookie.
    
    If you use a binary value, you may want to use BASE64 encoding.
    
    With Version 0 cookies, values should not contain white space, brackets, parentheses, equals signs, commas, double quotes, slashes, question marks, at signs, colons, and semicolons. Empty values may not behave the same way on all browsers.
    
    Parameters:
    
    value - The new value of the cookie.
  - getPath
```
public final String getPath()
```
    Returns the path on the server to which the browser returns this cookie. The cookie is visible to all sub-paths on the server.
    
    Returns:
    
    A String specifying a path that contains a servlet name, for example, /catalog.
  - setPath
```
public final void setPath(String uri)
```
    Specifies a path for the cookie to which the client should return the cookie.
    
    The cookie is visible to all the pages in the directory you specify, and all the pages in that directory's subdirectories. A cookie's path must include the servlet that set the cookie, for example, /catalog, which makes the cookie visible to all directories on the server under /catalog.
    
    Consult RFC 2109 (available on the Internet) for more information on setting path names for cookies.
    
    Parameters:
    
    uri - A String specifying a path
  - getDomain
```
public final String getDomain()
```
    Gets the domain name of this Cookie.
    
    Domain names are formatted according to RFC 2109.
    
    Returns:
    
    The domain name of this Cookie.
  - setDomain
```
public final void setDomain(String domain)
```
    Specifies the domain within which this cookie should be presented.
    
    The form of the domain name is specified by RFC 2109. A domain name begins with a dot (.example.com) and means that the cookie is visible to servers in a specified Domain Name System (DNS) zone (for example, www.example.com, but not a.b.example.com). By default, cookies are only returned to the server that sent them.
    
    Domain will only be set if the provided domain is not null.
    
    Parameters:
    
    domain - The domain name within which this cookie is visible; form is according to RFC 2109.
  - getMaxAge
```
public final int getMaxAge()
```
    Gets the maximum age in seconds of this Cookie.
    
    By default, -1 is returned, which indicates that the cookie will persist until browser shutdown.
    
    Returns:
    
    An integer specifying the maximum age of the cookie in seconds; if negative, means the cookie persists until browser shutdown.
  - setMaxAge
```
public final void setMaxAge(int expiry)
```
    Sets the maximum age in seconds for this Cookie.
    
    A positive value indicates that the cookie will expire after that many seconds have passed. Note that the value is the maximum age when the cookie will expire, not the cookie's current age.
    
    A negative value means that the cookie is not stored persistently and will be deleted when the Web browser exits. A zero value causes the cookie to be deleted.
    
    Parameters:
    
    expiry - An integer specifying the maximum age of the cookie in seconds; if negative, means the cookie is not stored; if zero, deletes the cookie.
  - isSecure
```
public final boolean isSecure()
```
    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:
    
    true if the browser uses a secure protocol, false otherwise.
  - setSecure
```
public final void setSecure(boolean isSecure)
```
    Indicates to the browser whether the cookie should only be sent using a secure protocol, such as HTTPS or SSL.
    
    The default value is false.
    
    Parameters:
    
    isSecure - If true, sends the cookie from the browser to the server only when using a secure protocol; if false, sent on any protocol.
  - isHttpOnly
```
public boolean isHttpOnly()
```
    Checks whether this Cookie has been marked as HttpOnly.
    
    Returns:
    
    true if this Cookie has been marked as HttpOnly, false otherwise.
  - setHttpOnly
```
public void setHttpOnly(boolean isHttpOnly)
```
    Marks or unmarks this Cookie as HttpOnly.
    
    If isHttpOnly is set to true, this cookie is marked as HttpOnly, by adding the HttpOnly attribute to it.
    
    HttpOnly cookies are not supposed to be exposed to client-side scripting code, and may therefore help mitigate certain kinds of cross-site scripting attacks.
    
    Parameters:
    
    isHttpOnly - true if this cookie is to be marked as HttpOnly, false otherwise.
  - getComment
```
public final String getComment()
```
    Returns the comment describing the purpose of this cookie, or null if the cookie has no comment.
    
    Returns:
    
    The comment of the cookie, or null if unspecified
  - setComment
```
public void setComment(String purpose)
```
    Specifies a comment that describes a cookie's purpose. The comment is useful if the browser presents the cookie to the user. Comments are not supported by Netscape Version 0 cookies.
    
    Parameters:
    
    purpose - A String specifying the comment to display to the user.
  - getVersion
```
public final 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 final void setVersion(int version)
```
    Sets the version of the cookie protocol that 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.
  - newCookie
```
public static Cookie newCookie(String name,
                               String value)
```
    Creates a new Cookie with the provided name and value.
    
    Parameters:
    
    name - The name of the cookie.
    
    value - The value of the Cookie.
    
    Returns:
    
    A Cookie instance.
    
    Throws:
    
    IllegalArgumentException - If the cookie name is null or empty or contains any illegal characters (for example, a comma, space or semicolon) or matches a token reserved for use by the cookie protocol.
  - addCookie
```
public static void addCookie(Cookie cookie,
                             javax.servlet.http.HttpServletResponse resp)
```
    Adds the provided cookie to the provided HttpServletResponse as a 'Set-Cookie' header.
    
    Parameters:
    
    cookie - The cookie to add to the response.
    
    resp - The response to add the cookie to.
  - addCookies
```
public static void addCookies(Collection<Cookie> cookies,
                              javax.servlet.http.HttpServletResponse resp)
```
    Adds the provided cookies to the provided HttpServletResponse as a 'Set-Cookie' header.
    
    Parameters:
    
    cookies - The cookies to add to the response.
    
    resp - The response to add the cookie to.
  - getCookies
```
public static Set<Cookie> getCookies(javax.servlet.http.HttpServletRequest request)
```
    Gets all of the Cookies from the provided HttpServletRequest.
    
    Use this method to convert Cookies into Cookies so as to use as API which supports both the Servlet 2.5 and 3.0 Cookie API.
    
    Parameters:
    
    request - The request to get the cookies from.
    
    Returns:
    
    A Set of Cookies.

Class Cookie

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getName

getValue

setValue

getPath

setPath

getDomain

setDomain

getMaxAge

setMaxAge

isSecure

setSecure

isHttpOnly

setHttpOnly

getComment

setComment

getVersion

setVersion

newCookie

addCookie

addCookies

getCookies