Class CacheNotifierImpl<K,V>

java.lang.Object

org.infinispan.notifications.impl.AbstractListenerImpl<Event<K,V>, CacheEntryListenerInvocation<K,V>>

org.infinispan.notifications.cachelistener.CacheNotifierImpl<K,V>

All Implemented Interfaces:

CacheNotifier<K,V>, ClusterCacheNotifier<K,V>, ClassLoaderAwareFilteringListenable<K,V>, ClassLoaderAwareListenable, DataConversionAwareListenable<K,V>, FilteringListenable<K,V>, Listenable

public class CacheNotifierImpl<K,V>
extends AbstractListenerImpl<Event<K,V>, CacheEntryListenerInvocation<K,V>>
implements ClusterCacheNotifier<K,V>

Helper class that handles all notifications to registered listeners.

Since:

4.0

Author:

Manik Surtani (manik AT infinispan DOT org), Mircea.Markus@jboss.com, William Burns, anistor@redhat.com

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	CacheNotifierImpl.BaseCacheEntryListenerInvocation<K,V>
protected class	CacheNotifierImpl.CacheInvocationBuilder
protected class	CacheNotifierImpl.ClusteredListenerInvocation<K,V>	This class is to be used with cluster listener invocations only when they have included current state.
protected class	CacheNotifierImpl.DelegatingCacheInvocationBuilder

Nested classes/interfaces inherited from class AbstractListenerImpl

AbstractListenerImpl.AbstractInvocationBuilder, AbstractListenerImpl.ListenerInvocationImpl<A>

Field Summary

Fields inherited from class AbstractListenerImpl

asyncProcessor, listenersMap

Constructor Summary

Constructors

Constructor	Description
CacheNotifierImpl()

Method Summary

