Netty/Codec/HTTP 4.1.107.Final · io.netty.handler.codec.http.cookie.DefaultCookie

Modifier and Type	Field and Description
private String	domain
private boolean	httpOnly
private long	maxAge
private final String	name
private boolean	partitioned
private String	path
private CookieHeaderNames.SameSite	sameSite
private boolean	secure
private String	value
private boolean	wrap

Access	Constructor and Description
public	DefaultCookie(String name, String value) Creates a new cookie with the specified name and value.

Method Summary

Modifier and Type	Method and Description
public int	compareTo(Cookie the object to be compared. c) Implements java.lang.Comparable.compareTo. Compares this object with the specified object for order.
public String	domain() Implements io.netty.handler.codec.http.cookie.Cookie.domain. Returns the domain of this `Cookie`.
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public boolean	isHttpOnly() Implements io.netty.handler.codec.http.cookie.Cookie.isHttpOnly. Checks to see if this `Cookie` can only be accessed via HTTP.
public boolean	Returns: True if this `Cookie` is partitioned, otherwise false isPartitioned() Checks to see if this `Cookie` is partitioned
public boolean	isSecure() Implements io.netty.handler.codec.http.cookie.Cookie.isSecure. Checks to see if this `Cookie` is secure
public long	maxAge() Implements io.netty.handler.codec.http.cookie.Cookie.maxAge. Returns the maximum age of this `Cookie` in seconds or `Cookie#UNDEFINED_MAX_AGE` if unspecified
public String	name() Implements io.netty.handler.codec.http.cookie.Cookie.name. Returns the name of this `Cookie`.
public String	path() Implements io.netty.handler.codec.http.cookie.Cookie.path. Returns the path of this `Cookie`.
public CookieHeaderNames.SameSite	Returns: same-site-flag value sameSite() Checks to see if this `Cookie` can be sent along cross-site requests.
public void	setDomain(String The domain to use domain) Implements io.netty.handler.codec.http.cookie.Cookie.setDomain. Sets the domain of this `Cookie`.
public void	setHttpOnly(boolean True if the `Cookie` is HTTP only, otherwise false. httpOnly) Implements io.netty.handler.codec.http.cookie.Cookie.setHttpOnly. Determines if this `Cookie` is HTTP only.
public void	setMaxAge(long The maximum age of this `Cookie` in seconds maxAge) Implements io.netty.handler.codec.http.cookie.Cookie.setMaxAge. Sets the maximum age of this `Cookie` in seconds.
public void	setPartitioned(boolean True if this `Cookie` is to be partitioned, otherwise false partitioned) Sets the `Partitioned` attribute of this `Cookie`
public void	setPath(String The path to use for this `Cookie` path) Implements io.netty.handler.codec.http.cookie.Cookie.setPath. Sets the path of this `Cookie`.
public void	setSameSite(CookieHeaderNames.SameSite same-site-flag value sameSite) Determines if this this `Cookie` can be sent along cross-site requests.
public void	setSecure(boolean True if this `Cookie` is to be secure, otherwise false secure) Implements io.netty.handler.codec.http.cookie.Cookie.setSecure. Sets the security getStatus of this `Cookie`
public void	setValue(String The value to set value) Implements io.netty.handler.codec.http.cookie.Cookie.setValue. Sets the value of this `Cookie`.
public void	setWrap(boolean true if wrap wrap) Implements io.netty.handler.codec.http.cookie.Cookie.setWrap. Sets true if the value of this `Cookie` is to be wrapped with double quotes.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
protected String	Returns: the trimmed, validated attribute value validateValue(String attribute name name, String attribute value value) Deprecated CookieUtil is package private, will be removed once old Cookie API is dropped Validate a cookie attribute value, throws a `IllegalArgumentException` otherwise.
public String	value() Implements io.netty.handler.codec.http.cookie.Cookie.value. Returns the value of this `Cookie`.
public boolean	wrap() Implements io.netty.handler.codec.http.cookie.Cookie.wrap. Returns true if the raw value of this `Cookie`, was wrapped with double quotes in original Set-Cookie header.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

domain	back to summary
private String domain

httpOnly	back to summary
private boolean httpOnly

maxAge	back to summary
private long maxAge

name	back to summary
private final String name

partitioned	back to summary
private boolean partitioned

path	back to summary
private String path

sameSite	back to summary
private CookieHeaderNames.SameSite sameSite

