AdvancedCacheExpirationWriter (Red Hat Data Grid 7.3.9 API)

All Superinterfaces:

AdvancedCacheWriter<K,V>, CacheWriter<K,V>, Lifecycle
```
public interface AdvancedCacheExpirationWriter<K,V>
extends AdvancedCacheWriter<K,V>
```
Defines functionality for advanced expiration techniques. Note this interface allows for providing not just the key when an entry is expired. This is important so that proper cluster wide expiration can be performed.

Since:

8.0

Nested Class Summary

Nested Classes
Modifier and Type	Interface	Description
`static interface`	`AdvancedCacheExpirationWriter.ExpirationPurgeListener<K,V>`	Callback to be notified when an entry is removed by the `purge(Executor, ExpirationPurgeListener)` method.

Nested classes/interfaces inherited from interface org.infinispan.persistence.spi.AdvancedCacheWriter
AdvancedCacheWriter.PurgeListener<K>

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`void`	`purge(Executor executor, AdvancedCacheExpirationWriter.ExpirationPurgeListener<K,V> listener)`	Using the thread in the pool, removed all the expired data from the persistence storage.
`default void`	`purge(Executor threadPool, AdvancedCacheWriter.PurgeListener<? super K> listener)`	This method is never called.

Methods inherited from interface org.infinispan.persistence.spi.AdvancedCacheWriter
clear

Methods inherited from interface org.infinispan.persistence.spi.CacheWriter
delete, deleteBatch, init, isAvailable, write, writeBatch

Methods inherited from interface org.infinispan.commons.api.Lifecycle
start, stop

- Method Detail
  - purge
```
void purge(Executor executor,
           AdvancedCacheExpirationWriter.ExpirationPurgeListener<K,V> 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. This should be preferred to AdvancedCacheWriter.purge(Executor, PurgeListener) since it allows for value and metadata to be provided which provides more accurate expiration when coordination is required.
    
    Parameters:
    
    executor - the executor to invoke the given command on
    
    listener - the listener that is notified for each expired entry
    
    Throws:
    
    PersistenceException - in case of an error, e.g. communicating with the external storage
  - purge
```
default void purge(Executor threadPool,
                   AdvancedCacheWriter.PurgeListener<? super K> listener)
```
    This method is never called. Implementers of AdvancedCacheExpirationWriter must instead implement purge(Executor, ExpirationPurgeListener).
    
    Specified by:
    
    purge in interface AdvancedCacheWriter<K,V>