Package org.springframework.modulith.events.support

Class OutboxEventExternalizer

java.lang.Object

org.springframework.modulith.events.support.EventExternalizerSupport

org.springframework.modulith.events.support.TransportAwareEventExternalizer

org.springframework.modulith.events.support.OutboxEventExternalizer

public class OutboxEventExternalizer
extends TransportAwareEventExternalizer

An OutboxEventExternalizer that transports events from the outbox to an external target.

This handler is invoked by the outbox processor to externalize events that were previously recorded in the outbox table. It uses the configured transport function to deliver events to their target destination (e.g., message broker, email, SMS).

Since:

2.1

Author:

Roland Beisel, Oliver Drotbohm

See Also:

• EventExternalizationConfiguration

Constructor Summary

Constructors

Constructor	Description
OutboxEventExternalizer(EventExternalizationConfiguration configuration, ApplicationEventPublisher publisher, EventExternalizationTransport transport)	Creates a new OutboxEventExternalizer for the given EventExternalizationConfiguration and transport function.

Method Summary

Modifier and Type	Method	Description
CompletableFuture<?>	externalize(Object event)	Externalizes the given event.

Methods inherited from class org.springframework.modulith.events.support.TransportAwareEventExternalizer

externalize

Methods inherited from class java.lang.Object

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

Constructor Details

OutboxEventExternalizer

public OutboxEventExternalizer(EventExternalizationConfiguration configuration,
 ApplicationEventPublisher publisher,
 EventExternalizationTransport transport)

Creates a new OutboxEventExternalizer for the given EventExternalizationConfiguration and transport function.

Parameters:

configuration - must not be null.

publisher - must not be null.

Method Details

externalize

public CompletableFuture<?> externalize(Object event)

Description copied from class: EventExternalizerSupport

Externalizes the given event.

Overrides:

externalize in class EventExternalizerSupport

Parameters:

event - must not be null.

Returns:

the externalization result, will never be null.