io.netty.handler.codec.http

Interface Cookie

All Superinterfaces:

Comparable<Cookie>

All Known Implementing Classes:

DefaultCookie

public interface Cookie
extends Comparable<Cookie>

An interface defining an HTTP cookie.

Method Summary

Methods

Modifier and Type	Method and Description
String	getComment() Returns the comment of this Cookie.
String	getCommentUrl() Returns the comment URL of this Cookie.
String	getDomain() Returns the domain of this Cookie.
long	getMaxAge() Returns the maximum age of this Cookie in seconds or Long.MIN_VALUE if unspecified
String	getName() Returns the name of this Cookie.
String	getPath() Returns the path of this Cookie.
Set<Integer>	getPorts() Returns the ports that this Cookie can be accessed on.
String	getValue() Returns the value of this Cookie.
int	getVersion() Returns the version of this Cookie.
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
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	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.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getName

String getName()

Returns the name of this Cookie.

Returns:

The name of this Cookie

getValue

String getValue()

Returns the value of this Cookie.

Returns:

The value of this Cookie

setValue

void setValue(String value)

Sets the value of this Cookie.

Parameters:

value - The value to set

getDomain

String getDomain()

Returns the domain of this Cookie.

Returns:

The domain of this Cookie

setDomain

void setDomain(String domain)

Sets the domain of this Cookie.

Parameters:

domain - The domain to use

getPath

String getPath()

Returns the path of this Cookie.

Returns:

The Cookie's path

setPath

void setPath(String path)

Sets the path of this Cookie.

Parameters:

path - The path to use for this Cookie

getComment

String getComment()

Returns the comment of this Cookie.

Returns:

The comment of this Cookie

setComment

void setComment(String comment)

Sets the comment of this Cookie.

Parameters:

comment - The comment to use

getMaxAge

long getMaxAge()

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

Returns:

The maximum age of this Cookie

setMaxAge

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

Parameters:

maxAge - The maximum age of this Cookie in seconds

getVersion

int getVersion()

Returns the version of this Cookie.

Returns:

The version of this Cookie

setVersion

void setVersion(int version)

Sets the version of this Cookie.

Parameters:

version - The new version to use

isSecure

boolean isSecure()

Checks to see if this Cookie is secure

Returns:

True if this Cookie is secure, otherwise false

setSecure

void setSecure(boolean secure)

Sets the security getStatus of this Cookie

Parameters:

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

isHttpOnly

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:

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

setHttpOnly

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

Parameters:

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

getCommentUrl

String getCommentUrl()

Returns the comment URL of this Cookie.

Returns:

The comment URL of this Cookie

setCommentUrl

void setCommentUrl(String commentUrl)

Sets the comment URL of this Cookie.

Parameters:

commentUrl - The comment URL to use

isDiscard

boolean isDiscard()

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

Returns:

True if this Cookie is to be discarded, otherwise false

setDiscard

void setDiscard(boolean discard)

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

Parameters:

discard - True if the Cookie is to be discarded

getPorts

Set<Integer> getPorts()

Returns the ports that this Cookie can be accessed on.

Returns:

The Set of ports that this Cookie can use

setPorts

void setPorts(int... ports)

Sets the ports that this Cookie can be accessed on.

Parameters:

ports - The ports that this Cookie can be accessed on

setPorts

void setPorts(Iterable<Integer> ports)

Sets the ports that this Cookie can be accessed on.

Parameters:

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