io.netty.handler.codec.http

Class DefaultCookie

java.lang.Object

io.netty.handler.codec.http.DefaultCookie

All Implemented Interfaces:

Cookie, Comparable<Cookie>

public class DefaultCookie
extends Object
implements Cookie

The default Cookie implementation.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
String	comment() Returns the comment of this Cookie.
String	commentUrl() Returns the comment URL of this Cookie.
int	compareTo(Cookie c)
String	domain() Returns the domain of this Cookie.
boolean	equals(Object o)
int	hashCode()
boolean	isDiscard() Checks to see if this Cookie is to be discarded by the browser at the end of the current session.
boolean	isHttpOnly() Checks to see if this Cookie can only be accessed via HTTP.
boolean	isSecure() Checks to see if this Cookie is secure
long	maxAge() Returns the maximum age of this Cookie in seconds or Long.MIN_VALUE if unspecified
String	name() Returns the name of this Cookie.
String	path() Returns the path of this Cookie.
Set<Integer>	ports() Returns the ports that this Cookie can be accessed on.
String	rawValue() Returns the raw value of this Cookie, as it was set in original Set-Cookie header.
void	setComment(String comment) Sets the comment of this Cookie.
void	setCommentUrl(String commentUrl) Sets the comment URL of this Cookie.
void	setDiscard(boolean discard) Sets the discard flag of this Cookie.
void	setDomain(String domain) Sets the domain of this Cookie.
void	setHttpOnly(boolean httpOnly) Determines if this Cookie is HTTP only.
void	setMaxAge(long maxAge) Sets the maximum age of this Cookie in seconds.
void	setPath(String path) Sets the path of this Cookie.
void	setPorts(int... ports) Sets the ports that this Cookie can be accessed on.
void	setPorts(Iterable<Integer> ports) Sets the ports that this Cookie can be accessed on.
void	setRawValue(String rawValue) Sets the raw value of this Cookie.
void	setSecure(boolean secure) Sets the security getStatus of this Cookie
void	setValue(String value) Sets the value of this Cookie.
void	setVersion(int version) Sets the version of this Cookie.
String	toString()
String	value() Returns the value of this Cookie.
int	version() Returns the version of this Cookie.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultCookie

public DefaultCookie(String name,
             String value)

Creates a new cookie with the specified name and value.

Method Detail

name

public String name()

Description copied from interface: Cookie

Returns the name of this Cookie.

Specified by:

name in interface Cookie

Returns:

The name of this Cookie

value

public String value()

Description copied from interface: Cookie

Returns the value of this Cookie.

Specified by:

value in interface Cookie

Returns:

The value of this Cookie

setValue

public void setValue(String value)

Description copied from interface: Cookie

Sets the value of this Cookie.

Specified by:

setValue in interface Cookie

Parameters:

value - The value to set

rawValue

public String rawValue()

Description copied from interface: Cookie

Returns the raw value of this Cookie, as it was set in original Set-Cookie header.

Specified by:

rawValue in interface Cookie

Returns:

The raw value of this Cookie

setRawValue

public void setRawValue(String rawValue)

Description copied from interface: Cookie

Sets the raw value of this Cookie.

Specified by:

setRawValue in interface Cookie

Parameters:

rawValue - The raw value to set

domain

public String domain()

Description copied from interface: Cookie

Returns the domain of this Cookie.

Specified by:

domain in interface Cookie

Returns:

The domain of this Cookie

setDomain

public void setDomain(String domain)

Description copied from interface: Cookie

Sets the domain of this Cookie.

Specified by:

setDomain in interface Cookie

Parameters:

domain - The domain to use

path

public String path()

Description copied from interface: Cookie

Returns the path of this Cookie.

Specified by:

path in interface Cookie

Returns:

The Cookie's path

setPath

public void setPath(String path)

Description copied from interface: Cookie

Sets the path of this Cookie.

Specified by:

setPath in interface Cookie

Parameters:

path - The path to use for this Cookie

