org.eclipse.hyades.execution.core
Interface IExecutionComponent

All Known Subinterfaces:

IExecutionEnvironment, IExecutor, IExecutorWithProgressMonitorSupport, IRemoteHyadesComponent, ISession

All Known Implementing Classes:

ExecutionComponentImpl, ExecutionComponentSkeleton, ExecutionComponentStub, ExecutionEnvironmentImpl, ExecutionEnvironmentSkeleton, ExecutionEnvironmentStub, ExecutorSkeleton, ExecutorStub, JavaTaskExecutorImpl, JavaTaskRemoteHyadesComponentImpl, JavaTaskRemoteHyadesComponentSkeleton, JavaTaskRemoteHyadesComponentStub, ProcessExecutorImpl, SessionImpl, SessionImpl, SessionSkeleton, SessionStub

public interface IExecutionComponent

IExecutionComponent is the base class for all of the components in the runtime system. IExecutionComponent's are structured as a tree with the specialized ISession is the root of the tree on the workbench side.

IExecutionComponent's are uniquely identified at runtime with an ID. They are also named and typed but names and types are not guaranteed to be unique. Version support is provided as well.

IExecutionComponent's have at least four states. They can be inactive, ready, suspended, or dead.

• Inactive IExecutionComponent's are models of components that have not been created yet.
• Not Configured IExecutionComponent's are those that have been created but have not yet been completely initialized or properly configured
• Ready IExecutionComponent's are those that can produce or consume IMessage's and IRuntimeVariable's.
• Suspended IExecutionComponent's are are those that have been created and are expected to become ready at some point in the future.
• Dead IExecutionComponent's are those that will never be ready again.

Field Summary

static int	DEAD
static int	INACTIVE
static int	NOT_CONFIGURED
static int	READY
static int	SUSPENDED

Method Summary

void	addChild(IExecutionComponent child) Add a child
void	addExecutionComponentStateChangeListener(IExecutionComponentStateChangeListener listener) Adds an IExecutionComponentStateChangeListener to this IExecutionComponent
void	fireStateChangeEvent(ExecutionComponentStateChangeEvent event) Fire a state change event.
IExecutionComponent	getChildById(java.lang.String id) Retrieve a child of this IExecutionComponent based upon its ID.
IExecutionComponent	getChildByName(java.lang.String name) Retrieve a child of this IExecutionComponent based upon its name.
IExecutionComponent[]	getChildren() Get the first-level children that reside under this IExecutionComponent The typical heirarchy is a follows: ISession->IExecutor->IRemoteHyadesComponent It is possible, however, to have any level of nesting here.
java.lang.String	getId() All IExecutionComponent instances must have an immutable ID.
java.lang.String	getName() All IExecutionComponent instances must have an immutable name.
INode	getNode() Get the node on which this IExecutionComponent resides.
IExecutionComponent	getParent() Get the container where this IExecutionComponent is hosted.
int	getState()
java.lang.String	getType() All IExecutionComponent instances must have an immutable type.
java.lang.String	getVersion() Retrieve the version.
void	handleMessage(IControlMessage message)
void	init() This method should be called by the factory implementations after the object has been created so that it can do some addional setup if necessary.
void	removeChild(IExecutionComponent child) Remove a child
void	removeExecutionComponentStateChangeListener(IExecutionComponentStateChangeListener listener) Removes an IExecutionComponentStateChangeListener from this IExecutionComponent
void	sendMessage(IControlMessage message)
void	setParent(IExecutionComponent parent) Sets the container of this IExecutionComponent.

Field Detail

INACTIVE

public static final int INACTIVE

See Also:

Constant Field Values

NOT_CONFIGURED

public static final int NOT_CONFIGURED

See Also:

Constant Field Values

READY

public static final int READY

See Also:

Constant Field Values

SUSPENDED

public static final int SUSPENDED

See Also:

Constant Field Values

DEAD

public static final int DEAD

See Also:

Constant Field Values

Method Detail

init

public void init()

This method should be called by the factory implementations after the object has been created so that it can do some addional setup if necessary.

getName

public java.lang.String getName()

All IExecutionComponent instances must have an immutable name. Names are user friendly identifiers.

Returns:

the name of the IExecutionComponent

getId

public java.lang.String getId()

All IExecutionComponent instances must have an immutable ID. Id's are globaly unique values that identify this unique IExecutionComponent runtime instance.

Returns:

The ID of the IExecutionComponent

getType

public java.lang.String getType()

All IExecutionComponent instances must have an immutable type. The type field is intended to allow you to identify groups of IExecutionComponent instances as having the same behaviour.

Returns:

the type of the IExecutionComponent

getVersion

public java.lang.String getVersion()

Retrieve the version.

getParent

public IExecutionComponent getParent()

Get the container where this IExecutionComponent is hosted. The typical heirarchy is a follows: ISession->IExecutor->IRemoteHyadesComponent It is possible, however, to have any level of nesting here. The ISession is always the root.

setParent

public void setParent(IExecutionComponent parent)

Sets the container of this IExecutionComponent.

getChildren

public IExecutionComponent[] getChildren()

Get the first-level children that reside under this IExecutionComponent The typical heirarchy is a follows: ISession->IExecutor->IRemoteHyadesComponent It is possible, however, to have any level of nesting here. The ISession is always the root.

getChildById

public IExecutionComponent getChildById(java.lang.String id)

Retrieve a child of this IExecutionComponent based upon its ID.

getChildByName

public IExecutionComponent getChildByName(java.lang.String name)

Retrieve a child of this IExecutionComponent based upon its name. RKD: This may not be the best idea due to name collision issues. probably want to stick to just ID's.

Parameters:

name -

addChild

public void addChild(IExecutionComponent child)

Add a child

Parameters:

child - the child to add

removeChild

public void removeChild(IExecutionComponent child)

Remove a child

Parameters:

child - the child to remove

getNode

public INode getNode()

Get the node on which this IExecutionComponent resides.

Returns:

the node on which this IExecutionComponent resides

getState

public int getState()

addExecutionComponentStateChangeListener

public void addExecutionComponentStateChangeListener(IExecutionComponentStateChangeListener listener)

Adds an IExecutionComponentStateChangeListener to this IExecutionComponent

Parameters:

listener - the listener to be informed of state change events.

removeExecutionComponentStateChangeListener

public void removeExecutionComponentStateChangeListener(IExecutionComponentStateChangeListener listener)

Removes an IExecutionComponentStateChangeListener from this IExecutionComponent

Parameters:

listener - the listener to be no longer informed of state change events.

fireStateChangeEvent

public void fireStateChangeEvent(ExecutionComponentStateChangeEvent event)

Fire a state change event. This should be in the interface because the behaviour of how to fire the event is tightly coupled with the data structure used to hold the listeners.

handleMessage

public void handleMessage(IControlMessage message)
                   throws MessageProcessingException

Throws:

MessageProcessingException

sendMessage

public void sendMessage(IControlMessage message)
                 throws MessageDeliveryException

Throws:

MessageDeliveryException