org.infinispan.expiration.impl

Class ClusterExpirationManager<K,V>

java.lang.Object

org.infinispan.expiration.impl.ExpirationManagerImpl<K,V>

org.infinispan.expiration.impl.ClusterExpirationManager<K,V>

Type Parameters:

K -

V -

All Implemented Interfaces:

ExpirationManager<K,V>, InternalExpirationManager<K,V>

Direct Known Subclasses:

TxClusterExpirationManager

@ThreadSafe
public class ClusterExpirationManager<K,V>
extends ExpirationManagerImpl<K,V>

Allows for cluster based expirations to occur. This provides guarantees that when an entry is expired that it will expire that entry across the entire cluster at once. This requires obtaining the lock for said entry before expiration is performed. Since expiration can occur without holding onto the lock it is possible for an expiration to occur immediately after a value has been updated. This can cause a premature expiration to occur. Attempts are made to prevent this by using the expired entry's value and lifespan to limit this expiration so it only happens in a smaller amount of cases.

Cache stores however do not supply the value or metadata information which means if an entry is purged from the cache store that it will forcibly remove the value even if a concurrent write updated it just before. This will be addressed by future SPI changes to the cache store.

Nested Class Summary

Nested classes/interfaces inherited from interface org.infinispan.expiration.impl.InternalExpirationManager

InternalExpirationManager.ExpirationConsumer<T,U>

Field Summary

Fields

Modifier and Type	Field and Description
protected AdvancedCache<K,V>	cache
protected ComponentRef<AdvancedCache<K,V>>	cacheRef
protected DistributionManager	distributionManager
protected RpcManager	rpcManager

Fields inherited from class org.infinispan.expiration.impl.ExpirationManagerImpl

cacheNotifier, cf, cfRef, componentRegistry, configuration, dataContainer, enabled, executor, expirationTask, expiring, invokerRef, keyPartitioner, persistenceManager, timeService

Constructor Summary

Constructors

Constructor and Description
ClusterExpirationManager()

Method Summary

Modifier and Type	Method and Description
protected CompletionStage<Boolean>	checkExpiredMaxIdle(InternalCacheEntry ice, int segment) Response is whether the value should be treated as expired.
CompletableFuture<Boolean>	entryExpiredInMemory(InternalCacheEntry<K,V> entry, long currentTime, boolean isWrite) This should be invoked passing in an entry that is now expired.
boolean	entryExpiredInMemoryFromIteration(InternalCacheEntry<K,V> entry, long currentTime) This method is very similar to InternalExpirationManager.entryExpiredInMemory(InternalCacheEntry, long, boolean) except that it does the bare minimum when an entry expired to guarantee if the entry is valid or not.
CompletionStage<Void>	handleInStoreExpirationInternal(K key) This is to be invoked when a store entry expires.
CompletionStage<Void>	handleInStoreExpirationInternal(MarshallableEntry<K,V> marshalledEntry) This is to be invoked when a store entry expires and the value and/or metadata is available to be used.
void	processExpiration() Processes the expiration event queue.
void	start()

Methods inherited from class org.infinispan.expiration.impl.ExpirationManagerImpl

addInternalListener, handleInMemoryExpiration, handlePossibleExpiration, isEnabled, removeInternalListener, stop

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.infinispan.expiration.impl.InternalExpirationManager

handleInStoreExpiration, handleInStoreExpiration

Methods inherited from interface org.infinispan.expiration.ExpirationManager

registerWriteIncoming, unregisterWrite

Field Detail

cacheRef

protected ComponentRef<AdvancedCache<K,V>> cacheRef

rpcManager

protected RpcManager rpcManager

distributionManager

protected DistributionManager distributionManager

cache

protected AdvancedCache<K,V> cache

Constructor Detail

ClusterExpirationManager

public ClusterExpirationManager()

Method Detail

start

public void start()

Overrides:

start in class ExpirationManagerImpl<K,V>

processExpiration

public void processExpiration()

Description copied from interface: ExpirationManager

Processes the expiration event queue.

