MicroAgent (Jadex Active Component Platform 2.4 API.)

java.lang.Object
- jadex.micro.MicroAgent

All Implemented Interfaces:

IInternalAccess, IMicroAgent

Direct Known Subclasses:

KernelComponentAgent, KernelMicroAgent, KernelMultiAgent, PojoMicroAgent
```
public class MicroAgent
extends Object
implements IMicroAgent, IInternalAccess
```
Base class for application agents.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class MicroAgent.ExecuteWaitForStep
Step to execute a wait for entry.

Nested Classes
Modifier and Type	Class and Description
`static class`	`MicroAgent.ExecuteWaitForStep` Step to execute a wait for entry.

Constructor Summary

Constructors
Constructor and Description

MicroAgent()

Constructors
Constructor and Description
`MicroAgent()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addMessageHandler(IMessageHandler handler)` Add a message handler.
`IFuture<Void>`	`addService(String name, Class<?> type, Object service)` Add a service to the platform.
`IFuture<Void>`	`addService(String name, Class<?> type, Object service, PublishInfo pi)` Add a service to the platform.
`IFuture<Void>`	`addService(String name, Class<?> type, Object service, String proxytype)` Add a service to the platform.
`IFuture<Void>`	`agentCreated()` Called once after agent creation.
`IFuture<Void>`	`agentKilled()` Called just before the agent is removed from the platform.
`Map<String,Object>`	`createReply(Map<String,Object> msg, MessageType mt)` Create a reply to this message event.
`<T> IIntermediateResultListener<T>`	`createResultListener(IIntermediateResultListener<T> listener)` Create a result listener that is executed as an agent step.
`<T> IResultListener<T>`	`createResultListener(IResultListener<T> listener)` Create a result listener that is executed as an agent step.
`IServiceContainer`	`createServiceContainer(Map<String,Object> args)` May be overriden to provide a custom service container implementations.
`IFuture<Void>`	`executeBody()` Execute the functional body of the agent.
`IComponentAdapter`	`getAgentAdapter()` Get the agent adapter.
`String`	`getAgentName()` Get the agent name.
`Object`	`getArgument(String name)` Get an argument.
`Map<String,Object>`	`getArguments()` Get the arguments.
`ClassLoader`	`getClassLoader()` Get the class loader of the component.
`IComponentAdapter`	`getComponentAdapter()` Get the agent adapter.
`IComponentDescription`	`getComponentDescription()` Get the component description.
`IComponentIdentifier`	`getComponentIdentifier()` Get the agent identifier.
`String`	`getConfiguration()` Get the configuration.
`IExternalAccess`	`getExternalAccess()` Get the external access for this agent.
`IValueFetcher`	`getFetcher()` Get the fetcher.
`MicroAgentInterpreter`	`getInterpreter()` Get the interpreter.
`Logger`	`getLogger()` Get the logger.
`IModelInfo`	`getModel()` Get the model of the component.
`IFuture<INFPropertyMetaInfo>`	`getNfPropertyMetaInfo(String name)` Returns the meta information about a non-functional property of this service.
`IFuture<String[]>`	`getNonFunctionalPropertyNames()` Returns the names of all non-functional properties of this service.
`<T> IFuture<T>`	`getNonFunctionalPropertyValue(String name)` Returns the current value of a non-functional property of this service, performs unit conversion.
`<T,U> IFuture<T>`	`getNonFunctionalPropertyValue(String name, Class<U> unit)` Returns the current value of a non-functional property of this service, performs unit conversion.
`IExternalAccess`	`getParentAccess()` Get the parent component.
`Object`	`getProperty(String name)` Get a property.
`Object`	`getRawService(Class<?> type)` Get a raw reference to a provided service implementation.
`Object`	`getRawService(String name)` Get a raw reference to a provided service implementation.
`Object[]`	`getRawServices(Class<?> type)` Get a raw reference to a provided service implementation.
`<T> IFuture<T>`	`getRequiredService(String name)` Get a required service of a given name.
`INFMixedPropertyProvider`	`getRequiredServicePropertyProvider(IServiceIdentifier sid)` Get the required service property provider for a service.
`<T> ITerminableIntermediateFuture<T>`	`getRequiredServices(String name)` Get a required services of a given name.
`Map<String,Object>`	`getResults()` Get the component results.
`IServiceContainer`	`getServiceContainer()` Get the service container.
`IServiceProvider`	`getServiceProvider()` Get the service provider.
`IFuture<Long>`	`getTime()` Get the current time.
`boolean`	`hasEventTargets(IMonitoringService.PublishTarget pt, IMonitoringService.PublishEventLevel pi)` Check if event targets exist.
`boolean`	`hasRequiredServicePropertyProvider(IServiceIdentifier sid)` Has the service a property provider.
`void`	`init(MicroAgentInterpreter interpreter)` Init the micro agent with the interpreter.
`boolean`	`isAtBreakpoint(String[] breakpoints)` Test if the agent's execution is currently at one of the given breakpoints.
`boolean`	`isComponentThread()` Test if current thread is the component thread.
`IFuture<Map<String,Object>>`	`killAgent()` Kill the agent.
`IFuture<Map<String,Object>>`	`killComponent()` Kill the component.
`void`	`messageArrived(Map<String,Object> msg, MessageType mt)` Called, whenever a message is received.
`IFuture<Void>`	`publishEvent(IMonitoringEvent event, IMonitoringService.PublishTarget pt)` Publish a monitoring event.
`void`	`removeMessageHandler(IMessageHandler handler)` Remove a message handler.
`IFuture<Void>`	`removeService(IServiceIdentifier sid)` Removes a service from the platform (shutdowns also the service).
`<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 agent.
`IFuture<Void>`	`sendMessage(Map<String,Object> me, MessageType mt)` Send a message.
`IFuture<Void>`	`sendMessage(Map<String,Object> me, MessageType mt, byte[] codecids)` Send a message.
`IFuture<Void>`	`sendMessageAndWait(Map<String,Object> me, MessageType mt, IMessageHandler handler)` Send a message and wait for a reply.
`void`	`setResultValue(String name, Object value)` Set a result value.
`void`	`streamArrived(IConnection con)` Called, whenever a stream is received.
`ISubscriptionIntermediateFuture<IMonitoringEvent>`	`subscribeToEvents(IFilter<IMonitoringEvent> filter, boolean initial, IMonitoringService.PublishEventLevel elm)` Subscribe to component events.
`IFuture<ITimer>`	`waitFor(long time, IComponentStep<Void> step)` Wait for an specified amount of time.
`IFuture<ITimer>`	`waitFor(long time, IComponentStep<Void> step, boolean realtime)` Wait for an specified amount of time.
`IFuture<Void>`	`waitForDelay(long delay)` Wait for some time.
`IFuture<Void>`	`waitForDelay(long delay, boolean realtime)` Wait for some time.
`<T> IFuture<T>`	`waitForDelay(long delay, IComponentStep<T> step)` Wait for some time and execute a component step afterwards.
`<T> IFuture<T>`	`waitForDelay(long delay, IComponentStep<T> step, boolean realtime)` Wait for some time and execute a component step afterwards.
`IFuture<MicroAgent.TimerWrapper>`	`waitForTick(IComponentStep<Void> run)` Wait for the next tick.

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

- Constructor Detail
  - MicroAgent
```
public MicroAgent()
```
- Method Detail
  - init
```
public void init(MicroAgentInterpreter interpreter)
```
    Init the micro agent with the interpreter.
    
    Parameters:
    interpreter - The interpreter.
  - agentCreated
```
public IFuture<Void> agentCreated()
```
    Called once after agent creation.
    
    Specified by:
    
    agentCreated in interface IMicroAgent
  - executeBody
```
public IFuture<Void> executeBody()
```
    Execute the functional body of the agent. Is only called once.
    
    Specified by:
    
    executeBody in interface IMicroAgent
  - messageArrived
```
public void messageArrived(Map<String,Object> msg,
                  MessageType mt)
