Package org.springframework.modulith.events

Class EventExternalizationConfiguration.Router

java.lang.Object

org.springframework.modulith.events.EventExternalizationConfiguration.BaseConfiguration<EventExternalizationConfiguration.Router>

org.springframework.modulith.events.EventExternalizationConfiguration.Router

Enclosing interface:

EventExternalizationConfiguration

public static class EventExternalizationConfiguration.Router
extends EventExternalizationConfiguration.BaseConfiguration<EventExternalizationConfiguration.Router>

API to define the event routing.

Since:

1.1

Author:

Oliver Drotbohm

Field Summary

Fields inherited from class org.springframework.modulith.events.EventExternalizationConfiguration.BaseConfiguration

serializeExternalization

Constructor Summary

Constructors

Constructor	Description
Router(Predicate<Object> filter)	Creates a new EventExternalizationConfiguration.Router for the given selector filter.
Router(Predicate<Object> filter, Function<Object,Object> mapper, Function<Object,RoutingTarget> router, Function<Object,Map<String,Object>> headers, boolean serializeExternalization)	Creates a new EventExternalizationConfiguration.Router for the given selector Predicate and mapper and router Functions.

Method Summary

Modifier and Type	Method	Description
EventExternalizationConfiguration	build()	Creates a new EventExternalizationConfiguration reflecting the current configuration.
<T> EventExternalizationConfiguration.Router	headers(Class<T> type, Function<T,Map<String,Object>> extractor)	Registers the given type-specific function to extract headers from the events to be externalized.
EventExternalizationConfiguration.Router	headers(Function<Object,Map<String,Object>> extractor)	Registers the given function to extract headers from the events to be externalized.
<T> EventExternalizationConfiguration.Router	mapping(Class<T> type, Function<T,Object> mapper)	Registers a type-specific mapping function.
EventExternalizationConfiguration.Router	mapping(Function<Object,Object> mapper)	Registers a new mapping Function replacing the old one entirely.
<T> EventExternalizationConfiguration.Router	route(Class<T> type, Function<T,RoutingTarget> router)	Registers a router function for the events of the given specific type.
EventExternalizationConfiguration.Router	routeAll(Function<Object,RoutingTarget> router)	Routes all events based on the given function.
EventExternalizationConfiguration.Router	routeAllByType(Function<Class<?>,RoutingTarget> router)	Routes all messages based on the event type only.
<T> EventExternalizationConfiguration.Router	routeKey(Class<T> type, Function<T,String> extractor)	Registers a BiFunction to resolve the key for a RoutingTarget based on the event instance.
EventExternalizationConfiguration.Router	routeMapped()	Configures the routing to rather use the mapping result rather than the original event instance.
EventExternalizationConfiguration	routeOptional(Function<Object,Optional<RoutingTarget>> router)	Routes by extracting an Optional route from the event.
EventExternalizationConfiguration	routeOptionalByType(Function<Class<?>,Optional<RoutingTarget>> router)	Routes by extracting an Optional route from the event type.

Methods inherited from class org.springframework.modulith.events.EventExternalizationConfiguration.BaseConfiguration

serializeExternalization

Methods inherited from class java.lang.Object

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

Constructor Details

Router

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

Creates a new EventExternalizationConfiguration.Router for the given selector Predicate and mapper and router Functions.

Parameters:

filter - must not be null.

mapper - must not be null.

router - must not be null.

headers - must not be null.

Router

Router(Predicate<Object> filter)

Creates a new EventExternalizationConfiguration.Router for the given selector filter.

Parameters:

filter - must not be null.

Method Details

mapping

public EventExternalizationConfiguration.Router mapping(Function<Object,Object> mapper)

Registers a new mapping Function replacing the old one entirely.

Parameters:

mapper - must not be null.

Returns:

will never be null.

See Also:

• mapping(Class, Function)

mapping

public <T> EventExternalizationConfiguration.Router mapping(Class<T> type,
 Function<T,Object> mapper)

Registers a type-specific mapping function. Events not matching that type will still fall back to the global mapping function defined.

Type Parameters:

T - the type to handle.

Parameters:

type - the type to handle, must not be null.

mapper - the mapping function, must not be null.

Returns:

will never be null.

See Also:

• mapping(Function)

headers

public EventExternalizationConfiguration.Router headers(Function<Object,Map<String,Object>> extractor)

Registers the given function to extract headers from the events to be externalized. Will reset the entire header extractor arrangement. For type-specific extractions, see headers(Class, Function).

Parameters:

extractor - must not be null.

Returns:

will never be null.

Since:

1.3

See Also:

• headers(Class, Function)

headers

public <T> EventExternalizationConfiguration.Router headers(Class<T> type,
 Function<T,Map<String,Object>> extractor)

Registers the given type-specific function to extract headers from the events to be externalized.

Parameters:

extractor - must not be null.

Returns:

will never be null.

Since:

1.3

routeMapped

public EventExternalizationConfiguration.Router routeMapped()

Configures the routing to rather use the mapping result rather than the original event instance.

Returns:

will never be null.

routeAll

public EventExternalizationConfiguration.Router routeAll(Function<Object,RoutingTarget> router)

Routes all events based on the given function.

Parameters:

router - must not be null.

Returns:

will never be null.

route

public <T> EventExternalizationConfiguration.Router route(Class<T> type,
 Function<T,RoutingTarget> router)

Registers a router function for the events of the given specific type.

Type Parameters:

T - the type to handle

Parameters:

type - must not be null.

router - must not be null.

Returns:

will never be null.

routeKey

public <T> EventExternalizationConfiguration.Router routeKey(Class<T> type,
 Function<T,String> extractor)

Registers a BiFunction to resolve the key for a RoutingTarget based on the event instance. The actual target will have been resolved through the currently configured, global router. To dynamically define full, type-specific resolution of a RoutingTarget, see route(Class, Function).

Type Parameters:

T - the type to handle.

Parameters:

type - the type to configure the key extraction for, must not be null.

extractor - the key extractor, must not be null.

Returns:

will never be null.

See Also:

• route(Class, Function)

routeOptional

public EventExternalizationConfiguration routeOptional(Function<Object,Optional<RoutingTarget>> router)

Routes by extracting an Optional route from the event. If Optional.empty() is returned by the function, we will fall back to the configured default routing.

Parameters:

router - must not be null.

Returns:

will never be null.

routeOptionalByType

public EventExternalizationConfiguration routeOptionalByType(Function<Class<?>,Optional<RoutingTarget>> router)

Routes by extracting an Optional route from the event type. If Optional.empty() is returned by the function, we will fall back to the configured general routing.

Parameters:

router - must not be null.

Returns:

will never be null.

routeAllByType

public EventExternalizationConfiguration.Router routeAllByType(Function<Class<?>,RoutingTarget> router)

Routes all messages based on the event type only.

Parameters:

router - must not be null.

Returns:

will never be null.

build

public EventExternalizationConfiguration build()

Creates a new EventExternalizationConfiguration reflecting the current configuration.

Returns:

will never be null.