jadex.bpmn.runtime

Class BpmnInterpreter

java.lang.Object

jadex.bridge.nonfunctional.NFPropertyProvider

jadex.kernelbase.StatelessAbstractInterpreter

jadex.kernelbase.AbstractInterpreter

jadex.bpmn.runtime.BpmnInterpreter

All Implemented Interfaces:

IComponentInstance, IInternalAccess, INFPropertyProvider

Direct Known Subclasses:

BpmnPlanBodyInstance

public class BpmnInterpreter
extends jadex.kernelbase.AbstractInterpreter
implements IInternalAccess

The bpmn interpreter is able to execute bpmn diagrams. Arguments are treated in BPMN as parameters, i.e. the argument values will be fed into corresponding parameters.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALL The flag for all pools.
static Map<String,IActivityHandler>	DEFAULT_ACTIVITY_HANDLERS The activity execution handlers (activity type -> handler).
static Map<String,IStepHandler>	DEFAULT_STEP_HANDLERS The step execution handlers (activity type -> handler).
static String	TYPE_ACTIVITY Constant for step event.
static String	TYPE_THREAD The change event prefix denoting a thread event.

Fields inherited from class jadex.kernelbase.StatelessAbstractInterpreter

TYPE_COMPONENT

Constructor Summary

Constructors

Constructor and Description
BpmnInterpreter(IComponentAdapter adapter, jadex.bpmn.model.MBpmnModel model, Map<String,Object> arguments, String config, IExternalAccess parent, Map<String,IActivityHandler> activityhandlers, Map<String,IStepHandler> stephandlers, IValueFetcher fetcher, IComponentManagementService cms, IClockService cs, IMessageService ms, IServiceContainer container, LocalServiceRegistry registry) Create a new bpmn process.
BpmnInterpreter(IComponentDescription desc, IComponentAdapterFactory factory, jadex.bpmn.model.MBpmnModel model, Map<String,Object> arguments, String config, IExternalAccess parent, Map<String,IActivityHandler> activityhandlers, Map<String,IStepHandler> stephandlers, IValueFetcher fetcher, RequiredServiceBinding[] bindings, ProvidedServiceInfo[] pinfos, boolean copy, boolean realtime, boolean persist, IPersistInfo persistinfo, IIntermediateResultListener<Tuple2<String,Object>> resultlistener, Future<Void> inited, LocalServiceRegistry registry) Create a new bpmn process.

Method Summary

Modifier and Type	Method and Description
void	afterBlock() Called after unblocking the component thread.
void	beforeBlock() Called before blocking the component thread.
IMonitoringEvent	createActivityEvent(String type, ProcessThread thread, jadex.bpmn.model.MActivity activity) Create an activity event (start, end).
ProcessThreadInfo	createProcessThreadInfo(ProcessThread thread) Create a new process thread info for logging / debug tools.
Map<String,Object>	createReply(IMessageAdapter msg) Create a reply to this message event.
Map<String,Object>	createReply(Map<String,Object> msg, MessageType mt) Create a reply to this message event.
IMonitoringEvent	createThreadEvent(String type, ProcessThread thread) Create a thread event (creation, modification, termination).
boolean	executeStep() Can be called on the component thread only.
void	executeStep(String pool, String lane) Execute one step of the process.
IActivityHandler	getActivityHandler(jadex.bpmn.model.MActivity activity) Get the activity handler for an activity.
ClassLoader	getClassLoader() Get the classloader.
Object	getContextVariable(String name) Get the value of the given context variable.
List<IMonitoringEvent>	getCurrentStateEvents() Get the current state as monitoring events.
IValueFetcher	getFetcher() Get the value fetcher.
IInternalAccess	getInternalAccess() Get the internal access.
jadex.bpmn.model.MBpmnModel	getModelElement() Get the model of the BPMN process instance.
jadex.kernelbase.DefaultPersistInfo	getPersistableState() Get the persistable state.
ProcessThread	getTopLevelThread() Get the top level thread (is not executed and just acts as top level thread container).
Map<String,Object>	getVariables() Get the variables.
boolean	hasContextVariable(String name) Test if the given context variable is declared.
IFuture<Void>	init(IModelInfo model, String config, Map<String,Object> arguments) Special init that is used to announce event start events to process engine (if any).
boolean	isAtBreakpoint(String[] breakpoints) Test if the component's execution is currently at one of the given breakpoints.
boolean	isFinished() Check, if the process has terminated.
boolean	isFinished(String pool, String lane) Check, if the process has terminated.
boolean	isReady() Check if the process is ready, i.e.
boolean	isReady(String pool, String lane) Check if the process is ready, i.e.
void	messageArrived(IMessageAdapter message) Can be called concurrently (also during executeAction()).
void	notify(jadex.bpmn.model.MActivity activity, ProcessThread thread, Object event) Method that should be called, when an activity is finished and the following activity should be scheduled.
<T> IFuture<T>	scheduleStep(IComponentStep<T> step) Schedule a step of the agent.
void	setContextVariable(String name, Object value) Set the value of the given context variable.
void	setContextVariable(String name, Object key, Object value) Set the value of the given context variable.
void	startBehavior() Start the component behavior.
IFuture<Void>	startEndSteps() Start the end steps of the component.
void	step(jadex.bpmn.model.MActivity activity, BpmnInterpreter instance, ProcessThread thread, Object event) Make a process step, i.e.
void	streamArrived(IConnection con) Can be called concurrently (also during executeAction()).