Modifier and Type	Method	Description
<C> CompletionStage<Void>	addFilteredListenerAsync(Object listener, CacheEventFilter<? super K, ? super V> filter, CacheEventConverter<? super K, ? super V, C> converter, Set<Class<? extends Annotation>> filterAnnotations)	Asynchronous version of FilteringListenable.addFilteredListener(Object, CacheEventFilter, CacheEventConverter, Set)
<C> CompletionStage<Void>	addFilteredListenerAsync(ListenerHolder listenerHolder, CacheEventFilter<? super K, ? super V> filter, CacheEventConverter<? super K, ? super V, C> converter, Set<Class<? extends Annotation>> filterAnnotations)
CompletionStage<Void>	addListenerAsync(Object listener)	Asynchronous version of Listenable.addListener(Object)
CompletionStage<Void>	addListenerAsync(Object listener, ClassLoader classLoader)	Asynchronous version of ClassLoaderAwareListenable.addListener(Object, ClassLoader)
<C> CompletionStage<Void>	addListenerAsync(Object listener, CacheEventFilter<? super K, ? super V> filter, CacheEventConverter<? super K, ? super V, C> converter)	Asynchronous version of FilteringListenable.addListener(Object, CacheEventFilter, CacheEventConverter)
<C> CompletionStage<Void>	addListenerAsync(Object listener, CacheEventFilter<? super K, ? super V> filter, CacheEventConverter<? super K, ? super V, C> converter, ClassLoader classLoader)	Adds the listener using the provided filter converter and class loader.
<C> CompletionStage<Void>	addListenerAsync(ListenerHolder listenerHolder, CacheEventFilter<? super K, ? super V> filter, CacheEventConverter<? super K, ? super V, C> converter, ClassLoader classLoader)
<C> CompletionStage<Void>	addStorageFormatFilteredListenerAsync(Object listener, CacheEventFilter<? super K, ? super V> filter, CacheEventConverter<? super K, ? super V, C> converter, Set<Class<? extends Annotation>> filterAnnotations)	Asynchronous version of FilteringListenable.addStorageFormatFilteredListener(Object, CacheEventFilter, CacheEventConverter, Set)
protected boolean	clusterListenerOnPrimaryOnly()
protected Map<Class<? extends Annotation>, Class<?>>	getAllowedMethodAnnotations(Listener l)
List<CacheEntryListenerInvocation<K,V>>	getListenerCollectionForAnnotation(Class<? extends Annotation> annotation)
protected org.infinispan.util.logging.Log	getLog()
boolean	isNotificationAllowed(FlagAffectedCommand cmd, List<CacheEntryListenerInvocation<K,V>> listeners)
CompletionStage<Void>	notifyCacheEntriesEvicted(Collection<Map.Entry<K,V>> entries, InvocationContext ctx, FlagAffectedCommand command)	Notifies all registered listeners of a CacheEntriesEvictedEvent event.
CompletionStage<Void>	notifyCacheEntryActivated(K key, V value, boolean pre, InvocationContext ctx, FlagAffectedCommand command)	Notifies all registered listeners of a CacheEntryActivatedEvent event.
CompletionStage<Void>	notifyCacheEntryCreated(K key, V value, Metadata metadata, boolean pre, InvocationContext ctx, FlagAffectedCommand command)	Notifies all registered listeners of a CacheEntryCreatedEvent event.
CompletionStage<Void>	notifyCacheEntryExpired(K key, V value, Metadata metadata, InvocationContext ctx)	Notifies all registered listeners of a CacheEntryExpired event.
CompletionStage<Void>	notifyCacheEntryInvalidated(K key, V value, Metadata metadata, boolean pre, InvocationContext ctx, FlagAffectedCommand command)	Notifies all registered listeners of a CacheEntryInvalidatedEvent event.
CompletionStage<Void>	notifyCacheEntryLoaded(K key, V value, boolean pre, InvocationContext ctx, FlagAffectedCommand command)	Notifies all registered listeners of a CacheEntryLoadedEvent event.
CompletionStage<Void>	notifyCacheEntryModified(K key, V value, Metadata metadata, V previousValue, Metadata previousMetadata, boolean pre, InvocationContext ctx, FlagAffectedCommand command)	Notifies all registered listeners of a CacheEntryModifiedEvent event.
CompletionStage<Void>	notifyCacheEntryPassivated(K key, V value, boolean pre, InvocationContext ctx, FlagAffectedCommand command)	Notifies all registered listeners of a CacheEntryPassivatedEvent event.
CompletionStage<Void>	notifyCacheEntryRemoved(K key, V previousValue, Metadata previousMetadata, boolean pre, InvocationContext ctx, FlagAffectedCommand command)	Notifies all registered listeners of a CacheEntryRemovedEvent event.
CompletionStage<Void>	notifyCacheEntryVisited(K key, V value, boolean pre, InvocationContext ctx, FlagAffectedCommand command)	Notifies all registered listeners of a CacheEntryVisitedEvent event.
CompletionStage<Void>	notifyClusterListeners(Collection<ClusterEvent<K,V>> events, UUID uuid)	Method that is invoked on the node that has the given cluster listener that when registered generated the given listenerId.
CompletionStage<Void>	notifyDataRehashed(ConsistentHash oldCH, ConsistentHash newCH, ConsistentHash unionCH, int newTopologyId, boolean pre)
CompletionStage<Void>	notifyPartitionStatusChanged(AvailabilityMode mode, boolean pre)
CompletionStage<Void>	notifyPersistenceAvailabilityChanged(boolean available)
CompletionStage<Void>	notifyTopologyChanged(CacheTopology oldTopology, CacheTopology newTopology, int newTopologyId, boolean pre)
CompletionStage<Void>	notifyTransactionCompleted(GlobalTransaction transaction, boolean successful, InvocationContext ctx)	Notifies all registered listeners of a transaction completion event.
CompletionStage<Void>	notifyTransactionRegistered(GlobalTransaction globalTransaction, boolean isOriginLocal)	Notifies all registered listeners of a transaction registration event.
CompletionStage<Void>	removeListenerAsync(Object listener)	Asynchronous version of Listenable.removeListener(Object)
protected Set<CacheEntryListenerInvocation<K,V>>	removeListenerInvocation(Class<? extends Annotation> annotation, Object listener)
protected final void	resumeIfNeeded(jakarta.transaction.Transaction transaction)
Collection<ClusterListenerReplicateCallable<K,V>>	retrieveClusterListenerCallablesToInstall()	This method is invoked so that this node can send the details required for a new node to be bootstrapped with the existing cluster listeners that are already installed.
void	start()
void	stop()	Removes all listeners from the notifier
protected final jakarta.transaction.Transaction	suspendIfNeeded()

Methods inherited from class AbstractListenerImpl

canApply, composeStageIfNeeded, findListenerCallbacks, getListeners, handleException, hasListener, hasListeners, invokeListeners, removeListenerFromMaps, resumeOnCPU, testListenerClassValidity, testListenerMethodValidity, validateAndAddFilterListenerInvocations, validateAndAddListenerInvocations

Methods inherited from class Object

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

Methods inherited from interface CacheNotifier

getListeners, hasListener, hasListeners

Methods inherited from interface ClassLoaderAwareFilteringListenable

addListener

Methods inherited from interface ClassLoaderAwareListenable

addListener

Methods inherited from interface DataConversionAwareListenable

