Package javax.ws.rs.core
Class Cookie
java.lang.Object
javax.ws.rs.core.Cookie
- Direct Known Subclasses:
NewCookie
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.
- Since:
- 1.0
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
Cookies using the default version correspond to RFC 2109. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Compare for equality.Get the domain of the cookie.getName()
Get the name of the cookie.getPath()
Get the path of the cookie.getValue()
Get the value of the cookie.int
Get the version of the cookie.int
hashCode()
Generate a hash code by hashing all of the cookies properties.toString()
Convert the cookie to a string suitable for use as the value of the corresponding HTTP header.static Cookie
Creates a new instance ofCookie
by parsing the supplied string.
-
Field Details
-
DEFAULT_VERSION
public static final int DEFAULT_VERSIONCookies using the default version correspond to RFC 2109.- See Also:
-
-
Constructor Details
-
Cookie
public Cookie(String name, String value, String path, String domain, int version) throws IllegalArgumentException Create a new instance.- Parameters:
name
- the name of the cookie.value
- the value of the cookie.path
- the URI path for which the cookie is valid.domain
- the host domain for which the cookie is valid.version
- the version of the specification to which the cookie complies.- Throws:
IllegalArgumentException
- if name isnull
.
-
Cookie
public Cookie(String name, String value, String path, String domain) throws IllegalArgumentException Create a new instance.- Parameters:
name
- the name of the cookie.value
- the value of the cookie.path
- the URI path for which the cookie is valid.domain
- the host domain for which the cookie is valid.- Throws:
IllegalArgumentException
- if name isnull
.
-
Cookie
Create a new instance.- Parameters:
name
- the name of the cookie.value
- the value of the cookie.- Throws:
IllegalArgumentException
- if name isnull
.
-
-
Method Details
-
valueOf
Creates a new instance ofCookie
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 isnull
.
-
getName
Get the name of the cookie.- Returns:
- the cookie name.
-
getValue
Get the value of the cookie.- Returns:
- the cookie value.
-
getVersion
public int getVersion()Get the version of the cookie.- Returns:
- the cookie version.
-
getDomain
Get the domain of the cookie.- Returns:
- the cookie domain.
-
getPath
Get the path of the cookie.- Returns:
- the cookie path.
-
toString
Convert the cookie to a string suitable for use as the value of the corresponding HTTP header. -
hashCode
public int hashCode()Generate a hash code by hashing all of the cookies properties. -
equals
Compare for equality.
-