Package org.infinispan.persistence.cluster

Class ClusterLoader

java.lang.Object

org.infinispan.persistence.cluster.ClusterLoader

All Implemented Interfaces:

Lifecycle, CacheLoader, LocalOnlyCacheLoader

public class ClusterLoader
extends Object
implements CacheLoader, LocalOnlyCacheLoader

Cache loader that consults other members in the cluster for values. A remoteCallTimeout property is required, a long that specifies in milliseconds how long to wait for results before returning a null.

Author:

Mircea.Markus@jboss.com

Constructor Summary

Constructors

Constructor	Description
ClusterLoader()

Method Summary

Modifier and Type	Method	Description
boolean	contains(Object key)	Returns true if the storage contains an entry associated with the given key.
void	init(InitializationContext ctx)	Used to initialize a cache loader.
protected boolean	isCacheReady()	A test to check whether the cache is in its started state.
MarshallableEntry	loadEntry(Object key)	Fetches an entry from the storage.
void	start()	Invoked on component start
void	stop()	Invoked on component stop

Methods inherited from interface org.infinispan.persistence.spi.CacheLoader

isAvailable, load

Constructor Detail

ClusterLoader

public ClusterLoader()

Method Detail

init

public void init(InitializationContext ctx)

Description copied from interface: CacheLoader

Used to initialize a cache loader. Typically invoked by the PersistenceManager when setting up cache loaders.

Specified by:

init in interface CacheLoader

loadEntry

public MarshallableEntry loadEntry(Object key)
                            throws PersistenceException

Description copied from interface: CacheLoader

Fetches an entry from the storage. If a MarshallableEntry needs to be created here, InitializationContext.getMarshallableEntryFactory() ()} and InitializationContext.getByteBufferFactory() should be used.

Specified by:

loadEntry in interface CacheLoader

Returns:

the entry, or null if the entry does not exist

Throws:

PersistenceException - in case of an error, e.g. communicating with the external storage

contains

public boolean contains(Object key)

Description copied from interface: CacheLoader

Returns true if the storage contains an entry associated with the given key.

Specified by:

contains in interface CacheLoader

start

public void start()

Description copied from interface: Lifecycle

Invoked on component start

Specified by:

start in interface Lifecycle

stop

public void stop()

Description copied from interface: Lifecycle

Invoked on component stop

Specified by:

stop in interface Lifecycle

isCacheReady

protected boolean isCacheReady()

A test to check whether the cache is in its started state. If not, calls should not be made as the channel may not have properly started, blocks due to state transfers may be in progress, etc.

Returns:

true if the cache is in its STARTED state.