addFilteredListener, addListener

Methods inherited from interface FilteringListenable

addFilteredListener, addListener, addStorageFormatFilteredListener

Methods inherited from interface Listenable

addListener, removeListener

Constructor Details

CacheNotifierImpl

public CacheNotifierImpl()

Method Details

start

public void start()

stop

public void stop()

Description copied from class: AbstractListenerImpl

Removes all listeners from the notifier

Overrides:

stop in class AbstractListenerImpl<Event<K,V>, CacheEntryListenerInvocation<K,V>>

getLog

protected org.infinispan.util.logging.Log getLog()

Specified by:

getLog in class AbstractListenerImpl<Event<K,V>, CacheEntryListenerInvocation<K,V>>

getAllowedMethodAnnotations

protected Map<Class<? extends Annotation>, Class<?>> getAllowedMethodAnnotations(Listener l)

Specified by:

getAllowedMethodAnnotations in class AbstractListenerImpl<Event<K,V>, CacheEntryListenerInvocation<K,V>>

suspendIfNeeded

protected final jakarta.transaction.Transaction suspendIfNeeded()

Specified by:

suspendIfNeeded in class AbstractListenerImpl<Event<K,V>, CacheEntryListenerInvocation<K,V>>

resumeIfNeeded

protected final void resumeIfNeeded(jakarta.transaction.Transaction transaction)

Specified by:

resumeIfNeeded in class AbstractListenerImpl<Event<K,V>, CacheEntryListenerInvocation<K,V>>

notifyCacheEntryCreated

public CompletionStage<Void> notifyCacheEntryCreated(K key,
 V value,
 Metadata metadata,
 boolean pre,
 InvocationContext ctx,
 FlagAffectedCommand command)

Description copied from interface: CacheNotifier

Notifies all registered listeners of a CacheEntryCreatedEvent event.

Specified by:

notifyCacheEntryCreated in interface CacheNotifier<K,V>

notifyCacheEntryModified

public CompletionStage<Void> notifyCacheEntryModified(K key,
 V value,
 Metadata metadata,
 V previousValue,
 Metadata previousMetadata,
 boolean pre,
 InvocationContext ctx,
 FlagAffectedCommand command)

Description copied from interface: CacheNotifier

Notifies all registered listeners of a CacheEntryModifiedEvent event.

Specified by:

notifyCacheEntryModified in interface CacheNotifier<K,V>

notifyCacheEntryRemoved

public CompletionStage<Void> notifyCacheEntryRemoved(K key,
 V previousValue,
 Metadata previousMetadata,
 boolean pre,
 InvocationContext ctx,
 FlagAffectedCommand command)

Description copied from interface: CacheNotifier

Notifies all registered listeners of a CacheEntryRemovedEvent event.

Specified by:

notifyCacheEntryRemoved in interface CacheNotifier<K,V>

notifyCacheEntryVisited

public CompletionStage<Void> notifyCacheEntryVisited(K key,
 V value,
 boolean pre,
 InvocationContext ctx,
 FlagAffectedCommand command)

Description copied from interface: CacheNotifier

Notifies all registered listeners of a CacheEntryVisitedEvent event.

Specified by:

notifyCacheEntryVisited in interface CacheNotifier<K,V>

notifyCacheEntriesEvicted

public CompletionStage<Void> notifyCacheEntriesEvicted(Collection<Map.Entry<K,V>> entries,
 InvocationContext ctx,
 FlagAffectedCommand command)

Description copied from interface: CacheNotifier

Notifies all registered listeners of a CacheEntriesEvictedEvent event.

Specified by:

notifyCacheEntriesEvicted in interface CacheNotifier<K,V>

notifyCacheEntryExpired

public CompletionStage<Void> notifyCacheEntryExpired(K key,
 V value,
 Metadata metadata,
 InvocationContext ctx)

Description copied from interface: CacheNotifier

Notifies all registered listeners of a CacheEntryExpired event.

Specified by:

notifyCacheEntryExpired in interface CacheNotifier<K,V>

notifyCacheEntryInvalidated

public CompletionStage<Void> notifyCacheEntryInvalidated(K key,
 V value,
 Metadata metadata,
 boolean pre,
 InvocationContext ctx,
 FlagAffectedCommand command)

Description copied from interface: CacheNotifier

Notifies all registered listeners of a CacheEntryInvalidatedEvent event.

Specified by:

notifyCacheEntryInvalidated in interface CacheNotifier<K,V>

notifyCacheEntryLoaded

public CompletionStage<Void> notifyCacheEntryLoaded(K key,
 V value,
 boolean pre,
 InvocationContext ctx,
 FlagAffectedCommand command)

Description copied from interface: CacheNotifier

Notifies all registered listeners of a CacheEntryLoadedEvent event.

Specified by:

notifyCacheEntryLoaded in interface CacheNotifier<K,V>

notifyCacheEntryActivated

public CompletionStage<Void> notifyCacheEntryActivated(K key,
 V value,
 boolean pre,
 InvocationContext ctx,
 FlagAffectedCommand command)

Description copied from interface: CacheNotifier

Notifies all registered listeners of a CacheEntryActivatedEvent event.

Specified by:

notifyCacheEntryActivated in interface CacheNotifier<K,V>

notifyCacheEntryPassivated

public CompletionStage<Void> notifyCacheEntryPassivated(K key,
 V value,
 boolean pre,
 InvocationContext ctx,
 FlagAffectedCommand command)

Description copied from interface: CacheNotifier

Notifies all registered listeners of a CacheEntryPassivatedEvent event.

Specified by:

notifyCacheEntryPassivated in interface CacheNotifier<K,V>

notifyTransactionCompleted

public CompletionStage<Void> notifyTransactionCompleted(GlobalTransaction transaction,
 boolean successful,
 InvocationContext ctx)

Description copied from interface: CacheNotifier

Notifies all registered listeners of a transaction completion event.

Specified by:

notifyTransactionCompleted in interface CacheNotifier<K,V>

Parameters:

transaction - the transaction that has just completed

successful - if true, the transaction committed. If false, this is a rollback event

notifyTransactionRegistered

public CompletionStage<Void> notifyTransactionRegistered(GlobalTransaction globalTransaction,
 boolean isOriginLocal)

Description copied from interface: CacheNotifier

Notifies all registered listeners of a transaction registration event.

Specified by:

notifyTransactionRegistered in interface CacheNotifier<K,V>

Parameters:

globalTransaction -

notifyDataRehashed

public CompletionStage<Void> notifyDataRehashed(ConsistentHash oldCH,
 ConsistentHash newCH,
 ConsistentHash unionCH,
 int newTopologyId,
 boolean pre)

Specified by:

notifyDataRehashed in interface CacheNotifier<K,V>

notifyTopologyChanged

public CompletionStage<Void> notifyTopologyChanged(CacheTopology oldTopology,
 CacheTopology newTopology,
 int newTopologyId,
 boolean pre)

Specified by:

notifyTopologyChanged in interface CacheNotifier<K,V>

notifyPartitionStatusChanged

public CompletionStage<Void> notifyPartitionStatusChanged(AvailabilityMode mode,
 boolean pre)

Specified by:

notifyPartitionStatusChanged in interface CacheNotifier<K,V>

notifyPersistenceAvailabilityChanged

public CompletionStage<Void> notifyPersistenceAvailabilityChanged(boolean available)

Specified by:

notifyPersistenceAvailabilityChanged in interface CacheNotifier<K,V>

notifyClusterListeners

public CompletionStage<Void> notifyClusterListeners(Collection<ClusterEvent<K,V>> events,
 UUID uuid)

Description copied from interface: ClusterCacheNotifier

Method that is invoked on the node that has the given cluster listener that when registered generated the given listenerId. Note this will notify only cluster listeners and regular listeners are not notified of the events. Will fire the events in the order of the iteration of the collection.

Specified by:

notifyClusterListeners in interface ClusterCacheNotifier<K,V>

Parameters:

events -

uuid -

retrieveClusterListenerCallablesToInstall

public Collection<ClusterListenerReplicateCallable<K,V>> retrieveClusterListenerCallablesToInstall()

Description copied from interface: ClusterCacheNotifier

This method is invoked so that this node can send the details required for a new node to be bootstrapped with the existing cluster listeners that are already installed.

Specified by:

retrieveClusterListenerCallablesToInstall in interface ClusterCacheNotifier<K,V>

Returns:

A collection of callables that should be invoked on the new node to properly install cluster listener information

isNotificationAllowed

public boolean isNotificationAllowed(FlagAffectedCommand cmd,
 List<CacheEntryListenerInvocation<K,V>> listeners)

addListenerAsync

public CompletionStage<Void> addListenerAsync(Object listener)

Description copied from interface: Listenable

Asynchronous version of Listenable.addListener(Object)

Specified by:

addListenerAsync in interface Listenable

Parameters:

listener - listener to add, must not be null

Returns:

CompletionStage that when complete the listener is fully installed

addListenerAsync

public CompletionStage<Void> addListenerAsync(Object listener,
 ClassLoader classLoader)

