org.infinispan.persistence.spi

Interface CacheWriter<K,V>

All Superinterfaces:

Lifecycle

All Known Subinterfaces:

AdvancedCacheExpirationWriter<K,V>, AdvancedCacheWriter<K,V>, AdvancedLoadWriteStore<K,V>, ExternalStore<K,V>, FlagAffectedStore<K,V>, TransactionalCacheWriter<K,V>

All Known Implementing Classes:

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

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

Allows persisting data to an external storage, as opposed to the CacheLoader.

Since:

6.0

Author:

Mircea Markus

Method Summary

Modifier and Type	Method and Description
boolean	delete(Object key)
default void	deleteBatch(Iterable<Object> keys) Remove all provided keys from the store in a single batch operation.
void	init(InitializationContext ctx) Used to initialize a cache loader.
void	write(MarshalledEntry<? extends K,? extends V> entry) Persists the entry to the storage.
default void	writeBatch(Iterable<MarshalledEntry<? extends K,? extends V>> entries) Persist all provided entries to the store in a single batch update.

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

write

void write(MarshalledEntry<? extends K,? extends V> entry)

Persists the entry to the storage.

Throws:

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

See Also:

MarshalledEntry

delete

boolean delete(Object key)

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

writeBatch

default void writeBatch(Iterable<MarshalledEntry<? extends K,? extends V>> entries)

Persist all provided entries to the store in a single batch update. If this is not supported by the underlying store, then entries are written to the store individually via write(MarshalledEntry).

Parameters:

entries - an Iterable of MarshalledEntry to be written to the store. Implementations should take into account that the passed iterable may contain no entries.

Throws:

NullPointerException - if entries is null.

deleteBatch

default void deleteBatch(Iterable<Object> keys)

Remove all provided keys from the store in a single batch operation. If this is not supported by the underlying store, then keys are removed from the store individually via delete(Object).

Parameters:

keys - an Iterable of entry Keys to be removed from the store. Implementations should take into account that the passed iterable may contain no keys.

Throws:

NullPointerException - if keys is null.