org.eclipse.hyades.execution.local
Class ExecutorStub

java.lang.Object
  org.eclipse.hyades.execution.local.RemoteObjectStub
      org.eclipse.hyades.execution.local.ExecutionComponentStub
          org.eclipse.hyades.execution.local.ExecutorStub

All Implemented Interfaces:

IExecutionComponent, IExecutor, IExecutorWithProgressMonitorSupport, IRemoteObject

Direct Known Subclasses:

JavaProcessExecutorStub, JavaTaskExecutorStub

public abstract class ExecutorStub
extends ExecutionComponentStub
implements IExecutorWithProgressMonitorSupport

Field Summary

IDataProcessor[]

dataProcessors

Fields inherited from interface org.eclipse.hyades.execution.core.IExecutor

CONTROL_EVENT_RESUME, CONTROL_EVENT_SUSPEND

Fields inherited from interface org.eclipse.hyades.execution.core.IExecutionComponent

DEAD, INACTIVE, NOT_CONFIGURED, READY, SUSPENDED

Constructor Summary

ExecutorStub()

ExecutorStub(IExecutionComponent delegate)

Method Summary

java.lang.String	getCommunicationPort()
IExecutableObject	getCompatibleExecutableObject(java.lang.String classname) Create an IExecutableObject instance that is compatible with this executor.
IDataProcessor[]	getDataProcessors() returns the array of IDataProcessors which are to monitor this executor
IExecutableObject	getExecutableObject()
java.lang.String	getExecutionResultLocation()
java.lang.String	getExecutionResultName()
java.lang.String	getPid() returns the process ID of this executor.
IProcessConsole	getProcessConsole() Return the process console of the current executor
void	kill() Kills this process if it is active.
void	kill(org.eclipse.core.runtime.IProgressMonitor progressMonitor) Kill using the given progress monitor, this progress monitor will be used for progress reports as work units are complete and for polling the cancel status of the monitor.
void	launch() Launches the executable on this ISession's node
void	launch(org.eclipse.core.runtime.IProgressMonitor progressMonitor) Launch using the given progress monitor, this progress monitor will be used for progress reports as work units are complete and for polling the cancel status of the monitor.
void	setCommunicationPort(java.lang.String communicationPort)
void	setDataProcessors(IDataProcessor[] processors) called to set the IDataProcessor collection.
void	setExecutableObject(IExecutableObject theExecutableObject) Associate an executable object with this executor.
void	setExecutionResultLocation(java.lang.String string)
void	setExecutionResultName(java.lang.String string)

Methods inherited from class org.eclipse.hyades.execution.local.ExecutionComponentStub

addChild, addExecutionComponentStateChangeListener, fireStateChangeEvent, getChildById, getChildByName, getChildren, getId, getName, getNode, getParent, getState, getType, getVersion, handleMessage, init, removeChild, removeExecutionComponentStateChangeListener, sendMessage, setParent

Methods inherited from class org.eclipse.hyades.execution.local.RemoteObjectStub

delegateRemoteCall, getDelegate, getSessionContext, getUniqueId, setDelegate, setSessionContext

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eclipse.hyades.execution.core.IExecutor

performControlEvent, supportsControlEvent

Methods inherited from interface org.eclipse.hyades.execution.core.IExecutionComponent

addChild, addExecutionComponentStateChangeListener, fireStateChangeEvent, getChildById, getChildByName, getChildren, getId, getName, getNode, getParent, getState, getType, getVersion, handleMessage, init, removeChild, removeExecutionComponentStateChangeListener, sendMessage, setParent

Field Detail

dataProcessors

public IDataProcessor[] dataProcessors

Constructor Detail

ExecutorStub

public ExecutorStub()

ExecutorStub

public ExecutorStub(IExecutionComponent delegate)

Method Detail

launch

public void launch(org.eclipse.core.runtime.IProgressMonitor progressMonitor)

Description copied from interface: IExecutorWithProgressMonitorSupport

Launch using the given progress monitor, this progress monitor will be used for progress reports as work units are complete and for polling the cancel status of the monitor.

Specified by:

launch in interface IExecutorWithProgressMonitorSupport

launch

public void launch()
            throws ExecutionComponentStateException

Description copied from interface: IExecutor

Launches the executable on this ISession's node

Specified by:

launch in interface IExecutor

Throws:

ExecutionComponentStateException

See Also:

IExecutor.launch()

kill

public void kill(org.eclipse.core.runtime.IProgressMonitor progressMonitor)
          throws ExecutionComponentStateException

Description copied from interface: IExecutorWithProgressMonitorSupport

Kill using the given progress monitor, this progress monitor will be used for progress reports as work units are complete and for polling the cancel status of the monitor.

Specified by:

kill in interface IExecutorWithProgressMonitorSupport

Throws:

ExecutionComponentStateException

kill

public void kill()
          throws ExecutionComponentStateException

Description copied from interface: IExecutor

Kills this process if it is active.

Specified by:

kill in interface IExecutor

Throws:

ExecutionComponentStateException

See Also:

IExecutor.kill()

setExecutableObject

public void setExecutableObject(IExecutableObject theExecutableObject)
                         throws ExecutionComponentStateException

Associate an executable object with this executor. There is a local and a remote portion of this operation.

Specified by:

setExecutableObject in interface IExecutor

Parameters:

theExecutableObject - An IExecutableObject instance which describes the executable in a manner understood by this IExecutor.

Throws:

ExecutionComponentStateException - If the IExecutor is not in a valid state to accept an IExecutableObject.

See Also:

IExecutor.setExecutableObject(org.eclipse.hyades.execution.core.IExecutableObject)

getExecutableObject

public IExecutableObject getExecutableObject()

Specified by:

getExecutableObject in interface IExecutor

See Also:

IExecutor.getExecutableObject()

getProcessConsole

public IProcessConsole getProcessConsole()
                                  throws ExecutionComponentStateException

Description copied from interface: IExecutor

Return the process console of the current executor

Specified by:

getProcessConsole in interface IExecutor

Returns:

IProcessConsole

Throws:

ExecutionComponentStateException

getCompatibleExecutableObject

public IExecutableObject getCompatibleExecutableObject(java.lang.String classname)
                                                throws java.lang.ClassNotFoundException

Create an IExecutableObject instance that is compatible with this executor. The implementation of this method differs from the norm, as no responsibilities are delegated to the delegate object. Instead, the creation of the executable object is handled completely by the stub/skeleton combination.

Specified by:

getCompatibleExecutableObject in interface IExecutor

Returns:

a JavaTaskExcutableObjectStub

Throws:

java.lang.ClassNotFoundException

getExecutionResultLocation

public java.lang.String getExecutionResultLocation()

Returns:

getExecutionResultName

public java.lang.String getExecutionResultName()

Returns:

setExecutionResultLocation

public void setExecutionResultLocation(java.lang.String string)

Parameters:

string -

setExecutionResultName

public void setExecutionResultName(java.lang.String string)

Parameters:

string -

getDataProcessors

public IDataProcessor[] getDataProcessors()

returns the array of IDataProcessors which are to monitor this executor

setDataProcessors

public void setDataProcessors(IDataProcessor[] processors)

called to set the IDataProcessor collection.

Parameters:

processors -

getPid

public java.lang.String getPid()

returns the process ID of this executor.

Returns:

String

getCommunicationPort

public java.lang.String getCommunicationPort()

Returns:

Returns the communicationPort.

setCommunicationPort

public void setCommunicationPort(java.lang.String communicationPort)

Parameters:

communicationPort - The communicationPort to set.