Description copied from interface: ClassLoaderAwareListenable

Asynchronous version of ClassLoaderAwareListenable.addListener(Object, ClassLoader)

Specified by:

addListenerAsync in interface ClassLoaderAwareListenable

Parameters:

listener - listener to add, must not be null

classLoader - classloader, must not be null

Returns:

CompletionStage that when complete the listener is fully installed

addListenerAsync

public <C> CompletionStage<Void> addListenerAsync(Object listener,
 CacheEventFilter<? super K, ? super V> filter,
 CacheEventConverter<? super K, ? super V, C> converter,
 ClassLoader classLoader)

Adds the listener using the provided filter converter and class loader. The provided builder is used to add additional configuration including (clustered, onlyPrimary and identifier) which can be used after this method is completed to see what values were used in the addition of this listener

Specified by:

addListenerAsync in interface ClassLoaderAwareFilteringListenable<K,V>

getListenerCollectionForAnnotation

public List<CacheEntryListenerInvocation<K,V>> getListenerCollectionForAnnotation(Class<? extends Annotation> annotation)

Overrides:

getListenerCollectionForAnnotation in class AbstractListenerImpl<Event<K,V>, CacheEntryListenerInvocation<K,V>>

addListenerAsync

public <C> CompletionStage<Void> addListenerAsync(Object listener,
 CacheEventFilter<? super K, ? super V> filter,
 CacheEventConverter<? super K, ? super V, C> converter)

Description copied from interface: FilteringListenable

Asynchronous version of FilteringListenable.addListener(Object, CacheEventFilter, CacheEventConverter)

Specified by:

addListenerAsync in interface FilteringListenable<K,V>

Type Parameters:

C -

Parameters:

listener - listener to add, must not be null

filter -

converter -

Returns:

CompletionStage that when complete the listener is fully installed

addFilteredListenerAsync

public <C> CompletionStage<Void> addFilteredListenerAsync(Object listener,
 CacheEventFilter<? super K, ? super V> filter,
 CacheEventConverter<? super K, ? super V, C> converter,
 Set<Class<? extends Annotation>> filterAnnotations)

Description copied from interface: FilteringListenable

Asynchronous version of FilteringListenable.addFilteredListener(Object, CacheEventFilter, CacheEventConverter, Set)

Specified by:

addFilteredListenerAsync in interface FilteringListenable<K,V>

addStorageFormatFilteredListenerAsync

public <C> CompletionStage<Void> addStorageFormatFilteredListenerAsync(Object listener,
 CacheEventFilter<? super K, ? super V> filter,
 CacheEventConverter<? super K, ? super V, C> converter,
 Set<Class<? extends Annotation>> filterAnnotations)

Description copied from interface: FilteringListenable

Asynchronous version of FilteringListenable.addStorageFormatFilteredListener(Object, CacheEventFilter, CacheEventConverter, Set)

Specified by:

addStorageFormatFilteredListenerAsync in interface FilteringListenable<K,V>

addListenerAsync

public <C> CompletionStage<Void> addListenerAsync(ListenerHolder listenerHolder,
 CacheEventFilter<? super K, ? super V> filter,
 CacheEventConverter<? super K, ? super V, C> converter,
 ClassLoader classLoader)

Specified by:

addListenerAsync in interface DataConversionAwareListenable<K,V>

addFilteredListenerAsync

public <C> CompletionStage<Void> addFilteredListenerAsync(ListenerHolder listenerHolder,
 CacheEventFilter<? super K, ? super V> filter,
 CacheEventConverter<? super K, ? super V, C> converter,
 Set<Class<? extends Annotation>> filterAnnotations)

Specified by:

addFilteredListenerAsync in interface DataConversionAwareListenable<K,V>

clusterListenerOnPrimaryOnly

protected boolean clusterListenerOnPrimaryOnly()

removeListenerAsync

public CompletionStage<Void> removeListenerAsync(Object listener)

Description copied from interface: Listenable

Asynchronous version of Listenable.removeListener(Object)

Specified by:

removeListenerAsync in interface Listenable

Specified by:

removeListenerAsync in class AbstractListenerImpl<Event<K,V>, CacheEntryListenerInvocation<K,V>>

Parameters:

listener - listener to remove, must not be null

Returns:

CompletionStage that when complete the listener is fully removed

removeListenerInvocation

protected Set<CacheEntryListenerInvocation<K,V>> removeListenerInvocation(Class<? extends Annotation> annotation,
 Object listener)

Overrides:

removeListenerInvocation in class AbstractListenerImpl<Event<K,V>, CacheEntryListenerInvocation<K,V>>