Specified by:

processExpiration in interface ExpirationManager<K,V>

Overrides:

processExpiration in class ExpirationManagerImpl<K,V>

entryExpiredInMemory

public CompletableFuture<Boolean> entryExpiredInMemory(InternalCacheEntry<K,V> entry,
                                                       long currentTime,
                                                       boolean isWrite)

Description copied from interface: InternalExpirationManager

This should be invoked passing in an entry that is now expired. This method may attempt to lock this key to preserve atomicity. This method should be invoked when an entry was read via get but found to be expired.

This method returns true if the entry was removed due to expiration or false if the entry was not removed due to expiration

If hasLock is true, this method assumes that the caller has the lock for the key and it must allow the expiration to occur, ie. returned CompletableFuture has completed, before the lock is released. Failure to do so may cause inconsistency in data.

Specified by:

entryExpiredInMemory in interface InternalExpirationManager<K,V>

Overrides:

entryExpiredInMemory in class ExpirationManagerImpl<K,V>

Parameters:

entry - the entry that has expired

currentTime - the current time when it expired

isWrite - if the expiration was found during a write operation

Returns:

if this entry actually expired or not

entryExpiredInMemoryFromIteration

public boolean entryExpiredInMemoryFromIteration(InternalCacheEntry<K,V> entry,
                                                 long currentTime)

Description copied from interface: InternalExpirationManager

This method is very similar to InternalExpirationManager.entryExpiredInMemory(InternalCacheEntry, long, boolean) except that it does the bare minimum when an entry expired to guarantee if the entry is valid or not. This is important to reduce time spent per entry when iterating. This method may not actually remove the entry and may just return immediately if it is safe to do so.

Specified by:

entryExpiredInMemoryFromIteration in interface InternalExpirationManager<K,V>

Overrides:

entryExpiredInMemoryFromIteration in class ExpirationManagerImpl<K,V>

Parameters:

entry - the entry that has expired

currentTime - the current time when it expired

Returns:

if this entry actually expired or not

handleInStoreExpirationInternal

public CompletionStage<Void> handleInStoreExpirationInternal(K key)

Description copied from interface: InternalExpirationManager

This is to be invoked when a store entry expires. This method may attempt to lock this key to preserve atomicity.

Note this method doesn't currently take a InternalCacheEntry and this is due to a limitation in the cache store API. This may cause some values to be removed if they were updated at the same time.

Specified by:

handleInStoreExpirationInternal in interface InternalExpirationManager<K,V>

Overrides:

handleInStoreExpirationInternal in class ExpirationManagerImpl<K,V>

Parameters:

key - the key of the expired entry This method will be renamed to handleInStoreExpiration when the method can be removed from ExpirationManager

handleInStoreExpirationInternal

public CompletionStage<Void> handleInStoreExpirationInternal(MarshallableEntry<K,V> marshalledEntry)

Description copied from interface: InternalExpirationManager

This is to be invoked when a store entry expires and the value and/or metadata is available to be used. This method is preferred over ExpirationManager.handleInStoreExpiration(Object) as it allows for more specific expiration to possibly occur.

Specified by:

handleInStoreExpirationInternal in interface InternalExpirationManager<K,V>

Overrides:

handleInStoreExpirationInternal in class ExpirationManagerImpl<K,V>

Parameters:

marshalledEntry - the entry that can be unmarshalled as needed This method will be renamed to handleInStoreExpiration when the method can be removed from ExpirationManager

checkExpiredMaxIdle

protected CompletionStage<Boolean> checkExpiredMaxIdle(InternalCacheEntry ice,
                                                       int segment)

Description copied from class: ExpirationManagerImpl

Response is whether the value should be treated as expired. This is determined by if a value as able to be touched or not, that is if it couldn't be touched - we assumed expired (as it was removed in some way).

Overrides:

checkExpiredMaxIdle in class ExpirationManagerImpl<K,V>

Parameters:

ice - the entry to check expiration and touch

segment - the segment the entry maps to

Returns:

whether the entry was expired or not