Methods inherited from class jadex.kernelbase.AbstractInterpreter

addArgument, addDefaultResult, addExtension, addProperty, checkAllowedThread, createServiceContainer, getArguments, getBindings, getComponentAdapter, getConfiguration, getExtension, getExtensions, getExternalAccess, getModel, getMonitoringServiceGetter, getParentAccess, getProperties, getProvidedServiceInfos, getPublishEmitLevelMonitoring, getPublishEmitLevelSubscriptions, getResults, getServiceContainer, getServiceRegistry, hasEventTargets, invalidateAccess, isCopy, isRealtime, publishLocalEvent, setResultValue, subscribeToEvents, subscribeToResults, terminateResultSubscribers

Methods inherited from class jadex.kernelbase.StatelessAbstractInterpreter

addService, cleanupComponent, componentCreated, componentDestroyed, createChild, createComponent, createInternalService, createResultListener, createResultListener, getArguments, getChildren, getComponentDescription, getComponentFilename, getComponentIdentifier, getLocalType, getLogger, getName, getName, getNumber, getParent, getProperty, getRawService, getRawService, getRawServices, getServicePrefix, getServiceProvider, initArguments, initComponents, initExtension, initExtensions, initFutureProperties, initProvidedServices, initRequiredServices, isComponentThread, isExternalThread, killComponent, publishEvent, publishEvent, startInitialSteps, startServiceContainer, terminateExtensions, terminateServiceContainer, toString, waitForDelay, waitForDelay, waitForDelay, waitForDelay

Methods inherited from class jadex.bridge.nonfunctional.NFPropertyProvider

addNFProperty, getNFAllPropertyNames, getNFPropertyMetaInfo, getNFPropertyMetaInfos, getNFPropertyNames, getNFPropertyValue, getNFPropertyValue, removeNFProperty, setParent, shutdownNFPropertyProvider

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface jadex.bridge.IInternalAccess

createResultListener, createResultListener, getArguments, getComponentDescription, getComponentIdentifier, getConfiguration, getExternalAccess, getLogger, getModel, getParentAccess, getResults, getServiceContainer, hasEventTargets, isComponentThread, killComponent, publishEvent, setResultValue, subscribeToEvents, waitForDelay, waitForDelay, waitForDelay, waitForDelay

Field Detail

TYPE_ACTIVITY

public static final String TYPE_ACTIVITY

Constant for step event.

See Also:

Constant Field Values

TYPE_THREAD

public static final String TYPE_THREAD

The change event prefix denoting a thread event.

See Also:

Constant Field Values

DEFAULT_ACTIVITY_HANDLERS

public static final Map<String,IActivityHandler> DEFAULT_ACTIVITY_HANDLERS

The activity execution handlers (activity type -> handler).

DEFAULT_STEP_HANDLERS

public static final Map<String,IStepHandler> DEFAULT_STEP_HANDLERS

The step execution handlers (activity type -> handler).

ALL

public static final String ALL

The flag for all pools.

See Also:

Constant Field Values

Constructor Detail

BpmnInterpreter

public BpmnInterpreter(IComponentAdapter adapter,
                       jadex.bpmn.model.MBpmnModel model,
                       Map<String,Object> arguments,
                       String config,
                       IExternalAccess parent,
                       Map<String,IActivityHandler> activityhandlers,
                       Map<String,IStepHandler> stephandlers,
                       IValueFetcher fetcher,
                       IComponentManagementService cms,
                       IClockService cs,
                       IMessageService ms,
                       IServiceContainer container,
                       LocalServiceRegistry registry)

Create a new bpmn process.

Parameters:

adapter - The adapter.

BpmnInterpreter

