org.apache.jcs.auxiliary.lateral

Class LateralCacheNoWaitFacade

java.lang.Object

org.apache.jcs.auxiliary.AbstractAuxiliaryCache

org.apache.jcs.auxiliary.lateral.LateralCacheNoWaitFacade

All Implemented Interfaces:

java.io.Serializable, AuxiliaryCache, ICache, ICacheType

public class LateralCacheNoWaitFacade
extends AbstractAuxiliaryCache

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

Fields

Modifier and Type	Field and Description
LateralCacheNoWait[]	noWaits The queuing facade to the client.

Fields inherited from class org.apache.jcs.auxiliary.AbstractAuxiliaryCache

cacheEventLogger, elementSerializer, keyMatcher

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

CACHE_HUB, DISK_CACHE, LATERAL_CACHE, REMOTE_CACHE

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
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.lang.String	getEventLoggingExtraInfo() this won't be called since we don't do ICache logging here.
java.util.Set	getGroupKeys(java.lang.String group) Gets the set of keys of objects currently in the group
java.util.Map	getMatching(java.lang.String pattern) Synchronously reads from the lateral cache.
java.util.Map	getMultiple(java.util.Set keys) Gets multiple items from the cache based on the given set of keys.
int	getSize() No lateral invocation.
IStats	getStatistics()
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 org.apache.jcs.auxiliary.AbstractAuxiliaryCache

createICacheEvent, createICacheEvent, getCacheEventLogger, getElementSerializer, getKeyMatcher, logApplicationEvent, logError, logICacheEvent, setCacheEventLogger, setElementSerializer, setKeyMatcher

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: ICache

Puts an item to the cache.

Parameters:

ce -

Throws:

java.io.IOException

get

public ICacheElement get(java.io.Serializable key)

Synchronously reads from the lateral cache.

Parameters:

key -

Returns:

ICacheElement

getMultiple

public java.util.Map getMultiple(java.util.Set keys)

Gets multiple items from the cache based on the given set of keys.

Parameters:

keys -

Returns:

a map of Serializable key to ICacheElement element, or an empty map if there is no data in cache for any of these keys

getMatching

public java.util.Map getMatching(java.lang.String pattern)

Synchronously reads from the lateral cache. Get a response from each! This will be slow. Merge them.

Parameters:

pattern -

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

Parameters:

group -

Returns:

Set

remove

public boolean remove(java.io.Serializable key)

Adds a remove request to the lateral cache.

Parameters:

key -

Returns:

always false.

removeAll

public void removeAll()

Adds a removeAll request to the lateral cache.

dispose

public void dispose()

Adds a dispose request to the lateral cache.

getSize

public int getSize()

No lateral invocation.

Returns:

The size value

getCacheType

public int getCacheType()

Gets the cacheType attribute of the LateralCacheNoWaitFacade object.

Returns:

The cacheType value

getCacheName

public java.lang.String getCacheName()

Gets the cacheName attribute of the LateralCacheNoWaitFacade object.

Returns:

The cacheName value

getStatus

public int getStatus()

Gets the status attribute of the LateralCacheNoWaitFacade object

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.

Returns:

Returns the AuxiliaryCacheAttributes.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

"LateralCacheNoWaitFacade: " + cacheName;

getEventLoggingExtraInfo

public java.lang.String getEventLoggingExtraInfo()

this won't be called since we don't do ICache logging here.

Specified by:

getEventLoggingExtraInfo in class AbstractAuxiliaryCache

Returns:

String

getStats

public java.lang.String getStats()

getStats

Returns:

String

getStatistics

public IStats getStatistics()

Returns:

IStats