jadex.bridge

Interface IComponentManagementService

All Superinterfaces:

IService

public interface IComponentManagementService
extends IService

General interface for components that the container can execute.

Field Summary

Fields inherited from interface jadex.bridge.service.IService

EMPTY_SERVICES

Method Summary

Methods

Modifier and Type	Method and Description
void	addComponentListener(IComponentIdentifier comp, ICMSComponentListener listener) Add an component listener.
IFuture<IComponentIdentifier>	createComponent(String name, String model, CreationInfo info, IResultListener killlistener) Create a new component on the platform.
IComponentDescription	createComponentDescription(IComponentIdentifier id, String state, String ownership, String type, String modelname, String localtype) Create a component description.
IComponentIdentifier	createComponentIdentifier(String name) Create component identifier (name assumed being local).
IComponentIdentifier	createComponentIdentifier(String name, boolean local) Create component identifier.
IComponentIdentifier	createComponentIdentifier(String name, boolean local, String[] addresses) Create component identifier.
IComponentIdentifier	createComponentIdentifier(String name, IComponentIdentifier parent, String[] addresses) Create component identifier.
ISearchConstraints	createSearchConstraints(int maxresults, int maxdepth) Create a search constraints object.
IFuture<Map>	destroyComponent(IComponentIdentifier componentid) Destroy (forcefully terminate) an component on the platform.
IComponentIdentifier	generateComponentIdentifier(String name, String platformname) Create a component identifier that is allowed on the platform.
IFuture<IComponentIdentifier[]>	getChildren(IComponentIdentifier cid) Get the children components of a component.
IFuture<IComponentDescription[]>	getChildrenDescriptions(IComponentIdentifier cid) Get the children components of a component.
IComponentAdapter	getComponentAdapter(IComponentIdentifier cid) Get the component adapter for a component identifier.
IFuture<IComponentDescription>	getComponentDescription(IComponentIdentifier cid) Get the component description of a single component.
IFuture<IComponentDescription[]>	getComponentDescriptions() Get all component descriptions.
IFuture<IComponentIdentifier[]>	getComponentIdentifiers() Get the component identifiers.
IFuture<IExternalAccess>	getExternalAccess(IComponentIdentifier cid) Get the external access of a component.
IFuture<IComponentIdentifier>	getParent(IComponentIdentifier cid) Get the parent component of a component.
IFuture<IModelInfo>	loadComponentModel(String filename) Load a component model.
void	removeComponentListener(IComponentIdentifier comp, ICMSComponentListener listener) Remove a listener.
IFuture<Void>	resumeComponent(IComponentIdentifier componentid) Resume the execution of an component.
IFuture<IComponentDescription[]>	searchComponents(IComponentDescription adesc, ISearchConstraints con) Search for components matching the given description.
IFuture<IComponentDescription[]>	searchComponents(IComponentDescription adesc, ISearchConstraints con, boolean remote) Search for components matching the given description.
IFuture<Void>	setComponentBreakpoints(IComponentIdentifier componentid, String[] breakpoints) Set breakpoints for a component.
IFuture<Void>	stepComponent(IComponentIdentifier componentid) Execute a step of a suspended component.
IFuture<Void>	suspendComponent(IComponentIdentifier componentid) Suspend the execution of an component.

Methods inherited from interface jadex.bridge.service.IService

getPropertyMap, getServiceIdentifier, isValid

Method Detail

loadComponentModel

IFuture<IModelInfo> loadComponentModel(String filename)

Load a component model.

Parameters:

name - The component name.

Returns:

The model info of the

createComponent

IFuture<IComponentIdentifier> createComponent(String name,
                                            String model,
                                            CreationInfo info,
                                            IResultListener killlistener)

Create a new component on the platform.

Parameters:

name - The component name or null for automatic generation.

model - The model identifier (e.g. file name).

info - Additional start information such as parent component or arguments (optional).

killlistener - The kill listener (if any). Will receive the results of the component execution, after the component has terminated.

Returns:

The id of the component as future result, when the component has been created and initialized.

destroyComponent

IFuture<Map> destroyComponent(IComponentIdentifier componentid)

Destroy (forcefully terminate) an component on the platform.

Parameters:

componentid - The component to destroy.

suspendComponent

IFuture<Void> suspendComponent(IComponentIdentifier componentid)

Suspend the execution of an component.

Parameters:

componentid - The component identifier.

resumeComponent

IFuture<Void> resumeComponent(IComponentIdentifier componentid)

Resume the execution of an component.

Parameters:

componentid - The component identifier.

stepComponent

IFuture<Void> stepComponent(IComponentIdentifier componentid)

Execute a step of a suspended component.

Parameters:

componentid - The component identifier.

listener - Called when the step is finished (result will be the component description).

setComponentBreakpoints

IFuture<Void> setComponentBreakpoints(IComponentIdentifier componentid,
                                    String[] breakpoints)

Set breakpoints for a component. Replaces existing breakpoints. To add/remove breakpoints, use current breakpoints from component description as a base.

Parameters:

componentid - The component identifier.

breakpoints - The new breakpoints (if any).

getComponentIdentifiers

IFuture<IComponentIdentifier[]> getComponentIdentifiers()

Get the component identifiers.

Returns:

The component identifiers. This method should be used with caution when the agent population is large.

getComponentDescription

IFuture<IComponentDescription> getComponentDescription(IComponentIdentifier cid)

Get the component description of a single component.

Parameters:

cid - The component identifier.

Returns:

The component description of this component.

getComponentDescriptions

IFuture<IComponentDescription[]> getComponentDescriptions()

Get all component descriptions.

Returns:

The component descriptions of the platform.

searchComponents

IFuture<IComponentDescription[]> searchComponents(IComponentDescription adesc,
                                                ISearchConstraints con)

Search for components matching the given description.

Returns:

An array of matching component descriptions.

searchComponents

IFuture<IComponentDescription[]> searchComponents(IComponentDescription adesc,
                                                ISearchConstraints con,
                                                boolean remote)

Search for components matching the given description.

Returns:

An array of matching component descriptions.

addComponentListener

void addComponentListener(IComponentIdentifier comp,
                        ICMSComponentListener listener)

Add an component listener. The listener is registered for component changes.

Parameters:

comp - The component to be listened on (or null for listening on all components).

listener - The listener to be added.

removeComponentListener

void removeComponentListener(IComponentIdentifier comp,
                           ICMSComponentListener listener)

Remove a listener.

Parameters:

comp - The component to be listened on (or null for listening on all components).

listener - The listener to be removed.

getExternalAccess

IFuture<IExternalAccess> getExternalAccess(IComponentIdentifier cid)

Get the external access of a component.

Parameters:

cid - The component identifier.

listener - The result listener (recieves an IExternalAccess object).

getParent

IFuture<IComponentIdentifier> getParent(IComponentIdentifier cid)

Get the parent component of a component.

Parameters:

cid - The component identifier.

Returns:

The parent component identifier.

getChildren

IFuture<IComponentIdentifier[]> getChildren(IComponentIdentifier cid)

Get the children components of a component.

Parameters:

cid - The component identifier.

Returns:

The children component identifiers.

getChildrenDescriptions

IFuture<IComponentDescription[]> getChildrenDescriptions(IComponentIdentifier cid)

Get the children components of a component.

Parameters:

cid - The component identifier.

Returns:

The children component descriptions.

createComponentIdentifier

IComponentIdentifier createComponentIdentifier(String name)

Create component identifier (name assumed being local).

Parameters:

name - The name.

Returns:

The new component identifier.

createComponentIdentifier

IComponentIdentifier createComponentIdentifier(String name,
                                             boolean local)

Create component identifier.

Parameters:

name - The name.

local - True for local name.

Returns:

The new component identifier.

createComponentIdentifier

IComponentIdentifier createComponentIdentifier(String name,
                                             boolean local,
                                             String[] addresses)

Create component identifier.

Parameters:

name - The name.

local - True for local name.

addresses - The addresses.

Returns:

The new component identifier.

createComponentIdentifier

IComponentIdentifier createComponentIdentifier(String name,
                                             IComponentIdentifier parent,
                                             String[] addresses)

Create component identifier.

Parameters:

name - The name.

addresses - The addresses.

Returns:

The new component identifier.

generateComponentIdentifier

IComponentIdentifier generateComponentIdentifier(String name,
                                               String platformname)

Create a component identifier that is allowed on the platform.

Parameters:

name - The base name.

Returns:

The component identifier.

createComponentDescription

IComponentDescription createComponentDescription(IComponentIdentifier id,
                                               String state,
                                               String ownership,
                                               String type,
                                               String modelname,
                                               String localtype)

Create a component description.

Parameters:

id - The component identifier.

state - The state.

ownership - The ownership.

type - The component type.

parent - The parent.

Returns:

The component description.

createSearchConstraints

ISearchConstraints createSearchConstraints(int maxresults,
                                         int maxdepth)

Create a search constraints object.

Parameters:

maxresults - The maximum number of results.

maxdepth - The maximal search depth.

Returns:

The search constraints.

getComponentAdapter

IComponentAdapter getComponentAdapter(IComponentIdentifier cid)

Get the component adapter for a component identifier.

Parameters:

aid - The component identifier.

listener - The result listener.