org.infinispan.persistence.spi

Interface CacheLoader<K,V>

All Superinterfaces:

Lifecycle

All Known Subinterfaces:

AdvancedCacheLoader<K,V>, AdvancedLoadWriteStore<K,V>, ExternalStore<K,V>

All Known Implementing Classes:

Adaptor52xStore, AdvancedAsyncCacheLoader, AsyncCacheLoader, CLInterfaceLoader, ClusterLoader, DelegatingCacheLoader, JCacheLoaderAdapter, JdbcBinaryStore, JdbcMixedStore, JdbcStringBasedStore, LevelDBStore, LuceneCacheLoader, RemoteEventStore, RemoteStore, RestStore, SingleFileStore

@ThreadSafe
public interface CacheLoader<K,V>
extends Lifecycle

Defines the logic for loading data from an external storage. The writing of data is optional and coordinated through a CacheWriter.

Since:

6.0

Author:

Mircea Markus

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(K key) Returns true if the storage contains an entry associated with the given key.
void	init(InitializationContext ctx) Used to initialize a cache loader.
MarshalledEntry<K,V>	load(K key) Fetches an entry from the storage.

Methods inherited from interface org.infinispan.lifecycle.Lifecycle

start, stop

Method Detail

init

void init(InitializationContext ctx)

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

Throws:

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

load

MarshalledEntry<K,V> load(K key)

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

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

boolean contains(K key)

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

Throws:

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