secure	back to summary
private boolean secure

value	back to summary
private String value

wrap	back to summary
private boolean wrap

Method Detail

compareTo back to summary

public int compareTo(Cookie c)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters

c:Cookie: the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations

@Override

domain back to summary

domain	back to summary
public String domain() Implements io.netty.handler.codec.http.cookie.Cookie.domain. Doc from io.netty.handler.codec.http.cookie.Cookie.domain. Returns the domain of this `Cookie`. Returns:String The domain of this `Cookie` Annotations @Override

public String domain()

Implements io.netty.handler.codec.http.cookie.Cookie.domain.

Doc from io.netty.handler.codec.http.cookie.Cookie.domain.

Returns the domain of this Cookie.

Returns:String

The domain of this Cookie

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object.

Annotations

@Override

isHttpOnly back to summary

isHttpOnly	back to summary
public boolean isHttpOnly() Implements io.netty.handler.codec.http.cookie.Cookie.isHttpOnly. Doc from io.netty.handler.codec.http.cookie.Cookie.isHttpOnly. Checks to see if this `Cookie` can only be accessed via HTTP. If this returns true, the `Cookie` cannot be accessed through client side script - But only if the browser supports it. For more information, please look here Returns:boolean True if this `Cookie` is HTTP-only or false if it isn't Annotations @Override

public boolean isHttpOnly()

Implements io.netty.handler.codec.http.cookie.Cookie.isHttpOnly.

Doc from io.netty.handler.codec.http.cookie.Cookie.isHttpOnly.

Checks to see if this Cookie can only be accessed via HTTP. If this returns true, the Cookie cannot be accessed through client side script - But only if the browser supports it. For more information, please look here

Returns:boolean

True if this Cookie is HTTP-only or false if it isn't

Annotations

@Override

isPartitioned back to summary

isPartitioned	back to summary
public boolean isPartitioned() Checks to see if this `Cookie` is partitioned Returns:boolean True if this `Cookie` is partitioned, otherwise false

public boolean isPartitioned()

Checks to see if this Cookie is partitioned

Returns:boolean: True if this Cookie is partitioned, otherwise false

isSecure back to summary

isSecure	back to summary
public boolean isSecure() Implements io.netty.handler.codec.http.cookie.Cookie.isSecure. Doc from io.netty.handler.codec.http.cookie.Cookie.isSecure. Checks to see if this `Cookie` is secure Returns:boolean True if this `Cookie` is secure, otherwise false Annotations @Override

public boolean isSecure()

Implements io.netty.handler.codec.http.cookie.Cookie.isSecure.

Doc from io.netty.handler.codec.http.cookie.Cookie.isSecure.

Checks to see if this Cookie is secure

Returns:boolean

True if this Cookie is secure, otherwise false

Annotations

@Override

maxAge back to summary

maxAge	back to summary
public long maxAge() Implements io.netty.handler.codec.http.cookie.Cookie.maxAge. Doc from io.netty.handler.codec.http.cookie.Cookie.maxAge. Returns the maximum age of this `Cookie` in seconds or `Cookie#UNDEFINED_MAX_AGE` if unspecified Returns:long The maximum age of this `Cookie` Annotations @Override

public long maxAge()

Implements io.netty.handler.codec.http.cookie.Cookie.maxAge.

Doc from io.netty.handler.codec.http.cookie.Cookie.maxAge.

Returns the maximum age of this Cookie in seconds or Cookie#UNDEFINED_MAX_AGE if unspecified

Returns:long

The maximum age of this Cookie

Annotations

@Override

name back to summary

name	back to summary
public String name() Implements io.netty.handler.codec.http.cookie.Cookie.name. Doc from io.netty.handler.codec.http.cookie.Cookie.name. Returns the name of this `Cookie`. Returns:String The name of this `Cookie` Annotations @Override

public String name()

Implements io.netty.handler.codec.http.cookie.Cookie.name.

Doc from io.netty.handler.codec.http.cookie.Cookie.name.

Returns the name of this Cookie.

Returns:String

The name of this Cookie

Annotations

@Override

path back to summary

path	back to summary
public String path() Implements io.netty.handler.codec.http.cookie.Cookie.path. Doc from io.netty.handler.codec.http.cookie.Cookie.path. Returns the path of this `Cookie`. Returns:String The `Cookie`'s path Annotations @Override

public String path()

Implements io.netty.handler.codec.http.cookie.Cookie.path.

