org.jboss.as.clustering.ejb3.cache.backing.infinispan

Class InfinispanBackingCacheEntryStore<K extends Serializable,V extends Cacheable<K>,E extends BackingCacheEntry<K,V>,C>

java.lang.Object

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

org.jboss.as.clustering.ejb3.cache.backing.infinispan.InfinispanBackingCacheEntryStore<K,V,E,C>

All Implemented Interfaces:

org.infinispan.affinity.KeyGenerator<K>, AffinitySupport<K>, IdentifierFactory<K>, BackingCacheEntryStore<K,V,E>, GroupCompatibilityChecker

public class InfinispanBackingCacheEntryStore<K extends Serializable,V extends Cacheable<K>,E extends BackingCacheEntry<K,V>,C>
extends AbstractBackingCacheEntryStore<K,V,E>
implements org.infinispan.affinity.KeyGenerator<K>

Infinispan-based backing cache entry store.

Author:

Paul Ferraro

Constructor Summary

Constructors

Constructor and Description

InfinispanBackingCacheEntryStore(org.infinispan.Cache<K,MarshalledValue<E,C>> cache, CacheInvoker invoker, IdentifierFactory<K> identifierFactory, KeyAffinityServiceFactory affinityFactory, PassivationManager<K,E> passivationManager, StatefulTimeoutInfo timeout, ClusteredBackingCacheEntryStoreConfig config, boolean controlCacheLifecycle, MarshalledValueFactory<C> valueFactory, C context, NodeFactory<org.infinispan.remoting.transport.Address> nodeFactory, Registry<String,?> registry)

Method Summary

Methods

Modifier and Type	Method and Description
void	activated(org.infinispan.notifications.cachelistener.event.CacheEntryActivatedEvent<MarshalledValue<K,C>,MarshalledValue<E,C>> event)
K	createIdentifier()
E	get(K id, boolean lock) Gets the entry with the given id from the store.
K	getKey()
int	getPassivatedCount()
int	getStoreSize()
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.
void	passivated(org.infinispan.notifications.cachelistener.event.CacheEntryPassivatedEvent<MarshalledValue<K,C>,MarshalledValue<E,C>> event)
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

InfinispanBackingCacheEntryStore

public InfinispanBackingCacheEntryStore(org.infinispan.Cache<K,MarshalledValue<E,C>> cache,
                                CacheInvoker invoker,
                                IdentifierFactory<K> identifierFactory,
                                KeyAffinityServiceFactory affinityFactory,
                                PassivationManager<K,E> passivationManager,
                                StatefulTimeoutInfo timeout,
                                ClusteredBackingCacheEntryStoreConfig config,
                                boolean controlCacheLifecycle,
                                MarshalledValueFactory<C> valueFactory,
                                C context,
                                NodeFactory<org.infinispan.remoting.transport.Address> nodeFactory,
                                Registry<String,?> registry)

Method Detail

start

public void start()

Description copied from interface: BackingCacheEntryStore

Perform any initialization work.

Specified by:

start in interface BackingCacheEntryStore<K extends Serializable,V extends Cacheable<K>,E extends BackingCacheEntry<K,V>>

stop

public void stop()

Description copied from interface: BackingCacheEntryStore

Perform any shutdown work.

Specified by:

stop in interface BackingCacheEntryStore<K extends Serializable,V extends Cacheable<K>,E extends BackingCacheEntry<K,V>>

createIdentifier

public K createIdentifier()

Specified by:

createIdentifier in interface IdentifierFactory<K extends Serializable>

getKey

public K getKey()

Specified by:

getKey in interface org.infinispan.affinity.KeyGenerator<K extends Serializable>

hasAffinity

public boolean hasAffinity(K key)

Description copied from interface: AffinitySupport

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

Specified by:

hasAffinity in interface AffinitySupport<K extends Serializable>

Parameters:

key - a candidate key

Returns:

true if this cache likes this key, false otherwise

getStrictAffinity

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

Description copied from interface: AffinitySupport

Returns the strict affinity associated with the entries of this cache

Specified by:

getStrictAffinity in interface AffinitySupport<K extends Serializable>

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

Specified by:

getWeakAffinity in interface AffinitySupport<K extends Serializable>

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.

Specified by:

insert in interface BackingCacheEntryStore<K extends Serializable,V extends Cacheable<K>,E extends BackingCacheEntry<K,V>>

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

get

public E get(K id,
    boolean lock)

Description copied from interface: BackingCacheEntryStore

Gets the entry with the given id from the store.

Specified by:

get in interface BackingCacheEntryStore<K extends Serializable,V extends Cacheable<K>,E extends BackingCacheEntry<K,V>>

Parameters:

id - id of the entry. Cannot be null.

Returns:

the object store under id. May return null.

update

public void update(E entry,
          boolean modified)

Description copied from interface: BackingCacheEntryStore

Update an already cached item.

Specified by:

update in interface BackingCacheEntryStore<K extends Serializable,V extends Cacheable<K>,E extends BackingCacheEntry<K,V>>

Parameters:

entry - the entry to update

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

remove

public E remove(K id)

Description copied from interface: BackingCacheEntryStore

Remove the object with the given key from the store.

Specified by:

remove in interface BackingCacheEntryStore<K extends Serializable,V extends Cacheable<K>,E extends BackingCacheEntry<K,V>>

Parameters:

id - id of the entry. Cannot be null.

Returns:

the object that was cached under key

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.

Specified by:

passivate in interface BackingCacheEntryStore<K extends Serializable,V extends Cacheable<K>,E extends BackingCacheEntry<K,V>>

Parameters:

entry - the entry to passivate

isClustered

public boolean isClustered()

Description copied from interface: BackingCacheEntryStore

Gets whether this store supports clustering functionality.

Specified by:

isClustered in interface BackingCacheEntryStore<K extends Serializable,V extends Cacheable<K>,E extends BackingCacheEntry<K,V>>

Returns:

true if clustering is supported, false otherwise

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.

Specified by:

isCompatibleWith in interface GroupCompatibilityChecker

Parameters:

other - the other checker. May be null.

Returns:

true if this object is compatible with other, false otherwise

activated

public void activated(org.infinispan.notifications.cachelistener.event.CacheEntryActivatedEvent<MarshalledValue<K,C>,MarshalledValue<E,C>> event)

passivated

public void passivated(org.infinispan.notifications.cachelistener.event.CacheEntryPassivatedEvent<MarshalledValue<K,C>,MarshalledValue<E,C>> event)

getStoreSize

public int getStoreSize()

Specified by:

getStoreSize in interface BackingCacheEntryStore<K extends Serializable,V extends Cacheable<K>,E extends BackingCacheEntry<K,V>>

getPassivatedCount

public int getPassivatedCount()

Specified by:

getPassivatedCount in interface BackingCacheEntryStore<K extends Serializable,V extends Cacheable<K>,E extends BackingCacheEntry<K,V>>