Package org.alfresco.event.outbox

Interface Outbox

public interface Outbox

The main entrypoint to the Outbox module. It allows to store an event (getInboundEventConsumer()). When started (start()) it will begin relaying the stored Events to the target system.
An Outbox instance can be created by the OutboxBuilder

See Also:

• OutboxBuilder.build()

Method Summary

Modifier and Type	Method	Description
EventConsumer	getInboundEventConsumer()
void	shutdown()	the Outbox background processes.
void	start()	Starts the Outbox background processes which are used to relay the stored Events to the target system.

Method Details

start

void start()

Starts the Outbox background processes which are used to relay the stored Events to the target system.

Throws:

OutboxException - on failures.

shutdown

void shutdown()

the Outbox background processes.

getInboundEventConsumer

EventConsumer getInboundEventConsumer()

Returns:

an EventConsumer which can be used to store Events in the Outbox.
The EventConsumer.consume(Event) method might fail with the OutboxException when storing an Event failed.