IExecutionContext (MRules Javadoc 2.7.0 API)

All Superinterfaces:

IContext

All Known Implementing Classes:

AbstractExecutionContext, ExecutionContextWrapper, MCompilationContextConverter, MExecutionContext, MInOutExecutionContext, MListExecutionContext, MStandaloneExecutionContext
```
public interface IExecutionContext
extends IContext
```
Base methods for execution contexts.
The Execution context will hold all useful data required by execution, for example input / output beans, variables values, cache, and different state informations.
It's accessible by all rule engine components.

As it holds data dedicated to a single execution, an instance should not be used by different Threads: it could lead to unpredictable behaviors. All Thread should own their own instance of the context to run executions.
But, a context instance should be reused multiple times for several executions. All specific data are reset at the beginning of the execution process.

On the opposite, the Rule Set instance associated to the context is Thread safe and might be shared between several execution process without risks.

Field Summary

Fields
Modifier and Type Field and Description

static String DEFAULT_LOGGER_NAME
Default logger used for execution contexts.

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_LOGGER_NAME` Default logger used for execution contexts.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`debug(String msg)` Writes a debug message.
`void`	`debugEntering()` Forces to enter a log sub-phase without logging any message.
`void`	`debugEntering(String msg)` Increments Debug Level : When entering into a sub-phase.
`void`	`debugExiting()` Forces to exit a log sub-phase without logging any message.
`void`	`debugExiting(String msg)` Decreases Debug Level : When exiting from a sub-phase.
`void`	`debugParent(String msg)` Writes a debug message indented once less (if possible).
`void`	`debugSub(String msg)` Writes a debug message indented once more.
`IExecutionResult`	`execute()` Convenience method to execute the MRuleExecutionSet of this context with this context.
`Object`	`getCachedData(IAddon a)` Retrieves data cached by `setCachedData(IAddon, Object)`.
`ExtPropertySource`	`getCachedPropertySource(Object src)` Internal use only: Drastically disminuish memory footprint by caching Property Source Object.
`ExtPropertySource`	`getCachedPropertySource(Object src, Class<?> defaultSrcType)` Internal use only: Drastically disminuish memory footprint by caching Property Source Object.
`Appendable`	`getErr()`
`String`	`getLogSpaces()` Get spaces corresponding to stack level.
`Appendable`	`getOut()`
`String`	`getParentLogSpaces()` Get spaces corresponding to stack level indented once less (if possible).
`Object`	`getReadBase()` Returns base object for property read access.
`IExecutionContext`	`getRootContext()` In case of sub context usage, this allows to access the root context.
`MExecutionContext<Object>`	`getSubContextForNewBases(Object newBases)` Gets a new Execution Context instance, modifying the following behaviours : Read and write bases are the provided newBases Cache is disabled
`MInOutExecutionContext<Object,Object>`	`getSubContextForNewBases(Object newReadBase, Object newWriteBase)` Gets a new Execution Context instance, modifying the following behaviours : Read and write bases are the provided newReadBase and newWriteBase Cache is disabled
`MInOutExecutionContext<Object,Object>`	`getSubContextForNewVariables()` Gets a new Execution Context instance, modifying the following behaviours : Variables repository is different
`String`	`getSubLogSpaces()` Get spaces corresponding to stack level indented once more.
`Object`	`getWriteBase()` Returns base object for property write access.
`boolean`	`hasCachedData(IAddon a)` Tells if data are cached by `setCachedData(IAddon, Object)`, included null value.
`void`	`init()` INTERNAL USE ONLY: Called by rule engine to initialize and check before execution.
`boolean`	`isDebugEnabled()` Debug is enabled if LOGGER has debug enabled.
`void`	`resetCachedData()` Resets all cached data for all addons.
`Object`	`resetCachedData(IAddon a)` Resets cached data for one addons, returning previously cached data.
`Object`	`setCachedData(IAddon a, Object o)` Allows to cache data for a given addon.

Methods inherited from interface com.massa.mrules.context.IContext
getExecutionSet, getImports, getLog, getPhase, getReadBaseType, getSecurityManager, getVariables, getWriteBaseType, setExecutionSet, setLoggerName

- Field Detail
  - DEFAULT_LOGGER_NAME
```
static final String DEFAULT_LOGGER_NAME
```
    Default logger used for execution contexts.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getLogSpaces
```
String getLogSpaces()
```
    Get spaces corresponding to stack level.
  - getSubLogSpaces
```
String getSubLogSpaces()
```
    Get spaces corresponding to stack level indented once more.
  - getParentLogSpaces
```
String getParentLogSpaces()
```
    Get spaces corresponding to stack level indented once less (if possible).
  - debugEntering
```
void debugEntering()
```
    Forces to enter a log sub-phase without logging any message.
  - debugEntering
```
void debugEntering(String msg)
```
    Increments Debug Level : When entering into a sub-phase.
  - debug
```
void debug(String msg)
```
    Writes a debug message.
  - debugSub
```
void debugSub(String msg)
```
    Writes a debug message indented once more.
  - debugParent
```
void debugParent(String msg)
```
    Writes a debug message indented once less (if possible).
  - debugExiting
```
void debugExiting()
```
    Forces to exit a log sub-phase without logging any message.
  - debugExiting
```
void debugExiting(String msg)
```
    Decreases Debug Level : When exiting from a sub-phase.
  - isDebugEnabled
```
boolean isDebugEnabled()
```
    Debug is enabled if LOGGER has debug enabled.
  - execute
```
IExecutionResult execute()
                  throws MExecutionException
