Package org.springframework.modulith.events.support

Class EventExternalizationSupport

java.lang.Object

org.springframework.modulith.events.support.EventExternalizationSupport

All Implemented Interfaces:

ConditionalEventListener

Direct Known Subclasses:

DelegatingEventExternalizer

abstract class EventExternalizationSupport
extends Object
implements ConditionalEventListener

Fundamental support for event externalization. Considers the configured EventExternalizationConfiguration before handing off the ultimate message publication to externalize(Object, RoutingTarget).

Since:

1.1

Author:

Oliver Drotbohm

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EventExternalizationSupport(EventExternalizationConfiguration configuration)	Creates a new EventExternalizationSupport for the given EventExternalizationConfiguration.

Method Summary

Modifier and Type	Method	Description
CompletableFuture<?>	externalize(Object event)	Externalizes the given event.
protected abstract CompletableFuture<?>	externalize(Object payload, RoutingTarget target)	Publish the given payload to the given RoutingTarget.
boolean	supports(Object event)	Returns whether the given event instance is supported by the listener.

Methods inherited from class java.lang.Object

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

Constructor Details

EventExternalizationSupport

protected EventExternalizationSupport(EventExternalizationConfiguration configuration)

Creates a new EventExternalizationSupport for the given EventExternalizationConfiguration.

Parameters:

configuration - must not be null.

Method Details

supports

public boolean supports(Object event)

Description copied from interface: ConditionalEventListener

Returns whether the given event instance is supported by the listener.

Specified by:

supports in interface ConditionalEventListener

Parameters:

event - must not be null.

Returns:

whether the given event instance is supported by the listener.

externalize

@ApplicationModuleListener(propagation=SUPPORTS)
public CompletableFuture<?> externalize(Object event)

Externalizes the given event.

Parameters:

event - must not be null.

Returns:

the externalization result, will never be null.

externalize

protected abstract CompletableFuture<?> externalize(Object payload,
 RoutingTarget target)

Publish the given payload to the given RoutingTarget.

Parameters:

payload - must not be null.

target - must not be null.

Returns:

the externalization result, will never be null.