public BpmnInterpreter(IComponentDescription desc,
                       IComponentAdapterFactory factory,
                       jadex.bpmn.model.MBpmnModel model,
                       Map<String,Object> arguments,
                       String config,
                       IExternalAccess parent,
                       Map<String,IActivityHandler> activityhandlers,
                       Map<String,IStepHandler> stephandlers,
                       IValueFetcher fetcher,
                       RequiredServiceBinding[] bindings,
                       ProvidedServiceInfo[] pinfos,
                       boolean copy,
                       boolean realtime,
                       boolean persist,
                       IPersistInfo persistinfo,
                       IIntermediateResultListener<Tuple2<String,Object>> resultlistener,
                       Future<Void> inited,
                       LocalServiceRegistry registry)

Create a new bpmn process.

Parameters:

adapter - The adapter.

Method Detail

init

public IFuture<Void> init(IModelInfo model,
                          String config,
                          Map<String,Object> arguments)

Special init that is used to announce event start events to process engine (if any).

Overrides:

init in class jadex.kernelbase.StatelessAbstractInterpreter

executeStep

public boolean executeStep()

Can be called on the component thread only. Main method to perform component execution. Whenever this method is called, the component performs one of its scheduled actions. The platform can provide different execution models for components (e.g. thread based, or synchronous). To avoid idle waiting, the return value can be checked. The platform guarantees that executeStep() will not be called in parallel.

Specified by:

executeStep in interface IComponentInstance

Specified by:

executeStep in class jadex.kernelbase.StatelessAbstractInterpreter

Returns:

True, when there are more actions waiting to be executed.

startBehavior

public void startBehavior()

Start the component behavior.

Specified by:

startBehavior in interface IComponentInstance

Overrides:

startBehavior in class jadex.kernelbase.StatelessAbstractInterpreter

beforeBlock

public void beforeBlock()

Called before blocking the component thread.

Specified by:

beforeBlock in interface IComponentInstance

afterBlock

public void afterBlock()

Called after unblocking the component thread.

Specified by:

afterBlock in interface IComponentInstance

messageArrived

public void messageArrived(IMessageAdapter message)

Can be called concurrently (also during executeAction()). Inform the agent that a message has arrived. Can be called concurrently (also during executeAction()).

Specified by:

messageArrived in interface IComponentInstance

Overrides:

messageArrived in class jadex.kernelbase.StatelessAbstractInterpreter

Parameters:

message - The message that arrived.

streamArrived

public void streamArrived(IConnection con)

Can be called concurrently (also during executeAction()). Inform the agent that a message has arrived. Can be called concurrently (also during executeAction()).

Specified by:

streamArrived in interface IComponentInstance

Overrides:

streamArrived in class jadex.kernelbase.StatelessAbstractInterpreter

Parameters:

message - The message that arrived.

startEndSteps

public IFuture<Void> startEndSteps()

Start the end steps of the component. Called as part of cleanup behavior.

Overrides:

startEndSteps in class jadex.kernelbase.StatelessAbstractInterpreter

isAtBreakpoint

public boolean isAtBreakpoint(String[] breakpoints)

Test if the component's execution is currently at one of the given breakpoints. If yes, the component will be suspended by the platform.

Specified by:

isAtBreakpoint in interface IComponentInstance

Specified by:

isAtBreakpoint in class jadex.kernelbase.StatelessAbstractInterpreter

Parameters:

breakpoints - An array of breakpoints.

Returns:

True, when some breakpoint is triggered.

getModelElement

public jadex.bpmn.model.MBpmnModel getModelElement()

Get the model of the BPMN process instance.

Returns:

The model.

getTopLevelThread

public ProcessThread getTopLevelThread()

Get the top level thread (is not executed and just acts as top level thread container).

isFinished

public boolean isFinished()

Check, if the process has terminated.

Parameters:

pool - The pool to be executed or null for any.

lane - The lane to be executed or null for any. Nested lanes may be addressed by dot-notation, e.g. 'OuterLane.InnerLane'.

Returns:

True, when the process instance is finished with regards to the specified pool/lane. When both pool and lane are null, true is returned only when all pools/lanes are finished.

isFinished

public boolean isFinished(String pool,
                          String lane)

Check, if the process has terminated.

Parameters:

pool - The pool to be executed or null for any.

lane - The lane to be executed or null for any. Nested lanes may be addressed by dot-notation, e.g. 'OuterLane.InnerLane'.

Returns:

True, when the process instance is finished with regards to the specified pool/lane. When both pool and lane are null, true is returned only when all pools/lanes are finished.

executeStep

public void executeStep(String pool,
                        String lane)

Execute one step of the process.

Parameters:

pool - The pool to be executed or null for any.

lane - The lane to be executed or null for any. Nested lanes may be addressed by dot-notation, e.g. 'OuterLane.InnerLane'.

