Package org.alfresco.event.outbox

Class OutboxBuilder

java.lang.Object

org.alfresco.event.outbox.OutboxBuilder

public final class OutboxBuilder
extends Object

Creates an Outbox instance backed by the relational database. Created instance relays the events using the At Least Once Delivery semantic. It means that:

• it will try to participate in the already running Transaction while storing events
• an OutboxException will be thrown on storing event failure
• events will be delivered in order - but might be retried

Implementation Note - Delivery Semantic:
For the performance reasons the events are processed in batches (default behaviour). It means that more than one event can be retried. In some corner cases all events in the batch might be retried. The events will be still delivered in order. If it's important to prevent this behaviour the OutboxConfig.getFetchLimit() can be used to set the batch size to 1.

Implementation Note - Concurrency:
Multiple Outbox instances can work together and still provide the same guarantees as if there were only one Outbox instance. It means that it can be used in a clustered environment.

Method Summary

Modifier and Type	Method	Description
Outbox	build()
static OutboxBuilder	forAutodetectedDb(ConnectionSource connectionSource)	Creates a new OutboxBuilder which will detect (lazily) the database using the provided ConnectionSource.
OutboxBuilder	withConfig(OutboxConfig config)	Configures the OutboxConfig used by the Outbox implementation.
OutboxBuilder	withMetricsAdapter(MetricsAdapter metricsAdapter)	Configures the MetricsAdapter used by the Outbox implementation.
OutboxBuilder	withOutboundEventConsumer(EventConsumer outboundEventConsumer)	Configures the outbound EventConsumer which is used to relay the stored events to the target system in an asynchronous way.

Methods inherited from class java.lang.Object

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

Method Details

forAutodetectedDb

public static OutboxBuilder forAutodetectedDb(ConnectionSource connectionSource)

Creates a new OutboxBuilder which will detect (lazily) the database using the provided ConnectionSource.

Parameters:

connectionSource - a ConnectionSource used to detect the database type. It will be also used by the final Outbox implementation.

Returns:

an OutboxBuilder

withOutboundEventConsumer

public OutboxBuilder withOutboundEventConsumer(EventConsumer outboundEventConsumer)

Configures the outbound EventConsumer which is used to relay the stored events to the target system in an asynchronous way.
If not configured the events will be discarded.

Parameters:

outboundEventConsumer - an EventConsumer.

Returns:

an OutboxBuilder for chaining the build steps.

withMetricsAdapter

public OutboxBuilder withMetricsAdapter(MetricsAdapter metricsAdapter)

Configures the MetricsAdapter used by the Outbox implementation.
If not configured the metrics are not reported.

Parameters:

metricsAdapter - a MetricsAdapter

Returns:

an OutboxBuilder for chaining the build steps.

withConfig

public OutboxBuilder withConfig(OutboxConfig config)

Configures the OutboxConfig used by the Outbox implementation.
If not provided the default config will be used.

Parameters:

config - an OutboxConfig

Returns:

an OutboxBuilder for chaining the build steps.

build

public Outbox build()