Package org.springframework.modulith.events

Class DefaultEventExternalizationConfiguration

java.lang.Object

org.springframework.modulith.events.DefaultEventExternalizationConfiguration

All Implemented Interfaces:

EventExternalizationConfiguration

class DefaultEventExternalizationConfiguration
extends Object
implements EventExternalizationConfiguration

Default implementation of EventExternalizationConfiguration.

Since:

1.1

Author:

Oliver Drotbohm

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.modulith.events.EventExternalizationConfiguration

EventExternalizationConfiguration.BaseConfiguration<T extends EventExternalizationConfiguration.BaseConfiguration<T>>, EventExternalizationConfiguration.Router, EventExternalizationConfiguration.Selector

Constructor Summary

Constructors

Constructor	Description
DefaultEventExternalizationConfiguration(Predicate<Object> filter, Function<Object,Object> mapper, Function<Object,RoutingTarget> router, Function<Object,Map<String,Object>> headers, boolean serializeExternalization)	Creates a new DefaultEventExternalizationConfiguration

Method Summary

Modifier and Type	Method	Description
(package private) static EventExternalizationConfiguration.Selector	builder()	Returns a new EventExternalizationConfiguration.Selector instance to build up a new configuration.
RoutingTarget	determineTarget(Object event)	Determines the RoutingTarget for the given event based on the current configuration.
Map<String,Object>	getHeadersFor(Object event)	Returns the headers to be attached to the message sent out for the given event.
Object	map(Object event)	Map the event to be externalized before publishing it.
boolean	serializeExternalization()	Returns whether the event externalization should be serialized to make sure the broker sees the events in the order they were published in the application.
boolean	supports(Object event)	Whether the configuration supports the given event.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultEventExternalizationConfiguration

DefaultEventExternalizationConfiguration(Predicate<Object> filter,
 Function<Object,Object> mapper,
 Function<Object,RoutingTarget> router,
 Function<Object,Map<String,Object>> headers,
 boolean serializeExternalization)

Creates a new DefaultEventExternalizationConfiguration

Parameters:

filter - must not be null.

mapper - must not be null.

router - must not be null.

headers - must not be null.

Method Details

builder

static EventExternalizationConfiguration.Selector builder()

Returns a new EventExternalizationConfiguration.Selector instance to build up a new configuration.

Returns:

will never be null.

supports

public boolean supports(Object event)

Description copied from interface: EventExternalizationConfiguration

Whether the configuration supports the given event. In other words, whether the given event is supposed to be externalized in the first place.

Specified by:

supports in interface EventExternalizationConfiguration

Parameters:

event - must not be null.

Returns:

whether to externalize the given event.

map

public Object map(Object event)

Description copied from interface: EventExternalizationConfiguration

Map the event to be externalized before publishing it.

Specified by:

map in interface EventExternalizationConfiguration

Parameters:

event - must not be null.

Returns:

the mapped event.

determineTarget

public RoutingTarget determineTarget(Object event)

Description copied from interface: EventExternalizationConfiguration

Determines the RoutingTarget for the given event based on the current configuration.

Specified by:

determineTarget in interface EventExternalizationConfiguration

Parameters:

event - must not be null.

Returns:

will never be null.

getHeadersFor

public Map<String,Object> getHeadersFor(Object event)

Description copied from interface: EventExternalizationConfiguration

Returns the headers to be attached to the message sent out for the given event.

Specified by:

getHeadersFor in interface EventExternalizationConfiguration

Parameters:

event - must not be null.

Returns:

will never be null.

serializeExternalization

public boolean serializeExternalization()

Description copied from interface: EventExternalizationConfiguration

Returns whether the event externalization should be serialized to make sure the broker sees the events in the order they were published in the application. By default, this is not guaranteed as multiple threads might trigger events and the externalization of one event might overtake the one of another.

Specified by:

serializeExternalization in interface EventExternalizationConfiguration