Package org.springframework.modulith.events.support

Class OutboxEventExternalizer

java.lang.Object

org.springframework.modulith.events.support.OutboxEventExternalizer

All Implemented Interfaces:

Aware, ApplicationEventPublisherAware

public class OutboxEventExternalizer
extends Object
implements ApplicationEventPublisherAware

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, BiFunction<RoutingTarget,Object,CompletableFuture<?>> transport)	Creates a new OutboxEventExternalizer for the given EventExternalizationConfiguration and transport function.

Method Summary

Modifier and Type	Method	Description
void	handle(Object event)	Handles an outbox event by determining its routing target and transporting it to the external target using the configured transport function.
void	setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)

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,
 BiFunction<RoutingTarget,Object,CompletableFuture<?>> transport)

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

Parameters:

configuration - must not be null.

transport - must not be null.

Method Details

setApplicationEventPublisher

public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)

Specified by:

setApplicationEventPublisher in interface ApplicationEventPublisherAware

handle

public void handle(Object event)

Handles an outbox event by determining its routing target and transporting it to the external target using the configured transport function.

Parameters:

event - the event payload to transport