Annotation Interface Interceptor

@Retention(RUNTIME)
@Target(TYPE)
@Inherited
public @interface Interceptor

Interceptor is an annotation that can be applied to EventInterceptor implementations. The annotation allows the specification of an identifier and an order.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Interceptor.Order	This enum provides an indication of whether the EventInterceptor should request to be first in the chain of EventInterceptors, hence have a HIGH priority.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
CacheLifecycleEvent.Type[]	cacheLifecycleEvents	Deprecated. use CacheLifecycleEvents annotation instead
EntryEvent.Type[]	entryEvents	Deprecated. use EntryEvents annotation instead
EntryProcessorEvent.Type[]	entryProcessorEvents	Deprecated. use EntryProcessorEvents annotation instead
FederatedChangeEvent.Type[]	federatedChangeEvents	Deprecated. use FederatedChangeEvents annotation instead
FederatedConnectionEvent.Type[]	federatedConnectionEvents	Deprecated. use FederatedConnectionEvents annotation instead
FederatedPartitionEvent.Type[]	federatedPartitionEvents	Deprecated. use FederatedPartitionEvents annotation instead
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	Deprecated. use TransactionEvents annotation instead
TransferEvent.Type[]	transferEvents	Deprecated. use TransferEvents annotation instead
UnsolicitedCommitEvent.Type[]	unsolicitedEvents	Deprecated. use UnsolicitedCommitEvents annotation instead

Element Details

identifier

String identifier

A unique identifier for the interceptor.

Returns:

unique identifier for the interceptor

Default:

""

entryEvents

@Deprecated
EntryEvent.Type[] entryEvents

Deprecated.

use EntryEvents annotation instead

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

@Deprecated
EntryProcessorEvent.Type[] entryProcessorEvents

Deprecated.

use EntryProcessorEvents annotation instead

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

@Deprecated
FederatedChangeEvent.Type[] federatedChangeEvents

Deprecated.

use FederatedChangeEvents annotation instead

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

@Deprecated
FederatedConnectionEvent.Type[] federatedConnectionEvents

Deprecated.

use FederatedConnectionEvents annotation instead

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

@Deprecated
FederatedPartitionEvent.Type[] federatedPartitionEvents

Deprecated.

use FederatedPartitionEvents annotation instead

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

@Deprecated
TransferEvent.Type[] transferEvents

Deprecated.

use TransferEvents annotation instead

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

@Deprecated
TransactionEvent.Type[] transactionEvents

Deprecated.

use TransactionEvents annotation instead

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

@Deprecated
UnsolicitedCommitEvent.Type[] unsolicitedEvents

Deprecated.

use UnsolicitedCommitEvents annotation instead

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

@Deprecated
CacheLifecycleEvent.Type[] cacheLifecycleEvents

Deprecated.

use CacheLifecycleEvents annotation instead

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

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:

LOW