com.jaunt

Class Cookie

java.lang.Object

com.jaunt.Cookie

All Implemented Interfaces:

Serializable

public class Cookie
extends Object
implements Serializable

Represents a cookie.

Since:

0.9.0

Author:

Tom Cervenka

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Cookie(String sourceUrl, String cookieStr) Creates a Cookie for the specified sourceUrl from the specified cookieString, which has the following format (optional [] in any order):

Method Summary

Modifier and Type	Method and Description
Cookie	copy() Creates and returns a deep copy of this cookie.
String	getDomain() Retrieves the domain field of the cookie.
String	getExpires() Retrieves the (GMT String) expiry field of the cookie, eg Thu, 15-Apr-2010 20:00:00 GMT
boolean	getHttpOnly() Whether the HttpOnly flag is present.
String	getName() Retrieves the name field of the cookie.
String	getPath() Retrieves the path field of the cookie
boolean	getSecure() Whether the secure flag is present.
String	getValue() Retrieves the value field of the cookie.
boolean	isExpired() Whether the cookie has expired.
void	setDomain(String domain) Sets the domain of the cookie to the specified value.
void	setExpires(String expires) Sets the expires field of the cookie to the specified (GMT String) value, eg Thu, 15-Apr-2010 20:00:00 GMT
void	setHttpOnly(boolean httpOnly) Sets whether the cookie has the HttpOnly flag.
void	setName(String name) Sets the name field of the cookie to the specified value.
void	setPath(String path) Sets the path of the cookie to the specified value.
void	setSecure(boolean secure) Sets whether the cookie has the secure flag.
void	setValue(String value) Sets the value field of the cookie to the specified value.
String	toString() Returns a String representation of the Cookie (formatted as the Set-Cookie http header).

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Cookie

public Cookie(String sourceUrl,
              String cookieStr)
       throws JauntException

Creates a Cookie for the specified sourceUrl from the specified cookieString, which has the following format (optional [] in any order):

  "cookieName=cookieValue   (every cookie must have name and value, value can be "".  This is the only req. field)
  [; expires=timeInGMTString]  (eg expires=Thu, 15-Apr-2010 20:00:00 GMT)
  [; path=pathName]
  [; domain=domainName]
  [; secure]
  [; HttpOnly]"
  

Throws:

JauntException

Method Detail

copy

public Cookie copy()

Creates and returns a deep copy of this cookie.

isExpired

public boolean isExpired()

Whether the cookie has expired.

setName

public void setName(String name)

Sets the name field of the cookie to the specified value.

setValue

public void setValue(String value)

Sets the value field of the cookie to the specified value.

setExpires

public void setExpires(String expires)

Sets the expires field of the cookie to the specified (GMT String) value, eg Thu, 15-Apr-2010 20:00:00 GMT

setPath

public void setPath(String path)

Sets the path of the cookie to the specified value.

setDomain

public void setDomain(String domain)

Sets the domain of the cookie to the specified value.

setSecure

public void setSecure(boolean secure)

Sets whether the cookie has the secure flag.

setHttpOnly

public void setHttpOnly(boolean httpOnly)

Sets whether the cookie has the HttpOnly flag.

getName

public String getName()

Retrieves the name field of the cookie.

getValue

public String getValue()

Retrieves the value field of the cookie.

getExpires

public String getExpires()

Retrieves the (GMT String) expiry field of the cookie, eg Thu, 15-Apr-2010 20:00:00 GMT

getPath

public String getPath()

Retrieves the path field of the cookie

getDomain

public String getDomain()

Retrieves the domain field of the cookie.

getSecure

public boolean getSecure()

Whether the secure flag is present.

getHttpOnly

public boolean getHttpOnly()

Whether the HttpOnly flag is present.

toString

public String toString()

Returns a String representation of the Cookie (formatted as the Set-Cookie http header).

Overrides:

toString in class Object