org.apache.jcs.auxiliary.lateral
Class LateralCacheNoWaitFacade

java.lang.Object
  org.apache.jcs.auxiliary.lateral.LateralCacheNoWaitFacade

All Implemented Interfaces:

java.io.Serializable, AuxiliaryCache, ICache, ICacheType

public class LateralCacheNoWaitFacade
extends java.lang.Object
implements AuxiliaryCache

Used to provide access to multiple services under nowait protection. Composite factory should construct LateralCacheNoWaitFacade to give to the composite cache out of caches it constructs from the varies manager to lateral services. Perhaps the lateralcache factory should be able to do this.

See Also:

Serialized Form

Field Summary

LateralCacheNoWait[]

noWaits The queuing facade to the client.

Fields inherited from interface org.apache.jcs.engine.behavior.ICacheType

CACHE_HUB, DISK_CACHE, LATERAL_CACHE, REMOTE_CACHE

Constructor Summary

LateralCacheNoWaitFacade(LateralCacheNoWait[] noWaits, ILateralCacheAttributes cattr)
Constructs with the given lateral cache, and fires events to any listeners.

Method Summary

boolean	addNoWait(LateralCacheNoWait noWait) Adds a no wait to the list if it isn't already in the list.
void	dispose() Adds a dispose request to the lateral cache.
ICacheElement	get(java.io.Serializable key) Synchronously reads from the lateral cache.
AuxiliaryCacheAttributes	getAuxiliaryCacheAttributes() This returns the generic attributes for an auxiliary cache.
java.lang.String	getCacheName() Gets the cacheName attribute of the LateralCacheNoWaitFacade object
int	getCacheType() Gets the cacheType attribute of the LateralCacheNoWaitFacade object
java.util.Set	getGroupKeys(java.lang.String group) Gets the set of keys of objects currently in the group
int	getSize() No lateral invokation.
IStats	getStatistics() Returns the historical and statistical data for a region's auxiliary cache.
java.lang.String	getStats() getStats
int	getStatus() Gets the status attribute of the LateralCacheNoWaitFacade object
boolean	remove(java.io.Serializable key) Adds a remove request to the lateral cache.
void	removeAll() Adds a removeAll request to the lateral cache.
java.lang.String	toString()
void	update(ICacheElement ce) Puts an item to the cache.

Methods inherited from class java.lang.Object

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

Field Detail

noWaits

public LateralCacheNoWait[] noWaits

The queuing facade to the client.

Constructor Detail

LateralCacheNoWaitFacade

public LateralCacheNoWaitFacade(LateralCacheNoWait[] noWaits,
                                ILateralCacheAttributes cattr)

Constructs with the given lateral cache, and fires events to any listeners.

Parameters:

noWaits -

cattr -

Method Detail

addNoWait

public boolean addNoWait(LateralCacheNoWait noWait)

Adds a no wait to the list if it isn't already in the list.

Parameters:

noWait -

Returns:

true if it wasn't alreay contained

update

public void update(ICacheElement ce)
            throws java.io.IOException

Description copied from interface: AuxiliaryCache

Puts an item to the cache.

Specified by:

update in interface AuxiliaryCache

Specified by:

update in interface ICache

Throws:

java.io.IOException

get

public ICacheElement get(java.io.Serializable key)

Synchronously reads from the lateral cache.

Specified by:

get in interface AuxiliaryCache

Specified by:

get in interface ICache

Parameters:

key -

Returns:

ICacheElement

getGroupKeys

public java.util.Set getGroupKeys(java.lang.String group)

Description copied from interface: AuxiliaryCache

Gets the set of keys of objects currently in the group

Specified by:

getGroupKeys in interface AuxiliaryCache

Returns:

a set of group keys

remove

public boolean remove(java.io.Serializable key)

Adds a remove request to the lateral cache.

Specified by:

remove in interface AuxiliaryCache

Specified by:

remove in interface ICache

Parameters:

key -

Returns:

always false.

removeAll

public void removeAll()

Adds a removeAll request to the lateral cache.

Specified by:

removeAll in interface AuxiliaryCache

Specified by:

removeAll in interface ICache

dispose

public void dispose()

Adds a dispose request to the lateral cache.

Specified by:

dispose in interface AuxiliaryCache

Specified by:

dispose in interface ICache

getSize

public int getSize()

No lateral invokation.

Specified by:

getSize in interface AuxiliaryCache

Specified by:

getSize in interface ICache

Returns:

The size value

getCacheType

public int getCacheType()

Gets the cacheType attribute of the LateralCacheNoWaitFacade object

Specified by:

getCacheType in interface ICacheType

Returns:

The cacheType value

getCacheName

public java.lang.String getCacheName()

Gets the cacheName attribute of the LateralCacheNoWaitFacade object

Specified by:

getCacheName in interface AuxiliaryCache

Specified by:

getCacheName in interface ICache

Returns:

The cacheName value

getStatus

public int getStatus()

Gets the status attribute of the LateralCacheNoWaitFacade object

Specified by:

getStatus in interface AuxiliaryCache

Specified by:

getStatus in interface ICache

Returns:

The status value

getAuxiliaryCacheAttributes

public AuxiliaryCacheAttributes getAuxiliaryCacheAttributes()

Description copied from interface: AuxiliaryCache

This returns the generic attributes for an auxiliary cache. Most implementations will cast this to a more specific type.

Specified by:

getAuxiliaryCacheAttributes in interface AuxiliaryCache

Returns:

Returns the AuxiliaryCacheAttributes.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getStats

public java.lang.String getStats()

getStats

Specified by:

getStats in interface ICache

Returns:

String

getStatistics

public IStats getStatistics()

Description copied from interface: AuxiliaryCache

Returns the historical and statistical data for a region's auxiliary cache.

Specified by:

getStatistics in interface AuxiliaryCache

Returns: