com.codename1.io

Class Cookie

java.lang.Object

com.codename1.io.Cookie

All Implemented Interfaces:

Externalizable

public class Cookie
extends Object
implements Externalizable

A cookie for an HTTP request

Author:

Shai Almog

Field Summary

Fields

Modifier and Type	Field and Description
static String	STORAGE_NAME

Constructor Summary

Constructors

Constructor and Description
Cookie()

Method Summary

Modifier and Type	Method and Description
static void	clearCookiesFromStorage() Clears all cookies history from storage
void	externalize(DataOutputStream out) Allows us to store an object state, this method must be implemented in order to save the state of an object
String	getDomain()
long	getExpires()
String	getName()
String	getObjectId() The object id must be unique, it is used to identify the object when loaded even when it is obfuscated.
String	getPath()
String	getValue()
int	getVersion() Returns the version for the current persistance code, the version will be pased to internalized thus allowing the internalize method to recognize classes persisted in older revisions
void	internalize(int version, DataInputStream in) Loads the object from the input stream and allows deserialization
static boolean	isAutoStored() Returns true if the Cookies are auto stored to storage
boolean	isHttpOnly()
boolean	isSecure()
static void	setAutoStored(boolean autoStored) This method configures the auto storage of cookies
void	setDomain(String domain)
void	setExpires(long expires)
void	setHttpOnly(boolean httpOnly)
void	setName(String name)
void	setPath(String path)
void	setSecure(boolean secure)
void	setValue(String value)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

STORAGE_NAME

public static String STORAGE_NAME

Constructor Detail

Cookie

public Cookie()

Method Detail

getName

public String getName()

Returns:

the name

setName

public void setName(String name)

Parameters:

name - the name to set

setSecure

public void setSecure(boolean secure)

isSecure

public boolean isSecure()

setHttpOnly

public void setHttpOnly(boolean httpOnly)

isHttpOnly

public boolean isHttpOnly()

setPath

public void setPath(String path)

getPath

public String getPath()

getValue

public String getValue()

Returns:

the value

setValue

public void setValue(String value)

Parameters:

value - the value to set

getDomain

public String getDomain()

Returns:

the domain

setDomain

public void setDomain(String domain)

Parameters:

domain - the domain to set

getExpires

public long getExpires()

Returns:

the expires

setExpires

public void setExpires(long expires)

Parameters:

expires - the expires to set

getVersion

public int getVersion()

Returns the version for the current persistance code, the version will be pased to internalized thus allowing the internalize method to recognize classes persisted in older revisions

Specified by:

getVersion in interface Externalizable

Returns:

version number for the persistant code

externalize

public void externalize(DataOutputStream out)
                 throws IOException

Allows us to store an object state, this method must be implemented in order to save the state of an object

Specified by:

externalize in interface Externalizable

Parameters:

out - the stream into which the object must be serialized

Throws:

IOException - the method may throw an exception

internalize

public void internalize(int version,
                        DataInputStream in)
                 throws IOException

Loads the object from the input stream and allows deserialization

Specified by:

internalize in interface Externalizable

Parameters:

version - the version the class returned during the externalization processs

in - the input stream used to load the class

Throws:

IOException - the method may throw an exception

getObjectId

public String getObjectId()

The object id must be unique, it is used to identify the object when loaded even when it is obfuscated.

Specified by:

getObjectId in interface Externalizable

Returns:

a unique id

toString

public String toString()

Overrides:

toString in class Object

setAutoStored

public static void setAutoStored(boolean autoStored)

This method configures the auto storage of cookies

Parameters:

autoStored -

isAutoStored

public static boolean isAutoStored()

Returns true if the Cookies are auto stored to storage

Returns:

autoStored

clearCookiesFromStorage

public static void clearCookiesFromStorage()

Clears all cookies history from storage