com.nosolojava.fsm.runtime

Interface StateMachineEngine

public interface StateMachineEngine

Method Summary

Modifier and Type	Method and Description
void	endSession(String sessionId) When a FSM session finish this method is called to cleanup internal variables and to avoid more events to be processed.
void	forceShutdown()
Collection<Context>	getActiveSessions()
InvokeHandler	getInvokeHandler(String type)
Set<InvokeHandler>	getInvokeHandlers()
IOProcessor	getIOProcessor(String name)
Set<IOProcessor>	getIOProcessors()
FSMLogCallback	getLogCallback() Used to get the same logger as the fsm.
StateMachineParser	getParser()
Context	getSession(String sessionId) Get a session by id.
StateMachineFramework	getStateMachineFramework()
boolean	isSessionActive(String sessionId) Checks if there is an FSM session active with the indicated session id.
void	pushEvent(String sessionId, Event event) Look up the FSM session and push an event to its external event queue.
void	registerInvokeHandler(InvokeHandler invokeHandler)
void	registerIOProcessor(IOProcessor ioprocessor)
void	setContextFactory(ContextFactory contextFactory) This factory will be used when the engine starts a new fsm session
void	setLogCallback(FSMLogCallback logCallback) Used to change default log (useful in android).
void	setParser(StateMachineParser parser)
void	setStateMachineFramework(StateMachineFramework framework)
boolean	shutdownAndWait(long timeout, TimeUnit unit)
void	start()
Context	startFSMSession(String sessionId, String parentSessionId, URI fsmModelUri, Map<String,Serializable> initValues) Used to start a SCXML session when the session id is known.
Context	startFSMSession(String parentSessionId, URI fsmModelUri) Used to start a SCXML session with a parent session.
Context	startFSMSession(URI fsmModelUri) Used to start a SCXML session (normal scenario).
void	unRegisterInvokeHandler(String type)
void	unRegisterIOProcessor(String name)

Method Detail

start

void start()

forceShutdown

void forceShutdown()

shutdownAndWait

boolean shutdownAndWait(long timeout,
                        TimeUnit unit)
                 throws InterruptedException

Throws:

InterruptedException

startFSMSession

Context startFSMSession(URI fsmModelUri)
                 throws ConfigurationException,
                        IOException,
                        SCXMLParserException

Used to start a SCXML session (normal scenario).

Parameters:

fsmModelURI - FSM model source

Returns:

the current FSM config (after initialization)

Throws:

IOException

ConfigurationException

SCXMLParserException

startFSMSession

Context startFSMSession(String parentSessionId,
                        URI fsmModelUri)
                 throws ConfigurationException,
                        IOException,
                        SCXMLParserException

Used to start a SCXML session with a parent session.

Parameters:

parentSessionId - parent scxml session id (null could be passed if this doesn't apply

fsmModelURI - FSM model source

Returns:

the current FSM config (after initialization)

Throws:

IOException

ConfigurationException

SCXMLParserException

startFSMSession

Context startFSMSession(String sessionId,
                        String parentSessionId,
                        URI fsmModelUri,
                        Map<String,Serializable> initValues)
                 throws ConfigurationException,
                        IOException,
                        SCXMLParserException

Used to start a SCXML session when the session id is known. For example when an Invoke of type "scxml" is called.

Parameters:

sessionId - scxml session id

parentSessionId - parent scxml session id (null could be passed if this doesn't apply

fsmModelURI - FSM model source

initValues - invoke params used to initialize the called session

Returns:

the current FSM config (after initialization)

Throws:

ConfigurationException

IOException

SCXMLParserException

isSessionActive

boolean isSessionActive(String sessionId)

Checks if there is an FSM session active with the indicated session id.

Parameters:

sessionId -

Returns:

getActiveSessions

Collection<Context> getActiveSessions()

Returns:

the active sessions

getSession

Context getSession(String sessionId)

Get a session by id.

Parameters:

sessionId -

Returns:

endSession

void endSession(String sessionId)

When a FSM session finish this method is called to cleanup internal variables and to avoid more events to be processed.

Parameters:

sessionId -

pushEvent

void pushEvent(String sessionId,
               Event event)

Look up the FSM session and push an event to its external event queue.

Parameters:

sessionId -

event -

getIOProcessors

Set<IOProcessor> getIOProcessors()

getIOProcessor

IOProcessor getIOProcessor(String name)

registerIOProcessor

void registerIOProcessor(IOProcessor ioprocessor)

unRegisterIOProcessor

void unRegisterIOProcessor(String name)

getInvokeHandlers

Set<InvokeHandler> getInvokeHandlers()

getInvokeHandler

InvokeHandler getInvokeHandler(String type)

registerInvokeHandler

void registerInvokeHandler(InvokeHandler invokeHandler)

unRegisterInvokeHandler

void unRegisterInvokeHandler(String type)

setParser

void setParser(StateMachineParser parser)

getParser

StateMachineParser getParser()

setStateMachineFramework

void setStateMachineFramework(StateMachineFramework framework)

getStateMachineFramework

StateMachineFramework getStateMachineFramework()

setContextFactory

void setContextFactory(ContextFactory contextFactory)

This factory will be used when the engine starts a new fsm session

Parameters:

contextFactory -

setLogCallback

void setLogCallback(FSMLogCallback logCallback)

Used to change default log (useful in android).

Parameters:

logCallback -

getLogCallback

FSMLogCallback getLogCallback()

Used to get the same logger as the fsm.

Returns: