org.apache.commons.jcs.engine

Class AbstractCacheEventQueue<K,V>

java.lang.Object

org.apache.commons.jcs.engine.AbstractCacheEventQueue<K,V>

All Implemented Interfaces:

ICacheEventQueue<K,V>

Direct Known Subclasses:

CacheEventQueue, PooledCacheEventQueue

public abstract class AbstractCacheEventQueue<K,V>
extends Object
implements ICacheEventQueue<K,V>

An abstract base class to the different implementations

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractCacheEventQueue.AbstractCacheEvent Retries before declaring failure.
protected class	AbstractCacheEventQueue.DisposeEvent The cache should be disposed when this event is processed.
protected class	AbstractCacheEventQueue.PutEvent An element should be put in the cache.
protected class	AbstractCacheEventQueue.RemoveAllEvent All elements should be removed from the cache when this event is processed.
protected class	AbstractCacheEventQueue.RemoveEvent An element should be removed from the cache.

Nested classes/interfaces inherited from interface org.apache.commons.jcs.engine.behavior.ICacheEventQueue

ICacheEventQueue.QueueType

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	DEFAULT_WAIT_TO_DIE_MILLIS default

Constructor Summary

Constructors

Constructor and Description
AbstractCacheEventQueue()

Method Summary

Modifier and Type	Method and Description
void	addDisposeEvent() Adds a feature to the DisposeEvent attribute of the ICacheEventQueue object
void	addPutEvent(ICacheElement<K,V> ce) This adds a put event to the queue.
void	addRemoveAllEvent() This adds a remove all event to the queue.
void	addRemoveEvent(K key) This adds a remove event to the queue.
protected String	getCacheName()
long	getListenerId() Gets the listenerId attribute of the ICacheEventQueue object
int	getWaitToDieMillis() Returns the time to wait for events before killing the background thread.
protected void	initialize(ICacheListener<K,V> listener, long listenerId, String cacheName, int maxFailure, int waitBeforeRetry) Initializes the queue.
boolean	isAlive() If they queue has an active thread it is considered alive.
boolean	isWorking() A Queue is working unless it has reached its max failure count.
protected abstract void	put(AbstractCacheEventQueue.AbstractCacheEvent event) Adds an event to the queue.
void	setAlive(boolean aState) Sets whether the queue is actively processing -- if there are working threads.
void	setWaitToDieMillis(int wtdm) Sets the time to wait for events before killing the background thread.
void	setWorking(boolean b) This means that the queue is functional.
String	toString() Creates a brief string identifying the listener and the region.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.commons.jcs.engine.behavior.ICacheEventQueue

destroy, getQueueType, getStatistics, isEmpty, size

Field Detail

DEFAULT_WAIT_TO_DIE_MILLIS

protected static final int DEFAULT_WAIT_TO_DIE_MILLIS

default

See Also:

Constant Field Values

Constructor Detail

AbstractCacheEventQueue

public AbstractCacheEventQueue()

Method Detail

getWaitToDieMillis

public int getWaitToDieMillis()

Returns the time to wait for events before killing the background thread.

Returns:

int

setWaitToDieMillis

public void setWaitToDieMillis(int wtdm)

Sets the time to wait for events before killing the background thread.

Parameters:

wtdm - the ms for the q to sit idle.

toString

public String toString()

Creates a brief string identifying the listener and the region.

Overrides:

toString in class Object

Returns:

String debugging info.

isAlive

public boolean isAlive()

If they queue has an active thread it is considered alive.

Specified by:

isAlive in interface ICacheEventQueue<K,V>

Returns:

The alive value

setAlive

public void setAlive(boolean aState)

Sets whether the queue is actively processing -- if there are working threads.

Parameters:

aState -

getListenerId

public long getListenerId()

Description copied from interface: ICacheEventQueue

Gets the listenerId attribute of the ICacheEventQueue object

Specified by:

getListenerId in interface ICacheEventQueue<K,V>

Returns:

The listenerId value

getCacheName

protected String getCacheName()

Returns:

the cacheName

initialize

protected void initialize(ICacheListener<K,V> listener,
                          long listenerId,
                          String cacheName,
                          int maxFailure,
                          int waitBeforeRetry)

Initializes the queue.

Parameters:

listener -

listenerId -

cacheName -

maxFailure -

waitBeforeRetry -

addPutEvent

public void addPutEvent(ICacheElement<K,V> ce)
                 throws IOException

This adds a put event to the queue. When it is processed, the element will be put to the listener.

Specified by:

addPutEvent in interface ICacheEventQueue<K,V>

Parameters:

ce - The feature to be added to the PutEvent attribute

Throws:

IOException

addRemoveEvent

public void addRemoveEvent(K key)
                    throws IOException

This adds a remove event to the queue. When processed the listener's remove method will be called for the key.

Specified by:

addRemoveEvent in interface ICacheEventQueue<K,V>

Parameters:

key - The feature to be added to the RemoveEvent attribute

Throws:

IOException

addRemoveAllEvent

public void addRemoveAllEvent()
                       throws IOException

This adds a remove all event to the queue. When it is processed, all elements will be removed from the cache.

Specified by:

addRemoveAllEvent in interface ICacheEventQueue<K,V>

Throws:

IOException

addDisposeEvent

public void addDisposeEvent()
                     throws IOException

Description copied from interface: ICacheEventQueue

Adds a feature to the DisposeEvent attribute of the ICacheEventQueue object

Specified by:

addDisposeEvent in interface ICacheEventQueue<K,V>

Throws:

IOException

put

protected abstract void put(AbstractCacheEventQueue.AbstractCacheEvent event)

Adds an event to the queue.

Parameters:

event -

isWorking

public boolean isWorking()

Description copied from interface: ICacheEventQueue

A Queue is working unless it has reached its max failure count.

Specified by:

isWorking in interface ICacheEventQueue<K,V>

Returns:

whether the queue is functional.

setWorking

public void setWorking(boolean b)

This means that the queue is functional. If we reached the max number of failures, the queue is marked as non functional and will never work again.

Parameters:

b -