io.seata.saga.engine.impl

Class ProcessCtrlStateMachineEngine

java.lang.Object

io.seata.saga.engine.impl.ProcessCtrlStateMachineEngine

All Implemented Interfaces:

StateMachineEngine

public class ProcessCtrlStateMachineEngine
extends Object
implements StateMachineEngine

ProcessCtrl-based state machine engine

Constructor Summary

Constructors

Constructor and Description
ProcessCtrlStateMachineEngine()

Method Summary

Modifier and Type	Method and Description
protected boolean	checkStatus(StateMachineInstance stateMachineInstance, ExecutionStatus[] acceptStatus, ExecutionStatus[] denyStatus, ExecutionStatus status, ExecutionStatus compenStatus, String operation) Check if the status is legal
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	compensateInternal(String stateMachineInstId, Map<String,Object> replaceParams, boolean async, AsyncCallback callback)
StateInstance	findOutLastForwardStateInstance(List<StateInstance> stateInstanceList) Find the last instance of the forward execution state
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
protected StateMachineInstance	forwardInternal(String stateMachineInstId, Map<String,Object> replaceParams, boolean skip, boolean async, AsyncCallback callback)
StateMachineConfig	getStateMachineConfig() get state machine configurations
StateMachineInstance	reloadStateMachineInstance(String instId) override state machine instance
protected Map<String,Object>	replayContextVariables(StateMachineInstance stateMachineInstance)
void	setStateMachineConfig(StateMachineConfig stateMachineConfig)
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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProcessCtrlStateMachineEngine

public ProcessCtrlStateMachineEngine()

Method Detail

start

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

Description copied from interface: StateMachineEngine

start a state machine instance

Specified by:

start in interface StateMachineEngine

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

startAsync

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

Description copied from interface: StateMachineEngine

start a state machine instance asynchronously

Specified by:

startAsync in interface StateMachineEngine

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

startWithBusinessKey

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

Description copied from interface: StateMachineEngine

start a state machine instance with businessKey

Specified by:

startWithBusinessKey in interface StateMachineEngine

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

startWithBusinessKeyAsync

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

Description copied from interface: StateMachineEngine

start a state machine instance asynchronously with businessKey

Specified by:

startWithBusinessKeyAsync in interface StateMachineEngine

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

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

Description copied from interface: StateMachineEngine

forward restart a failed state machine instance

Specified by:

forward in interface StateMachineEngine

Parameters:

stateMachineInstId - the state machine instance id

replaceParams - the replace params

Returns:

the state machine instance

Throws:

ForwardInvalidException - forward invalid exception

EngineExecutionException

forwardAsync

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

Description copied from interface: StateMachineEngine

forward restart a failed state machine instance asynchronously

Specified by:

forwardAsync in interface StateMachineEngine

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

EngineExecutionException

forwardInternal

protected StateMachineInstance forwardInternal(String stateMachineInstId,
                                               Map<String,Object> replaceParams,
                                               boolean skip,
                                               boolean async,
                                               AsyncCallback callback)
                                        throws EngineExecutionException

Throws:

EngineExecutionException

replayContextVariables

protected Map<String,Object> replayContextVariables(StateMachineInstance stateMachineInstance)

findOutLastForwardStateInstance

public StateInstance findOutLastForwardStateInstance(List<StateInstance> stateInstanceList)

Find the last instance of the forward execution state

Parameters:

stateInstanceList - the state instance list

Returns:

the state instance

compensate

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

Description copied from interface: StateMachineEngine

compensate a state machine instance

Specified by:

compensate in interface StateMachineEngine

Parameters:

stateMachineInstId - the state machine id

replaceParams - the replace params

Returns:

the state machine instance

Throws:

EngineExecutionException - the engin execution exception

compensateAsync

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

Description copied from interface: StateMachineEngine

compensate a state machine instance asynchronously

Specified by:

compensateAsync in interface StateMachineEngine

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

compensateInternal

public StateMachineInstance compensateInternal(String stateMachineInstId,
                                               Map<String,Object> replaceParams,
                                               boolean async,
                                               AsyncCallback callback)
                                        throws EngineExecutionException

Throws:

EngineExecutionException

skipAndForward

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

Description copied from interface: StateMachineEngine

skip current failed state instance and forward restart state machine instance

Specified by:

skipAndForward in interface StateMachineEngine

Parameters:

stateMachineInstId - the state machine instance id

Returns:

the state machine instance

Throws:

EngineExecutionException - the engine execution exception

skipAndForwardAsync

public StateMachineInstance skipAndForwardAsync(String stateMachineInstId,
                                                AsyncCallback callback)
                                         throws EngineExecutionException

Description copied from interface: StateMachineEngine

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

Specified by:

skipAndForwardAsync in interface StateMachineEngine

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

reloadStateMachineInstance

public StateMachineInstance reloadStateMachineInstance(String instId)

override state machine instance

Specified by:

reloadStateMachineInstance in interface StateMachineEngine

Parameters:

instId - the state instance id

Returns:

the state machine instance

checkStatus

protected boolean checkStatus(StateMachineInstance stateMachineInstance,
                              ExecutionStatus[] acceptStatus,
                              ExecutionStatus[] denyStatus,
                              ExecutionStatus status,
                              ExecutionStatus compenStatus,
                              String operation)

Check if the status is legal

Parameters:

stateMachineInstance - the state machine instance

acceptStatus - accept status

denyStatus - deny status

status - execution status

compenStatus - compensate status

operation - the operation

Returns:

the boolean

getStateMachineConfig

public StateMachineConfig getStateMachineConfig()

Description copied from interface: StateMachineEngine

get state machine configurations

Specified by:

getStateMachineConfig in interface StateMachineEngine

Returns:

the state machine configurations

setStateMachineConfig

public void setStateMachineConfig(StateMachineConfig stateMachineConfig)