TPTP 4.4.0 Platform Project
Public API Specification

org.eclipse.hyades.execution.remote
Class JavaTaskRemoteHyadesComponentSkeleton

java.lang.Object
  extended byorg.eclipse.hyades.execution.remote.RemoteObjectSkeleton
      extended byorg.eclipse.hyades.execution.remote.ExecutionComponentSkeleton
          extended byorg.eclipse.hyades.execution.remote.JavaTaskRemoteHyadesComponentSkeleton
All Implemented Interfaces:
IExecutionComponent, IRemoteHyadesComponent, IRemoteObject

public class JavaTaskRemoteHyadesComponentSkeleton
extends ExecutionComponentSkeleton
implements IRemoteHyadesComponent

At present, this class does not provide much functionality. Most of the monitoring operations are implemented entirely on the local side. Those operations that will involve both the local and remote layers do not, at present, do anything meaningful.


Field Summary
 
Fields inherited from class org.eclipse.hyades.execution.remote.RemoteObjectSkeleton
delegate, sessionContext, uniqueId
 
Fields inherited from interface org.eclipse.hyades.execution.core.IExecutionComponent
DEAD, INACTIVE, NOT_CONFIGURED, READY, SUSPENDED
 
Constructor Summary
JavaTaskRemoteHyadesComponentSkeleton()
           
 
Method Summary
 boolean isActive()
          This method is implemented in the stub layer.
 boolean isLocked()
          Determine is this agent is currently attached to a client.
 boolean isMonitored()
          This method is implemented in the stub layer.
 void lock(long timeout)
          The lock request will either succeed within the specified timeout, or will throw a TimeoutException.
 void startMonitoring(IDataChannel processor)
          This method is implemented in the stub layer.
 void startMonitoring(IDataProcessor arg0)
          This method is implemented in the stub layer.
 void stopMonitoring()
          This method is implemented in the stub layer.
 void unlock()
          Unlocks the component for use by other readers.
 
Methods inherited from class org.eclipse.hyades.execution.remote.ExecutionComponentSkeleton
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.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, init, removeChild, removeExecutionComponentStateChangeListener, sendMessage, setParent
 

Constructor Detail

JavaTaskRemoteHyadesComponentSkeleton

public JavaTaskRemoteHyadesComponentSkeleton()
Method Detail

isActive

public boolean isActive()
This method is implemented in the stub layer.

Specified by:
isActive in interface IRemoteHyadesComponent
Returns:
whether this agent is currently active
See Also:
IRemoteHyadesComponent.isActive()

isMonitored

public boolean isMonitored()
This method is implemented in the stub layer.

Specified by:
isMonitored in interface IRemoteHyadesComponent
Returns:
if this agent is currently being monitored
See Also:
IRemoteHyadesComponent.isMonitored()

isLocked

public boolean isLocked()
Description copied from interface: IRemoteHyadesComponent
Determine is this agent is currently attached to a client.

Specified by:
isLocked in interface IRemoteHyadesComponent
Returns:
if this agent is currently attached to a client
See Also:
IRemoteHyadesComponent.isLocked()

lock

public void lock(long timeout)
          throws TimeoutException
Description copied from interface: IRemoteHyadesComponent

The lock request will either succeed within the specified timeout, or will throw a TimeoutException. If the IRemoteHyadesComponent supports multiple readers, it can allow multiple readers to have simultaneous locks.

Specified by:
lock in interface IRemoteHyadesComponent
Parameters:
timeout - The number of milliseconds that during which the lock will attempt to be acquired.
Throws:
TimeoutException - If the lock can not be acquired within the specified timeout.
See Also:
IRemoteHyadesComponent.lock(long)

unlock

public void unlock()
Description copied from interface: IRemoteHyadesComponent
Unlocks the component for use by other readers.

Specified by:
unlock in interface IRemoteHyadesComponent
See Also:
IRemoteHyadesComponent.unlock()

startMonitoring

public void startMonitoring(IDataChannel processor)
                     throws ExecutionComponentStateException
This method is implemented in the stub layer.

Specified by:
startMonitoring in interface IRemoteHyadesComponent
Parameters:
processor - a reader to process the captured data
Throws:
ExecutionComponentStateException - if the remote hyades component is not in a state that can accept this call.
See Also:
IRemoteHyadesComponent.startMonitoring(org.eclipse.hyades.execution.core.IDataChannel)

stopMonitoring

public void stopMonitoring()
                    throws ExecutionComponentStateException
This method is implemented in the stub layer.

Specified by:
stopMonitoring in interface IRemoteHyadesComponent
Throws:
ExecutionComponentStateException - if the remote hyades component is not in a state that can accept this call.
See Also:
IRemoteHyadesComponent.stopMonitoring()

startMonitoring

public void startMonitoring(IDataProcessor arg0)
                     throws ExecutionComponentStateException
This method is implemented in the stub layer.

Specified by:
startMonitoring in interface IRemoteHyadesComponent
Throws:
ExecutionComponentStateException
See Also:
IRemoteHyadesComponent.startMonitoring(org.eclipse.hyades.execution.core.IDataProcessor)

TPTP 4.4.0 Platform Project
Public API Specification