org.jboss.as.ejb3.cache.impl.backing

Class SimpleBackingCacheEntryStore<K extends Serializable,V extends Cacheable<K>,E extends BackingCacheEntry<K,V>>

java.lang.Object

org.jboss.as.ejb3.cache.spi.impl.AbstractBackingCacheEntryStore<K,V,E>

org.jboss.as.ejb3.cache.impl.backing.SimpleBackingCacheEntryStore<K,V,E>

All Implemented Interfaces:

AffinitySupport<K>, BackingCacheEntryStore<K,V,E>, GroupCompatibilityChecker

public class SimpleBackingCacheEntryStore<K extends Serializable,V extends Cacheable<K>,E extends BackingCacheEntry<K,V>>
extends AbstractBackingCacheEntryStore<K,V,E>

A BackingCacheEntryStore that stores in a simple Map and delegates to a provided PersistentObjectStore for persistence.

Author:

Brian Stansberry, Paul Ferraro

Constructor Summary

Constructors

Constructor and Description
SimpleBackingCacheEntryStore(PersistentObjectStore<K,E> store, ServerEnvironment environment, StatefulTimeoutInfo timeout, BackingCacheEntryStoreConfig config) Create a new SimpleIntegratedObjectStore.

Method Summary

Methods

Modifier and Type	Method and Description
E	get(K key, boolean lock) Gets the entry with the given id from the store.
org.jboss.ejb.client.Affinity	getStrictAffinity() Returns the strict affinity associated with the entries of this cache
org.jboss.ejb.client.Affinity	getWeakAffinity(K key) Returns the weak affinity associated with the specified entry of this cache
boolean	hasAffinity(K key) Indicates whether the cache has an affinity for the specified key.
Set<K>	insert(E entry) Put a new entry into the store.
boolean	isClustered() Gets whether this store supports clustering functionality.
boolean	isCompatibleWith(GroupCompatibilityChecker other) Gets whether this object can work compatibly with another in the management of SerializationGroups.
void	passivate(E entry) Remove the entry with the given key from any in-memory store while retaining it in the persistent store.
E	remove(K id) Remove the object with the given key from the store.
void	start() Perform any initialization work.
void	stop() Perform any shutdown work.
void	update(E entry, boolean modified) Update an already cached item.

Methods inherited from class org.jboss.as.ejb3.cache.spi.impl.AbstractBackingCacheEntryStore

getConfig, getTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleBackingCacheEntryStore

public SimpleBackingCacheEntryStore(PersistentObjectStore<K,E> store,
                            ServerEnvironment environment,
                            StatefulTimeoutInfo timeout,
                            BackingCacheEntryStoreConfig config)

Create a new SimpleIntegratedObjectStore.

Method Detail

getStrictAffinity

public org.jboss.ejb.client.Affinity getStrictAffinity()

Description copied from interface: AffinitySupport

Returns the strict affinity associated with the entries of this cache

getWeakAffinity

public org.jboss.ejb.client.Affinity getWeakAffinity(K key)

Description copied from interface: AffinitySupport

Returns the weak affinity associated with the specified entry of this cache

hasAffinity

public boolean hasAffinity(K key)

Description copied from interface: AffinitySupport

Indicates whether the cache has an affinity for the specified key.

Parameters:

key - a candidate key

Returns:

true if this cache likes this key, false otherwise

isClustered

public boolean isClustered()

Description copied from interface: BackingCacheEntryStore

Gets whether this store supports clustering functionality.

Returns:

true if clustering is supported, false otherwise

get

public E get(K key,
    boolean lock)

Description copied from interface: BackingCacheEntryStore

Gets the entry with the given id from the store.

Parameters:

key - id of the entry. Cannot be null.

Returns:

the object store under id. May return null.

insert

public Set<K> insert(E entry)

Description copied from interface: BackingCacheEntryStore

Put a new entry into the store. This operation should only be performed once per entry.

Parameters:

entry - the object to store. Cannot be null.

Returns:

A set of keys that need to be passivated, to keep the store below the max size

update

public void update(E entry,
          boolean modified)

Description copied from interface: BackingCacheEntryStore

Update an already cached item.

Parameters:

entry - the entry to update

modified - was the entry modified since BackingCacheEntryStore.get(java.io.Serializable, boolean) was called?

passivate

public void passivate(E entry)

Description copied from interface: BackingCacheEntryStore

Remove the entry with the given key from any in-memory store while retaining it in the persistent store.

Parameters:

entry - the entry to passivate

remove

public E remove(K id)

Description copied from interface: BackingCacheEntryStore

Remove the object with the given key from the store.

Parameters:

id - id of the entry. Cannot be null.

Returns:

the object that was cached under key

start

public void start()

Description copied from interface: BackingCacheEntryStore

Perform any initialization work.

stop

public void stop()

Description copied from interface: BackingCacheEntryStore

Perform any shutdown work.

isCompatibleWith

public boolean isCompatibleWith(GroupCompatibilityChecker other)

Description copied from interface: GroupCompatibilityChecker

Gets whether this object can work compatibly with another in the management of SerializationGroups.

Parameters:

other - the other checker. May be null.

Returns:

true if this object is compatible with other, false otherwise