jadex.bridge

Interface IExternalAccess

All Superinterfaces:

INFPropertyProvider

All Known Subinterfaces:

IBDIExternalAccess, IMicroExternalAccess

All Known Implementing Classes:

jadex.kernelbase.ExternalAccess, MicroExternalAccess

public interface IExternalAccess
extends INFPropertyProvider

The interface for accessing components from the outside. Methods may be called from any thread, but the result listener will not be scheduled back to the calling thread!

Method Summary

Methods

Modifier and Type	Method and Description
IFuture<IComponentIdentifier>	createChild(ComponentInstanceInfo component) Create a subcomponent.
IFuture<Map<String,Object>>	getArguments() Get the arguments.
IFuture<IComponentIdentifier[]>	getChildren(String type) Get the children (if any) component identifiers.
IComponentIdentifier	getComponentIdentifier() Get the id of the component.
IFuture<IExtensionInstance>	getExtension(String name) Get a space of the application.
IFuture<String>	getFileName(String ctype) Get the model name of a component type.
String	getLocalType() Get the local type name of this component as defined in the parent.
IModelInfo	getModel() Get the model of the component.
IFuture<Map<String,Object>>	getResults() Get the component results.
IServiceProvider	getServiceProvider() Get the service provider.
IFuture<Map<String,Object>>	killComponent() Kill the component.
<T> IFuture<T>	scheduleImmediate(IComponentStep<T> step) Execute some code on the component's thread.
<T> IFuture<T>	scheduleImmediate(IComponentStep<T> step, long delay) Execute some code on the component's thread.
<T> IFuture<T>	scheduleStep(IComponentStep<T> step) Schedule a step of the component.
<T> IFuture<T>	scheduleStep(IComponentStep<T> step, long delay) Schedule a step of the component.
ISubscriptionIntermediateFuture<IMonitoringEvent>	subscribeToEvents(IFilter<IMonitoringEvent> filter, boolean initial, IMonitoringService.PublishEventLevel elm) Subscribe to component events.

Methods inherited from interface jadex.bridge.nonfunctional.INFPropertyProvider

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

Method Detail

getModel

IModelInfo getModel()

Get the model of the component.

Returns:

The model.

getComponentIdentifier

IComponentIdentifier getComponentIdentifier()

Get the id of the component.

Returns:

The component id.

getServiceProvider

IServiceProvider getServiceProvider()

Get the service provider.

Returns:

The service provider.

scheduleStep

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

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.

Returns:

The result of the step.

scheduleImmediate

<T> IFuture<T> scheduleImmediate(IComponentStep<T> step)

Execute some code on the component's thread. Unlike scheduleStep(), the action will also be executed while the component is suspended.

Parameters:

action - Code to be executed on the component's thread.

Returns:

The result of the step.

scheduleStep

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

scheduleImmediate

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

Execute some code on the component's thread. Unlike scheduleStep(), the action will also be executed while the component is suspended.

Parameters:

action - Code to be executed on the component's thread.

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

Returns:

The result of the step.

createChild

IFuture<IComponentIdentifier> createChild(ComponentInstanceInfo component)

Create a subcomponent.

Parameters:

component - The instance info.

killComponent

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

Kill the component.

getChildren

IFuture<IComponentIdentifier[]> getChildren(String type)

Get the children (if any) component identifiers.

Returns:

The children component identifiers.

getFileName

IFuture<String> getFileName(String ctype)

Get the model name of a component type.

Parameters:

ctype - The component type.

Returns:

The model name of this component type.

getLocalType

String getLocalType()

Get the local type name of this component as defined in the parent.

Returns:

The type of this component type.

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.

getResults

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

Get the component results.

Returns:

The results.

getArguments

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

Get the arguments.

Returns:

The arguments.

getExtension

IFuture<IExtensionInstance> getExtension(String name)

Get a space of the application.

Parameters:

name - The name of the space.

Returns:

The space.