Doc from io.netty.handler.codec.http.cookie.Cookie.path.

Returns the path of this Cookie.

Returns:String

The Cookie's path

Annotations

@Override

sameSite back to summary

sameSite	back to summary
public CookieHeaderNames.SameSite sameSite() Checks to see if this `Cookie` can be sent along cross-site requests. For more information, please look here Returns:CookieHeaderNames.SameSite same-site-flag value

public CookieHeaderNames.SameSite sameSite()

Checks to see if this Cookie can be sent along cross-site requests. For more information, please look here

Returns:CookieHeaderNames.SameSite: same-site-flag value

setDomain back to summary

setDomain	back to summary
public void setDomain(String domain) Implements io.netty.handler.codec.http.cookie.Cookie.setDomain. Doc from io.netty.handler.codec.http.cookie.Cookie.setDomain. Sets the domain of this `Cookie`. Parameters domain:String The domain to use Annotations @Override

public void setDomain(String domain)

Implements io.netty.handler.codec.http.cookie.Cookie.setDomain.

Doc from io.netty.handler.codec.http.cookie.Cookie.setDomain.

Sets the domain of this Cookie.

Parameters

domain:String: The domain to use

Annotations

@Override

setHttpOnly back to summary

setHttpOnly	back to summary
public void setHttpOnly(boolean httpOnly) Implements io.netty.handler.codec.http.cookie.Cookie.setHttpOnly. Doc from io.netty.handler.codec.http.cookie.Cookie.setHttpOnly. Determines if this `Cookie` is HTTP only. If set to true, this `Cookie` cannot be accessed by a client side script. However, this works only if the browser supports it. For information, please look here. Parameters httpOnly:boolean True if the `Cookie` is HTTP only, otherwise false. Annotations @Override

public void setHttpOnly(boolean httpOnly)

Implements io.netty.handler.codec.http.cookie.Cookie.setHttpOnly.

Doc from io.netty.handler.codec.http.cookie.Cookie.setHttpOnly.

Determines if this Cookie is HTTP only. If set to true, this Cookie cannot be accessed by a client side script. However, this works only if the browser supports it. For information, please look here.

Parameters

httpOnly:boolean: True if the Cookie is HTTP only, otherwise false.

Annotations

@Override

setMaxAge back to summary

setMaxAge	back to summary
public void setMaxAge(long maxAge) Implements io.netty.handler.codec.http.cookie.Cookie.setMaxAge. Doc from io.netty.handler.codec.http.cookie.Cookie.setMaxAge. Sets the maximum age of this `Cookie` in seconds. If an age of `0` is specified, this `Cookie` will be automatically removed by browser because it will expire immediately. If `Cookie#UNDEFINED_MAX_AGE` is specified, this `Cookie` will be removed when the browser is closed. Parameters maxAge:long The maximum age of this `Cookie` in seconds Annotations @Override

public void setMaxAge(long maxAge)

Implements io.netty.handler.codec.http.cookie.Cookie.setMaxAge.

Doc from io.netty.handler.codec.http.cookie.Cookie.setMaxAge.

Sets the maximum age of this Cookie in seconds. If an age of 0 is specified, this Cookie will be automatically removed by browser because it will expire immediately. If Cookie#UNDEFINED_MAX_AGE is specified, this Cookie will be removed when the browser is closed.

Parameters

maxAge:long: The maximum age of this Cookie in seconds

Annotations

@Override

setPartitioned back to summary

setPartitioned	back to summary
public void setPartitioned(boolean partitioned) Sets the `Partitioned` attribute of this `Cookie` Parameters partitioned:boolean True if this `Cookie` is to be partitioned, otherwise false

public void setPartitioned(boolean partitioned)

Sets the Partitioned attribute of this Cookie

Parameters

partitioned:boolean: True if this Cookie is to be partitioned, otherwise false

setPath back to summary

setPath	back to summary
public void setPath(String path) Implements io.netty.handler.codec.http.cookie.Cookie.setPath. Doc from io.netty.handler.codec.http.cookie.Cookie.setPath. Sets the path of this `Cookie`. Parameters path:String The path to use for this `Cookie` Annotations @Override

public void setPath(String path)

Implements io.netty.handler.codec.http.cookie.Cookie.setPath.

Doc from io.netty.handler.codec.http.cookie.Cookie.setPath.

Sets the path of this Cookie.

Parameters

path:String: The path to use for this Cookie