```
    Called, whenever a message is received.
    
    Specified by:
    
    messageArrived in interface IMicroAgent
    
    Parameters:
    msg - The message.
    mt - The message type.
  - streamArrived
```
public void streamArrived(IConnection con)
```
    Called, whenever a stream is received.
    
    Parameters:
    con - The stream.
  - agentKilled
```
public IFuture<Void> agentKilled()
```
    Called just before the agent is removed from the platform.
    
    Specified by:
    
    agentKilled in interface IMicroAgent
    
    Returns:
    The result of the component.
  - getProperty
```
public Object getProperty(String name)
```
    Get a property.
    
    Parameters:
    name - The name of the property.
    
    Returns:
    The property value or null.
  - getServiceProvider
```
public IServiceProvider getServiceProvider()
```
    Get the service provider.
    
    Returns:
    The service provider.
  - getServiceContainer
```
public IServiceContainer getServiceContainer()
```
    Get the service container. Internal method for accessing the service container.
    
    Specified by:
    
    getServiceContainer in interface IInternalAccess
    
    Returns:
    The service container.
  - isAtBreakpoint
```
public boolean isAtBreakpoint(String[] breakpoints)
```
    Test if the agent's execution is currently at one of the given breakpoints. If yes, the agent will be suspended by the platform. Available breakpoints can be specified in the micro agent meta info.
    
    Parameters:
    breakpoints - An array of breakpoints.
    
    Returns:
    True, when some breakpoint is triggered.
  - getExternalAccess
```
public IExternalAccess getExternalAccess()
```
    Get the external access for this agent.
    
    Specified by:
    
    getExternalAccess in interface IInternalAccess
    
    Returns:
    The external access.
  - getParentAccess
```
public IExternalAccess getParentAccess()
```
    Get the parent component.
    
    Specified by:
    
    getParentAccess in interface IInternalAccess
    
    Returns:
    The parent (if any).
  - getAgentAdapter
```
public IComponentAdapter getAgentAdapter()
```
    Get the agent adapter.
    
    Returns:
    The agent adapter. // todo: deprecated, all kernels should have getComponentAdapter?
  - getComponentAdapter
```
public IComponentAdapter getComponentAdapter()
```
    Get the agent adapter.
    
    Returns:
    The agent adapter.
  - getComponentDescription
```
public IComponentDescription getComponentDescription()
```
    Get the component description.
    
    Specified by:
    
    getComponentDescription in interface IInternalAccess
    
    Returns:
    The component description.
  - getArguments
```
public Map<String,Object> getArguments()
```
    Get the arguments.
    
    Specified by:
    
    getArguments in interface IInternalAccess
    
    Returns:
    The arguments.
  - getResults
```
public Map<String,Object> getResults()
```
    Get the component results.
    
    Specified by:
    
    getResults in interface IInternalAccess
    
    Returns:
    The results.
  - setResultValue
```
public void setResultValue(String name,
                  Object value)
