org.apache.jcs.auxiliary

Class AbstractAuxiliaryCacheAttributes

java.lang.Object

org.apache.jcs.auxiliary.AbstractAuxiliaryCacheAttributes

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, AuxiliaryCacheAttributes

Direct Known Subclasses:

AbstractDiskCacheAttributes, LateralCacheAttributes, RemoteCacheAttributes, RemoteCacheServerAttributes, RemoteHttpCacheServerAttributes

public abstract class AbstractAuxiliaryCacheAttributes
extends java.lang.Object
implements AuxiliaryCacheAttributes

This has common attributes used by all auxiliaries.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	cacheName cacheName
protected java.lang.String	eventQueuePoolName Named when pooled
protected java.lang.String	eventQueueType eventQueueType -- custom classname, pooled, or single threaded
protected java.lang.String	name name

Fields inherited from interface org.apache.jcs.auxiliary.AuxiliaryCacheAttributes

POOLED_QUEUE_TYPE, SINGLE_QUEUE_TYPE

Constructor Summary

Constructors

Constructor and Description
AbstractAuxiliaryCacheAttributes()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getCacheName() Gets the cacheName attribute of the AuxiliaryCacheAttributes object
java.lang.String	getEventQueuePoolName() Sets the pool name to use.
java.lang.String	getEventQueueType()
java.lang.String	getName() Gets the name attribute of the AuxiliaryCacheAttributes object
void	setCacheName(java.lang.String name) Sets the name of the cache, referenced by the appropriate manager.
void	setEventQueuePoolName(java.lang.String s) If you choose a POOLED event queue type, the value of EventQueuePoolName will be used.
void	setEventQueueType(java.lang.String queueType) SINGLE is the default.
void	setName(java.lang.String s) This is the name of the auxiliary in configuration file.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.jcs.auxiliary.AuxiliaryCacheAttributes

copy

Field Detail

cacheName

protected java.lang.String cacheName

cacheName

name

protected java.lang.String name

name

eventQueueType

protected java.lang.String eventQueueType

eventQueueType -- custom classname, pooled, or single threaded

eventQueuePoolName

protected java.lang.String eventQueuePoolName

Named when pooled

Constructor Detail

AbstractAuxiliaryCacheAttributes

public AbstractAuxiliaryCacheAttributes()

Method Detail

setCacheName

public void setCacheName(java.lang.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 java.lang.String getCacheName()

Gets the cacheName attribute of the AuxiliaryCacheAttributes object

Specified by:

getCacheName in interface AuxiliaryCacheAttributes

Returns:

The cacheName value

setName

public void setName(java.lang.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(java.lang.String)

getName

public java.lang.String getName()

Gets the name attribute of the AuxiliaryCacheAttributes object

Specified by:

getName in interface AuxiliaryCacheAttributes

Returns:

The name value

setEventQueueType

public void setEventQueueType(java.lang.String 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 or a classname

getEventQueueType

public java.lang.String getEventQueueType()

Specified by:

getEventQueueType in interface AuxiliaryCacheAttributes

Returns:

SINGLE or POOLED

setEventQueuePoolName

public void setEventQueuePoolName(java.lang.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 java.lang.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