org.bridje.http

Interface HttpCookie

All Superinterfaces:

Comparable<HttpCookie>

public interface HttpCookie
extends Comparable<HttpCookie>

An interface defining an HTTP cookie.

Method Summary

Modifier and Type	Method and Description
String	getDomain() Returns the domain of this HttpCookie.
long	getMaxAge() Returns the maximum age of this HttpCookie in seconds or Long.MIN_VALUE if unspecified
String	getName() Returns the name of this HttpCookie.
String	getPath() Returns the path of this HttpCookie.
String	getValue() Returns the value of this HttpCookie.
boolean	getWrap() Returns true if the raw value of this HttpCookie, was wrapped with double quotes in original Set-Cookie header.
boolean	isHttpOnly() Checks to see if this HttpCookie can only be accessed via HTTP.
boolean	isSecure() Checks to see if this HttpCookie is secure
void	setDomain(String domain) Sets the domain of this HttpCookie.
void	setHttpOnly(boolean httpOnly) Determines if this HttpCookie is HTTP only.
void	setMaxAge(long maxAge) Sets the maximum age of this HttpCookie in seconds.
void	setPath(String path) Sets the path of this HttpCookie.
void	setSecure(boolean secure) Sets the security getStatus of this HttpCookie
void	setValue(String value) Sets the value of this HttpCookie.
void	setWrap(boolean wrap) Sets true if the value of this HttpCookie is to be wrapped with double quotes.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getName

String getName()

Returns the name of this HttpCookie.

Returns:

The name of this HttpCookie

getValue

String getValue()

Returns the value of this HttpCookie.

Returns:

The value of this HttpCookie

setValue

void setValue(String value)

Sets the value of this HttpCookie.

Parameters:

value - The value to set

getWrap

boolean getWrap()

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

Returns:

If the value of this HttpCookie is to be wrapped

setWrap

void setWrap(boolean wrap)

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

Parameters:

wrap - true if wrap

getDomain

String getDomain()

Returns the domain of this HttpCookie.

Returns:

The domain of this HttpCookie

setDomain

void setDomain(String domain)

Sets the domain of this HttpCookie.

Parameters:

domain - The domain to use

getPath

String getPath()

Returns the path of this HttpCookie.

Returns:

The HttpCookie's path

setPath

void setPath(String path)

Sets the path of this HttpCookie.

Parameters:

path - The path to use for this HttpCookie

getMaxAge

long getMaxAge()

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

Returns:

The maximum age of this HttpCookie

setMaxAge

void setMaxAge(long maxAge)

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

Parameters:

maxAge - The maximum age of this HttpCookie in seconds

isSecure

boolean isSecure()

Checks to see if this HttpCookie is secure

Returns:

True if this HttpCookie is secure, otherwise false

setSecure

void setSecure(boolean secure)

Sets the security getStatus of this HttpCookie

Parameters:

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

isHttpOnly

boolean isHttpOnly()

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

Returns:

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

setHttpOnly

void setHttpOnly(boolean httpOnly)

Determines if this HttpCookie is HTTP only. If set to true, this HttpCookie 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 HttpCookie is HTTP only, otherwise false.