```
    Convenience method to execute the MRuleExecutionSet of this context with this context.
    
    Returns:
    
    ExecutionResultState of the execution.
    
    Throws:
    
    MExecutionException
  - init
```
void init()
   throws MExecutionException
```
    INTERNAL USE ONLY: Called by rule engine to initialize and check before execution.
    
    Throws:
    
    MExecutionException
  - setCachedData
```
Object setCachedData(IAddon a,
                     Object o)
```
    Allows to cache data for a given addon. Two identical instances have the same cache space. The cached data lives during the current execution only.
    
    Returns:
    
    previously cached data.
  - getCachedData
```
Object getCachedData(IAddon a)
```
    Retrieves data cached by setCachedData(IAddon, Object).
  - hasCachedData
```
boolean hasCachedData(IAddon a)
```
    Tells if data are cached by setCachedData(IAddon, Object), included null value.
  - resetCachedData
```
Object resetCachedData(IAddon a)
```
    Resets cached data for one addons, returning previously cached data.
    To force an addon instance to reset its cached data, please call the IAddon.resetCachedData(IExecutionContext).
    
    Returns:
    
    previously cached data.
  - resetCachedData
```
void resetCachedData()
```
    Resets all cached data for all addons.
  - getOut
```
Appendable getOut()
```
    Returns:
    
    Standard output stream for this context, dedicated to executables which print outputs. No log should be printed here. Defaults to System.out.
  - getErr
```
Appendable getErr()
```
    Returns:
    
    Error output stream for this context, dedicated to executables which print outputs. No log should be printed here. Defaults to System.err.
  - getCachedPropertySource
```
ExtPropertySource getCachedPropertySource(Object src)
```
    Internal use only: Drastically disminuish memory footprint by caching Property Source Object.
    
    Since:
    
    1.3.0
  - getCachedPropertySource
```
ExtPropertySource getCachedPropertySource(Object src,
                                          Class<?> defaultSrcType)
```
    Internal use only: Drastically disminuish memory footprint by caching Property Source Object.
    
    Since:
    
    1.9.0
  - getReadBase
```
Object getReadBase()
```
    Returns base object for property read access.
  - getWriteBase
```
Object getWriteBase()
```
    Returns base object for property write access.
  - getSubContextForNewBases
```
MExecutionContext<Object> getSubContextForNewBases(Object newBases)
```
    Gets a new Execution Context instance, modifying the following behaviours :
    - Read and write bases are the provided newBases
    - Cache is disabled
  - getSubContextForNewBases
```
MInOutExecutionContext<Object,Object> getSubContextForNewBases(Object newReadBase,
                                                               Object newWriteBase)
```
    Gets a new Execution Context instance, modifying the following behaviours :
    - Read and write bases are the provided newReadBase and newWriteBase
    - Cache is disabled
  - getSubContextForNewVariables
```
MInOutExecutionContext<Object,Object> getSubContextForNewVariables()
```
    Gets a new Execution Context instance, modifying the following behaviours :
    - Variables repository is different
  - getRootContext
```
IExecutionContext getRootContext()
```
    Description copied from interface: IContext
    
    In case of sub context usage, this allows to access the root context.
    Calling this method on the root context returns the root context.
    
    Specified by:
    
    getRootContext in interface IContext
    
    Returns:
    
    The root context

Interface IExecutionContext

Field Summary

Method Summary

Methods inherited from interface com.massa.mrules.context.IContext

Field Detail

DEFAULT_LOGGER_NAME

Method Detail

getLogSpaces

getSubLogSpaces

getParentLogSpaces

debugEntering

debugEntering

debug

debugSub

debugParent

debugExiting

debugExiting

isDebugEnabled

execute

init

setCachedData

getCachedData

hasCachedData

resetCachedData

resetCachedData

getOut

getErr

getCachedPropertySource

getCachedPropertySource

getReadBase

getWriteBase

getSubContextForNewBases

getSubContextForNewBases

getSubContextForNewVariables

getRootContext