com.tangosol.net.events.annotation

Annotation Type Interceptor

@Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface Interceptor

Interceptor is an annotation that should be applied to EventInterceptor implementations. The annotation allows the specification of an identifier, event types and an order. These are used to restrict the events an EventInterceptor subscribes to.

When used in combination with the cache configuration the annotation members identifier() and order() can be overridden by the corresponding XML elements.

Since:

Coherence 12.1.2

Author:

hr 2011.10.07

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
CacheLifecycleEvent.Type[]	cacheLifecycleEvents This element specifies all types of CacheLifecycleEvent.Types the interceptor would like to be invoked on.
EntryEvent.Type[]	entryEvents This element specifies all types of EntryEvent.Types the interceptor would like to be invoked on.
EntryProcessorEvent.Type[]	entryProcessorEvents This element specifies all types of EntryProcessorEvent.Types the interceptor would like to be invoked on.
FederatedChangeEvent.Type[]	federatedChangeEvents This element specifies all types of FederatedChangeEvent.Types the interceptor would like to be invoked on.
FederatedConnectionEvent.Type[]	federatedConnectionEvents This element specifies all types of FederatedConnectionEvent.Types the interceptor would like to be invoked on.
FederatedPartitionEvent.Type[]	federatedPartitionEvents This element specifies all types of FederatedPartitionEvent.Types the interceptor would like to be invoked on.
String	identifier A unique identifier for the interceptor.
Interceptor.Order	order Iff a value of Interceptor.Order.HIGH is provided this interceptor will request to be the first in the chain of interceptors.
TransactionEvent.Type[]	transactionEvents This element specifies all types of TransactionEvent.Types the interceptor would like to be invoked on.
TransferEvent.Type[]	transferEvents This element specifies all types of TransferEvent.Types the interceptor would like to be invoked on.
UnsolicitedCommitEvent.Type[]	unsolicitedEvents This element specifies all types of UnsolicitedCommitEvent.Types the interceptor would like to be invoked on.

Element Detail

identifier

public abstract String identifier

A unique identifier for the interceptor.

Returns:

unique identifier for the interceptor

Default:

""

entryEvents

public abstract EntryEvent.Type[] entryEvents

This element specifies all types of EntryEvent.Types the interceptor would like to be invoked on.

Returns:

all EntryEvent.Types the EventInterceptor would like to receive notifications on

Default:

{}

entryProcessorEvents

public abstract EntryProcessorEvent.Type[] entryProcessorEvents

This element specifies all types of EntryProcessorEvent.Types the interceptor would like to be invoked on.

Returns:

all EntryProcessorEvent.Types the EventInterceptor would like to receive notifications on

Default:

{}

federatedChangeEvents

public abstract FederatedChangeEvent.Type[] federatedChangeEvents

This element specifies all types of FederatedChangeEvent.Types the interceptor would like to be invoked on.

Returns:

all FederatedChangeEvent.Types the EventInterceptor would like to receive notifications on

Default:

{}

federatedConnectionEvents

public abstract FederatedConnectionEvent.Type[] federatedConnectionEvents

This element specifies all types of FederatedConnectionEvent.Types the interceptor would like to be invoked on.

Returns:

all FederatedConnectionEvent.Types the EventInterceptor would like to receive notifications on

Default:

{}

federatedPartitionEvents

public abstract FederatedPartitionEvent.Type[] federatedPartitionEvents

This element specifies all types of FederatedPartitionEvent.Types the interceptor would like to be invoked on.

Returns:

all FederatedPartitionEvent.Types the EventInterceptor would like to receive notifications on

Default:

{}

transferEvents

public abstract TransferEvent.Type[] transferEvents

This element specifies all types of TransferEvent.Types the interceptor would like to be invoked on.

Returns:

all TransferEvent.Types the EventInterceptor would like to receive notifications on

Default:

{}

transactionEvents

public abstract TransactionEvent.Type[] transactionEvents

This element specifies all types of TransactionEvent.Types the interceptor would like to be invoked on.

Returns:

all TransactionEvent.Types the EventInterceptor would like to receive notifications on

Default:

{}

unsolicitedEvents

public abstract UnsolicitedCommitEvent.Type[] unsolicitedEvents

This element specifies all types of UnsolicitedCommitEvent.Types the interceptor would like to be invoked on.

Returns:

all UnsolicitedCommitEvent.Types the EventInterceptor would like to receive notifications on

Default:

{}

cacheLifecycleEvents

public abstract CacheLifecycleEvent.Type[] cacheLifecycleEvents

This element specifies all types of CacheLifecycleEvent.Types the interceptor would like to be invoked on.

Returns:

all CacheLifecycleEvent.Types the EventInterceptor would like to receive notifications on

Default:

{}

order

public abstract Interceptor.Order order

Iff a value of Interceptor.Order.HIGH is provided this interceptor will request to be the first in the chain of interceptors.

Returns:

whether this EventInterceptor should be first (Interceptor.Order.HIGH) in the chain of EventInterceptors

Default:

com.tangosol.net.events.annotation.Interceptor.Order.LOW