TPTP 4.4.0 Platform Project
Public API Specification

org.eclipse.hyades.execution.remote
Class JavaTaskExecutorSkeleton

java.lang.Object
  extended byorg.eclipse.hyades.execution.remote.RemoteObjectSkeleton
      extended byorg.eclipse.hyades.execution.remote.ExecutionComponentSkeleton
          extended byorg.eclipse.hyades.execution.remote.ExecutorSkeleton
              extended byorg.eclipse.hyades.execution.remote.JavaTaskExecutorSkeleton
All Implemented Interfaces:
IExecutionComponent, IExecutor, IRemoteObject

public class JavaTaskExecutorSkeleton
extends ExecutorSkeleton

In addition to delegating method invocations to the associated implementation objects, instances this class create the remote portion of the "test agent". The test agent is used for monitoring and in a handshaking scheme that attempts to insure that the test does not begin running before the client on the local side is ready for it to do so.


Field Summary
 
Fields inherited from class org.eclipse.hyades.execution.remote.RemoteObjectSkeleton
delegate, sessionContext, uniqueId
 
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
JavaTaskExecutorSkeleton()
           
JavaTaskExecutorSkeleton(IExecutionComponent delegate, java.lang.Integer id)
           
 
Method Summary
 org.eclipse.hyades.internal.execution.remote.RemoteComponentSkeleton getAgent()
          Get the remote end of the test monitoring and control agent for the test that this executor can run.
 void init()
          Setup the remote test agent.
 boolean isOKToStart()
          Is it okay to continue starting the test?
 void setExecutableObject(IExecutableObject theExecutableObject)
          Set the executable object.
 void waitForOKToStart()
          Block the calling thread until it is okay to start the test.
 
Methods inherited from class org.eclipse.hyades.execution.remote.ExecutorSkeleton
getCompatibleExecutableObject, getExecutableObject, getProcessConsole, kill, launch, performControlEvent, supportsControlEvent
 
Methods inherited from class org.eclipse.hyades.execution.remote.ExecutionComponentSkeleton
addChild, addExecutionComponentStateChangeListener, fireStateChangeEvent, getChildById, getChildByName, getChildren, getId, getName, getNode, getParent, getState, getType, getVersion, handleMessage, removeChild, removeExecutionComponentStateChangeListener, sendMessage, setParent
 
Methods inherited from class org.eclipse.hyades.execution.remote.RemoteObjectSkeleton
delegateRemoteCall, getDelegate, getSessionContext, getUniqueId, setDelegate, setId, setSessionContext
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.eclipse.hyades.execution.core.IExecutionComponent
addChild, addExecutionComponentStateChangeListener, fireStateChangeEvent, getChildById, getChildByName, getChildren, getId, getName, getNode, getParent, getState, getType, getVersion, handleMessage, removeChild, removeExecutionComponentStateChangeListener, sendMessage, setParent
 

Constructor Detail

JavaTaskExecutorSkeleton

public JavaTaskExecutorSkeleton()

JavaTaskExecutorSkeleton

public JavaTaskExecutorSkeleton(IExecutionComponent delegate,
                                java.lang.Integer id)
Method Detail

setExecutableObject

public void setExecutableObject(IExecutableObject theExecutableObject)
                         throws ExecutionComponentStateException
Description copied from interface: IExecutor
Set the executable object. The executable object contains all information necessary to execute within the parent execution environment

Specified by:
setExecutableObject in interface IExecutor
Overrides:
setExecutableObject in class ExecutorSkeleton
Throws:
ExecutionComponentStateException
See Also:
IExecutor.setExecutableObject(org.eclipse.hyades.execution.core.IExecutableObject)

getAgent

public org.eclipse.hyades.internal.execution.remote.RemoteComponentSkeleton getAgent()
Get the remote end of the test monitoring and control agent for the test that this executor can run. The agent is guaranteed to have been properly initialized.

This method is only available in the skeleton layer.

Returns:
a RemoteComponentSkeleton instance

init

public void init()
Setup the remote test agent.

Specified by:
init in interface IExecutionComponent
Overrides:
init in class ExecutionComponentSkeleton
See Also:
IRemoteObject.init()

isOKToStart

public boolean isOKToStart()
Is it okay to continue starting the test?

Returns:
true if it is okay to start the test, false otherwise

waitForOKToStart

public void waitForOKToStart()
Block the calling thread until it is okay to start the test. Calls to setOKToStart(boolean) result in notifications being issued to all threads blocked waiting on this object's monitor.


TPTP 4.4.0 Platform Project
Public API Specification