Package javax.ws.rs.core
Class Cookie
- java.lang.Object
-
- javax.ws.rs.core.Cookie
-
- Direct Known Subclasses:
NewCookie
public class Cookie extends Object
Represents the value of a HTTP cookie, transferred in a request. RFC 2109 specifies the legal characters for name, value, path and domain. The default version of 1 corresponds to RFC 2109.- See Also:
- IETF RFC 2109
-
-
Field Summary
Fields Modifier and Type Field Description static int
DEFAULT_VERSION
Cookies using the default version correspond to RFC 2109.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object obj)
Compare for equalityString
getDomain()
Get the domain of the cookieString
getName()
Get the name of the cookieString
getPath()
Get the path of the cookieString
getValue()
Get the value of the cookieint
getVersion()
Get the version of the cookieint
hashCode()
Generate a hashcode by hashing all of the cookies propertiesString
toString()
Convert the cookie to a string suitable for use as the value of the corresponding HTTP header.static Cookie
valueOf(String value)
Creates a new instance of Cookie by parsing the supplied string.
-
-
-
Field Detail
-
DEFAULT_VERSION
public static final int DEFAULT_VERSION
Cookies using the default version correspond to RFC 2109.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
Cookie
public Cookie(String name, String value, String path, String domain, int version)
Create a new instance.- Parameters:
name
- the name of the cookievalue
- the value of the cookiepath
- the URI path for which the cookie is validdomain
- the host domain for which the cookie is validversion
- the version of the specification to which the cookie complies- Throws:
IllegalArgumentException
- if name is null
-
Cookie
public Cookie(String name, String value, String path, String domain)
Create a new instance.- Parameters:
name
- the name of the cookievalue
- the value of the cookiepath
- the URI path for which the cookie is validdomain
- the host domain for which the cookie is valid- Throws:
IllegalArgumentException
- if name is null
-
Cookie
public Cookie(String name, String value)
Create a new instance.- Parameters:
name
- the name of the cookievalue
- the value of the cookie- Throws:
IllegalArgumentException
- if name is null
-
-
Method Detail
-
valueOf
public static Cookie valueOf(String value) throws IllegalArgumentException
Creates a new instance of Cookie by parsing the supplied string.- Parameters:
value
- the cookie string- Returns:
- the newly created Cookie
- Throws:
IllegalArgumentException
- if the supplied string cannot be parsed or is null
-
getName
public String getName()
Get the name of the cookie- Returns:
- the name
-
getValue
public String getValue()
Get the value of the cookie- Returns:
- the value
-
getVersion
public int getVersion()
Get the version of the cookie- Returns:
- the version
-
getDomain
public String getDomain()
Get the domain of the cookie- Returns:
- the domain
-
getPath
public String getPath()
Get the path of the cookie- Returns:
- the path
-
toString
public String toString()
Convert the cookie to a string suitable for use as the value of the corresponding HTTP header.
-
hashCode
public int hashCode()
Generate a hashcode by hashing all of the cookies properties
-
-