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

Modifier and Type	Field and Description
public static final long	UNDEFINED_MAX_AGE Constant for undefined MaxAge attribute value.

Method Summary

Modifier and Type	Method and Description
public String	Returns: The domain of this `Cookie` domain() Returns the domain of this `Cookie`.
public boolean	Returns: True if this `Cookie` is HTTP-only or false if it isn't isHttpOnly() Checks to see if this `Cookie` can only be accessed via HTTP.
public boolean	Returns: True if this `Cookie` is secure, otherwise false isSecure() Checks to see if this `Cookie` is secure
public long	Returns: The maximum age of this `Cookie` maxAge() Returns the maximum age of this `Cookie` in seconds or `Cookie#UNDEFINED_MAX_AGE` if unspecified
public String	Returns: The name of this `Cookie` name() Returns the name of this `Cookie`.
public String	Returns: The `Cookie`'s path path() Returns the path of this `Cookie`.
public void	setDomain(String The domain to use domain) Sets the domain of this `Cookie`.
public void	setHttpOnly(boolean True if the `Cookie` is HTTP only, otherwise false. httpOnly) Determines if this `Cookie` is HTTP only.
public void	setMaxAge(long The maximum age of this `Cookie` in seconds maxAge) Sets the maximum age of this `Cookie` in seconds.
public void	setPath(String The path to use for this `Cookie` path) Sets the path of this `Cookie`.
public void	setSecure(boolean True if this `Cookie` is to be secure, otherwise false secure) Sets the security getStatus of this `Cookie`
public void	setValue(String The value to set value) Sets the value of this `Cookie`.
public void	setWrap(boolean true if wrap wrap) Sets true if the value of this `Cookie` is to be wrapped with double quotes.
public String	Returns: The value of this `Cookie` value() Returns the value of this `Cookie`.
public boolean	Returns: If the value of this `Cookie` is to be wrapped wrap() Returns true if the raw value of this `Cookie`, was wrapped with double quotes in original Set-Cookie header.

Inherited from java.lang.Comparable:: compareTo

UNDEFINED_MAX_AGE	back to summary
public static final long UNDEFINED_MAX_AGE Constant for undefined MaxAge attribute value.

Method Detail

domain back to summary

domain	back to summary
public String domain() Returns the domain of this `Cookie`. Returns:String The domain of this `Cookie`

public String domain()

Returns the domain of this Cookie.

Returns:String: The domain of this Cookie

isHttpOnly back to summary

isHttpOnly	back to summary
public boolean 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

public boolean 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

isSecure back to summary

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

public boolean isSecure()

Checks to see if this Cookie is secure

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

maxAge back to summary

maxAge	back to summary
public long 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`

public long 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

name back to summary

name	back to summary
public String name() Returns the name of this `Cookie`. Returns:String The name of this `Cookie`

public String name()

Returns the name of this Cookie.

Returns:String: The name of this Cookie

path back to summary

path	back to summary
public String path() Returns the path of this `Cookie`. Returns:String The `Cookie`'s path

public String path()

Returns the path of this Cookie.

Returns:String: The Cookie's path

setDomain back to summary

setDomain	back to summary
public void setDomain(String domain) Sets the domain of this `Cookie`. Parameters domain:String The domain to use

public void setDomain(String domain)

Sets the domain of this Cookie.

Parameters

domain:String: The domain to use

setHttpOnly back to summary

setHttpOnly	back to summary
public void setHttpOnly(boolean httpOnly) 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.

public void setHttpOnly(boolean httpOnly)

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.

setMaxAge back to summary

setMaxAge	back to summary
public void setMaxAge(long maxAge) 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

public void setMaxAge(long maxAge)

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

setPath back to summary

setPath	back to summary
public void setPath(String path) Sets the path of this `Cookie`. Parameters path:String The path to use for this `Cookie`

public void setPath(String path)

Sets the path of this Cookie.

Parameters

path:String: The path to use for this Cookie

setSecure back to summary

setSecure	back to summary
public void setSecure(boolean secure) Sets the security getStatus of this `Cookie` Parameters secure:boolean True if this `Cookie` is to be secure, otherwise false

public void setSecure(boolean secure)

Sets the security getStatus of this Cookie

Parameters

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

setValue back to summary

setValue	back to summary
public void setValue(String value) Sets the value of this `Cookie`. Parameters value:String The value to set

public void setValue(String value)

Sets the value of this Cookie.

Parameters

value:String: The value to set

setWrap back to summary

setWrap	back to summary
public void setWrap(boolean wrap) Sets true if the value of this `Cookie` is to be wrapped with double quotes. Parameters wrap:boolean true if wrap

public void setWrap(boolean wrap)

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

Parameters

wrap:boolean: true if wrap

value back to summary

value	back to summary
public String value() Returns the value of this `Cookie`. Returns:String The value of this `Cookie`

public String value()

Returns the value of this Cookie.

Returns:String: The value of this Cookie

wrap back to summary

wrap	back to summary
public boolean 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

public boolean 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

public Interface Cookie

Field Summary

Method Summary

Field Detail

Method Detail