SCXMLExecutionContext (Apache Commons SCXML 2.0-SNAPSHOT API)

java.lang.Object
- org.apache.commons.scxml2.SCXMLExecutionContext

All Implemented Interfaces:

SCXMLIOProcessor
```
public class SCXMLExecutionContext
extends Object
implements SCXMLIOProcessor
```
SCXMLExecutionContext provides all the services and internal data used during the interpretation of an SCXML statemachine across micro and macro steps

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SCXML_INVOKER_TYPE` Alias for `SCXML_INVOKER_TYPE_URI`
`static String`	`SCXML_INVOKER_TYPE_URI` Default and required supported SCXML Processor Invoker service URI

Fields inherited from interface org.apache.commons.scxml2.SCXMLIOProcessor
DEFAULT_EVENT_PROCESSOR, EVENT_PROCESSOR_ALIAS_PREFIX, INTERNAL_EVENT_PROCESSOR, PARENT_EVENT_PROCESSOR, SCXML_EVENT_PROCESSOR, SCXML_SESSION_EVENT_PROCESSOR_PREFIX

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`SCXMLExecutionContext(SCXMLExecutor scxmlExecutor, Evaluator evaluator, EventDispatcher eventDispatcher, ErrorReporter errorReporter)` Constructor

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addEvent(TriggerEvent event)` Add an event to the internal event queue
`protected void`	`attachInstance(SCInstance instance)` Re-attach a previously detached SCInstance.
`void`	`cancelInvoker(Invoke invoke)` Cancel and remove an active Invoker
`protected SCInstance`	`detachInstance()` Detach the current SCInstance to allow external serialization.
`ActionExecutionContext`	`getActionExecutionContext()`
`org.apache.commons.logging.Log`	`getAppLog()`
`ErrorReporter`	`getErrorReporter()`
`Evaluator`	`getEvaluator()`
`EventDispatcher`	`getEventDispatcher()`
`SCXMLIOProcessor`	`getExternalIOProcessor()`
`SCXMLIOProcessor`	`getInternalIOProcessor()`
`Map<Invoke,String>`	`getInvokeIds()`
`Invoker`	`getInvoker(Invoke invoke)` Get the `Invoker` for this `Invoke`.
`String`	`getLocation()` The SCXML specification section "C.1.1 _ioprocessors Value" states that the SCXMLEventProcessor must maintain a 'location' field inside its entry in the _ioprocessors environment variable.
`NotificationRegistry`	`getNotificationRegistry()`
`SCInstance`	`getScInstance()`
`SCXMLExecutor`	`getSCXMLExecutor()`
`SCXML`	`getStateMachine()`
`boolean`	`hasPendingInternalEvent()`
`void`	`initialize()` Initialize method which will cancel all current active Invokers, clear the internal event queue and mark the state machine process as running (again).
`protected void`	`initializeIOProcessors()` Initialize the _ioprocessors environment variable, which only can be done when the evaluator is available
`boolean`	`isCheckLegalConfiguration()`
`boolean`	`isRunning()`
`Invoker`	`newInvoker(String type)` Create a new `Invoker`
`TriggerEvent`	`nextInternalEvent()`
`void`	`registerInvoker(Invoke invoke, Invoker invoker)` Register the active `Invoker` for a `Invoke`
`protected void`	`registerInvokerClass(String type, Class<? extends Invoker> invokerClass)` Register an Invoker for this target type.
`void`	`removeInvoker(Invoke invoke)` Remove a previously active Invoker, which must already have been canceled
`void`	`setCheckLegalConfiguration(boolean checkLegalConfiguration)` Set if the SCXML configuration should be checked before execution (default = true)
`protected void`	`setErrorReporter(ErrorReporter errorReporter)` Set or replace the error reporter
`protected void`	`setEvaluator(Evaluator evaluator)` Set or replace the evaluator If the state machine instance has been initialized before, it will be initialized again, destroying all existing state!
`protected void`	`setEventdispatcher(EventDispatcher eventdispatcher)` Set or replace the event dispatch
`protected void`	`setStateMachine(SCXML stateMachine)` Set or replace the state machine to be executed If the state machine instance has been initialized before, it will be initialized again, destroying all existing state!
`void`	`stopRunning()` Stop a running state machine
`protected void`	`unregisterInvokerClass(String type)` Remove the Invoker registered for this target type (if there is one registered).

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SCXML_INVOKER_TYPE_URI
```
public static final String SCXML_INVOKER_TYPE_URI
```
    Default and required supported SCXML Processor Invoker service URI
    
    See Also:
    Constant Field Values
  - SCXML_INVOKER_TYPE
