org.axonframework.eventhandling

Class AnnotationEventListenerAdapter

java.lang.Object

org.axonframework.eventhandling.AnnotationEventListenerAdapter

All Implemented Interfaces:

EventListener, EventListenerProxy

public class AnnotationEventListenerAdapter
extends Object
implements EventListenerProxy

Adapter that turns any bean with EventHandler annotated methods into an EventListener.

Since:

0.1

Author:

Allard Buijze

See Also:

EventListener

Constructor Summary

Constructors

Constructor and Description
AnnotationEventListenerAdapter(Object annotatedEventListener) Wraps the given annotatedEventListener, allowing it to be subscribed to an Event Bus.
AnnotationEventListenerAdapter(Object annotatedEventListener, ParameterResolverFactory parameterResolverFactory) Wraps the given annotatedEventListener, allowing it to be subscribed to an Event Bus.
AnnotationEventListenerAdapter(Object annotatedEventListener, ParameterResolverFactory parameterResolverFactory, HandlerDefinition handlerDefinition) Wraps the given annotatedEventListener, allowing it to be subscribed to an Event Bus.

Method Summary

Modifier and Type	Method and Description
boolean	canHandle(EventMessage<?> event) Indicates whether this listener can handle the given event message
Class<?>	getTargetType() Returns the instance type that this proxy delegates all event handling to.
void	handle(EventMessage<?> event) Process the given event.
void	prepareReset() Performs any activities that are required to reset the state managed by handlers assigned to this invoker.
boolean	supportsReset() Indicates whether the handlers managed by this invoker support a reset.

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotationEventListenerAdapter

public AnnotationEventListenerAdapter(Object annotatedEventListener)

Wraps the given annotatedEventListener, allowing it to be subscribed to an Event Bus.

Parameters:

annotatedEventListener - the annotated event listener

AnnotationEventListenerAdapter

public AnnotationEventListenerAdapter(Object annotatedEventListener,
                                      ParameterResolverFactory parameterResolverFactory)

Wraps the given annotatedEventListener, allowing it to be subscribed to an Event Bus. The given parameterResolverFactory is used to resolve parameter values for handler methods.

Parameters:

annotatedEventListener - the annotated event listener

parameterResolverFactory - the strategy for resolving handler method parameter values

AnnotationEventListenerAdapter

public AnnotationEventListenerAdapter(Object annotatedEventListener,
                                      ParameterResolverFactory parameterResolverFactory,
                                      HandlerDefinition handlerDefinition)

Wraps the given annotatedEventListener, allowing it to be subscribed to an Event Bus. The given parameterResolverFactory is used to resolve parameter values for handler methods. Handler definition is used to create concrete handlers.

Parameters:

annotatedEventListener - the annotated event listener

parameterResolverFactory - the strategy for resolving handler method parameter values

handlerDefinition - the handler definition used to create concrete handlers

Method Detail

handle

public void handle(EventMessage<?> event)
            throws Exception

Description copied from interface: EventListener

Process the given event. The implementation may decide to process or skip the given event. It is highly unrecommended to throw any exception during the event handling process.

Specified by:

handle in interface EventListener

Parameters:

event - the event to handle

Throws:

Exception - when an exception is raised during event handling

canHandle

public boolean canHandle(EventMessage<?> event)

Description copied from interface: EventListener

Indicates whether this listener can handle the given event message

Specified by:

canHandle in interface EventListener

Parameters:

event - The event message to verify

Returns:

true if this listener can handle the event, otherwise false

getTargetType

public Class<?> getTargetType()

Description copied from interface: EventListenerProxy

Returns the instance type that this proxy delegates all event handling to.

Specified by:

getTargetType in interface EventListenerProxy

Returns:

the instance type that this proxy delegates all event handling to

prepareReset

public void prepareReset()

Description copied from interface: EventListener

Performs any activities that are required to reset the state managed by handlers assigned to this invoker.

Specified by:

prepareReset in interface EventListener

supportsReset

public boolean supportsReset()

Description copied from interface: EventListener

Indicates whether the handlers managed by this invoker support a reset.

Specified by:

supportsReset in interface EventListener

Returns:

true if a reset is supported, otherwise false