edu.wisc.my.webproxy.beans.http
Interface ICookie

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

PersistedCookieImpl

public interface ICookie
extends java.io.Serializable

Represents a cookie that is passed to/from the remote application.

Version:

$Id: ICookie.java 47656 2010-01-08 21:03:49Z edalquist $

Author:

nramzan

Method Summary

java.lang.String	getComment() Returns the comment describing the purpose of this cookie, or null if no such comment has been defined.
java.util.Date	getCreated()
java.lang.String	getDomain() Returns domain attribute of the cookie.
java.util.Date	getExpiryDate() Returns the expiration Date of the cookie, or null if none exists.
java.lang.String	getName() Return the name.
java.lang.String	getPath() Returns the path attribute of the cookie
java.util.Date	getUpdated()
java.lang.String	getValue()
int	getVersion() Returns the version of the cookie specification to which this cookie conforms.
boolean	isExpired() Returns true if this cookie has expired.
boolean	isSecure()
void	setComment(java.lang.String purpose) Sets the comment used to describe the cookie's purpose.
void	setExpiryDate(java.util.Date expiry) Sets expiration date.
void	setPath(java.lang.String uri) Sets the path attribute.
void	setSecure(boolean flag) Sets the secure attribute of the cookie.
void	setValue(java.lang.String newValue) Set the value.
void	setVersion(int v) Sets the version of the cookie specification to which this cookie conforms.

Method Detail

getComment

java.lang.String getComment()

Returns the comment describing the purpose of this cookie, or null if no such comment has been defined.

Returns:

comment

See Also:

setComment(String)

getDomain

java.lang.String getDomain()

Returns domain attribute of the cookie.

Returns:

the value of the domain attribute

See Also:

#setDomain(java.lang.String)

getExpiryDate

java.util.Date getExpiryDate()

Returns the expiration Date of the cookie, or null if none exists.

Returns:

Expiration Date, or null.

See Also:

setExpiryDate(java.util.Date)

getName

java.lang.String getName()

Return the name.

Returns:

String name The name

See Also:

#setName(String)

getPath

java.lang.String getPath()

Returns the path attribute of the cookie

Returns:

The value of the path attribute.

See Also:

setPath(java.lang.String)

isSecure

boolean isSecure()

Returns:

true if this cookie should only be sent over secure connections.

See Also:

setSecure(boolean)

isExpired

boolean isExpired()

Returns true if this cookie has expired.

Returns:

true if the cookie has expired.

getValue

java.lang.String getValue()

getVersion

int getVersion()

Returns the version of the cookie specification to which this cookie conforms.

Returns:

the version of the cookie.

See Also:

setVersion(int)

setComment

void setComment(java.lang.String purpose)

Sets the comment used to describe the cookie's purpose.

Parameters:

comment -

See Also:

getComment()

setExpiryDate

void setExpiryDate(java.util.Date expiry)

Sets expiration date.

Parameters:

expiryDate - the Date after which this cookie is no longer valid.

See Also:

getExpiryDate()

setPath

void setPath(java.lang.String uri)

Sets the path attribute.

Parameters:

path - The value of the path attribute

See Also:

getPath()

setSecure

void setSecure(boolean flag)

Sets the secure attribute of the cookie.

When true the cookie should only be sent using a secure protocol (https). This should only be set when the cookie's originating server used a secure protocol to set the cookie's value.

Parameters:

secure - The value of the secure attribute

See Also:

#getSecure()

setValue

void setValue(java.lang.String newValue)

Set the value.

Parameters:

value - The new value.

setVersion

void setVersion(int v)

Sets the version of the cookie specification to which this cookie conforms.

Parameters:

version - the version of the cookie.

See Also:

getVersion()

getCreated

java.util.Date getCreated()

Returns:

When this cookie was originally created

getUpdated

java.util.Date getUpdated()

Returns:

The last time this cookie was updated