org.apache.commons.jcs3.auxiliary

Class AbstractAuxiliaryCacheAttributes

java.lang.Object

org.apache.commons.jcs3.auxiliary.AbstractAuxiliaryCacheAttributes

All Implemented Interfaces:

Serializable, Cloneable, AuxiliaryCacheAttributes

Direct Known Subclasses:

AbstractDiskCacheAttributes, CommonRemoteCacheAttributes, LateralCacheAttributes, RemoteHttpCacheServerAttributes

public abstract class AbstractAuxiliaryCacheAttributes
extends Object
implements AuxiliaryCacheAttributes

This has common attributes used by all auxiliaries.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractAuxiliaryCacheAttributes()

Method Summary

Modifier and Type	Method and Description
AbstractAuxiliaryCacheAttributes	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 name) 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 queueType) SINGLE is the default.
void	setName(String s) This is the name of the auxiliary in configuration file.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractAuxiliaryCacheAttributes

public AbstractAuxiliaryCacheAttributes()

Method Detail

setCacheName

public void setCacheName(String name)

Description copied from interface: AuxiliaryCacheAttributes

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

Specified by:

setCacheName in interface AuxiliaryCacheAttributes

Parameters:

name -

getCacheName

public String getCacheName()

Gets the cacheName attribute of the AuxiliaryCacheAttributes object

Specified by:

getCacheName in interface AuxiliaryCacheAttributes

Returns:

The cacheName value

setName

public void setName(String s)

This is the name of the auxiliary in configuration file.

Specified by:

setName in interface AuxiliaryCacheAttributes

Parameters:

s - The new name value

See Also:

AuxiliaryCacheAttributes.setName(String)

getName

public String getName()

Gets the name attribute of the AuxiliaryCacheAttributes object

Specified by:

getName in interface AuxiliaryCacheAttributes

Returns:

The name value

setEventQueueType

public void setEventQueueType(ICacheEventQueue.QueueType queueType)

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

Specified by:

setEventQueueType in interface AuxiliaryCacheAttributes

Parameters:

queueType - SINGLE or POOLED

getEventQueueType

public ICacheEventQueue.QueueType getEventQueueType()

Specified by:

getEventQueueType in interface AuxiliaryCacheAttributes

Returns:

SINGLE or POOLED

setEventQueuePoolName

public 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

Specified by:

setEventQueuePoolName in interface AuxiliaryCacheAttributes

Parameters:

s - SINGLE or POOLED

getEventQueuePoolName

public 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.

Specified by:

getEventQueuePoolName in interface AuxiliaryCacheAttributes

Returns:

name of thread pool to use for this auxiliary

clone

public AbstractAuxiliaryCacheAttributes clone()

Description copied from interface: AuxiliaryCacheAttributes

Clone object

Specified by:

clone in interface AuxiliaryCacheAttributes

Overrides:

clone in class Object

See Also:

Object.clone()