Package jakarta.ws.rs.core
Class Cookie
java.lang.Object
jakarta.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.
- Since:
- 1.0
- Author:
- Paul Sandoz, Marc Hadley
- 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. -
Constructor Summary
-
Method Summary
Modifier and Type Method Description boolean
equals(Object obj)
Compare for equality.String
getDomain()
Get the domain of the cookie.String
getName()
Get the name of the cookie.String
getPath()
Get the path of the cookie.String
getValue()
Get the value of the cookie.int
getVersion()
Get the version of the cookie.int
hashCode()
Generate a hash code by hashing all of the cookies properties.String
toString()
Deprecated.The format of the toString() method is subject to change in a future version.static Cookie
valueOf(String value)
Deprecated.This method will be removed in a future version.
-
Field Details
-
DEFAULT_VERSION
public static final int DEFAULT_VERSIONCookies using the default version correspond to RFC 2109.- See Also:
- Constant Field Values
-
-
Constructor Details
-
Cookie
public Cookie(String name, String value, String path, String domain, int version) throws IllegalArgumentExceptionCreate 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 IllegalArgumentExceptionCreate 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
Deprecated.This method will be removed in a future version. Please use RuntimeDelegate.getInstance().createHeaderDelegate(Cookie.class).fromString(value) instead.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
Deprecated.The format of the toString() method is subject to change in a future version. Please use RuntimeDelegate.getInstance().createHeaderDelegate(Cookie.class).toString(value) instead if you rely on the format of this method.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.
-