org.infinispan.loaders.cluster

Class ClusterCacheLoader

java.lang.Object

org.infinispan.loaders.AbstractCacheLoader

org.infinispan.loaders.cluster.ClusterCacheLoader

All Implemented Interfaces:

CacheLoader

public class ClusterCacheLoader
extends AbstractCacheLoader

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

Field Summary

Fields inherited from class org.infinispan.loaders.AbstractCacheLoader

marshaller

Constructor Summary

Constructors

Constructor and Description
ClusterCacheLoader()

Method Summary

Methods

Modifier and Type	Method and Description
Class<? extends CacheLoaderConfig>	getConfigurationClass() This method is used by the configuration parser to get a hold of the CacheLoader implementation's corresponding CacheLoaderConfig type.
void	init(CacheLoaderConfig config, Cache<?,?> cache, StreamingMarshaller m) Used to initialize a cache loader.
protected boolean	isCacheReady() A test to check whether the cache is in its started state.
Set<InternalCacheEntry>	load(int maxElems) Loads up to a specific number of entries.
InternalCacheEntry	load(Object key) Loads an entry mapped to by a given key.
Set<InternalCacheEntry>	loadAll() Loads all entries in the loader.
Set<Object>	loadAllKeys(Set<Object> keysToExclude) Loads a set of all keys, excluding a filter set.
void	start()
void	stop()

Methods inherited from class org.infinispan.loaders.AbstractCacheLoader

containsKey

Methods inherited from class java.lang.Object

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

Constructor Detail

ClusterCacheLoader

public ClusterCacheLoader()

Method Detail

init

public void init(CacheLoaderConfig config,
        Cache<?,?> cache,
        StreamingMarshaller m)

Description copied from interface: CacheLoader

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

Specified by:

init in interface CacheLoader

Overrides:

init in class AbstractCacheLoader

Parameters:

config - the cache loader configuration bean

cache - cache associated with this cache loader. Implementations may use this to determine cache name when selecting where refer to state in storage, for example, a different database table name.

m - marshaller to use when loading state from a stream, if supported by the implementation.

load

public InternalCacheEntry load(Object key)
                        throws CacheLoaderException

Description copied from interface: CacheLoader

Loads an entry mapped to by a given key. Should return null if the entry does not exist. Expired entries are not returned.

Parameters:

key - key

Returns:

an entry

Throws:

CacheLoaderException - in the event of problems reading from source

loadAll

public Set<InternalCacheEntry> loadAll()
                                throws CacheLoaderException

Description copied from interface: CacheLoader

Loads all entries in the loader. Expired entries are not returned.

Returns:

a set of entries, or an empty set if the loader is emptied.

Throws:

CacheLoaderException - in the event of problems reading from source

load

public Set<InternalCacheEntry> load(int maxElems)
                             throws CacheLoaderException

Description copied from interface: CacheLoader

Loads up to a specific number of entries. There is no guarantee as to order of entries loaded. The set returned would contain up to a maximum of numEntries entries, and no more.

Parameters:

maxElems - maximum number of entries to load

Returns:

a set of entries, which would contain between 0 and numEntries entries.

Throws:

CacheLoaderException

loadAllKeys

public Set<Object> loadAllKeys(Set<Object> keysToExclude)
                        throws CacheLoaderException

Description copied from interface: CacheLoader

Loads a set of all keys, excluding a filter set.

Parameters:

keysToExclude - a set of keys to exclude. An empty set or null will indicate that all keys should be returned.

Returns:

A set containing keys of entries stored. An empty set is returned if the loader is empty.

Throws:

CacheLoaderException

start

public void start()
           throws CacheLoaderException

Throws:

CacheLoaderException

stop

public void stop()
          throws CacheLoaderException

Throws:

CacheLoaderException

getConfigurationClass

public Class<? extends CacheLoaderConfig> getConfigurationClass()

Description copied from interface: CacheLoader

This method is used by the configuration parser to get a hold of the CacheLoader implementation's corresponding CacheLoaderConfig type. This is usually done by instantiating the CacheLoader and then calling this method. This may result in 2 instances being created, however, since the instance created to get a hold of the configuration type is then discarded and another instance is created for actual use as a CacheLoader when the cache starts.

Since Infinispan 4.1, you can also annotate your CacheLoader implementation with CacheLoaderMetadata and provide this information via the annotation, which will prevent unnecessary instances being created.

Returns:

the type of the CacheLoaderConfig bean used to configure this implementation of CacheLoader.

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.