CacheNotifierImpl (Red Hat JBoss Enterprise Application Platform 7.4.0.GA public API)

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 final 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 and Description
`protected static class`	`CacheNotifierImpl.BaseCacheEntryListenerInvocation<K,V>`
`protected class`	`CacheNotifierImpl.CacheInvocationBuilder`
`protected static 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 org.infinispan.notifications.impl.AbstractListenerImpl
AbstractListenerImpl.AbstractInvocationBuilder, AbstractListenerImpl.ListenerInvocationImpl<A>

Field Summary
- Fields inherited from class org.infinispan.notifications.impl.AbstractListenerImpl
  asyncProcessor, listenersMap

Constructor Summary

Constructors
Constructor and Description

CacheNotifierImpl()

Constructors
Constructor and Description
`CacheNotifierImpl()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<C> CompletionStage<Void>`	`addFilteredListenerAsync(ListenerHolder listenerHolder, CacheEventFilter<? super K,? super V> filter, CacheEventConverter<? super K,? super V,C> converter, Set<Class<? extends Annotation>> filterAnnotations)`
`<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>`	`addListenerAsync(ListenerHolder listenerHolder, CacheEventFilter<? super K,? super V> filter, CacheEventConverter<? super K,? super V,C> converter, ClassLoader classLoader)`
`CompletionStage<Void>`	`addListenerAsync(Object listener)` Asynchronous version of `Listenable.addListener(Object)`
`<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.
`CompletionStage<Void>`	`addListenerAsync(Object listener, ClassLoader classLoader)` Asynchronous version of `ClassLoaderAwareListenable.addListener(Object, 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 Map<Class<? extends Annotation>,Class<?>>`	`getAllowedMethodAnnotations(Listener l)`
`List<CacheEntryListenerInvocation<K,V>>`	`getListenerCollectionForAnnotation(Class<? extends Annotation> annotation)`
`protected 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 void`	`resumeIfNeeded(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 Transaction`	`suspendIfNeeded()`

Methods inherited from class org.infinispan.notifications.impl.AbstractListenerImpl
canApply, composeStageIfNeeded, findListenerCallbacks, getListeners, hasListener, removeListenerFromMaps, resumeOnCPU, testListenerClassValidity, testListenerMethodValidity, validateAndAddFilterListenerInvocations, validateAndAddListenerInvocations

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.infinispan.notifications.cachelistener.CacheNotifier
hasListener

Methods inherited from interface org.infinispan.notifications.DataConversionAwareListenable
addFilteredListener, addListener

Methods inherited from interface org.infinispan.notifications.ClassLoaderAwareFilteringListenable
addListener

Methods inherited from interface org.infinispan.notifications.FilteringListenable
addFilteredListener, addListener, addStorageFormatFilteredListener

Methods inherited from interface org.infinispan.notifications.Listenable
addListener, getListeners, removeListener

Methods inherited from interface org.infinispan.notifications.ClassLoaderAwareListenable
addListener

Constructor Detail
- CacheNotifierImpl
```
public CacheNotifierImpl()
```

Method Detail

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 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 Transaction suspendIfNeeded()
```
Specified by:

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

resumeIfNeeded
```
protected final void resumeIfNeeded(Transaction transaction)
```
Specified by:

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