```
    Set a result value.
    
    Specified by:
    
    setResultValue in interface IInternalAccess
    
    Parameters:
    name - The result name.
    value - The result value.
  - getArgument
```
public Object getArgument(String name)
```
    Get an argument.
    
    Parameters:
    name - The argument name.
    
    Returns:
    The value.
  - getConfiguration
```
public String getConfiguration()
```
    Get the configuration.
    
    Specified by:
    
    getConfiguration in interface IInternalAccess
    
    Returns:
    the Configuration.
  - getRawService
```
public Object getRawService(String name)
```
    Get a raw reference to a provided service implementation.
  - getRawService
```
public Object getRawService(Class<?> type)
```
    Get a raw reference to a provided service implementation.
  - getRawServices
```
public Object[] getRawServices(Class<?> type)
```
    Get a raw reference to a provided service implementation.
  - createResultListener
```
public <T> IResultListener<T> createResultListener(IResultListener<T> listener)
```
    Create a result listener that is executed as an agent step.
    
    Specified by:
    
    createResultListener in interface IInternalAccess
    
    Parameters:
    listener - The listener to be executed as an agent step.
  - createResultListener
```
public <T> IIntermediateResultListener<T> createResultListener(IIntermediateResultListener<T> listener)
```
    Create a result listener that is executed as an agent step.
    
    Specified by:
    
    createResultListener in interface IInternalAccess
    
    Parameters:
    listener - The listener to be executed as an agent step.
  - getTime
```
public IFuture<Long> getTime()
```
    Get the current time.
    
    Returns:
    The current time.
  - waitFor
```
public IFuture<ITimer> waitFor(long time,
                      IComponentStep<Void> step)
```
    Wait for an specified amount of time.
    
    Parameters:
    time - The time.
    step - The runnable.
  - waitFor
```
public IFuture<ITimer> waitFor(long time,
                      IComponentStep<Void> step,
                      boolean realtime)
```
    Wait for an specified amount of time.
    
    Parameters:
    time - The time.
    step - The runnable.
  - waitForTick
```
public IFuture<MicroAgent.TimerWrapper> waitForTick(IComponentStep<Void> run)
```
    Wait for the next tick.
    
    Parameters:
    time - The time.
  - getLogger
```
public Logger getLogger()
```
    Get the logger.
    
    Specified by:
    
    getLogger in interface IInternalAccess
    
    Returns:
    The logger.
  - killAgent
```
public IFuture<Map<String,Object>> killAgent()
```
    Kill the agent.
  - sendMessage
```
public IFuture<Void> sendMessage(Map<String,Object> me,
                        MessageType mt)
