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

java.lang.Object
- org.infinispan.notifications.cachelistener.CacheNotifierImpl.BaseCacheEntryListenerInvocation<K,V>

All Implemented Interfaces:

CacheEntryListenerInvocation<K,V>, ListenerInvocation<Event<K,V>>

Direct Known Subclasses:

CacheNotifierImpl.ClusteredListenerInvocation

Enclosing class:

CacheNotifierImpl<K,V>
```
protected static class CacheNotifierImpl.BaseCacheEntryListenerInvocation<K,V>
extends Object
implements CacheEntryListenerInvocation<K,V>
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected Class<? extends Annotation>`	`annotation`
`protected boolean`	`clustered`
`protected CacheEventConverter<? super K,? super V,?>`	`converter`
`protected CacheEventFilter<? super K,? super V>`	`filter`
`protected boolean`	`filterAndConvert`
`protected Set<Class<? extends Annotation>>`	`filterAnnotations`
`protected UUID`	`identifier`
`protected ListenerInvocation<Event<K,V>>`	`invocation`
`protected Listener.Observation`	`observation`
`protected boolean`	`onlyPrimary`
`protected boolean`	`sync`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	BaseCacheEntryListenerInvocation(EncoderRegistry encoderRegistry, ListenerInvocation<Event<K,V>> invocation, CacheEventFilter<? super K,? super V> filter, CacheEventConverter<? super K,? super V,?> converter, Class<? extends Annotation> annotation, boolean onlyPrimary, boolean clustered, UUID identifier, boolean sync, Listener.Observation observation, Set<Class<? extends Annotation>> filterAnnotations, DataConversion keyDataConversion, DataConversion valueDataConversion, boolean useStorageFormat)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected CacheEntryEvent<K,V>`	`convertValue(CacheEventConverter<? super K,? super V,?> converter, CacheEntryEvent<K,V> event)`
`protected CompletionStage<Void>`	`doRealInvocation(Event<K,V> event)`
`protected CompletionStage<Void>`	`doRealInvocation(EventWrapper<K,V,CacheEntryEvent<K,V>> event)`
`Class<? extends Annotation>`	`getAnnotation()`
`CacheEventConverter<? super K,? super V,?>`	`getConverter()`
`CacheEventFilter<? super K,? super V>`	`getFilter()`
`Set<Class<? extends Annotation>>`	`getFilterAnnotations()`
`UUID`	`getIdentifier()`
`DataConversion`	`getKeyDataConversion()`
`Listener.Observation`	`getObservation()`
`Object`	`getTarget()` The listener instance that is notified of events
`DataConversion`	`getValueDataConversion()`
`CompletionStage<Void>`	`invoke(Event<K,V> event)` Invokes the event
`CompletionStage<Void>`	`invoke(EventWrapper<K,V,CacheEntryEvent<K,V>> wrapped, boolean isLocalNodePrimaryOwner)` This is the entry point for local listeners firing events
`CompletionStage<Void>`	`invokeNoChecks(EventWrapper<K,V,CacheEntryEvent<K,V>> wrapped, boolean skipQueue, boolean skipConverter, boolean needsTransform)` This is the entry point for remote listener events being fired
`boolean`	`isClustered()`
`boolean`	`isSync()`
`protected CacheEntryEvent<K,V>`	`shouldInvoke(CacheEntryEvent<K,V> event, boolean isLocalNodePrimaryOwner)`
`protected boolean`	`shouldInvoke(Event<K,V> event)`
`String`	`toString()`
`boolean`	`useStorageFormat()`

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

Field Detail

invocation

protected final ListenerInvocation<Event<K,V>> invocation

filter

protected final CacheEventFilter<? super K,? super V> filter

converter

protected final CacheEventConverter<? super K,? super V,?> converter

onlyPrimary
```
protected final boolean onlyPrimary
```

clustered
```
protected final boolean clustered
```

identifier
```
protected final UUID identifier
```

annotation

protected final Class<? extends Annotation> annotation

sync
```
protected final boolean sync
```

filterAndConvert

protected final boolean filterAndConvert

observation

protected final Listener.Observation observation

filterAnnotations

protected final Set<Class<? extends Annotation>> filterAnnotations

Constructor Detail

BaseCacheEntryListenerInvocation

protected BaseCacheEntryListenerInvocation(EncoderRegistry encoderRegistry,
                                           ListenerInvocation<Event<K,V>> invocation,
                                           CacheEventFilter<? super K,? super V> filter,
                                           CacheEventConverter<? super K,? super V,?> converter,
                                           Class<? extends Annotation> annotation,
                                           boolean onlyPrimary,
                                           boolean clustered,
                                           UUID identifier,
                                           boolean sync,
                                           Listener.Observation observation,
                                           Set<Class<? extends Annotation>> filterAnnotations,
                                           DataConversion keyDataConversion,
                                           DataConversion valueDataConversion,
                                           boolean useStorageFormat)

Method Detail
- invoke
```
public CompletionStage<Void> invoke(Event<K,V> event)
```
  Description copied from interface: ListenerInvocation
  
  Invokes the event
  
  Specified by:
  
  invoke in interface ListenerInvocation<Event<K,V>>
  
  Returns:
  
  null if event was ignored or already complete otherwise the event will be completely notified when the provided stage is completed
- invoke
```
public CompletionStage<Void> invoke(EventWrapper<K,V,CacheEntryEvent<K,V>> wrapped,
                                    boolean isLocalNodePrimaryOwner)
