jadex.bridge.service.types.factory

Interface IComponentAdapter

public interface IComponentAdapter

The adapter for a specific platform component (e.g. a JADE agent). These are the methods a kernel components needs to call on its host component. Implementations of this interface should be thread safe.

Field Summary

Fields

Modifier and Type	Field and Description
static ThreadLocal<IComponentAdapter>	LOCAL The currently executing component (if any).

Method Summary

Methods

Modifier and Type	Method and Description
IFuture<Collection<IExternalAccess>>	getChildrenAccesses() Get the children (if any).
IFuture<IComponentIdentifier[]>	getChildrenIdentifiers() Get the children (if any).
IComponentIdentifier	getComponentIdentifier() Return the native component-identifier that allows to send messages to this component.
IComponentDescription	getDescription() Return the component description.
Exception	getException() Get the exception.
Logger	getLogger() Get the component logger.
IExternalAccess	getParent() Get the parent component.
void	invokeLater(Runnable action) Execute an action on the component thread.
boolean	isExternalThread() Check if the external thread is accessing.
void	wakeup() Called by the component when it probably awoke from an idle state.

Field Detail

LOCAL

static final ThreadLocal<IComponentAdapter> LOCAL

The currently executing component (if any).

Method Detail

wakeup

void wakeup()
            throws ComponentTerminatedException

Called by the component when it probably awoke from an idle state. The platform has to make sure that the component will be executed again from now on. Note, this method can be called also from external threads (e.g. property changes). Therefore, on the calling thread no component related actions must be executed (use some kind of wake-up mechanism). Also proper synchronization has to be made sure, as this method can be called concurrently from different threads.

Throws:

ComponentTerminatedException

invokeLater

void invokeLater(Runnable action)

Execute an action on the component thread. May be safely called from any (internal or external) thread. The contract of this method is as follows: The component adapter ensures the execution of the external action, otherwise the method will throw a terminated exception.

Parameters:

action - The action to be executed on the component thread.

isExternalThread

boolean isExternalThread()

Check if the external thread is accessing.

Returns:

True, if called from an external (i.e. non-synchronized) thread.

getComponentIdentifier

IComponentIdentifier getComponentIdentifier()
                                            throws ComponentTerminatedException

Return the native component-identifier that allows to send messages to this component.

Throws:

ComponentTerminatedException

getDescription

IComponentDescription getDescription()

Return the component description.

getLogger

Logger getLogger()

Get the component logger.

Returns:

The logger.

getParent

IExternalAccess getParent()

Get the parent component.

Returns:

The parent (if any).

getChildrenIdentifiers

IFuture<IComponentIdentifier[]> getChildrenIdentifiers()

Get the children (if any).

Returns:

The children.

getChildrenAccesses

IFuture<Collection<IExternalAccess>> getChildrenAccesses()

Get the children (if any).

Returns:

The children.

getException

Exception getException()

Get the exception.

Returns:

The exception.