org.castor.cache.distributed
Class OsCache

java.lang.Object
  org.castor.cache.AbstractBaseCache
      org.castor.cache.distributed.OsCache

All Implemented Interfaces:

Cache, java.util.Map

public final class OsCache

extends AbstractBaseCache

OSCache (opensymphony) implementation of Castor JDO Cache. For more details of OSCache, see http://www.opensymphony.com/oscache

Since:

1.0

Version:

$Revision: 7085 $ $Date: 2006-04-25 16:09:10 -0600 (Tue, 25 Apr 2006) $

Author:

Werner Guttmann, Ralf Joachim

See Also:

The OSCache Home page

Nested Class Summary

Nested classes inherited from class java.util.Map

java.util.Map.Entry

Field Summary

static java.lang.String	IMPLEMENTATION The classname of the implementations cache class.
static java.lang.String	NEEDS_REFRESH_EXCEPTION Classname of exception thrown by getFromCache() method of oscache.
static java.lang.String	TYPE The type of the cache.

Fields inherited from interface org.castor.cache.Cache

DEFAULT_DEBUG, DEFAULT_NAME, DEFAULT_TYPE, PARAM_DEBUG, PARAM_NAME, PARAM_TYPE

Constructor Summary

OsCache(java.lang.Object cache)
Construct an instance of OsCache that wrapps access to given cache implementation of class com.opensymphony.oscache.general.GeneralCacheAdministrator.

Method Summary

void	clear()
boolean	containsKey(java.lang.Object key)
boolean	containsValue(java.lang.Object value)
java.util.Set	entrySet()
java.lang.Object	get(java.lang.Object key)
java.lang.String	getType() Indicates the type of this cache.
void	initialize(java.util.Properties params) Lyfe-cycle method to allow custom initialization of cache implementations.
boolean	isEmpty()
java.util.Set	keySet()
java.lang.Object	put(java.lang.Object key, java.lang.Object value)
void	putAll(java.util.Map map)
java.lang.Object	remove(java.lang.Object key)
int	size()
java.util.Collection	values()

Methods inherited from class org.castor.cache.AbstractBaseCache

close, expire, expireAll, getName, invokeMethod, invokeStaticMethod

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

equals, hashCode

Field Detail

TYPE

public static final java.lang.String TYPE

The type of the cache.

See Also:

Constant Field Values

IMPLEMENTATION

public static final java.lang.String IMPLEMENTATION

The classname of the implementations cache class.

See Also:

Constant Field Values

NEEDS_REFRESH_EXCEPTION

public static final java.lang.String NEEDS_REFRESH_EXCEPTION

Classname of exception thrown by getFromCache() method of oscache.

See Also:

Constant Field Values

Constructor Detail

OsCache

public OsCache(java.lang.Object cache)

Construct an instance of OsCache that wrapps access to given cache implementation of class com.opensymphony.oscache.general.GeneralCacheAdministrator.

Parameters:

cache - The cache to be wrapped.

Method Detail

initialize

public void initialize(java.util.Properties params)
                throws CacheAcquireException

Lyfe-cycle method to allow custom initialization of cache implementations.

Specified by:

initialize in interface Cache

Overrides:

initialize in class AbstractBaseCache

Throws:

CacheAcquireException

See Also:

Cache.initialize(java.util.Properties)

getType

public java.lang.String getType()

Indicates the type of this cache.

Returns:

The cache type.

See Also:

Cache.getType()

size

public int size()

See Also:

Map.size()

isEmpty

public boolean isEmpty()

See Also:

Map.isEmpty()

containsKey

public boolean containsKey(java.lang.Object key)

See Also:

Map.containsKey(java.lang.Object)

containsValue

public boolean containsValue(java.lang.Object value)

See Also:

Map.containsValue(java.lang.Object)

get

public java.lang.Object get(java.lang.Object key)

See Also:

Map.get(java.lang.Object)

put

public java.lang.Object put(java.lang.Object key,
                            java.lang.Object value)

See Also:

Map.put(java.lang.Object, java.lang.Object)

remove

public java.lang.Object remove(java.lang.Object key)

See Also:

Map.remove(java.lang.Object)

putAll

public void putAll(java.util.Map map)

See Also:

Map.putAll(java.util.Map)

clear

public void clear()

See Also:

Map.clear()

keySet

public java.util.Set keySet()

See Also:

Map.keySet()

values

public java.util.Collection values()

See Also:

Map.values()

entrySet

public java.util.Set entrySet()

See Also:

Map.entrySet()