public interface IComponentManagementService
Modifier and Type | Interface and Description |
---|---|
static class |
IComponentManagementService.CMSCreatedEvent |
static class |
IComponentManagementService.CMSIntermediateResultEvent |
static class |
IComponentManagementService.CMSStatusEvent |
static class |
IComponentManagementService.CMSTerminatedEvent |
Modifier and Type | Method and Description |
---|---|
IFuture<java.lang.Void> |
addComponentListener(IComponentIdentifier comp,
ICMSComponentListener listener)
Add an component listener.
|
ISubscriptionIntermediateFuture<IComponentManagementService.CMSStatusEvent> |
createComponent(CreationInfo info,
java.lang.String name,
java.lang.String model)
Create a new component on the platform.
|
ITuple2Future<IComponentIdentifier,java.util.Map<java.lang.String,java.lang.Object>> |
createComponent(java.lang.String model,
CreationInfo info)
Create a new component on the platform.
|
ITuple2Future<IComponentIdentifier,java.util.Map<java.lang.String,java.lang.Object>> |
createComponent(java.lang.String name,
java.lang.String model,
CreationInfo info)
Create a new component on the platform.
|
IFuture<IComponentIdentifier> |
createComponent(java.lang.String name,
java.lang.String model,
CreationInfo info,
IResultListener<java.util.Collection<Tuple2<java.lang.String,java.lang.Object>>> resultlistener)
Deprecated.
Use other createComponent methods.
|
IFuture<java.util.Map<java.lang.String,java.lang.Object>> |
destroyComponent(IComponentIdentifier componentid)
Destroy (forcefully terminate) an component 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.
|
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)
Deprecated.
Use cid.getParent() instead
|
IFuture<IComponentIdentifier> |
getRootIdentifier()
Get the root identifier (platform).
|
IFuture<IModelInfo> |
loadComponentModel(java.lang.String filename,
IResourceIdentifier rid)
Load a component model.
|
IFuture<java.lang.Void> |
removeComponentListener(IComponentIdentifier comp,
ICMSComponentListener listener)
Remove a listener.
|
IFuture<java.lang.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<java.lang.Void> |
setComponentBreakpoints(IComponentIdentifier componentid,
java.lang.String[] breakpoints)
Set breakpoints for a component.
|
IFuture<java.lang.Void> |
stepComponent(IComponentIdentifier componentid,
java.lang.String stepinfo)
Execute a step of a suspended component.
|
IFuture<java.lang.Void> |
suspendComponent(IComponentIdentifier componentid)
Suspend the execution of an component.
|
IFuture<IModelInfo> loadComponentModel(java.lang.String filename, IResourceIdentifier rid)
name
- The component name.ITuple2Future<IComponentIdentifier,java.util.Map<java.lang.String,java.lang.Object>> createComponent(java.lang.String model, CreationInfo info)
model
- The model identifier (e.g. file name).info
- Additional start information such as parent component or arguments (optional).ITuple2Future<IComponentIdentifier,java.util.Map<java.lang.String,java.lang.Object>> createComponent(java.lang.String name, java.lang.String model, CreationInfo info)
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).ISubscriptionIntermediateFuture<IComponentManagementService.CMSStatusEvent> createComponent(CreationInfo info, java.lang.String name, java.lang.String model)
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).IFuture<IComponentIdentifier> createComponent(java.lang.String name, java.lang.String model, CreationInfo info, IResultListener<java.util.Collection<Tuple2<java.lang.String,java.lang.Object>>> resultlistener)
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).resultlistener
- The result listener (if any). Will receive the results of the component execution, after the component has terminated.IFuture<java.util.Map<java.lang.String,java.lang.Object>> destroyComponent(IComponentIdentifier componentid)
componentid
- The component to destroy.IFuture<java.lang.Void> suspendComponent(IComponentIdentifier componentid)
componentid
- The component identifier.IFuture<java.lang.Void> resumeComponent(IComponentIdentifier componentid)
componentid
- The component identifier.IFuture<java.lang.Void> stepComponent(IComponentIdentifier componentid, java.lang.String stepinfo)
componentid
- The component identifier.listener
- Called when the step is finished (result will be the component description).IFuture<java.lang.Void> setComponentBreakpoints(IComponentIdentifier componentid, java.lang.String[] breakpoints)
componentid
- The component identifier.breakpoints
- The new breakpoints (if any).IFuture<IComponentIdentifier> getRootIdentifier()
IFuture<IComponentIdentifier[]> getComponentIdentifiers()
IFuture<IComponentDescription> getComponentDescription(IComponentIdentifier cid)
cid
- The component identifier.IFuture<IComponentDescription[]> getComponentDescriptions()
IFuture<IComponentDescription[]> searchComponents(IComponentDescription adesc, ISearchConstraints con)
IFuture<IComponentDescription[]> searchComponents(IComponentDescription adesc, ISearchConstraints con, boolean remote)
IFuture<java.lang.Void> addComponentListener(IComponentIdentifier comp, ICMSComponentListener listener)
comp
- The component to be listened on (or null for listening on all components).listener
- The listener to be added.IFuture<java.lang.Void> removeComponentListener(IComponentIdentifier comp, ICMSComponentListener listener)
comp
- The component to be listened on (or null for listening on all components).listener
- The listener to be removed.IFuture<IExternalAccess> getExternalAccess(IComponentIdentifier cid)
cid
- The component identifier.listener
- The result listener (receives an IExternalAccess object).IFuture<IComponentIdentifier> getParent(IComponentIdentifier cid)
cid
- The component identifier.IFuture<IComponentIdentifier[]> getChildren(IComponentIdentifier cid)
cid
- The component identifier.IFuture<IComponentDescription[]> getChildrenDescriptions(IComponentIdentifier cid)
cid
- The component identifier.