com.tangosol.net.events

Interface EventDispatcher

All Known Subinterfaces:

PartitionedCacheDispatcher, PartitionedServiceDispatcher

public interface EventDispatcher

An EventDispatcher is responsible for dispatching Events to EventInterceptors for processing.

Since:

Coherence 12.1.2

Author:

bo, nsa, rhan, mwj, rhl, hr 2011.03.29

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	EventDispatcher.InterceptorRegistrationEvent<E extends Event<? extends Enum>> An InterceptorRegistrationEvent allows EventInterceptors to observe other EventInterceptors being added or removed from an EventDispatcher instance.

Method Summary

Modifier and Type	Method and Description
<E extends Event<? extends Enum>> void	addEventInterceptor(EventInterceptor<E> interceptor) Add an EventInterceptor to this dispatcher to be used to process Events.
<E extends Event<? extends Enum>> void	addEventInterceptor(String sIdentifier, EventInterceptor<E> interceptor) Add a uniquely identified EventInterceptor to this dispatcher to be used to process Events.
<T extends Enum<T>,E extends Event<T>> void	addEventInterceptor(String sIdentifier, EventInterceptor<E> interceptor, Set<T> setTypes, boolean fFirst) Add a uniquely identified EventInterceptor to this dispatcher to be used to process Events.
Set<Enum>	getSupportedTypes() Return the set of Event types this EventDispatcher supports.
<E extends Event<? extends Enum>> void	removeEventInterceptor(EventInterceptor<E> interceptor) Remove an EventInterceptor from this dispatcher.
void	removeEventInterceptor(String sIdentifier) Remove an EventInterceptor from this dispatcher.

Method Detail

addEventInterceptor

<E extends Event<? extends Enum>> void addEventInterceptor(EventInterceptor<E> interceptor)

Add an EventInterceptor to this dispatcher to be used to process Events. The EventInterceptor will be analyzed to determine applicability to this dispatcher and an identifier will be generated if not specified via an annotation. The generated identifier is the fully qualified class name.

Type Parameters:

E - the Event the interceptor accepts

Parameters:

interceptor - the EventInterceptor to add

addEventInterceptor

<E extends Event<? extends Enum>> void addEventInterceptor(String sIdentifier,
                                                           EventInterceptor<E> interceptor)

Add a uniquely identified EventInterceptor to this dispatcher to be used to process Events. The EventInterceptor will be analyzed to determine applicability to this dispatcher.

Type Parameters:

E - the Event the interceptor accepts

Parameters:

sIdentifier - the unique name of the EventInterceptor to add

interceptor - the EventInterceptor to add

addEventInterceptor

<T extends Enum<T>,E extends Event<T>> void addEventInterceptor(String sIdentifier,
                                                                EventInterceptor<E> interceptor,
                                                                Set<T> setTypes,
                                                                boolean fFirst)

Add a uniquely identified EventInterceptor to this dispatcher to be used to process Events.

Type Parameters:

E - the Event the interceptor accepts

T - the type of events dispatched by Event E

Parameters:

sIdentifier - the unique name of the EventInterceptor to add

interceptor - the EventInterceptor to add

setTypes - the Event types the specified interceptor is subscribing to, or null to subscribe to all events

fFirst - true iff the EventInterceptor should be added to the head of this dispatcher's interceptor chain

removeEventInterceptor

<E extends Event<? extends Enum>> void removeEventInterceptor(EventInterceptor<E> interceptor)

Remove an EventInterceptor from this dispatcher.

Type Parameters:

E - the Event the interceptor accepts

Parameters:

interceptor - the EventInterceptor to be removed from the dispatcher based on identity reference

removeEventInterceptor

void removeEventInterceptor(String sIdentifier)

Remove an EventInterceptor from this dispatcher.

Parameters:

sIdentifier - the unique name identifying the EventInterceptor to remove

getSupportedTypes

Set<Enum> getSupportedTypes()

Return the set of Event types this EventDispatcher supports.

Returns:

the set of Event types this EventDispatcher supports