org.apache.jcs.auxiliary
Interface AuxiliaryCacheAttributes

All Superinterfaces:
java.lang.Cloneable, java.io.Serializable
All Known Subinterfaces:
IDiskCacheAttributes, IHSQLCacheAttributes, ILateralCacheAttributes, IRemoteCacheAttributes, IRemoteCacheServerAttributes, ITCPLateralCacheAttributes
All Known Implementing Classes:
AbstractAuxiliaryCacheAttributes, AbstractDiskCacheAttributes, LateralCacheAttributes, RemoteCacheAttributes, RemoteCacheServerAttributes, TCPLateralCacheAttributes

public interface AuxiliaryCacheAttributes
extends java.lang.Cloneable, java.io.Serializable

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


Field Summary
static java.lang.String POOLED_QUEUE_TYPE
          Uses a thread pool
static java.lang.String SINGLE_QUEUE_TYPE
          Does not use a thread pool.
 
Method Summary
 AuxiliaryCacheAttributes copy()
          Description of the Method
 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()
           
 int getEventQueueTypeFactoryCode()
          Returns the value used by the factory.
 java.lang.String getName()
          Gets the name attribute of the AuxiliaryCacheAttributes object
 void setCacheName(java.lang.String s)
          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 s)
          SINGLE is the default.
 void setName(java.lang.String s)
          Name know by by configurator
 

Field Detail

SINGLE_QUEUE_TYPE

public static final java.lang.String SINGLE_QUEUE_TYPE
Does not use a thread pool.

See Also:
Constant Field Values

POOLED_QUEUE_TYPE

public static final java.lang.String POOLED_QUEUE_TYPE
Uses a thread pool

See Also:
Constant Field Values
Method Detail

setCacheName

public void setCacheName(java.lang.String s)
Sets the name of the cache, referenced by the appropriate manager.

Parameters:
s - The new cacheName value

getCacheName

public java.lang.String getCacheName()
Gets the cacheName attribute of the AuxiliaryCacheAttributes object

Returns:
The cacheName value

setName

public void setName(java.lang.String s)
Name know by by configurator

Parameters:
s - The new name value

getName

public java.lang.String getName()
Gets the name attribute of the AuxiliaryCacheAttributes object

Returns:
The name value

setEventQueueType

public void setEventQueueType(java.lang.String s)
SINGLE is the default. If you choose POOLED, the value of EventQueuePoolName will be used

Parameters:
s - SINGLE or POOLED
Returns:

getEventQueueType

public java.lang.String getEventQueueType()
Returns:
SINGLE or POOLED

getEventQueueTypeFactoryCode

public int getEventQueueTypeFactoryCode()
Returns the value used by the factory.

Returns:

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

Parameters:
s - SINGLE or POOLED
Returns:

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.

Returns:
name of thread pool to use for this auxiliary

copy

public AuxiliaryCacheAttributes copy()
Description of the Method

Returns:


Copyright © 2002-2007 Apache Software Foundation. All Rights Reserved.