```
public static final String SCXML_INVOKER_TYPE
```
    Alias for SCXML_INVOKER_TYPE_URI
    
    See Also:
    Constant Field Values
- Constructor Detail
  - SCXMLExecutionContext
```
protected SCXMLExecutionContext(SCXMLExecutor scxmlExecutor,
                     Evaluator evaluator,
                     EventDispatcher eventDispatcher,
                     ErrorReporter errorReporter)
```
    Constructor
    
    Parameters:
    scxmlExecutor - The SCXMLExecutor of this SCXMLExecutionContext
    evaluator - The evaluator
    eventDispatcher - The event dispatcher, if null a SimpleDispatcher instance will be used
    errorReporter - The error reporter, if null a SimpleErrorReporter instance will be used
- Method Detail
  - getSCXMLExecutor
```
public SCXMLExecutor getSCXMLExecutor()
```
  - getExternalIOProcessor
```
public SCXMLIOProcessor getExternalIOProcessor()
```
  - getInternalIOProcessor
```
public SCXMLIOProcessor getInternalIOProcessor()
```
  - getActionExecutionContext
```
public ActionExecutionContext getActionExecutionContext()
```
    Returns:
    Returns the restricted execution context for actions
  - isRunning
```
public boolean isRunning()
```
    Returns:
    Returns true if this state machine is running
  - stopRunning
```
public void stopRunning()
```
    Stop a running state machine
  - setCheckLegalConfiguration
```
public void setCheckLegalConfiguration(boolean checkLegalConfiguration)
```
    Set if the SCXML configuration should be checked before execution (default = true)
    
    Parameters:
    checkLegalConfiguration - flag to set
  - isCheckLegalConfiguration
```
public boolean isCheckLegalConfiguration()
```
    Returns:
    if the SCXML configuration will be checked before execution
  - initialize
```
public void initialize()
                throws ModelException
```
    Initialize method which will cancel all current active Invokers, clear the internal event queue and mark the state machine process as running (again).
    
    Throws:
    
    ModelException - if the state machine instance failed to initialize.
  - getAppLog
```
public org.apache.commons.logging.Log getAppLog()
```
    Returns:
    Returns the SCXML Execution Logger for the application
  - getStateMachine
```
public SCXML getStateMachine()
```
    Returns:
    Returns the state machine
  - setStateMachine
```
protected void setStateMachine(SCXML stateMachine)
                        throws ModelException
```
    Set or replace the state machine to be executed
    If the state machine instance has been initialized before, it will be initialized again, destroying all existing state!
    
    Parameters:
    stateMachine - The state machine to set
    
    Throws:
    
    ModelException - if attempting to set a null value or the state machine instance failed to re-initialize
  - getLocation
```
public String getLocation()
```
    The SCXML specification section "C.1.1 _ioprocessors Value" states that the SCXMLEventProcessor must maintain a 'location' field inside its entry in the _ioprocessors environment variable.
    
    Returns:
    the 'location' of the SCXMLEventProcessor
  - getScInstance
```
public SCInstance getScInstance()
```
    Returns:
    Returns the SCInstance
  - getEvaluator
```
public Evaluator getEvaluator()
```
    Returns:
    Returns The evaluator.
  - setEvaluator
```
protected void setEvaluator(Evaluator evaluator)
                     throws ModelException
```
    Set or replace the evaluator
    If the state machine instance has been initialized before, it will be initialized again, destroying all existing state!
    
    Parameters:
    evaluator - The evaluator to set
    
    Throws:
    
    ModelException - if attempting to set a null value or the state machine instance failed to re-initialize
  - getErrorReporter
```
public ErrorReporter getErrorReporter()
```
    Returns:
    Returns the error reporter
  - setErrorReporter
```
protected void setErrorReporter(ErrorReporter errorReporter)
```
    Set or replace the error reporter
    
    Parameters:
    errorReporter - The error reporter to set, if null a SimpleErrorReporter instance will be used instead
  - getEventDispatcher
```
public EventDispatcher getEventDispatcher()
```
    Returns:
    Returns the event dispatcher
  - setEventdispatcher
```
protected void setEventdispatcher(EventDispatcher eventdispatcher)
```
    Set or replace the event dispatch
    
    Parameters:
    eventdispatcher - The event dispatcher to set, if null a SimpleDispatcher instance will be used instead
  - getNotificationRegistry
