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:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()Clone objectGets the cacheName attribute of the AuxiliaryCacheAttributes objectSets the pool name to use.getName()Gets the name attribute of the AuxiliaryCacheAttributes objectvoidsetCacheName(String name) Sets the name of the cache, referenced by the appropriate manager.voidIf you choose a POOLED event queue type, the value of EventQueuePoolName will be used.voidsetEventQueueType(ICacheEventQueue.QueueType queueType) SINGLE is the default.voidThis is the name of the auxiliary in configuration file.
-
Constructor Details
-
AbstractAuxiliaryCacheAttributes
public AbstractAuxiliaryCacheAttributes()
-
-
Method Details
-
setCacheName
Description copied from interface:AuxiliaryCacheAttributesSets the name of the cache, referenced by the appropriate manager.- Specified by:
setCacheNamein interfaceAuxiliaryCacheAttributes- Parameters:
name-
-
getCacheName
Gets the cacheName attribute of the AuxiliaryCacheAttributes object- Specified by:
getCacheNamein interfaceAuxiliaryCacheAttributes- Returns:
- The cacheName value
-
setName
This is the name of the auxiliary in configuration file.- Specified by:
setNamein interfaceAuxiliaryCacheAttributes- Parameters:
s- The new name value- See Also:
-
getName
Gets the name attribute of the AuxiliaryCacheAttributes object- Specified by:
getNamein interfaceAuxiliaryCacheAttributes- Returns:
- The name value
-
setEventQueueType
SINGLE is the default. If you choose POOLED, the value of EventQueuePoolName will be used- Specified by:
setEventQueueTypein interfaceAuxiliaryCacheAttributes- Parameters:
queueType- SINGLE or POOLED
-
getEventQueueType
- Specified by:
getEventQueueTypein interfaceAuxiliaryCacheAttributes- Returns:
- SINGLE or POOLED
-
setEventQueuePoolName
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:
setEventQueuePoolNamein interfaceAuxiliaryCacheAttributes- Parameters:
s- SINGLE or POOLED
-
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:
getEventQueuePoolNamein interfaceAuxiliaryCacheAttributes- Returns:
- name of thread pool to use for this auxiliary
-
clone
Description copied from interface:AuxiliaryCacheAttributesClone object- Specified by:
clonein interfaceAuxiliaryCacheAttributes- Overrides:
clonein classObject- See Also:
-