org.infinispan.persistence.remote

Class RemoteStore

java.lang.Object

org.infinispan.persistence.remote.RemoteStore

All Implemented Interfaces:

Lifecycle, AdvancedCacheLoader, AdvancedCacheWriter, AdvancedLoadWriteStore, CacheLoader, CacheWriter, ExternalStore, FlagAffectedStore

@ThreadSafe
public class RemoteStore
extends Object
implements AdvancedLoadWriteStore, FlagAffectedStore

Cache store that delegates the call to a infinispan cluster. Communication between this cache store and the remote cluster is achieved through the java HotRod client: this assures fault tolerance and smart dispatching of calls to the nodes that have the highest chance of containing the given key. This cache store supports both preloading and fetchPersistentState.

Purging elements is not possible, as HotRod does not support the fetching of all remote keys (this would be a very costly operation as well). Purging takes place at the remote end (infinispan cluster).

Since:

4.1

Author:

Mircea.Markus@jboss.com

See Also:

RemoteStoreConfiguration, Hotrod Java Client

Nested Class Summary

Nested classes/interfaces inherited from interface org.infinispan.persistence.spi.AdvancedCacheLoader

AdvancedCacheLoader.CacheLoaderTask<K,V>, AdvancedCacheLoader.TaskContext

Nested classes/interfaces inherited from interface org.infinispan.persistence.spi.AdvancedCacheWriter

AdvancedCacheWriter.PurgeListener<K>

Field Summary

Fields

Modifier and Type	Field and Description
protected InitializationContext	ctx

Constructor Summary

Constructors

Constructor and Description
RemoteStore()

Method Summary

Modifier and Type	Method and Description
void	clear() Removes all the data from the storage.
boolean	contains(Object key) Returns true if the storage contains an entry associated with the given key.
boolean	delete(Object key)
RemoteStoreConfiguration	getConfiguration()
RemoteCache<Object,Object>	getRemoteCache()
void	init(InitializationContext ctx) Used to initialize a cache loader.
MarshalledEntry	load(Object key) Fetches an entry from the storage.
void	process(KeyFilter filter, AdvancedCacheLoader.CacheLoaderTask task, Executor executor, boolean fetchValue, boolean fetchMetadata) Iterates in parallel over the entries in the storage using the threads from the executor pool.
void	purge(Executor threadPool, AdvancedCacheWriter.PurgeListener task) Using the thread in the pool, removed all the expired data from the persistence storage.
void	setInternalCacheEntryFactory(InternalEntryFactory iceFactory)
boolean	shouldWrite(long commandFlags)
int	size() Returns the number of elements in the store.
void	start() Invoked on component start
void	stop() Invoked on component stop
void	write(MarshalledEntry entry) Persists the entry to the storage.

Methods inherited from class java.lang.Object

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

Field Detail

ctx

protected InitializationContext ctx

Constructor Detail

RemoteStore

public RemoteStore()

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

Specified by:

init in interface CacheWriter

start

public void start()
           throws PersistenceException

Description copied from interface: Lifecycle

Invoked on component start

Specified by:

start in interface Lifecycle

Throws:

PersistenceException

stop

public void stop()
          throws PersistenceException

Description copied from interface: Lifecycle

Invoked on component stop

Specified by:

stop in interface Lifecycle

Throws:

PersistenceException

load

public MarshalledEntry load(Object key)
                     throws PersistenceException

Description copied from interface: CacheLoader

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

Specified by:

load 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)
                 throws PersistenceException

Description copied from interface: CacheLoader

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

Specified by:

contains in interface CacheLoader

Throws:

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

process

public void process(KeyFilter filter,
                    AdvancedCacheLoader.CacheLoaderTask task,
                    Executor executor,
                    boolean fetchValue,
                    boolean fetchMetadata)

Description copied from interface: AdvancedCacheLoader

Iterates in parallel over the entries in the storage using the threads from the executor pool. For each entry the CacheLoaderTask#processEntry(MarshalledEntry, TaskContext) is invoked. Before passing an entry to the callback task, the entry should be validated against the filter. Implementors should build an AdvancedCacheLoader.TaskContext instance (implementation) that is fed to the AdvancedCacheLoader.CacheLoaderTask on every invocation. The AdvancedCacheLoader.CacheLoaderTask might invoke AdvancedCacheLoader.TaskContext.stop() at any time, so implementors of this method should verify TaskContext's state for early termination of iteration. The method should only return once the iteration is complete or as soon as possible in the case TaskContext.stop() is invoked.

Specified by:

process in interface AdvancedCacheLoader

Parameters:

filter - to validate which entries should be feed into the task. Might be null.

task - callback to be invoked in parallel for each stored entry that passes the filter check

executor - an external thread pool to be used for parallel iteration

fetchValue - whether or not to fetch the value from the persistent store. E.g. if the iteration is intended only over the key set, no point fetching the values from the persistent store as well

fetchMetadata - whether or not to fetch the metadata from the persistent store. E.g. if the iteration is intended only ove the key set, then no pint fetching the metadata from the persistent store as well

size

public int size()

Description copied from interface: AdvancedCacheLoader

Returns the number of elements in the store.

Specified by:

size in interface AdvancedCacheLoader

purge

public void purge(Executor threadPool,
                  AdvancedCacheWriter.PurgeListener task)

Description copied from interface: AdvancedCacheWriter

Using the thread in the pool, removed all the expired data from the persistence storage. For each removed entry, the supplied listener is invoked.

Specified by:

purge in interface AdvancedCacheWriter

write

public void write(MarshalledEntry entry)
           throws PersistenceException

Description copied from interface: CacheWriter

Persists the entry to the storage.

Specified by:

write in interface CacheWriter

Throws:

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

See Also:

MarshalledEntry

clear

public void clear()
           throws PersistenceException

Description copied from interface: AdvancedCacheWriter

Removes all the data from the storage.

Specified by:

clear in interface AdvancedCacheWriter

Throws:

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

delete

public boolean delete(Object key)
               throws PersistenceException

Specified by:

delete in interface CacheWriter

Returns:

true if the entry existed in the persistent store and it was deleted.

Throws:

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

setInternalCacheEntryFactory

public void setInternalCacheEntryFactory(InternalEntryFactory iceFactory)

getRemoteCache

public RemoteCache<Object,Object> getRemoteCache()

getConfiguration

public RemoteStoreConfiguration getConfiguration()

shouldWrite

public boolean shouldWrite(long commandFlags)

Specified by:

shouldWrite in interface FlagAffectedStore