org.axonframework.eventhandling

Class SubscribingEventProcessor

java.lang.Object

org.axonframework.eventhandling.AbstractEventProcessor

org.axonframework.eventhandling.SubscribingEventProcessor

All Implemented Interfaces:

EventProcessor, MessageHandlerInterceptorSupport<EventMessage<?>>

public class SubscribingEventProcessor
extends AbstractEventProcessor

Event processor implementation that subscribes to the EventBus for events. Events published on the event bus are supplied to this processor in the publishing thread.

Depending on the given EventProcessingStrategy the events are processed directly (in the publishing thread) or asynchronously.

Since:

3.0

Author:

Rene de Waele

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SubscribingEventProcessor.Builder Builder class to instantiate a SubscribingEventProcessor.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SubscribingEventProcessor(SubscribingEventProcessor.Builder builder) Instantiate a SubscribingEventProcessor based on the fields contained in the SubscribingEventProcessor.Builder.

Method Summary

Modifier and Type	Method and Description
static SubscribingEventProcessor.Builder	builder() Instantiate a Builder to be able to create a SubscribingEventProcessor.
protected void	process(List<? extends EventMessage<?>> eventMessages) Process the given messages.
void	shutDown() Shut down this processor.
void	start() Start this processor.

Methods inherited from class org.axonframework.eventhandling.AbstractEventProcessor

canHandle, eventHandlerInvoker, getHandlerInterceptors, getName, processInUnitOfWork, processInUnitOfWork, registerHandlerInterceptor, reportIgnored, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SubscribingEventProcessor

protected SubscribingEventProcessor(SubscribingEventProcessor.Builder builder)

Instantiate a SubscribingEventProcessor based on the fields contained in the SubscribingEventProcessor.Builder.

Will assert that the Event Processor name, EventHandlerInvoker and SubscribableMessageSource are not null, and will throw an AxonConfigurationException if any of them is null.

Parameters:

builder - the SubscribingEventProcessor.Builder used to instantiate a SubscribingEventProcessor instance

Method Detail

builder

public static SubscribingEventProcessor.Builder builder()

Instantiate a Builder to be able to create a SubscribingEventProcessor.

The RollbackConfigurationType defaults to a RollbackConfigurationType.ANY_THROWABLE, the ErrorHandler is defaulted to a PropagatingErrorHandler, the MessageMonitor defaults to a NoOpMessageMonitor and the EventProcessingStrategy defaults to a DirectEventProcessingStrategy. The Event Processor name, EventHandlerInvoker and SubscribableMessageSource are hard requirements and as such should be provided.

Returns:

a Builder to be able to create a SubscribingEventProcessor

start

public void start()

Start this processor. This will register the processor with the EventBus.

process

protected void process(List<? extends EventMessage<?>> eventMessages)

Process the given messages. A Unit of Work must be created for this processing.

This implementation creates a Batching unit of work for the given batch of eventMessages.

Parameters:

eventMessages - The messages to process

shutDown

public void shutDown()

Shut down this processor. This will deregister the processor with the EventBus.