```
  This is the entry point for local listeners firing events
  
  Specified by:
  
  invoke in interface CacheEntryListenerInvocation<K,V>
  
  Parameters:
  
  wrapped -
  
  isLocalNodePrimaryOwner -
  
  Returns:
  
  null if event was ignored or already complete otherwise all listeners for the event will be notified when the provided stage is completed
- invokeNoChecks
```
public CompletionStage<Void> invokeNoChecks(EventWrapper<K,V,CacheEntryEvent<K,V>> wrapped,
                                            boolean skipQueue,
                                            boolean skipConverter,
                                            boolean needsTransform)
```
  This is the entry point for remote listener events being fired
  
  Specified by:
  
  invokeNoChecks in interface CacheEntryListenerInvocation<K,V>
  
  Parameters:
  
  wrapped -
  
  skipQueue -
  
  Returns:
  
  null if event was ignored or already complete otherwise all listeners for the event will be notified when the provided stage is completed
- doRealInvocation
```
protected CompletionStage<Void> doRealInvocation(EventWrapper<K,V,CacheEntryEvent<K,V>> event)
```
- doRealInvocation
```
protected CompletionStage<Void> doRealInvocation(Event<K,V> event)
```
- shouldInvoke
```
protected boolean shouldInvoke(Event<K,V> event)
```
- shouldInvoke
```
protected CacheEntryEvent<K,V> shouldInvoke(CacheEntryEvent<K,V> event,
                                            boolean isLocalNodePrimaryOwner)
```
- getTarget
```
public Object getTarget()
```
  Description copied from interface: ListenerInvocation
  
  The listener instance that is notified of events
  
  Specified by:
  
  getTarget in interface ListenerInvocation<Event<K,V>>
- getFilter
```
public CacheEventFilter<? super K,? super V> getFilter()
```
  Specified by:
  
  getFilter in interface CacheEntryListenerInvocation<K,V>
- getFilterAnnotations
```
public Set<Class<? extends Annotation>> getFilterAnnotations()
```
  Specified by:
  
  getFilterAnnotations in interface CacheEntryListenerInvocation<K,V>
- getKeyDataConversion
```
public DataConversion getKeyDataConversion()
```
  Specified by:
  
  getKeyDataConversion in interface CacheEntryListenerInvocation<K,V>
- getValueDataConversion
```
public DataConversion getValueDataConversion()
```
  Specified by:
  
  getValueDataConversion in interface CacheEntryListenerInvocation<K,V>
- useStorageFormat
```
public boolean useStorageFormat()
```
  Specified by:
  
  useStorageFormat in interface CacheEntryListenerInvocation<K,V>
  
  Returns:
  
  true if the filter/converter should be done in the storage format
- getConverter
```
public CacheEventConverter<? super K,? super V,?> getConverter()
```
  Specified by:
  
  getConverter in interface CacheEntryListenerInvocation<K,V>
- isClustered
```
public boolean isClustered()
```
  Specified by:
  
  isClustered in interface CacheEntryListenerInvocation<K,V>
- getIdentifier
```
public UUID getIdentifier()
```
  Specified by:
  
  getIdentifier in interface CacheEntryListenerInvocation<K,V>
- getObservation
```
public Listener.Observation getObservation()
```
  Specified by:
  
  getObservation in interface CacheEntryListenerInvocation<K,V>
- getAnnotation
```
public Class<? extends Annotation> getAnnotation()
```
  Specified by:
  
  getAnnotation in interface CacheEntryListenerInvocation<K,V>
- convertValue
```
protected CacheEntryEvent<K,V> convertValue(CacheEventConverter<? super K,? super V,?> converter,
                                            CacheEntryEvent<K,V> event)
```
- isSync
```
public boolean isSync()
```
  Specified by:
  
  isSync in interface CacheEntryListenerInvocation<K,V>
- toString
```
public String toString()
```
  Overrides:
  
  toString in class Object

Class CacheNotifierImpl.BaseCacheEntryListenerInvocation<K,V>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

invocation

filter

converter

onlyPrimary

clustered

identifier

annotation

sync

filterAndConvert

observation

filterAnnotations

Constructor Detail

BaseCacheEntryListenerInvocation

Method Detail

invoke

invoke

invokeNoChecks

doRealInvocation

doRealInvocation

shouldInvoke

shouldInvoke

getTarget

getFilter

getFilterAnnotations

getKeyDataConversion

getValueDataConversion

useStorageFormat

getConverter

isClustered

getIdentifier

getObservation

getAnnotation

convertValue

isSync

toString