jadex.bridge

Interface IExternalAccess

public interface IExternalAccess

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

Modifier and Type	Method and Description
IFuture<IComponentIdentifier>	createChild(ComponentInstanceInfo component) Create a subcomponent.
IFuture<java.util.Map<java.lang.String,java.lang.Object>>	getArguments() Get the arguments.
IFuture<IComponentIdentifier[]>	getChildren(java.lang.String type) Get the children (if any) component identifiers.
IComponentIdentifier	getComponentIdentifier() Get the id of the component.
IFuture<java.lang.String>	getFileName(java.lang.String ctype) Get the model name of a component type.
java.lang.String	getLocalType() Get the local type name of this component as defined in the parent.
IModelInfo	getModel() Get the model of the component.
IFuture<java.util.Map<java.lang.String,java.lang.Object>>	getResults() Get the component results.
IExternalAccess	getServiceContainer() Deprecated. From version 3.0 - replaced with external access. Get the service container.
IExternalAccess	getServiceProvider() Deprecated. From version 3.0 - replaced with external access. Get the service provider.
boolean	isExternalThread() Test if current thread is an external thread.
IFuture<java.util.Map<java.lang.String,java.lang.Object>>	killComponent() Kill the component.
IFuture<java.util.Map<java.lang.String,java.lang.Object>>	killComponent(java.lang.Exception e) Kill the component.
<T> IFuture<T>	scheduleStep(IComponentStep<T> step) Schedule a step of the component.
<T> IFuture<T>	scheduleStep(int priority, IComponentStep<T> step) Schedule a step of the component.
ISubscriptionIntermediateFuture<IMonitoringEvent>	subscribeToEvents(IFilter<IMonitoringEvent> filter, boolean initial, IMonitoringService.PublishEventLevel elm) Subscribe to component events.
ISubscriptionIntermediateFuture<Tuple2<java.lang.String,java.lang.Object>>	subscribeToResults() Subscribe to receive results.
<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.

getComponentIdentifier

IComponentIdentifier getComponentIdentifier()

Get the id of the component.

Returns:

The component id.

getServiceProvider

IExternalAccess getServiceProvider()

Deprecated. From version 3.0 - replaced with external access. Get the service provider.

Returns:

The service provider.

getServiceContainer

IExternalAccess getServiceContainer()

Deprecated. From version 3.0 - replaced with external access. Get the service container.

Returns:

The service container.

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.

scheduleStep

<T> IFuture<T> scheduleStep(int priority,
                            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.

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.

isExternalThread

boolean isExternalThread()

Test if current thread is an external thread.

Returns:

True if the current thread is not the component thread.

createChild

IFuture<IComponentIdentifier> createChild(ComponentInstanceInfo component)

Create a subcomponent.

Parameters:

component - The instance info.

killComponent

IFuture<java.util.Map<java.lang.String,java.lang.Object>> killComponent()

Kill the component.

killComponent

IFuture<java.util.Map<java.lang.String,java.lang.Object>> killComponent(java.lang.Exception e)

Kill the component.

Parameters:

e - The failure reason, if any.

getChildren

IFuture<IComponentIdentifier[]> getChildren(java.lang.String type)

Get the children (if any) component identifiers.

Returns:

The children component identifiers.

getFileName

IFuture<java.lang.String> getFileName(java.lang.String ctype)

Get the model name of a component type.

Parameters:

ctype - The component type.

Returns:

The model name of this component type.

getLocalType

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

subscribeToResults

ISubscriptionIntermediateFuture<Tuple2<java.lang.String,java.lang.Object>> subscribeToResults()

Subscribe to receive results.

getResults

IFuture<java.util.Map<java.lang.String,java.lang.Object>> getResults()

Get the component results.

Returns:

The results.

getArguments

IFuture<java.util.Map<java.lang.String,java.lang.Object>> getArguments()

Get the arguments.

Returns:

The arguments.