isReady

public boolean isReady()

Check if the process is ready, i.e. if at least one process thread can currently execute a step.

Parameters:

pool - The pool to be executed or null for any.

lane - The lane to be executed or null for any. Nested lanes may be addressed by dot-notation, e.g. 'OuterLane.InnerLane'.

isReady

public boolean isReady(String pool,
                       String lane)

Check if the process is ready, i.e. if at least one process thread can currently execute a step.

Parameters:

pool - The pool to be executed or null for any.

lane - The lane to be executed or null for any. Nested lanes may be addressed by dot-notation, e.g. 'OuterLane.InnerLane'.

notify

public void notify(jadex.bpmn.model.MActivity activity,
                   ProcessThread thread,
                   Object event)

Method that should be called, when an activity is finished and the following activity should be scheduled. Can safely be called from external threads.

Parameters:

activity - The timing event activity.

instance - The process instance.

thread - The process thread.

event - The event that has occurred, if any.

getActivityHandler

public IActivityHandler getActivityHandler(jadex.bpmn.model.MActivity activity)

Get the activity handler for an activity.

Parameters:

actvity - The activity.

Returns:

The activity handler.

step

public void step(jadex.bpmn.model.MActivity activity,
                 BpmnInterpreter instance,
                 ProcessThread thread,
                 Object event)

Make a process step, i.e. find the next edge or activity for a just executed thread.

Parameters:

activity - The activity to execute.

instance - The process instance.

thread - The process thread.

hasContextVariable

public boolean hasContextVariable(String name)

Test if the given context variable is declared.

Parameters:

name - The variable name.

Returns:

True, if the variable is declared.

getContextVariable

public Object getContextVariable(String name)

Get the value of the given context variable.

Parameters:

name - The variable name.

Returns:

The variable value.

setContextVariable

public void setContextVariable(String name,
                               Object value)

Set the value of the given context variable.

Parameters:

name - The variable name.

value - The variable value.

setContextVariable

public void setContextVariable(String name,
                               Object key,
                               Object value)

Set the value of the given context variable.

Parameters:

name - The variable name.

value - The variable value.

scheduleStep

public <T> IFuture<T> scheduleStep(IComponentStep<T> step)

Schedule a step of the agent. May safely be called from external threads.

Specified by:

scheduleStep in class jadex.kernelbase.StatelessAbstractInterpreter

Parameters:

step - Code to be executed as a step of the agent.

Returns:

The result of the step.

createProcessThreadInfo

public ProcessThreadInfo createProcessThreadInfo(ProcessThread thread)

Create a new process thread info for logging / debug tools.

getFetcher

public IValueFetcher getFetcher()

Get the value fetcher.

Specified by:

getFetcher in interface IInternalAccess

Overrides:

getFetcher in class jadex.kernelbase.AbstractInterpreter

Returns:

The fetcher.

getInternalAccess

public IInternalAccess getInternalAccess()

Get the internal access.

Specified by:

getInternalAccess in class jadex.kernelbase.StatelessAbstractInterpreter

createReply

public Map<String,Object> createReply(IMessageAdapter msg)

Create a reply to this message event.

Parameters:

msgeventtype - The message event type.

Returns:

The reply event.

createReply

public Map<String,Object> createReply(Map<String,Object> msg,
                                      MessageType mt)

Create a reply to this message event.

Parameters:

msgeventtype - The message event type.

Returns:

The reply event.

createThreadEvent

public IMonitoringEvent createThreadEvent(String type,
                                          ProcessThread thread)

Create a thread event (creation, modification, termination).

createActivityEvent

public IMonitoringEvent createActivityEvent(String type,
                                            ProcessThread thread,
                                            jadex.bpmn.model.MActivity activity)

Create an activity event (start, end).

getClassLoader

public ClassLoader getClassLoader()

Get the classloader.

Specified by:

getClassLoader in interface IComponentInstance

Specified by:

getClassLoader in interface IInternalAccess

Specified by:

getClassLoader in class jadex.kernelbase.StatelessAbstractInterpreter

Returns:

the classloader.

getCurrentStateEvents

public List<IMonitoringEvent> getCurrentStateEvents()

Get the current state as monitoring events.

Overrides:

getCurrentStateEvents in class jadex.kernelbase.StatelessAbstractInterpreter

getVariables

public Map<String,Object> getVariables()

Get the variables. return The variables.

getPersistableState

public jadex.kernelbase.DefaultPersistInfo getPersistableState()

Get the persistable state.

Specified by:

getPersistableState in interface IComponentInstance

Overrides:

getPersistableState in class jadex.kernelbase.StatelessAbstractInterpreter

Returns:

The persistable state.