oracle.hsgbu.hdr.base.fwk

Interface CTBCacheConfig

All Superinterfaces:

Serializable

public interface CTBCacheConfig
extends Serializable

Configures a CTB cache. This interface provides methods that allow caches to be individually configured, based on specific requirements for that cache.

Method Summary

Modifier and Type	Method and Description
String	getCacheName() Retrieves the name of the cache.
String	getCTBCacheLoaderClassName() Gets the name of the CTBCacheLoader class for this cache.
long	getIdleTime() Gets the idle time for objects in the cache.
long	getTimeToLive() Gets the maximum time for which objects can remain in the cache before being invalidated.
boolean	isDistributed() Returns a boolean value that indicates if the cache is distributed.
boolean	isPreLoadEnabled() Returns a boolean value that indicates if the cache is pre-loaded when it is created.
void	setCacheName(String cacheName) Sets the name of the cache.
void	setCTBCacheLoaderClassName(String loader) Sets the name of the CTBCacheLoader class for this cache.
void	setDistributed(boolean flag) Sets the flag that specifies if the cache is to be distributed.
void	setIdleTime(long value) Sets the idle time for objects in the cache.
void	setPreLoadEnabled(boolean enabled) Sets the flag that indicated if the cache is pre-loaded when it is created.
void	setTimeToLive(long value) Sets the maximum time for which objects can remain in the cache before being invalidated for objects in the cache.

Method Detail

setCacheName

void setCacheName(String cacheName)

Sets the name of the cache. This attribute is the unique identifier for the cache and is mandatory.

Parameters:

cacheName - Name of the cache.

getCacheName

String getCacheName()

Retrieves the name of the cache. This attribute is the unique identifier for the cache.

Returns:

Name of the cache.

setDistributed

void setDistributed(boolean flag)

Sets the flag that specifies if the cache is to be distributed. If the cache is distributed, invalidations are propogated to other JVMs when the key that is being invalidated exists in other JVMs. Also, if the cache is distributed and an object is updated, that key is invalidated in other JVMs. By default, the flag is set for the cache not to be distributed.

Parameters:

flag - true if the cache is to be distributed, otherwise false.

isDistributed

boolean isDistributed()

Returns a boolean value that indicates if the cache is distributed. If the cache is distributed, invalidations are propogated to other JVMs when the key being invalidated exists in other JVMs. Also, if the cache is distributed and an object is updated, that key will be invalidated in other JVMs. The default is for the cache NOT to be distributed.

Returns:

true if the cache is to be distributed, otherwise false.

setTimeToLive

void setTimeToLive(long value)

Sets the maximum time for which objects can remain in the cache before being invalidated for objects in the cache.

Parameters:

value - Time to live in seconds.

getTimeToLive

long getTimeToLive()

Gets the maximum time for which objects can remain in the cache before being invalidated.

Returns:

Time to live in seconds.

setIdleTime

void setIdleTime(long value)

Sets the idle time for objects in the cache. This attribute specifies the amount of time objects remain in the cache without being accessed before being invalidated. NOTE: DO NOT USE - Awaiting bugfix - Use timeToLive instead

Parameters:

value - Idle Time in seconds.

getIdleTime

long getIdleTime()

Gets the idle time for objects in the cache. This attribute is the amount of time objects remain in the cache without being accessed before being invalidated. NOTE: DO NOT USE - Awaiting bugfix - Use timeToLive instead

Returns:

Idle time

setPreLoadEnabled

void setPreLoadEnabled(boolean enabled)

Sets the flag that indicated if the cache is pre-loaded when it is created. If a cache is pre-load enabled, the bulkload method of the cache loader is called when the cache is created in order to load the cache.

Parameters:

enabled - true if the cache is pre-load enabled, otherwise false.

isPreLoadEnabled

boolean isPreLoadEnabled()

Returns a boolean value that indicates if the cache is pre-loaded when it is created. If a cache is pre-load enabled, the bulkload method of the cache loader is called when the cache is created in order to load the cache.

Returns:

True if cache is pre loaded

setCTBCacheLoaderClassName

void setCTBCacheLoaderClassName(String loader)

Sets the name of the CTBCacheLoader class for this cache. CTBCacheLoader is an abstract class that must be extended.

Parameters:

loader - Full name of the cache loader class for this cache.

getCTBCacheLoaderClassName

String getCTBCacheLoaderClassName()

Gets the name of the CTBCacheLoader class for this cache. CTBCacheLoader is an abstract class that must be extended.

Returns:

Full name of the cache loader class for this cache.