org.mule.runtime.core.policy

Interface PolicyStateHandler

All Known Implementing Classes:

DefaultPolicyStateHandler

public interface PolicyStateHandler

State handler for policies execution. Keeps track of the operation associated with a certain context of execution. Such context of execution is defined by the unique identifier of the generated Event. Implementations will be executed concurrently but always using different identifiers. There will be no concurrent invocation for the same identifier.

Since:

4.0

Method Summary

Modifier and Type	Method and Description
void	destroyState(String executionIdentifier) Frees resources associated with the given context identifier
Optional<Event>	getLatestState(PolicyStateId identifier)
Processor	retrieveNextOperation(String executionIdentifier)
void	updateNextOperation(String executionIdentifier, Processor nextOperation) Associated the identifier with the policy next operation to execute
void	updateState(PolicyStateId identifier, Event lastStateEvent) Updates the event of the policy for the context with the given identifier.

Method Detail

updateNextOperation

void updateNextOperation(String executionIdentifier,
                         Processor nextOperation)

Associated the identifier with the policy next operation to execute

Parameters:

executionIdentifier - the identifier of the context

nextOperation - the next operation of the policy

retrieveNextOperation

Processor retrieveNextOperation(String executionIdentifier)

Parameters:

executionIdentifier - the identifier of the context

Returns:

the next operation for the context.

destroyState

void destroyState(String executionIdentifier)

Frees resources associated with the given context identifier

Parameters:

executionIdentifier - the identifier of the context

getLatestState

Optional<Event> getLatestState(PolicyStateId identifier)

Parameters:

identifier - the identifier of the context

Returns:

the latest state of the policy for the given identifier. It may be empty if no other policy was executed before for this context.

updateState

void updateState(PolicyStateId identifier,
                 Event lastStateEvent)

Updates the event of the policy for the context with the given identifier.

Parameters:

identifier - the identifier of the context

lastStateEvent - the last state of the event