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>

@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.

Field Summary

Fields

Modifier and Type	Field and Description
protected static Log	log
protected static boolean	trace

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

cacheName, cacheNotifier, configuration, dataContainer, enabled, executor, expirationTask, expiring, persistenceManager, timeService

Constructor Summary

Constructors

Constructor and Description
ClusterExpirationManager()

Method Summary

Modifier and Type	Method and Description
void	handleInMemoryExpiration(InternalCacheEntry<K,V> entry, long currentTime) This should be invoked passing in an entry that is now expired.
void	handleInStoreExpiration(K key) This is to be invoked when a store entry expires.
void	handleInStoreExpiration(MarshalledEntry<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	inject(AdvancedCache<K,V> cache, ExecutorService asyncExecutor)
void	processExpiration() Processes the expiration event queue.

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

initialize, isEnabled, registerWriteIncoming, start, stop, unregisterWrite

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final Log log

trace

protected static final boolean trace

Constructor Detail

ClusterExpirationManager

public ClusterExpirationManager()

Method Detail

inject

public void inject(AdvancedCache<K,V> cache,
                   ExecutorService asyncExecutor)

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>

handleInMemoryExpiration

public void handleInMemoryExpiration(InternalCacheEntry<K,V> entry,
                                     long currentTime)

Description copied from interface: ExpirationManager

This should be invoked passing in an entry that is now expired. This method may attempt to lock this key to preserve atomicity.

Specified by:

handleInMemoryExpiration in interface ExpirationManager<K,V>

Overrides:

handleInMemoryExpiration in class ExpirationManagerImpl<K,V>

Parameters:

entry - entry that is now expired

currentTime - the current time in milliseconds

handleInStoreExpiration

public void handleInStoreExpiration(K key)

Description copied from interface: ExpirationManager

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:

handleInStoreExpiration in interface ExpirationManager<K,V>

Overrides:

handleInStoreExpiration in class ExpirationManagerImpl<K,V>

Parameters:

key - the key of the expired entry

handleInStoreExpiration

public void handleInStoreExpiration(MarshalledEntry<K,V> marshalledEntry)

Description copied from interface: ExpirationManager

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:

handleInStoreExpiration in interface ExpirationManager<K,V>

Overrides:

handleInStoreExpiration in class ExpirationManagerImpl<K,V>

Parameters:

marshalledEntry - the entry that can be unmarshalled as needed