```
public NotificationRegistry getNotificationRegistry()
```
    Returns:
    Returns the notification registry
  - initializeIOProcessors
```
protected void initializeIOProcessors()
```
    Initialize the _ioprocessors environment variable, which only can be done when the evaluator is available
  - detachInstance
```
protected SCInstance detachInstance()
```
    Detach the current SCInstance to allow external serialization.
    attachInstance(SCInstance) can be used to re-attach a previously detached instance
    
    Returns:
    the detached instance
  - attachInstance
```
protected void attachInstance(SCInstance instance)
```
    Re-attach a previously detached SCInstance.
    Note: an already attached instance will get overwritten (and thus lost).
    
    Parameters:
    instance - An previously detached SCInstance
  - registerInvokerClass
```
protected void registerInvokerClass(String type,
                        Class<? extends Invoker> invokerClass)
```
    Register an Invoker for this target type.
    
    Parameters:
    type - The target type (specified by "type" attribute of the invoke element).
    invokerClass - The Invoker class.
  - unregisterInvokerClass
```
protected void unregisterInvokerClass(String type)
```
    Remove the Invoker registered for this target type (if there is one registered).
    
    Parameters:
    type - The target type (specified by "type" attribute of the invoke element).
  - newInvoker
```
public Invoker newInvoker(String type)
                   throws InvokerException
```
    Create a new Invoker
    
    Parameters:
    type - The type of the target being invoked.
    
    Returns:
    An Invoker for the specified type, if an invoker class is registered against that type, null otherwise.
    
    Throws:
    
    InvokerException - When a suitable Invoker cannot be instantiated.
  - getInvoker
```
public Invoker getInvoker(Invoke invoke)
```
    Get the Invoker for this Invoke. May return null. A non-null Invoker will be returned if and only if the Invoke parent TransitionalState is currently active and contains the <invoke> child.
    
    Parameters:
    invoke - The Invoke.
    
    Returns:
    The Invoker.
  - registerInvoker
```
public void registerInvoker(Invoke invoke,
                   Invoker invoker)
                     throws InvokerException
```
    Register the active Invoker for a Invoke
    
    Parameters:
    invoke - The Invoke.
    invoker - The Invoker.
    
    Throws:
    
    InvokerException - when the Invoker doesn't have an invokerId
  - removeInvoker
```
public void removeInvoker(Invoke invoke)
```
    Remove a previously active Invoker, which must already have been canceled
    
    Parameters:
    invoke - The Invoke for the Invoker to remove
  - getInvokeIds
```
public Map<Invoke,String> getInvokeIds()
```
    Returns:
    Returns the map of current active Invokes and their invokeId
  - cancelInvoker
```
public void cancelInvoker(Invoke invoke)
```
    Cancel and remove an active Invoker
    
    Parameters:
    invoke - The Invoke for the Invoker to cancel
  - addEvent
```
public void addEvent(TriggerEvent event)
```
    Add an event to the internal event queue
    
    Specified by:
    
    addEvent in interface SCXMLIOProcessor
    
    Parameters:
    event - The event
  - nextInternalEvent
```
public TriggerEvent nextInternalEvent()
```
    Returns:
    Returns the next event from the internal event queue, if available
  - hasPendingInternalEvent
```
public boolean hasPendingInternalEvent()
```
    Returns:
    Returns true if the internal event queue isn't empty

Class SCXMLExecutionContext

Field Summary

Fields inherited from interface org.apache.commons.scxml2.SCXMLIOProcessor

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SCXML_INVOKER_TYPE_URI

SCXML_INVOKER_TYPE

Constructor Detail

SCXMLExecutionContext

Method Detail

getSCXMLExecutor

getExternalIOProcessor

getInternalIOProcessor

getActionExecutionContext

isRunning

stopRunning

setCheckLegalConfiguration

isCheckLegalConfiguration

initialize

getAppLog

getStateMachine

setStateMachine

getLocation

getScInstance

getEvaluator

setEvaluator

getErrorReporter

setErrorReporter

getEventDispatcher

setEventdispatcher

getNotificationRegistry

initializeIOProcessors

detachInstance

attachInstance

registerInvokerClass

unregisterInvokerClass

newInvoker

getInvoker

registerInvoker

removeInvoker

getInvokeIds

cancelInvoker

addEvent

nextInternalEvent

hasPendingInternalEvent