Package org.axonframework.eventhandling.gateway

Class DefaultEventGateway

java.lang.Object

org.axonframework.eventhandling.gateway.AbstractEventGateway

org.axonframework.eventhandling.gateway.DefaultEventGateway

All Implemented Interfaces:

EventGateway, MessageDispatchInterceptorSupport<EventMessage<?>>

public class DefaultEventGateway
extends AbstractEventGateway
implements EventGateway

Default implementation of the EventGateway interface. It allow configuration of EventDispatchInterceptors. The Event Dispatch Interceptors can intercept and alter events dispatched on this specific gateway. Typically, this would be used to add gateway specific meta data to the Event.

Since:

4.1

Author:

Bert laverman

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultEventGateway.Builder	A Builder class for DefaultEventGateways.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static DefaultEventGateway.Builder	builder()	Instantiate a Builder to be able to create a DefaultEventGateway.
void	publish(List<?> events)	Publish a collection of events on this bus (one, or multiple).

Methods inherited from class org.axonframework.eventhandling.gateway.AbstractEventGateway

getEventBus, processInterceptors, publish, publishAll, registerDispatchInterceptor

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.axonframework.eventhandling.gateway.EventGateway

publish

Methods inherited from interface org.axonframework.messaging.MessageDispatchInterceptorSupport

registerDispatchInterceptor

Constructor Details

DefaultEventGateway

protected DefaultEventGateway(DefaultEventGateway.Builder builder)

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

Will assert that the EventBus is not null and will throw an AxonConfigurationException if this is the case.

Parameters:

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

Method Details

builder

public static DefaultEventGateway.Builder builder()

Instantiate a Builder to be able to create a DefaultEventGateway.

The dispatchInterceptors are defaulted to an empty list. The EventBus is a hard requirement and as such should be provided.

Returns:

a Builder to be able to create a DefaultEventGateway

publish

public void publish(@Nonnull
 List<?> events)

Description copied from interface: EventGateway

Publish a collection of events on this bus (one, or multiple). The events will be dispatched to all subscribed listeners.

Implementations may treat the given events as a single batch and distribute the events as such to all subscribed EventListeners. When the given events is an empty list, nothing happens.

Specified by:

publish in interface EventGateway

Parameters:

events - The collection of events to publish