TPTP 4.6.0 Platform Project
Public API Specification

org.eclipse.hyades.execution.local
Class JavaTaskRemoteHyadesComponentStub

java.lang.Object
  extended by org.eclipse.hyades.execution.local.RemoteObjectStub
      extended by org.eclipse.hyades.execution.local.ExecutionComponentStub
          extended by org.eclipse.hyades.execution.local.JavaTaskRemoteHyadesComponentStub
All Implemented Interfaces:
IExecutionComponent, IRemoteHyadesComponent, IRemoteObject

public class JavaTaskRemoteHyadesComponentStub
extends ExecutionComponentStub
implements IRemoteHyadesComponent

Most of the tasks of this monitoring component are handled on the local side. Most of the tasks, also, are implemented in the stub layer only. For the monitoring operations, an Agent is needed. The Hyades execution core plugin knows nothing about Agents, and most of the operations provided by this class are only to be implemented on the local side.


Field Summary
 
Fields inherited from interface org.eclipse.hyades.execution.core.IExecutionComponent
DEAD, INACTIVE, NOT_CONFIGURED, READY, SUSPENDED
 
Constructor Summary
JavaTaskRemoteHyadesComponentStub()
           
 
Method Summary
 boolean isActive()
          This implementation does not delegate to the implementation class.
 boolean isLocked()
          This method currently does not provide meaningful functionality.
 boolean isMonitored()
          This implementation does not delegate to the implementation class.
 void lock(long timeout)
          This method currently does not provide meaningful functionality.
 void startMonitoring(IDataChannel processor)
          This implementation always throws an UnsupportedOperationException.
 void startMonitoring(IDataProcessor dataProcessor)
          This implementation does not delegate to the implementation class.
 void stopMonitoring()
          This implementation does not delegate to the implementation class.
 void unlock()
          This method currently does not provide meaningful functionality.
 
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.IExecutionComponent
addChild, addExecutionComponentStateChangeListener, fireStateChangeEvent, getChildById, getChildByName, getChildren, getId, getName, getNode, getParent, getState, getType, getVersion, handleMessage, init, removeChild, removeExecutionComponentStateChangeListener, sendMessage, setParent
 

Constructor Detail

JavaTaskRemoteHyadesComponentStub

public JavaTaskRemoteHyadesComponentStub()
Method Detail

isActive

public boolean isActive()
This implementation does not delegate to the implementation class. All agent state information is maintained at the stub level.

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

isMonitored

public boolean isMonitored()
This implementation does not delegate to the implementation class. All agent state information is maintained at the stub level.

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

isLocked

public boolean isLocked()
This method currently does not provide meaningful functionality.

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
This method currently does not provide meaningful functionality.

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()
This method currently does not provide meaningful functionality.

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

startMonitoring

public void startMonitoring(IDataChannel processor)
                     throws ExecutionComponentStateException
This implementation always throws an UnsupportedOperationException. Use startMonitoring(IDataProcessor).

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 implementation does not delegate to the implementation class. All agent state information is maintained at the stub level.

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 dataProcessor)
                     throws ExecutionComponentStateException
This implementation does not delegate to the implementation class. All agent state information is maintained at the stub level.

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

TPTP 4.6.0 Platform Project
Public API Specification