org.apache.jcs.auxiliary
Interface AuxiliaryCacheAttributes

All Superinterfaces:

Cloneable, Serializable

All Known Subinterfaces:

ICommonRemoteCacheAttributes, IDiskCacheAttributes, ILateralCacheAttributes, IRemoteCacheAttributes, IRemoteCacheServerAttributes, ITCPLateralCacheAttributes

All Known Implementing Classes:

AbstractAuxiliaryCacheAttributes, AbstractDiskCacheAttributes, BlockDiskCacheAttributes, CommonRemoteCacheAttributes, FileDiskCacheAttributes, IndexedDiskCacheAttributes, JDBCDiskCacheAttributes, LateralCacheAttributes, MySQLDiskCacheAttributes, RemoteCacheAttributes, RemoteCacheServerAttributes, RemoteHttpCacheAttributes, RemoteHttpCacheServerAttributes, TCPLateralCacheAttributes

public interface AuxiliaryCacheAttributes
extends Cloneable, Serializable

This is a nominal interface that auxiliary cache attributes should implement. This allows the auxiliary mangers to share a common interface.

SINGLE_QUEUE_TYPE

static final String SINGLE_QUEUE_TYPE

Does not use a thread pool.

See Also:

Constant Field Values

POOLED_QUEUE_TYPE

static final String POOLED_QUEUE_TYPE

Uses a thread pool.

See Also:

Constant Field Values

setCacheName

void setCacheName(String s)

Sets the name of the cache, referenced by the appropriate manager.

Parameters:

s - The new cacheName value

getCacheName

String getCacheName()

Gets the cacheName attribute of the AuxiliaryCacheAttributes object

Returns:

The cacheName value

setName

void setName(String s)

Name known by by configurator

Parameters:

s - The new name value

getName

String getName()

Gets the name attribute of the AuxiliaryCacheAttributes object

Returns:

The name value

setEventQueueType

void setEventQueueType(String s)

SINGLE is the default. If you choose POOLED, the value of EventQueuePoolName will be used

Parameters:

s - SINGLE or POOLED

getEventQueueType

String getEventQueueType()

Returns:

SINGLE or POOLED

setEventQueuePoolName

void setEventQueuePoolName(String s)

If you choose a POOLED event queue type, the value of EventQueuePoolName will be used. This is ignored if the pool type is SINGLE

Parameters:

s - SINGLE or POOLED

getEventQueuePoolName

String getEventQueuePoolName()

Sets the pool name to use. If a pool is not found by this name, the thread pool manager will return a default configuration.

Returns:

name of thread pool to use for this auxiliary

copy

AuxiliaryCacheAttributes copy()

Clones

Returns:

a copy