org.apache.commons.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, IndexedDiskCacheAttributes, JDBCDiskCacheAttributes, LateralCacheAttributes, MySQLDiskCacheAttributes, RemoteCacheAttributes, RemoteCacheServerAttributes, RemoteHttpCacheAttributes, RemoteHttpCacheServerAttributes, TCPLateralCacheAttributes

public interface AuxiliaryCacheAttributes
extends Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
AuxiliaryCacheAttributes	clone() Clone object
String	getCacheName() Gets the cacheName attribute of the AuxiliaryCacheAttributes object
String	getEventQueuePoolName() Sets the pool name to use.
ICacheEventQueue.QueueType	getEventQueueType()
String	getName() Gets the name attribute of the AuxiliaryCacheAttributes object
void	setCacheName(String s) Sets the name of the cache, referenced by the appropriate manager.
void	setEventQueuePoolName(String s) If you choose a POOLED event queue type, the value of EventQueuePoolName will be used.
void	setEventQueueType(ICacheEventQueue.QueueType s) SINGLE is the default.
void	setName(String s) Name known by by configurator

Method Detail

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(ICacheEventQueue.QueueType s)

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

Parameters:

s - SINGLE or POOLED

getEventQueueType

ICacheEventQueue.QueueType 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

clone

AuxiliaryCacheAttributes clone()

Clone object