```
    Send a message.
    
    Parameters:
    me - The message content (name value pairs).
    mt - The message type describing the content.
  - sendMessage
```
public IFuture<Void> sendMessage(Map<String,Object> me,
                        MessageType mt,
                        byte[] codecids)
```
    Send a message.
    
    Parameters:
    me - The message content (name value pairs).
    mt - The message type describing the content.
  - sendMessageAndWait
```
public IFuture<Void> sendMessageAndWait(Map<String,Object> me,
                               MessageType mt,
                               IMessageHandler handler)
```
    Send a message and wait for a reply.
    
    Parameters:
    me - The message content (name value pairs).
    mt - The message type describing the content.
  - 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.
  - 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.
  - getAgentName
```
public String getAgentName()
```
    Get the agent name.
    
    Returns:
    The agent name.
  - getComponentIdentifier
```
public IComponentIdentifier getComponentIdentifier()
```
    Get the agent identifier.
    
    Specified by:
    
    getComponentIdentifier in interface IInternalAccess
    
    Returns:
    The agent identifier.
  - scheduleStep
```
public <T> IFuture<T> scheduleStep(IComponentStep<T> step)
```
    Schedule a step of the agent. May safely be called from external threads.
    
    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 agent. May safely be called from external threads.
    
    Parameters:
    step - Code to be executed as a step of the agent.
  - addService
```
public IFuture<Void> addService(String name,
                       Class<?> type,
                       Object service,
                       String proxytype)
```
    Add a service to the platform. If under the same name and type a service was contained, the old one is removed and shutdowned.
    
    Parameters:
    type - The public service interface.
    service - The service.
    type - The proxy type (@see{BasicServiceInvocationHandler}).
  - addService
```
public IFuture<Void> addService(String name,
                       Class<?> type,
                       Object service)
```
    Add a service to the platform. If under the same name and type a service was contained, the old one is removed and shutdowned.
    
    Parameters:
    type - The public service interface.
    service - The service.
  - addService
```
public IFuture<Void> addService(String name,
                       Class<?> type,
                       Object service,
                       PublishInfo pi)
```
    Add a service to the platform. If under the same name and type a service was contained, the old one is removed and shutdowned.
    
    Parameters:
    type - The public service interface.
    service - The service.
  - removeService
```
public IFuture<Void> removeService(IServiceIdentifier sid)
```
    Removes a service from the platform (shutdowns also the service).
    
    Parameters:
    service - The service.
  - waitForDelay
```
public <T> IFuture<T> waitForDelay(long delay,
                          IComponentStep<T> step)
```
    Wait for some time and execute a component step afterwards.
    
    Specified by:
    
    waitForDelay in interface IInternalAccess
  - waitForDelay
```
public <T> IFuture<T> waitForDelay(long delay,
                          IComponentStep<T> step,
                          boolean realtime)
```
    Wait for some time and execute a component step afterwards.
    
    Specified by:
    
    waitForDelay in interface IInternalAccess
  - waitForDelay
```
public IFuture<Void> waitForDelay(long delay)
```
    Wait for some time.
    
    Specified by:
    
    waitForDelay in interface IInternalAccess
  - waitForDelay
```
public IFuture<Void> waitForDelay(long delay,
                         boolean realtime)
```
    Wait for some time.
    
    Specified by:
    
    waitForDelay in interface IInternalAccess
  - getModel
```
public IModelInfo getModel()
```
    Get the model of the component.
    
    Specified by:
    
    getModel in interface IInternalAccess
    
    Returns:
    The model.
  - killComponent
```
public IFuture<Map<String,Object>> killComponent()
```
    Kill the component.
    
    Specified by:
    
    killComponent in interface IInternalAccess
  - getRequiredService
```
public <T> IFuture<T> getRequiredService(String name)
```
    Get a required service of a given name.
    
    Parameters:
    name - The service name.
    
    Returns:
    The service.
  - getRequiredServices
```
public <T> ITerminableIntermediateFuture<T> getRequiredServices(String name)
```
    Get a required services of a given name.
    
    Parameters:
    name - The services name.
    
    Returns:
    The service.
  - createServiceContainer
```
public IServiceContainer createServiceContainer(Map<String,Object> args)
```
    May be overriden to provide a custom service container implementations.
  - getFetcher
```
public IValueFetcher getFetcher()
```
    Get the fetcher.
    
    Specified by:
    
    getFetcher in interface IInternalAccess
    
    Returns:
    The fetcher.
  - getClassLoader
```
public ClassLoader getClassLoader()
```
    Get the class loader of the component.
    
    Specified by:
    
    getClassLoader in interface IInternalAccess
  - getInterpreter
```
public MicroAgentInterpreter getInterpreter()
```
    Get the interpreter.
    
    Returns:
    The interpreter.
  - isComponentThread
```
public boolean isComponentThread()
```
    Test if current thread is the component thread.
    
    Specified by:
    
    isComponentThread in interface IInternalAccess
    
    Returns:
    True if the current thread is the component thread.
  - publishEvent
```
public IFuture<Void> publishEvent(IMonitoringEvent event,
                         IMonitoringService.PublishTarget pt)
