jadex.micro

Class MicroAgentInterpreter

java.lang.Object

jadex.bridge.nonfunctional.NFPropertyProvider

jadex.kernelbase.StatelessAbstractInterpreter

jadex.kernelbase.AbstractInterpreter

jadex.micro.MicroAgentInterpreter

All Implemented Interfaces:

IComponentInstance, INFPropertyProvider

public class MicroAgentInterpreter
extends jadex.kernelbase.AbstractInterpreter

The micro agent interpreter is the connection between the agent platform and a user-written micro agent.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MicroAgentInterpreter.HandleMessageStep Step to handle a message.
static class	MicroAgentInterpreter.StepInfo Info struct for steps.

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE_STEP Constant for step event.

Fields inherited from class jadex.kernelbase.StatelessAbstractInterpreter

TYPE_COMPONENT

Constructor Summary

Constructors

Constructor and Description

MicroAgentInterpreter(IComponentDescription desc, IComponentAdapterFactory factory, MicroModel model, Class<?> microclass, Map<String,Object> args, String config, IExternalAccess parent, 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 agent.

Method Summary

Modifier and Type	Method and Description
void	addMessageHandler(IMessageHandler handler) Add a message handler.
void	afterBlock() Called after unblocking the component thread.
void	beforeBlock() Called before blocking the component thread.
IExternalAccess	createExternalAccess() Can be called concurrently (also during executeAction()).
IServiceContainer	createMyServiceContainer(Map args) Create the service container.
IServiceContainer	createServiceContainer() Create the service container.
boolean	executeStep() Can be called on the agent thread only.
MicroAgent	getAgent() Get the agent.
IComponentAdapter	getAgentAdapter() Get the agent adapter.
ClassLoader	getClassLoader() Get the class loader of the component.
IValueFetcher	getFetcher() Get the value fetcher.
IInternalAccess	getInternalAccess() Get the internal access.
MicroModel	getMicroModel() Get the micro model.
jadex.kernelbase.DefaultPersistInfo	getPersistableState() Get the persistable state.
Object	getPojoAgent() Get the pojo agent (or null if it has none).
Object	getStepDetails(IComponentStep step) Get the details of a step.
IFuture<Void>	initComponents(IModelInfo model, String config) Add extra init code after components.
IFuture<Void>	initProvidedServices(IModelInfo model, String config) Add extra init code before provided services.
boolean	isAtBreakpoint(String[] breakpoints) Test if the component's execution is currently at one of the given breakpoints.
void	messageArrived(IMessageAdapter message) Can be called concurrently (also during executeAction()).
void	removeMessageHandler(IMessageHandler handler) Remove a message handler.
<T> IFuture<T>	scheduleStep(IComponentStep<T> step) Schedule a step of the agent.
<T> IFuture<T>	scheduleStep(IComponentStep<T> step, long delay) Schedule a step of the component.
void	startBehavior() Start the component behavior.
IFuture<Void>	startEndSteps() Start the end steps of the component.
void	streamArrived(IConnection con) Can be called concurrently (also during executeAction()).
IFuture<Void>	terminateServiceContainer() Called from cleanupComponent.

Methods inherited from class jadex.kernelbase.AbstractInterpreter

addArgument, addDefaultResult, addExtension, addProperty, checkAllowedThread, 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, getCurrentStateEvents, getLocalType, getLogger, getName, getName, getNumber, getParent, getProperty, getRawService, getRawService, getRawServices, getServicePrefix, getServiceProvider, init, initArguments, initExtension, initExtensions, initFutureProperties, initRequiredServices, isComponentThread, isExternalThread, killComponent, publishEvent, publishEvent, startInitialSteps, startServiceContainer, terminateExtensions, 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

Field Detail

TYPE_STEP

public static final String TYPE_STEP

Constant for step event.

See Also:

Constant Field Values

Constructor Detail

MicroAgentInterpreter

public MicroAgentInterpreter(IComponentDescription desc,
                             IComponentAdapterFactory factory,
                             MicroModel model,
                             Class<?> microclass,
                             Map<String,Object> args,
                             String config,
                             IExternalAccess parent,
                             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 agent.

Parameters:

adapter - The adapter.

microagent - The microagent.

Method Detail

initProvidedServices

public IFuture<Void> initProvidedServices(IModelInfo model,
                                          String config)

Add extra init code before provided services.

Overrides:

initProvidedServices in class jadex.kernelbase.StatelessAbstractInterpreter

initComponents

public IFuture<Void> initComponents(IModelInfo model,
                                    String config)

Add extra init code after components.

Overrides:

initComponents in class jadex.kernelbase.StatelessAbstractInterpreter

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.

afterBlock

public void afterBlock()

Called after unblocking the component thread.

getFetcher

public IValueFetcher getFetcher()

Get the value fetcher.

Overrides:

getFetcher in class jadex.kernelbase.AbstractInterpreter

executeStep

public boolean executeStep()

Can be called on the agent thread only. Main method to perform agent execution. Whenever this method is called, the agent performs one of its scheduled actions. The platform can provide different execution models for agents (e.g. thread based, or synchronous). To avoid idle waiting, the return value can be checked. The platform guarantees that executeAction() 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.

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 component that a stream has arrived. Can be called concurrently (also during executeAction()).

Specified by:

streamArrived in interface IComponentInstance

Overrides:

streamArrived in class jadex.kernelbase.StatelessAbstractInterpreter

Parameters:

con - The stream 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

terminateServiceContainer

public IFuture<Void> terminateServiceContainer()

Called from cleanupComponent.

Overrides:

terminateServiceContainer 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.

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.

scheduleStep

public <T> IFuture<T> scheduleStep(IComponentStep<T> step,
                                   long delay)

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

Parameters:

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

delay - The delay to wait before step should be done.

Returns:

The result of the step.

getAgentAdapter

public IComponentAdapter getAgentAdapter()

Get the agent adapter.

Returns:

The agent adapter.

getPojoAgent

public Object getPojoAgent()

Get the pojo agent (or null if it has none).

Returns:

The pojo agent object.

addMessageHandler

public void addMessageHandler(IMessageHandler handler)

Add a message handler.

Parameters:

The - handler.

removeMessageHandler

public void removeMessageHandler(IMessageHandler handler)

Remove a message handler.

Parameters:

handler - The handler.

getInternalAccess

public IInternalAccess getInternalAccess()

Get the internal access.

Specified by:

getInternalAccess in class jadex.kernelbase.StatelessAbstractInterpreter

createExternalAccess

public IExternalAccess createExternalAccess()

Can be called concurrently (also during executeAction()). Get the external access for this component. The specific external access interface is kernel specific and has to be casted to its corresponding incarnation.

Overrides:

createExternalAccess in class jadex.kernelbase.AbstractInterpreter

Parameters:

listener - External access is delivered via result listener.

createServiceContainer

public IServiceContainer createServiceContainer()

Create the service container.

Overrides:

createServiceContainer in class jadex.kernelbase.AbstractInterpreter

Returns:

The service conainer.

createMyServiceContainer

public IServiceContainer createMyServiceContainer(Map args)

Create the service container.

Returns:

The service conainer.

getStepDetails

public Object getStepDetails(IComponentStep step)

Get the details of a step.

getClassLoader

public ClassLoader getClassLoader()

Get the class loader of the component. The component class loader is required to avoid incompatible class issues, when changing the platform class loader while components are running. This may occur e.g. when decoding messages and instantiating parameter values.

Specified by:

getClassLoader in interface IComponentInstance

Specified by:

getClassLoader in class jadex.kernelbase.StatelessAbstractInterpreter

Returns:

The component class loader.

getMicroModel

public MicroModel getMicroModel()

Get the micro model.

Returns:

The micro model.

getAgent

public MicroAgent getAgent()

Get the agent.

Returns:

The agent.

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.