ice.net
Class CookieManagerSettings

java.lang.Object
  ice.net.CookieManagerSettings

All Implemented Interfaces:

Serializable, Settings

public class CookieManagerSettings

extends Object

implements Serializable, Settings

The CookieManagerSettings class specifies settings for a CookieManager.

Since:

1.5

Version:

1.5

Author:

Jack van Ooststroom

See Also:

Serialized Form

Constructor Summary

CookieManagerSettings()
Constructs a CookieManagerSettings object.

Method Summary

boolean	equals(Object object)
boolean	isCookieExpirationBufferEnabled() Returns whether or not the CookieManager to be created using this CookieManagerSettings uses an expiration buffer for Cookies.
static boolean	isDefaultCookieExpirationBufferEnabled() Returns the current boolean value of the ice.net.cookieExpirationBufferEnabled property.
void	resetToDefault() Resets the settings of current instance to the default settings.
void	setCookieExpirationBufferEnabled(boolean cookieExpirationBufferEnabled) Sets this CookieManagerSettings' boolean indicating to use an expiration buffer for Cookies to the specified cookieExpirationBufferEnabled.
static void	setDefaultCookieExpirationBufferEnabled(boolean cookieExpirationBufferEnabled) Sets the default value of the boolean indicating to use an expiration buffer for Cookies to the specified cookieExpirationBufferEnabled.
static void	setDefaultPersistPrivateCookies(boolean persistPrivateCookies) Sets the default value of the boolean indicating to persist private Cookies to the specified peristPrivateCookies.
void	setPersistPrivateCookies(boolean persistPrivateCookies)
static boolean	shouldDefaultPersistPrivateCookies() Returns the current boolean value of the ice.net.persistPrivateCookies property.
boolean	shouldPersistPrivateCookies() Returns whether or not the CookieManager to be created using this CookieManagerSettings persists private Cookies.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CookieManagerSettings

public CookieManagerSettings()

Constructs a CookieManagerSettings object.

Method Detail

equals

public boolean equals(Object object)

isCookieExpirationBufferEnabled

public boolean isCookieExpirationBufferEnabled()

Returns whether or not the CookieManager to be created using this CookieManagerSettings uses an expiration buffer for Cookies.

Returns:

true if the CookieManager to be created uses an expiration buffer for Cookies, false if not.

See Also:

setCookieExpirationBufferEnabled(boolean), Cookie

isDefaultCookieExpirationBufferEnabled

public static boolean isDefaultCookieExpirationBufferEnabled()

Returns the current boolean value of the ice.net.cookieExpirationBufferEnabled property.

Returns:

the boolean value of the ice.net.cookieExpirationBufferEnabled property.

See Also:

setDefaultCookieExpirationBufferEnabled(boolean)

resetToDefault

public void resetToDefault()

Description copied from interface: Settings

Resets the settings of current instance to the default settings.

Specified by:

resetToDefault in interface Settings

setCookieExpirationBufferEnabled

public void setCookieExpirationBufferEnabled(boolean cookieExpirationBufferEnabled)

Sets this CookieManagerSettings' boolean indicating to use an expiration buffer for Cookies to the specified cookieExpirationBufferEnabled.

When a new CookieManager is created through the CookieManager.CookieManager(CookieManagerSettings) costructor with this CookieManagerSettings as parameter, the CookieManager.isCookieExpirationBufferEnabled() method's return value of the new CookieManager equals this CookieManagerSettings' isCookieExpirationBufferEnabled() method return value.

Parameters:

cookieExpirationBufferEnabled - the new expiration buffer for Cookies boolean value.

See Also:

isCookieExpirationBufferEnabled(), CookieManager.CookieManager(CookieManagerSettings), CookieManager.isCookieExpirationBufferEnabled()

setDefaultCookieExpirationBufferEnabled

public static void setDefaultCookieExpirationBufferEnabled(boolean cookieExpirationBufferEnabled)

Sets the default value of the boolean indicating to use an expiration buffer for Cookies to the specified cookieExpirationBufferEnabled.

That is, every new instance of CookieManagerSettings will have the boolean indicating to use an expiration buffer for Cookies set to the specified cookieExpirationBufferEnabled.

This method sets the ice.net.cookieExpirationBufferEnabled property for the current runtime.

Parameters:

cookieExpirationBufferEnabled - the new boolean value indicating the usage of an expiration buffer for Cookies.

See Also:

isDefaultCookieExpirationBufferEnabled(), isCookieExpirationBufferEnabled()

setDefaultPersistPrivateCookies

public static void setDefaultPersistPrivateCookies(boolean persistPrivateCookies)

Sets the default value of the boolean indicating to persist private Cookies to the specified peristPrivateCookies.

That is, every new instance of CookieManagerSettings will have the boolean indicating to persist private Cookies set to the specified persistPrivateCookies.

This method sets the ice.net.persistPrivateCookies property for the current runtime.

Parameters:

persistPrivateCookies - the new boolean value indicating the persistence of private Cookies.

See Also:

shouldDefaultPersistPrivateCookies(), shouldPersistPrivateCookies()

setPersistPrivateCookies

public void setPersistPrivateCookies(boolean persistPrivateCookies)

shouldDefaultPersistPrivateCookies

public static boolean shouldDefaultPersistPrivateCookies()

Returns the current boolean value of the ice.net.persistPrivateCookies property.

Returns:

the boolean value of the ice.net.persistPrivateCookies property.

See Also:

setDefaultPersistPrivateCookies(boolean)

shouldPersistPrivateCookies

public boolean shouldPersistPrivateCookies()

Returns whether or not the CookieManager to be created using this CookieManagerSettings persists private Cookies.

Returns:

true if the CookieManager to be created persists private Cookies, false if not.

See Also:

setPersistPrivateCookies(boolean), Cookie

toString

public String toString()