org.infinispan.persistence.spi

Interface CacheLoader<K,V>

All Superinterfaces:

Lifecycle

All Known Subinterfaces:

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

All Known Implementing Classes:

ClusterLoader, JdbcStringBasedStore, JpaStore, RemoteStore, RestStore, RocksDBStore, SingleFileStore, SoftIndexFileStore

@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

Method Summary

Modifier and Type	Method and Description
boolean	contains(java.lang.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.
default boolean	isAvailable()
default MarshalledEntry<K,V>	load(java.lang.Object key) Deprecated. since 10.0 please implement {loadEntry(Object)} instead
default MarshallableEntry<K,V>	loadEntry(java.lang.Object key) Fetches an entry from the storage.

Methods inherited from interface org.infinispan.commons.api.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

@Deprecated
default MarshalledEntry<K,V> load(java.lang.Object key)

Deprecated. since 10.0 please implement {loadEntry(Object)} instead

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

loadEntry

default MarshallableEntry<K,V> loadEntry(java.lang.Object key)

Fetches an entry from the storage. If a MarshallableEntry needs to be created here, InitializationContext.getMarshallableEntryFactory() ()} 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(java.lang.Object 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

isAvailable

default boolean isAvailable()

Returns:

true if the writer can be connected to, otherwise false