```
    Publish a monitoring event. This event is automatically send to the monitoring service of the platform (if any).
    
    Specified by:
    
    publishEvent in interface IInternalAccess
  - subscribeToEvents
```
public ISubscriptionIntermediateFuture<IMonitoringEvent> subscribeToEvents(IFilter<IMonitoringEvent> filter,
                                                                  boolean initial,
                                                                  IMonitoringService.PublishEventLevel elm)
```
    Subscribe to component events.
    
    Specified by:
    
    subscribeToEvents in interface IInternalAccess
    
    Parameters:
    filter - An optional filter.
    initial - True, for receiving the current state.
  - getNonFunctionalPropertyNames
```
public IFuture<String[]> getNonFunctionalPropertyNames()
```
    Returns the names of all non-functional properties of this service.
    
    Returns:
    The names of the non-functional properties of this service.
  - getNfPropertyMetaInfo
```
public IFuture<INFPropertyMetaInfo> getNfPropertyMetaInfo(String name)
```
    Returns the meta information about a non-functional property of this service.
    
    Parameters:
    name - Name of the property.
    
    Returns:
    The meta information about a non-functional property of this service.
  - getNonFunctionalPropertyValue
```
public <T> IFuture<T> getNonFunctionalPropertyValue(String name)
```
    Returns the current value of a non-functional property of this service, performs unit conversion.
    
    Parameters:
    name - Name of the property.
    type - Type of the property value.
    
    Returns:
    The current value of a non-functional property of this service.
  - getNonFunctionalPropertyValue
```
public <T,U> IFuture<T> getNonFunctionalPropertyValue(String name,
                                             Class<U> unit)
```
    Returns the current value of a non-functional property of this service, performs unit conversion.
    
    Parameters:
    name - Name of the property.
    type - Type of the property value.
    unit - Unit of the property value.
    
    Returns:
    The current value of a non-functional property of this service.
  - getRequiredServicePropertyProvider
```
public INFMixedPropertyProvider getRequiredServicePropertyProvider(IServiceIdentifier sid)
```
    Get the required service property provider for a service.
  - hasRequiredServicePropertyProvider
```
public boolean hasRequiredServicePropertyProvider(IServiceIdentifier sid)
```
    Has the service a property provider.
  - hasEventTargets
```
public boolean hasEventTargets(IMonitoringService.PublishTarget pt,
                      IMonitoringService.PublishEventLevel pi)
```
    Check if event targets exist.
    
    Specified by:
    
    hasEventTargets in interface IInternalAccess

Class MicroAgent

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MicroAgent

Method Detail

init

agentCreated

executeBody

messageArrived

streamArrived

agentKilled

getProperty

getServiceProvider

getServiceContainer

isAtBreakpoint

getExternalAccess

getParentAccess

getAgentAdapter

getComponentAdapter

getComponentDescription

getArguments

getResults

setResultValue

getArgument

getConfiguration

getRawService

getRawService

getRawServices

createResultListener

createResultListener

getTime

waitFor

waitFor

waitForTick

getLogger

killAgent

sendMessage

sendMessage

sendMessageAndWait

addMessageHandler

removeMessageHandler

createReply

getAgentName

getComponentIdentifier

scheduleStep

scheduleStep

addService

addService

addService

removeService

waitForDelay

waitForDelay

waitForDelay

waitForDelay

getModel

killComponent

getRequiredService

getRequiredServices

createServiceContainer

getFetcher

getClassLoader

getInterpreter

isComponentThread

publishEvent

subscribeToEvents

getNonFunctionalPropertyNames

getNfPropertyMetaInfo

getNonFunctionalPropertyValue

getNonFunctionalPropertyValue

getRequiredServicePropertyProvider

hasRequiredServicePropertyProvider

hasEventTargets