Package com.sap.cds.services.outbox

Interface OutboxService

All Superinterfaces:

Service

public interface OutboxService
extends Service

Defines the outbox service API. The outbox can be used to couple emitting of events on a service to the currently active transaction. The following applies when using the outbox: - The outbox message is stored in the outbox. - If the transaction fails, the outbox message is not stored in the outbox and is never emitted. - A persisted outbox message is emitted eventually (asynchronously or synchronously, depending on the outbox implementation)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	INMEMORY_NAME
static final String	IS_OUTBOXED
static final String	PERSISTENT_NAME

Method Summary

Modifier and Type	Method	Description
void	enroll(String targetEvent, String message)	Stores the given message under the given target event in the outbox.

Methods inherited from interface com.sap.cds.services.Service

after, after, after, after, before, before, before, before, emit, getName, on, on, on, on

Field Details

IS_OUTBOXED

static final String IS_OUTBOXED

See Also:

• Constant Field Values

PERSISTENT_NAME

static final String PERSISTENT_NAME

See Also:

• Constant Field Values

INMEMORY_NAME

static final String INMEMORY_NAME

See Also:

• Constant Field Values

Method Details

enroll

void enroll(String targetEvent,
 String message)

Stores the given message under the given target event in the outbox.

Parameters:

targetEvent - the target event with which the message is stored and again published by the OutboxService

message - the outbox message stored and again published by the OutboxService