comment

public String comment()

Description copied from interface: Cookie

Returns the comment of this Cookie.

Specified by:

comment in interface Cookie

Returns:

The comment of this Cookie

setComment

public void setComment(String comment)

Description copied from interface: Cookie

Sets the comment of this Cookie.

Specified by:

setComment in interface Cookie

Parameters:

comment - The comment to use

commentUrl

public String commentUrl()

Description copied from interface: Cookie

Returns the comment URL of this Cookie.

Specified by:

commentUrl in interface Cookie

Returns:

The comment URL of this Cookie

setCommentUrl

public void setCommentUrl(String commentUrl)

Description copied from interface: Cookie

Sets the comment URL of this Cookie.

Specified by:

setCommentUrl in interface Cookie

Parameters:

commentUrl - The comment URL to use

isDiscard

public boolean isDiscard()

Description copied from interface: Cookie

Checks to see if this Cookie is to be discarded by the browser at the end of the current session.

Specified by:

isDiscard in interface Cookie

Returns:

True if this Cookie is to be discarded, otherwise false

setDiscard

public void setDiscard(boolean discard)

Description copied from interface: Cookie

Sets the discard flag of this Cookie. If set to true, this Cookie will be discarded by the browser at the end of the current session

Specified by:

setDiscard in interface Cookie

Parameters:

discard - True if the Cookie is to be discarded

ports

public Set<Integer> ports()

Description copied from interface: Cookie

Returns the ports that this Cookie can be accessed on.

Specified by:

ports in interface Cookie

Returns:

The Set of ports that this Cookie can use

setPorts

public void setPorts(int... ports)

Description copied from interface: Cookie

Sets the ports that this Cookie can be accessed on.

Specified by:

setPorts in interface Cookie

Parameters:

ports - The ports that this Cookie can be accessed on

setPorts

public void setPorts(Iterable<Integer> ports)

Description copied from interface: Cookie

Sets the ports that this Cookie can be accessed on.

Specified by:

setPorts in interface Cookie

Parameters:

ports - The Iterable collection of ports that this Cookie can be accessed on.

maxAge

public long maxAge()

Description copied from interface: Cookie

Returns the maximum age of this Cookie in seconds or Long.MIN_VALUE if unspecified

Specified by:

maxAge in interface Cookie

Returns:

The maximum age of this Cookie

setMaxAge

public void setMaxAge(long maxAge)

Description copied from interface: Cookie

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 Long.MIN_VALUE is specified, this Cookie will be removed when the browser is closed.

Specified by:

setMaxAge in interface Cookie

Parameters:

maxAge - The maximum age of this Cookie in seconds

version

public int version()

Description copied from interface: Cookie

Returns the version of this Cookie.

Specified by:

version in interface Cookie

Returns:

The version of this Cookie

setVersion

public void setVersion(int version)

Description copied from interface: Cookie

Sets the version of this Cookie.

Specified by:

setVersion in interface Cookie

Parameters:

version - The new version to use

isSecure

public boolean isSecure()

Description copied from interface: Cookie

Checks to see if this Cookie is secure

Specified by:

isSecure in interface Cookie

Returns:

True if this Cookie is secure, otherwise false

setSecure

public void setSecure(boolean secure)

Description copied from interface: Cookie

Sets the security getStatus of this Cookie

Specified by:

setSecure in interface Cookie

Parameters:

secure - True if this Cookie is to be secure, otherwise false

isHttpOnly

public boolean isHttpOnly()

Description copied from interface: Cookie

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

Specified by:

isHttpOnly in interface Cookie

Returns:

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

setHttpOnly

public void setHttpOnly(boolean httpOnly)

Description copied from interface: Cookie

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 for information, please look here.

Specified by:

setHttpOnly in interface Cookie

Parameters:

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

compareTo

public int compareTo(Cookie c)

Specified by:

compareTo in interface Comparable<Cookie>

toString

public String toString()

Overrides:

toString in class Object