TPTP 4.6.0 Platform Project
Internal API Specification

org.eclipse.hyades.internal.execution.local.control
Interface Node

All Superinterfaces:
CommandHandler
All Known Implementing Classes:
NodeImpl

public interface Node
extends CommandHandler


Method Summary
 Connection connect(int port)
          Attempt to connect to this node.
 java.util.Enumeration fastListProcesses()
          Enumerate all the active processes on this node.
 java.net.InetAddress[] getAllInetAddresses()
          Retrives all the InetAddresses for this Node.
 Application getApplication()
           
 Connection getConnection()
          Retrieve the connection associated with this node object
 java.net.InetAddress getInetAddress()
          Retrieve the InetAddress for this Node.
 java.lang.String getName()
          Retrieve the host name for this Node.
 Process getProcess(java.lang.String processId)
          Retrieve a specific Process on this Node
 SetNVPairCommand[] getPropertyValues(java.lang.String name, java.lang.String type)
          Enumerate all the properties on this node.
 org.eclipse.hyades.execution.security.ISecureClientParameters getSecurityParameters()
           
 User getUser()
          Retrieve the user for this node.
 boolean isConnected()
          Is this controller connected to this node
 void killProcess(Process process)
          Terminates the specified process on this node.
 java.util.Enumeration listMonitors()
          Enumerate all the monitors on this node.
 java.util.Enumeration listProcesses()
          Enumerate all the active processes on this node.
 void reboot(long delay)
          Causes this node to reboot after the specified number of seconds.
 void setApplication(Application app)
           
 void setSecurityParameters(org.eclipse.hyades.execution.security.ISecureClientParameters manager)
           
 void setUser(User user)
          Update the user for this node.
 void shutdown(long delay)
          Causes this node to shutdown after the specified number of seconds.
 Process waitForProcess(java.lang.String processIdentity, int timeout)
          Blocks calling thread until the process is retrieved, if the process cannot be retrieved within the timeout period, null is returned for the process return value.
 
Methods inherited from interface org.eclipse.hyades.internal.execution.local.control.CommandHandler
incommingCommand
 

Method Detail

killProcess

void killProcess(Process process)
                 throws InactiveProcessException,
                        NotConnectedException
Terminates the specified process on this node.

Throws:
InactiveProcessException
NotConnectedException

shutdown

void shutdown(long delay)
              throws NotConnectedException
Causes this node to shutdown after the specified number of seconds.

Throws:
NotConnectedException

reboot

void reboot(long delay)
            throws NotConnectedException
Causes this node to reboot after the specified number of seconds.

Throws:
NotConnectedException

listMonitors

java.util.Enumeration listMonitors()
                                   throws NotConnectedException
Enumerate all the monitors on this node.

Throws:
NotConnectedException

listProcesses

java.util.Enumeration listProcesses()
                                    throws NotConnectedException
Enumerate all the active processes on this node. This method has side effects of storing the process list within the node, populating the agents within each process in that list and retrieving the details of each agent in each process.

Throws:
NotConnectedException

fastListProcesses

java.util.Enumeration fastListProcesses()
                                        throws NotConnectedException
Enumerate all the active processes on this node. This method has side effects of storing the process list within the node and populating the agents within each process in that list Unlike the listProcesses() method, it does *not* retrieve the details for each agent.

Throws:
NotConnectedException

getPropertyValues

SetNVPairCommand[] getPropertyValues(java.lang.String name,
                                     java.lang.String type)
                                     throws NotConnectedException
Enumerate all the properties on this node.

Throws:
NotConnectedException

getProcess

Process getProcess(java.lang.String processId)
Retrieve a specific Process on this Node


getInetAddress

java.net.InetAddress getInetAddress()
Retrieve the InetAddress for this Node.


getAllInetAddresses

java.net.InetAddress[] getAllInetAddresses()
Retrives all the InetAddresses for this Node.


getName

java.lang.String getName()
Retrieve the host name for this Node.


isConnected

boolean isConnected()
Is this controller connected to this node


connect

Connection connect(int port)
                   throws AgentControllerUnavailableException,
                          SecureConnectionRequiredException,
                          UntrustedAgentControllerException,
                          LoginFailedException
Attempt to connect to this node.

Throws:
AgentControllerUnavailableException
SecureConnectionRequiredException
UntrustedAgentControllerException
LoginFailedException

getConnection

Connection getConnection()
Retrieve the connection associated with this node object


getUser

User getUser()
Retrieve the user for this node.


setUser

void setUser(User user)
Update the user for this node.


waitForProcess

Process waitForProcess(java.lang.String processIdentity,
                       int timeout)
                       throws NotConnectedException,
                              InactiveProcessException
Blocks calling thread until the process is retrieved, if the process cannot be retrieved within the timeout period, null is returned for the process return value.

Parameters:
processIdentity - the identity of the process to wait for
timeout - the maximum time to wait for the process to be retrieved
Returns:
the process retrieved or null if the timeout is reached before the process is found
Throws:
NotConnectedException
InactiveProcessException

setApplication

void setApplication(Application app)

getApplication

Application getApplication()

setSecurityParameters

void setSecurityParameters(org.eclipse.hyades.execution.security.ISecureClientParameters manager)

getSecurityParameters

org.eclipse.hyades.execution.security.ISecureClientParameters getSecurityParameters()

TPTP 4.6.0 Platform Project
Internal API Specification