org.infinispan.persistence.spi

Interface AdvancedCacheWriter<K,V>

All Superinterfaces:

CacheWriter<K,V>, Lifecycle

All Known Subinterfaces:

AdvancedCacheExpirationWriter<K,V>, AdvancedLoadWriteStore<K,V>, SegmentedAdvancedLoadWriteStore<K,V>, TransactionalCacheWriter<K,V>

All Known Implementing Classes:

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

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

Defines advanced functionality for persisting data to an external storage.

Since:

6.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	AdvancedCacheWriter.PurgeListener<K> Callback to be notified when an entry is removed by the purge(java.util.concurrent.Executor, org.infinispan.persistence.spi.AdvancedCacheWriter.PurgeListener) method.

Method Summary

Modifier and Type	Method and Description
void	clear() Removes all the data from the storage.
void	purge(java.util.concurrent.Executor threadPool, AdvancedCacheWriter.PurgeListener<? super K> listener) Using the thread in the pool, removed all the expired data from the persistence storage.

Methods inherited from interface org.infinispan.persistence.spi.CacheWriter

bulkUpdate, delete, deleteBatch, init, isAvailable, write, write, writeBatch

Methods inherited from interface org.infinispan.commons.api.Lifecycle

start, stop

Method Detail

clear

void clear()

Removes all the data from the storage.

Throws:

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

purge

void purge(java.util.concurrent.Executor threadPool,
           AdvancedCacheWriter.PurgeListener<? super K> listener)

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

When this method returns all entries will be purged and no tasks will be running due to this loader in the provided executor. If however an exception is thrown there could be tasks still pending or running in the executor.

Throws:

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