org.openhubframework.openhub.spi.extcall

Interface ExternalCallService

All Known Implementing Classes:

ExternalCallServiceImpl

public interface ExternalCallService

Contract for checking duplicate and obsolete calls.

Author:

Petr Juza

Method Summary

Methods

Modifier and Type	Method and Description
void	complete(ExternalCall externalCall) Marks the external call as a successfully executed call.
void	failed(ExternalCall externalCall) Marks the external call as an unsuccessfully executed call.
ExternalCall	prepare(String operationUri, String operationKey, Message message) Prepares a new external call for the specified unique operation invocation.

Method Detail

prepare

ExternalCall prepare(String operationUri,
                   String operationKey,
                   Message message)

Prepares a new external call for the specified unique operation invocation. Operation URI and operation key (such as object ID) together uniquely identify such an operation invocation.

The attempted external call might not be allowed. This could happen if the external call is either duplicate or outdated. To verify it's a new call, the provided Message.getMsgTimestamp() will be compared with an existing known one (if any) for this invocation: if the provided timestamp is newer, the call is considered new, otherwise the call is considered outdated or duplicate.

Parameters:

operationUri - the operation URI that the external call is done via

operationKey - the operation key that is to be unique for this operation URI (object ID for edits, correlation ID for single-entity creation messages, etc.)

message - the message with the correct msg timestamp

Returns:

an instance of ExternalCall, if the attempted call is new and is prepared to be made; null if the call is duplicate or outdated and should NOT be made

Throws:

LockFailureException - if the requested call is currently in the processing state and therefore is temporarily not allowed to be repeated

complete

void complete(ExternalCall externalCall)

Marks the external call as a successfully executed call.

Parameters:

externalCall - the external call to be finalized.

failed

void failed(ExternalCall externalCall)

Marks the external call as an unsuccessfully executed call.

Parameters:

externalCall - the external call to be finalized.