org.datanucleus.cache

Class AbstractLevel2Cache

java.lang.Object

org.datanucleus.cache.AbstractLevel2Cache

All Implemented Interfaces:

Serializable, Level2Cache

Direct Known Subclasses:

JavaxCacheLevel2Cache, NullLevel2Cache

public abstract class AbstractLevel2Cache
extends Object
implements Level2Cache

Abstract starting point for a third-party L2 cache plugin. Override the pin/unpin methods if supportable by your plugin.

See Also:

Serialized Form

Nested Class Summary

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

Level2Cache.PinnedClass

Field Summary

Fields

Modifier and Type	Field and Description
protected String	cacheName Name of the cache to use.
protected boolean	clearAtClose Whether to clear out all objects at close().
protected int	maxSize Maximum size of cache (if supported by the plugin).
protected NucleusContext	nucleusCtx
protected long	timeout Timeout for cache object expiration (milliseconds).

Constructor Summary

Constructors

Constructor and Description
AbstractLevel2Cache(NucleusContext nucleusCtx)

Method Summary

Modifier and Type	Method and Description
Map<Object,CachedPC>	getAll(Collection oids) Accessor for a collection of objects from the cache.
int	getNumberOfPinnedObjects() Accessor for the number of pinned objects in the cache.
int	getNumberOfUnpinnedObjects() Accessor for the number of unpinned objects in the cache.
boolean	isEmpty() Accessor for whether the cache is empty
void	pin(Object arg0) Pin the parameter instance in the second-level cache.
void	pinAll(Class arg0, boolean arg1) Pin instances in the second-level cache.
void	pinAll(Collection arg0) Pin the parameter instances in the second-level cache.
void	pinAll(Object[] arg0) Pin the parameter instances in the second-level cache.
void	putAll(Map<Object,CachedPC> objs) Method to put several objects into the cache.
void	unpin(Object arg0) Unpin the parameter instance from the second-level cache.
void	unpinAll(Class arg0, boolean arg1) Unpin instances from the second-level cache.
void	unpinAll(Collection arg0) Unpin the parameter instances from the second-level cache.
void	unpinAll(Object[] arg0) Unpin the parameter instance from the second-level cache.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.datanucleus.cache.Level2Cache

close, containsOid, evict, evictAll, evictAll, evictAll, evictAll, get, getSize, put

Field Detail

nucleusCtx

protected NucleusContext nucleusCtx

maxSize

protected int maxSize

Maximum size of cache (if supported by the plugin).

clearAtClose

protected boolean clearAtClose

Whether to clear out all objects at close().

timeout

protected long timeout

Timeout for cache object expiration (milliseconds).

cacheName

protected String cacheName

Name of the cache to use.

Constructor Detail

AbstractLevel2Cache

public AbstractLevel2Cache(NucleusContext nucleusCtx)

Method Detail

getAll

public Map<Object,CachedPC> getAll(Collection oids)

Description copied from interface: Level2Cache

Accessor for a collection of objects from the cache.

Specified by:

getAll in interface Level2Cache

Parameters:

oids - The Object IDs

Returns:

Map of the objects, keyed by the oids that are found

putAll

public void putAll(Map<Object,CachedPC> objs)

Description copied from interface: Level2Cache

Method to put several objects into the cache.

Specified by:

putAll in interface Level2Cache

Parameters:

objs - Map of cacheable object keyed by its oid.

isEmpty

public boolean isEmpty()

Accessor for whether the cache is empty

Specified by:

isEmpty in interface Level2Cache

Returns:

Whether it is empty.

See Also:

Level2Cache.isEmpty()

getNumberOfPinnedObjects

public int getNumberOfPinnedObjects()

Description copied from interface: Level2Cache

Accessor for the number of pinned objects in the cache.

Specified by:

getNumberOfPinnedObjects in interface Level2Cache

Returns:

Number of pinned objects

getNumberOfUnpinnedObjects

public int getNumberOfUnpinnedObjects()

Description copied from interface: Level2Cache

Accessor for the number of unpinned objects in the cache.

Specified by:

getNumberOfUnpinnedObjects in interface Level2Cache

Returns:

Number of unpinned objects

pin

public void pin(Object arg0)

Description copied from interface: Level2Cache

Pin the parameter instance in the second-level cache.

Specified by:

pin in interface Level2Cache

Parameters:

arg0 - the object id of the instance to pin.

pinAll

public void pinAll(Collection arg0)

Description copied from interface: Level2Cache

Pin the parameter instances in the second-level cache.

Specified by:

pinAll in interface Level2Cache

Parameters:

arg0 - the object ids of the instances to pin.

pinAll

public void pinAll(Object[] arg0)

Description copied from interface: Level2Cache

Pin the parameter instances in the second-level cache.

Specified by:

pinAll in interface Level2Cache

Parameters:

arg0 - the object ids of the instances to pin.

pinAll

public void pinAll(Class arg0,
                   boolean arg1)

Description copied from interface: Level2Cache

Pin instances in the second-level cache.

Specified by:

pinAll in interface Level2Cache

Parameters:

arg0 - the class of instances to pin

arg1 - if true, pin instances of subclasses also

unpin

public void unpin(Object arg0)

Description copied from interface: Level2Cache

Unpin the parameter instance from the second-level cache.

Specified by:

unpin in interface Level2Cache

Parameters:

arg0 - the object id of the instance to unpin.

unpinAll

public void unpinAll(Collection arg0)

Description copied from interface: Level2Cache

Unpin the parameter instances from the second-level cache.

Specified by:

unpinAll in interface Level2Cache

Parameters:

arg0 - the object ids of the instance to evict.

unpinAll

public void unpinAll(Object[] arg0)

Description copied from interface: Level2Cache

Unpin the parameter instance from the second-level cache.

Specified by:

unpinAll in interface Level2Cache

Parameters:

arg0 - the object id of the instance to evict.

unpinAll

public void unpinAll(Class arg0,
                     boolean arg1)

Description copied from interface: Level2Cache

Unpin instances from the second-level cache.

Specified by:

unpinAll in interface Level2Cache

Parameters:

arg0 - the class of instances to unpin

arg1 - if true, unpin instances of subclasses also