jadex.bridge

Interface IInternalAccess

All Known Subinterfaces:

IBDIInternalAccess

All Known Implementing Classes:

BpmnInterpreter, BpmnPlanBodyInstance, KernelComponentAgent, KernelMicroAgent, KernelMultiAgent, MicroAgent, PojoMicroAgent

public interface IInternalAccess

Common interface for all component types. Is used when scheduleStep() is called and the executing thread is the component thread.

Method Summary

Methods

Modifier and Type	Method and Description
<T> IIntermediateResultListener<T>	createResultListener(IIntermediateResultListener<T> listener) Create a result listener that is executed on the component thread.
<T> IResultListener<T>	createResultListener(IResultListener<T> listener) Create a result listener that is executed on the component thread.
Map<String,Object>	getArguments() Get the arguments.
ClassLoader	getClassLoader() Get the class loader of the component.
IComponentDescription	getComponentDescription() Get the component description.
IComponentIdentifier	getComponentIdentifier() Get the id of the component.
String	getConfiguration() Get the configuration.
IExternalAccess	getExternalAccess() Get the external access.
IValueFetcher	getFetcher() Get the fetcher.
Logger	getLogger() Get the logger.
IModelInfo	getModel() Get the model of the component.
IExternalAccess	getParentAccess() Get the parent access (if any).
Map<String,Object>	getResults() Get the component results.
IServiceContainer	getServiceContainer() Get the service provider.
boolean	hasEventTargets(IMonitoringService.PublishTarget pt, IMonitoringService.PublishEventLevel pi) Check if event targets exist.
boolean	isComponentThread() Test if current thread is the component thread.
IFuture<Map<String,Object>>	killComponent() Kill the component.
IFuture<Void>	publishEvent(IMonitoringEvent event, IMonitoringService.PublishTarget pt) Publish a monitoring event.
void	setResultValue(String name, Object value) Set a result value.
ISubscriptionIntermediateFuture<IMonitoringEvent>	subscribeToEvents(IFilter<IMonitoringEvent> filter, boolean initial, IMonitoringService.PublishEventLevel elm) Subscribe to component events.
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.

Method Detail

getModel

IModelInfo getModel()

Get the model of the component.

Returns:

The model.

getConfiguration

String getConfiguration()

Get the configuration.

Returns:

The configuration.

getParentAccess

IExternalAccess getParentAccess()

Get the parent access (if any).

Returns:

The parent access.

getComponentIdentifier

IComponentIdentifier getComponentIdentifier()

Get the id of the component.

Returns:

The component id.

getComponentDescription

IComponentDescription getComponentDescription()

Get the component description.

Returns:

The component description.

getServiceContainer

IServiceContainer getServiceContainer()

Get the service provider.

Returns:

The service provider.

killComponent

IFuture<Map<String,Object>> killComponent()

Kill the component.

createResultListener

<T> IResultListener<T> createResultListener(IResultListener<T> listener)

Create a result listener that is executed on the component thread.

createResultListener

<T> IIntermediateResultListener<T> createResultListener(IIntermediateResultListener<T> listener)

Create a result listener that is executed on the component thread.

getExternalAccess

IExternalAccess getExternalAccess()

Get the external access.

Returns:

The external access.

getLogger

Logger getLogger()

Get the logger.

Returns:

The logger.

getFetcher

IValueFetcher getFetcher()

Get the fetcher.

Returns:

The fetcher.

getArguments

Map<String,Object> getArguments()

Get the arguments.

Returns:

The arguments.

getResults

Map<String,Object> getResults()

Get the component results.

Returns:

The results.

setResultValue

void setResultValue(String name,
                  Object value)

Set a result value.

Parameters:

name - The result name.

value - The result value.

getClassLoader

ClassLoader getClassLoader()

Get the class loader of the component.

waitForDelay

<T> IFuture<T> waitForDelay(long delay,
                          IComponentStep<T> step,
                          boolean realtime)

Wait for some time and execute a component step afterwards.

waitForDelay

<T> IFuture<T> waitForDelay(long delay,
                          IComponentStep<T> step)

Wait for some time and execute a component step afterwards.

waitForDelay

IFuture<Void> waitForDelay(long delay,
                         boolean realtime)

Wait for some time.

waitForDelay

IFuture<Void> waitForDelay(long delay)

Wait for some time.

isComponentThread

boolean isComponentThread()

Test if current thread is the component thread.

Returns:

True if the current thread is the component thread.

subscribeToEvents

ISubscriptionIntermediateFuture<IMonitoringEvent> subscribeToEvents(IFilter<IMonitoringEvent> filter,
                                                                  boolean initial,
                                                                  IMonitoringService.PublishEventLevel elm)

Subscribe to component events.

Parameters:

filter - An optional filter.

initial - True, for receiving the current state.

publishEvent

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

hasEventTargets

boolean hasEventTargets(IMonitoringService.PublishTarget pt,
                      IMonitoringService.PublishEventLevel pi)

Check if event targets exist.