io.seata.saga.engine

Interface StateMachineEngine

All Known Implementing Classes:

ProcessCtrlStateMachineEngine

public interface StateMachineEngine

State machine engine

Method Summary

Modifier and Type	Method and Description
StateMachineInstance	compensate(String stateMachineInstId, Map<String,Object> replaceParams) compensate a state machine instance
StateMachineInstance	compensateAsync(String stateMachineInstId, Map<String,Object> replaceParams, AsyncCallback callback) compensate a state machine instance asynchronously
StateMachineInstance	forward(String stateMachineInstId, Map<String,Object> replaceParams) forward restart a failed state machine instance
StateMachineInstance	forwardAsync(String stateMachineInstId, Map<String,Object> replaceParams, AsyncCallback callback) forward restart a failed state machine instance asynchronously
StateMachineConfig	getStateMachineConfig() get state machine configurations
StateMachineInstance	reloadStateMachineInstance(String instId) Reload StateMachine Instance
StateMachineInstance	skipAndForward(String stateMachineInstId, Map<String,Object> replaceParams) skip current failed state instance and forward restart state machine instance
StateMachineInstance	skipAndForwardAsync(String stateMachineInstId, AsyncCallback callback) skip current failed state instance and forward restart state machine instance asynchronously
StateMachineInstance	start(String stateMachineName, String tenantId, Map<String,Object> startParams) start a state machine instance
StateMachineInstance	startAsync(String stateMachineName, String tenantId, Map<String,Object> startParams, AsyncCallback callback) start a state machine instance asynchronously
StateMachineInstance	startWithBusinessKey(String stateMachineName, String tenantId, String businessKey, Map<String,Object> startParams) start a state machine instance with businessKey
StateMachineInstance	startWithBusinessKeyAsync(String stateMachineName, String tenantId, String businessKey, Map<String,Object> startParams, AsyncCallback callback) start a state machine instance asynchronously with businessKey

Method Detail

start

StateMachineInstance start(String stateMachineName,
                           String tenantId,
                           Map<String,Object> startParams)
                    throws EngineExecutionException

start a state machine instance

Parameters:

stateMachineName - the state machine name

tenantId - the tenant id

startParams - the start params

Returns:

the state machine instance

Throws:

EngineExecutionException - the engine execution exception

startWithBusinessKey

StateMachineInstance startWithBusinessKey(String stateMachineName,
                                          String tenantId,
                                          String businessKey,
                                          Map<String,Object> startParams)
                                   throws EngineExecutionException

start a state machine instance with businessKey

Parameters:

stateMachineName - the state machine name

tenantId - the tenant id

businessKey - the businessKey

startParams - the start params

Returns:

the state machine instance

Throws:

EngineExecutionException - the engine execution exception

startAsync

StateMachineInstance startAsync(String stateMachineName,
                                String tenantId,
                                Map<String,Object> startParams,
                                AsyncCallback callback)
                         throws EngineExecutionException

start a state machine instance asynchronously

Parameters:

stateMachineName - the state machine name

tenantId - the tenant id

startParams - the start params

callback - callback after start machine

Returns:

the state machine instance

Throws:

EngineExecutionException - the engine execution exception

startWithBusinessKeyAsync

StateMachineInstance startWithBusinessKeyAsync(String stateMachineName,
                                               String tenantId,
                                               String businessKey,
                                               Map<String,Object> startParams,
                                               AsyncCallback callback)
                                        throws EngineExecutionException

start a state machine instance asynchronously with businessKey

Parameters:

stateMachineName - the state machine name

tenantId - the tenant id

businessKey - the businessKey

startParams - the start params

callback - the callback after start a state machine

Returns:

the state machine instance

Throws:

EngineExecutionException - the engine execution exception

forward

StateMachineInstance forward(String stateMachineInstId,
                             Map<String,Object> replaceParams)
                      throws ForwardInvalidException

forward restart a failed state machine instance

Parameters:

stateMachineInstId - the state machine instance id

replaceParams - the replace params

Returns:

the state machine instance

Throws:

ForwardInvalidException - forward invalid exception

forwardAsync

StateMachineInstance forwardAsync(String stateMachineInstId,
                                  Map<String,Object> replaceParams,
                                  AsyncCallback callback)
                           throws ForwardInvalidException

forward restart a failed state machine instance asynchronously

Parameters:

stateMachineInstId - the state machine instance id

replaceParams - the replace params

callback - callback after forward restart a failed state machine

Returns:

the state machine instance

Throws:

ForwardInvalidException - the forward invalid exception

compensate

StateMachineInstance compensate(String stateMachineInstId,
                                Map<String,Object> replaceParams)
                         throws EngineExecutionException

compensate a state machine instance

Parameters:

stateMachineInstId - the state machine id

replaceParams - the replace params

Returns:

the state machine instance

Throws:

EngineExecutionException - the engin execution exception

compensateAsync

StateMachineInstance compensateAsync(String stateMachineInstId,
                                     Map<String,Object> replaceParams,
                                     AsyncCallback callback)
                              throws EngineExecutionException

compensate a state machine instance asynchronously

Parameters:

stateMachineInstId - the state machine instance id

replaceParams - the replace params

callback - callback after compensate a failed state machine

Returns:

the state machine instance

Throws:

EngineExecutionException - the engine execution exception

skipAndForward

StateMachineInstance skipAndForward(String stateMachineInstId,
                                    Map<String,Object> replaceParams)
                             throws EngineExecutionException

skip current failed state instance and forward restart state machine instance

Parameters:

stateMachineInstId - the state machine instance id

Returns:

the state machine instance

Throws:

EngineExecutionException - the engine execution exception

skipAndForwardAsync

StateMachineInstance skipAndForwardAsync(String stateMachineInstId,
                                         AsyncCallback callback)
                                  throws EngineExecutionException

skip current failed state instance and forward restart state machine instance asynchronously

Parameters:

stateMachineInstId - the state machine instance id

callback - callback after skip and forward restart a failed state machine

Returns:

the state machine instance

Throws:

EngineExecutionException - the engine execution exception

getStateMachineConfig

StateMachineConfig getStateMachineConfig()

get state machine configurations

Returns:

the state machine configurations

reloadStateMachineInstance

StateMachineInstance reloadStateMachineInstance(String instId)

Reload StateMachine Instance

Parameters:

instId - the state machine instance id

Returns:

the state machine instance