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 SummaryConstructors
- 
Method SummaryModifier 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- 
AbstractAuxiliaryCacheAttributespublic AbstractAuxiliaryCacheAttributes()
 
- 
- 
Method Details- 
setCacheNameDescription copied from interface:AuxiliaryCacheAttributesSets the name of the cache, referenced by the appropriate manager.- Specified by:
- setCacheNamein interface- AuxiliaryCacheAttributes
- Parameters:
- name-
 
- 
getCacheNameGets the cacheName attribute of the AuxiliaryCacheAttributes object- Specified by:
- getCacheNamein interface- AuxiliaryCacheAttributes
- Returns:
- The cacheName value
 
- 
setNameThis is the name of the auxiliary in configuration file.- Specified by:
- setNamein interface- AuxiliaryCacheAttributes
- Parameters:
- s- The new name value
- See Also:
 
- 
getNameGets the name attribute of the AuxiliaryCacheAttributes object- Specified by:
- getNamein interface- AuxiliaryCacheAttributes
- Returns:
- The name value
 
- 
setEventQueueTypeSINGLE is the default. If you choose POOLED, the value of EventQueuePoolName will be used- Specified by:
- setEventQueueTypein interface- AuxiliaryCacheAttributes
- Parameters:
- queueType- SINGLE or POOLED
 
- 
getEventQueueType- Specified by:
- getEventQueueTypein interface- AuxiliaryCacheAttributes
- Returns:
- SINGLE or POOLED
 
- 
setEventQueuePoolNameIf 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 interface- AuxiliaryCacheAttributes
- Parameters:
- s- SINGLE or POOLED
 
- 
getEventQueuePoolNameSets 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 interface- AuxiliaryCacheAttributes
- Returns:
- name of thread pool to use for this auxiliary
 
- 
cloneDescription copied from interface:AuxiliaryCacheAttributesClone object- Specified by:
- clonein interface- AuxiliaryCacheAttributes
- Overrides:
- clonein class- Object
- See Also:
 
 
-