Annotations

@Override

setSameSite back to summary

public void setSameSite(CookieHeaderNames.SameSite sameSite)

Determines if this this Cookie can be sent along cross-site requests. For more information, please look here

Parameters

sameSite:CookieHeaderNames.SameSite: same-site-flag value

setSecure back to summary

setSecure	back to summary
public void setSecure(boolean secure) Implements io.netty.handler.codec.http.cookie.Cookie.setSecure. Doc from io.netty.handler.codec.http.cookie.Cookie.setSecure. Sets the security getStatus of this `Cookie` Parameters secure:boolean True if this `Cookie` is to be secure, otherwise false Annotations @Override

public void setSecure(boolean secure)

Implements io.netty.handler.codec.http.cookie.Cookie.setSecure.

Doc from io.netty.handler.codec.http.cookie.Cookie.setSecure.

Sets the security getStatus of this Cookie

Parameters

secure:boolean: True if this Cookie is to be secure, otherwise false

Annotations

@Override

setValue back to summary

setValue	back to summary
public void setValue(String value) Implements io.netty.handler.codec.http.cookie.Cookie.setValue. Doc from io.netty.handler.codec.http.cookie.Cookie.setValue. Sets the value of this `Cookie`. Parameters value:String The value to set Annotations @Override

public void setValue(String value)

Implements io.netty.handler.codec.http.cookie.Cookie.setValue.

Doc from io.netty.handler.codec.http.cookie.Cookie.setValue.

Sets the value of this Cookie.

Parameters

value:String: The value to set

Annotations

@Override

setWrap back to summary

setWrap	back to summary
public void setWrap(boolean wrap) Implements io.netty.handler.codec.http.cookie.Cookie.setWrap. Doc from io.netty.handler.codec.http.cookie.Cookie.setWrap. Sets true if the value of this `Cookie` is to be wrapped with double quotes. Parameters wrap:boolean true if wrap Annotations @Override

public void setWrap(boolean wrap)

Implements io.netty.handler.codec.http.cookie.Cookie.setWrap.

Doc from io.netty.handler.codec.http.cookie.Cookie.setWrap.

Sets true if the value of this Cookie is to be wrapped with double quotes.

Parameters

wrap:boolean: true if wrap

Annotations

@Override

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

validateValue back to summary

validateValue	back to summary
protected String validateValue(String name, String value) Deprecated CookieUtil is package private, will be removed once old Cookie API is dropped Validate a cookie attribute value, throws a `IllegalArgumentException` otherwise. Only intended to be used by `io.netty.handler.codec.http.DefaultCookie`. Parameters name:String attribute name value:String attribute value Returns:String the trimmed, validated attribute value Annotations @Deprecated

protected String validateValue(String name, String value)

Deprecated

CookieUtil is package private, will be removed once old Cookie API is dropped

Validate a cookie attribute value, throws a IllegalArgumentException otherwise. Only intended to be used by io.netty.handler.codec.http.DefaultCookie.

Parameters

name:String: attribute name
value:String: attribute value

Returns:String

the trimmed, validated attribute value

Annotations

@Deprecated

value back to summary

value	back to summary
public String value() Implements io.netty.handler.codec.http.cookie.Cookie.value. Doc from io.netty.handler.codec.http.cookie.Cookie.value. Returns the value of this `Cookie`. Returns:String The value of this `Cookie` Annotations @Override

public String value()

Implements io.netty.handler.codec.http.cookie.Cookie.value.

Doc from io.netty.handler.codec.http.cookie.Cookie.value.

Returns the value of this Cookie.

Returns:String

The value of this Cookie

Annotations

@Override

wrap back to summary

wrap	back to summary
public boolean wrap() Implements io.netty.handler.codec.http.cookie.Cookie.wrap. Doc from io.netty.handler.codec.http.cookie.Cookie.wrap. Returns true if the raw value of this `Cookie`, was wrapped with double quotes in original Set-Cookie header. Returns:boolean If the value of this `Cookie` is to be wrapped Annotations @Override

public boolean wrap()

Implements io.netty.handler.codec.http.cookie.Cookie.wrap.

Doc from io.netty.handler.codec.http.cookie.Cookie.wrap.

Returns true if the raw value of this Cookie, was wrapped with double quotes in original Set-Cookie header.

Returns:boolean

If the value of this Cookie is to be wrapped

Annotations

@Override

public Class DefaultCookie

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail