com.tangosol.coherence.config.builder

Class NamedEventInterceptorBuilder

java.lang.Object

com.tangosol.coherence.config.builder.NamedEventInterceptorBuilder

All Implemented Interfaces:

BuilderCustomization<EventInterceptor>, ParameterizedBuilder<com.tangosol.net.events.internal.NamedEventInterceptor>

public class NamedEventInterceptorBuilder
extends Object
implements ParameterizedBuilder<com.tangosol.net.events.internal.NamedEventInterceptor>, BuilderCustomization<EventInterceptor>

An NamedEventInterceptorBuilder facilitates the construction of a NamedEventInterceptor, which wraps an EventInterceptor. The wrapped EventInterceptor will be constructed based on its instance / class-scheme XML declaration, honoring any init-params defined.

The construction of a NamedEventInterceptor allows metadata associated with the EventInterceptor to be held. This metadata is used to determine eligibility against EventDispatchers and for registration purposes.

In addition to XML being used as input in defining an EventInterceptor and its metadata the presence of an annotation (Interceptor) can also contribute. This annotation can define the identifier for this interceptor, the event types to subscribe to and whether to be placed first in the chain of EventInterceptors (Interceptor.Order.HIGH.

NamedEventInterceptor objects also use class level generic type definitions as input for configuration. The generic type definition allows EventInterceptor implementations to restrict on event types by narrowing the type definition within the reference to the EventInterceptor interface. For example, the following interceptor restricts to only accept transfer events:

     class MyInterceptor
             implements EventInterceptor<TransferEvent>
         {
         public void onEvent(TransferEvent event);
         }
 

The precedence, in highest order first reading left to right, for configuration is as follows:

     XML -> Annotation -> Generic Type Bounds
 

Since:

Coherence 12.1.2

Author:

hr 2011.10.05

Nested Class Summary

Nested classes/interfaces inherited from interface com.tangosol.coherence.config.builder.ParameterizedBuilder

ParameterizedBuilder.ReflectionSupport

Constructor Summary

Constructors

Constructor and Description
NamedEventInterceptorBuilder()

Method Summary

Modifier and Type	Method and Description
ParameterizedBuilder<EventInterceptor>	getCustomBuilder() Obtains the custom ParameterizedBuilder.
String	getName() Get the logical name / identifier for this EventInterceptor.
Interceptor.Order	getOrder() Return the Interceptor.Order of this interceptor.
RegistrationBehavior	getRegistrationBehavior() Returns the behavior upon duplicate registration.
boolean	isFirst() Whether this EventInterceptor should be head of the stack.
com.tangosol.net.events.internal.NamedEventInterceptor	realize(com.tangosol.config.expression.ParameterResolver resolver, ClassLoader loader, ParameterList listParameters) Realizes (creates if necessary) an instance of a object of type T, using the provided ParameterResolver to resolve values any referenced Parameters.
void	setCustomBuilder(ParameterizedBuilder<EventInterceptor> bldr) Sets the ParameterizedBuilder to be used as the alternate builder.
NamedEventInterceptorBuilder	setName(String sName) Set the logical name / identifier for this EventInterceptor.
NamedEventInterceptorBuilder	setOrder(Interceptor.Order order) Set the EventInterceptor's order (HIGH || LOW), hence whether it should be at the start of the chain of interceptors.
NamedEventInterceptorBuilder	setRegistrationBehavior(RegistrationBehavior behavior) Specifies the behavior upon duplicate registration.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

NamedEventInterceptorBuilder

public NamedEventInterceptorBuilder()

Method Detail

realize

public com.tangosol.net.events.internal.NamedEventInterceptor realize(com.tangosol.config.expression.ParameterResolver resolver,
                                                                      ClassLoader loader,
                                                                      ParameterList listParameters)

Realizes (creates if necessary) an instance of a object of type T, using the provided ParameterResolver to resolve values any referenced Parameters.

Specified by:

realize in interface ParameterizedBuilder<com.tangosol.net.events.internal.NamedEventInterceptor>

Parameters:

resolver - the ParameterResolver for resolving named Parameters

loader - the ClassLoader for loading any necessary classes and if null the ClassLoader used to load the builder will be used instead

listParameters - an optional ParameterList (may be null) to be used for realizing the instance, eg: used as constructor parameters

Returns:

an instance of T

getCustomBuilder

public ParameterizedBuilder<EventInterceptor> getCustomBuilder()

Obtains the custom ParameterizedBuilder.

Specified by:

getCustomBuilder in interface BuilderCustomization<EventInterceptor>

Returns:

the ParameterizedBuilder

setCustomBuilder

public void setCustomBuilder(ParameterizedBuilder<EventInterceptor> bldr)

Sets the ParameterizedBuilder to be used as the alternate builder.

Specified by:

setCustomBuilder in interface BuilderCustomization<EventInterceptor>

Parameters:

bldr - the ParameterizedBuilder

getName

public String getName()

Get the logical name / identifier for this EventInterceptor.

Returns:

the logical name / identifier for this EventInterceptor

setName

@Injectable
public NamedEventInterceptorBuilder setName(String sName)

Set the logical name / identifier for this EventInterceptor.

Parameters:

sName - logical name / identifier for this EventInterceptor.

Returns:

a reference to this builder

isFirst

public boolean isFirst()

Whether this EventInterceptor should be head of the stack.

Returns:

whether this EventInterceptor should be head of the stack

getOrder

public Interceptor.Order getOrder()

Return the Interceptor.Order of this interceptor.

Returns:

the Interceptor.Order of this interceptor

setOrder

@Injectable
public NamedEventInterceptorBuilder setOrder(Interceptor.Order order)

Set the EventInterceptor's order (HIGH || LOW), hence whether it should be at the start of the chain of interceptors.

Parameters:

order - whether this EventInterceptor should be head of the stack based on the values Interceptor.Order.HIGH or Interceptor.Order.LOW

Returns:

a reference to this builder

getRegistrationBehavior

public RegistrationBehavior getRegistrationBehavior()

Returns the behavior upon duplicate registration.

Returns:

the behavior upon duplicate registration.

setRegistrationBehavior

@Injectable
public NamedEventInterceptorBuilder setRegistrationBehavior(RegistrationBehavior behavior)

Specifies the behavior upon duplicate registration.

Parameters:

behavior - the behavior upon duplicate registration

Returns:

a reference to this builder

toString

public String toString()

Overrides:

toString in class Object