org.datanucleus.cache.oscache
Class OSCacheLevel2Cache

java.lang.Object
  org.datanucleus.cache.AbstractLevel2Cache
      org.datanucleus.cache.oscache.OSCacheLevel2Cache

All Implemented Interfaces:

Serializable, org.datanucleus.cache.Level2Cache

public class OSCacheLevel2Cache
extends org.datanucleus.cache.AbstractLevel2Cache

Simple implementation of a plugin for use of OSCache caching product with DataNucleus. Please refer to OpenSymphony OSCache for full details of their product.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.datanucleus.cache.Level2Cache

org.datanucleus.cache.Level2Cache.PinnedClass

Field Summary

Fields inherited from class org.datanucleus.cache.AbstractLevel2Cache

cacheName, clearAtClose, LOCALISER, maxSize, nucleusCtx, timeout

Constructor Summary

OSCacheLevel2Cache(org.datanucleus.NucleusContext nucleusCtx)
Constructor.

Method Summary

void	close() Method to close the cache when no longer needed.
boolean	containsOid(Object oid) Accessor for whether the cache contains the specified id.
void	evict(Object oid) Evict the parameter instance from the second-level cache.
void	evictAll() Evict the parameter instances from the second-level cache.
void	evictAll(Class pcClass, boolean subclasses) Evict the parameter instances from the second-level cache.
void	evictAll(Collection oids) Evict the parameter instances from the second-level cache.
void	evictAll(Object[] oids) Evict the parameter instances from the second-level cache.
org.datanucleus.cache.CachedPC	get(Object oid) Accessor for an object in the cache.
int	getSize() Accessor for the size of the cache.
org.datanucleus.cache.CachedPC	put(Object oid, org.datanucleus.cache.CachedPC pc) Method to add an object to the cache under its id

Methods inherited from class org.datanucleus.cache.AbstractLevel2Cache

getAll, getNumberOfPinnedObjects, getNumberOfUnpinnedObjects, isEmpty, pin, pinAll, pinAll, pinAll, putAll, unpin, unpinAll, unpinAll, unpinAll

Methods inherited from class java.lang.Object

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

Constructor Detail

OSCacheLevel2Cache

public OSCacheLevel2Cache(org.datanucleus.NucleusContext nucleusCtx)

Constructor.

Parameters:

nucleusCtx - Context

Method Detail

close

public void close()

Method to close the cache when no longer needed. Provides a hook to release resources etc.

containsOid

public boolean containsOid(Object oid)

Accessor for whether the cache contains the specified id.

See Also:

Level2Cache.containsOid(java.lang.Object)

get

public org.datanucleus.cache.CachedPC get(Object oid)

Accessor for an object in the cache.

See Also:

Level2Cache.get(java.lang.Object)

getSize

public int getSize()

Accessor for the size of the cache.

See Also:

Level2Cache.getSize()

put

public org.datanucleus.cache.CachedPC put(Object oid,
                                          org.datanucleus.cache.CachedPC pc)

Method to add an object to the cache under its id

Parameters:

oid - The identity

pc - The cacheable object

Returns:

Previous object stored under this id

evict

public void evict(Object oid)

Evict the parameter instance from the second-level cache.

Parameters:

oid - the object id of the instance to evict.

evictAll

public void evictAll()

Evict the parameter instances from the second-level cache. All instances in the PersistenceManager's cache are evicted from the second-level cache.

evictAll

public void evictAll(Class pcClass,
                     boolean subclasses)

Evict the parameter instances from the second-level cache.

Parameters:

pcClass - the class of instances to evict

subclasses - if true, evict instances of subclasses also

evictAll

public void evictAll(Collection oids)

Evict the parameter instances from the second-level cache.

Parameters:

oids - the object ids of the instance to evict.

evictAll

public void evictAll(Object[] oids)

Evict the parameter instances from the second-level cache.

Parameters:

oids - the object ids of the instance to evict.