TPTP 4.5.0 Platform Project
Internal API Specification

org.eclipse.tptp.platform.execution.client.core.internal.commands
Class QueryRunningAgentsCommand

java.lang.Object
  extended by org.eclipse.tptp.platform.execution.util.internal.CommandElement
      extended by org.eclipse.tptp.platform.execution.client.core.internal.commands.QueryRunningAgentsCommand
All Implemented Interfaces:
org.eclipse.tptp.platform.execution.util.ICommandElement, Constants

public class QueryRunningAgentsCommand
extends CommandElement


Field Summary
protected  java.lang.String[] _agentInterface
           
protected  java.lang.String _agentName
           
protected  java.lang.String _commandData
           
protected  long _processID
           
 
Fields inherited from class org.eclipse.tptp.platform.execution.util.internal.CommandElement
_context, _dest, _iid, _src, _tag
 
Fields inherited from interface org.eclipse.tptp.platform.execution.util.internal.Constants
AC_DEST_ID, AC_MAGIC_NUMBER, AC_MESSAGE_HEADER_SIZE, ACK_HDR_LEN, agentAttachDenied_TAG, agentAttachedSuccessful_Cmd, agentAvailable_Cmd, agentControlGranted_Cmd, agentDeregistered_Cmd, agentID_TAG, agentIDs_TAG, agentMetadata_Cmd, agentNames_TAG, agentProcessExited_Cmd, agentReference_Cmd, agentRegistered_Cmd, agentRegistry_Cmd, agentUnavailable_Cmd, agentUnavailable_TAG, AGNT_MGR_IID, attachToAgent_Cmd, AUTHENTICATE, AUTHENTICATION_FAILED, AUTHENTICATION_SUCCESSFUL, availableAgents_Cmd, CMD_XML_BEGIN_TAG, CMD_XML_CLS_TAG, CONNECT, CONNECT_DATA, CONNECT_TIMEOUT_TRY_COUNT, CONNECTION_COMPLETE, CONNECTION_RECONNECT_REQUEST, CONNECTION_REFUSED, CTL_PORT_NUM_CLIENT, CTL_PORT_NUM_SERVER, CTX_XML_ATTR_TAG, DATA_CONNECTION_COMPLETE, DATA_CONNECTION_REFUSED, DATA_PATH_RECEIVE, DATA_PATH_SEND, DATA_PATH_TWO_WAY, DATA_PORT_NUM_CLIENT, DEST_XML_ATTR_TAG, detachFromAgent_Cmd, DIME_CONSOLE_PID_LEN, DIME_HEADER_LEN, DIME_TPTP_DP_DEF, DIME_TPTP_STDERR, DIME_TPTP_STDIN, DIME_TPTP_STDOUT, DISCONNECT, DSSRVR_LAUNCH_TIMEOUT_TRY_COUNT, ERR_NOT_SUPPORTED, GENERIC_EVNT_IID, getAgent_Cmd, GETAGENT_ID_TAG, GETAGENT_TAG, GETAGENT_TOK_TAG, getAgentMetadata_Cmd, getAgentRegistry_Cmd, getSpecificAgent_Cmd, interfaces_TAG, MAX_COMMAND_LINE_LENGTH, MAX_DATA_LENGTH, MAX_MESSAGE_LENGTH, MD5_PRESENT, MESSAGE_HEADER_LENGTH, metadata_TAG, PID_TAG, PROC_CTLR_EVNT_IID, PROC_CTLR_IID, PROCCTLR_AGENT_NAME, PROCESS_LAUNCH_TIMEOUT_TRY_COUNT, processExited_Cmd, processStarted_Cmd, processStopped_Cmd, processValidationResults_Cmd, queryAvailableAgents_Cmd, queryRunningAgents_Cmd, RA_ACKNOWLEDGEMENT_MESSAGE, RA_AGENT_ACTIVE, RA_AGENT_ATTACHED, RA_AGENT_DETACHED, RA_AGENT_DETAILS, RA_AGENT_INACTIVE, RA_AGENT_LIST, RA_AGENT_QUERY_STATE, RA_ATTACH_TO_AGENT, RA_AUTHENTICATE, RA_AUTHENTICATION_FAILED, RA_AUTHENTICATION_SUCCESSFUL, RA_BINARY_CUSTOM_COMMAND, RA_CONTROL_MESSAGE, RA_CONTROLLER_REQUEST_MONITOR, RA_CUSTOM_COMMAND, RA_DETACH_FROM_AGENT, RA_ERROR_STRING, RA_GET_PROPERTY_LIST, RA_KILL_PROCESS, RA_LAUNCH_PROCESS, RA_MAGIC, RA_MANAGE_FILE, RA_PROCESS_EXITED, RA_PROCESS_LAUNCHED, RA_PROCESS_LIST, RA_PROPERTY_LIST, RA_QUERY_AGENT_DETAILS, RA_QUERY_AGENT_LIST, RA_QUERY_PROCESS_LIST, RA_REGISTER_AGENT_NOTIFICATION, RA_RESOURCE_LOCATION, RA_SERVER_SECURITY_REQUIREMENTS, RA_SET_NAME_VALUE_PAIR, RA_START_MONITORING_AGENT_LOCAL, RA_START_MONITORING_AGENT_REMOTE, RA_STOP_MONITORING_AGENT, RA_VERSION, RAC_MESSAGE_HEADER_SIZE, Reason_TAG, releaseAgent_Cmd, releaseAgentControl_Cmd, requestAgentControl_Cmd, runningAgents_Cmd, SECURITY_REQUIRED, sizeofByte, sizeofChar, sizeofLong, sizeofShort, SRC_XML_ATTR_TAG, startProcess_Cmd, stopProcess_Cmd, TIMEOUT_PERIOD, TPTP_AC, TPTP_AC_MESSAGE, TPTP_CBE_ERROR, TPTP_CONTROLLER_ACCESS, TPTP_CREATE_INSTANCE, TPTP_DEBUG, TPTP_LOCK_AGENT, TPTP_OBSERVER_ACCESS, TPTP_PLATFORM_EXEC_MSG1, TPTP_PLATFORM_EXEC_MSG10, TPTP_PLATFORM_EXEC_MSG11, TPTP_PLATFORM_EXEC_MSG12, TPTP_PLATFORM_EXEC_MSG13, TPTP_PLATFORM_EXEC_MSG14, TPTP_PLATFORM_EXEC_MSG15, TPTP_PLATFORM_EXEC_MSG16, TPTP_PLATFORM_EXEC_MSG17, TPTP_PLATFORM_EXEC_MSG18, TPTP_PLATFORM_EXEC_MSG19, TPTP_PLATFORM_EXEC_MSG2, TPTP_PLATFORM_EXEC_MSG20, TPTP_PLATFORM_EXEC_MSG21, TPTP_PLATFORM_EXEC_MSG22, TPTP_PLATFORM_EXEC_MSG23, TPTP_PLATFORM_EXEC_MSG24, TPTP_PLATFORM_EXEC_MSG25, TPTP_PLATFORM_EXEC_MSG26, TPTP_PLATFORM_EXEC_MSG27, TPTP_PLATFORM_EXEC_MSG28, TPTP_PLATFORM_EXEC_MSG29, TPTP_PLATFORM_EXEC_MSG3, TPTP_PLATFORM_EXEC_MSG30, TPTP_PLATFORM_EXEC_MSG31, TPTP_PLATFORM_EXEC_MSG32, TPTP_PLATFORM_EXEC_MSG33, TPTP_PLATFORM_EXEC_MSG34, TPTP_PLATFORM_EXEC_MSG35, TPTP_PLATFORM_EXEC_MSG36, TPTP_PLATFORM_EXEC_MSG37, TPTP_PLATFORM_EXEC_MSG39, TPTP_PLATFORM_EXEC_MSG4, TPTP_PLATFORM_EXEC_MSG40, TPTP_PLATFORM_EXEC_MSG41, TPTP_PLATFORM_EXEC_MSG42, TPTP_PLATFORM_EXEC_MSG43, TPTP_PLATFORM_EXEC_MSG5, TPTP_PLATFORM_EXEC_MSG6, TPTP_PLATFORM_EXEC_MSG7, TPTP_PLATFORM_EXEC_MSG8, TPTP_PLATFORM_EXEC_MSG9, TPTP_RAC_MESSAGE, TPTP_RUNNING_AGENTS_ONLY, validApp_Ret, validateProcessToLaunch_Cmd, validWorkingDir_Ret, WAIT_RESPONCE_TIMEOUT, XML_CLS_TAG
 
Constructor Summary
QueryRunningAgentsCommand()
           
 
Method Summary
 java.lang.String buildCommand()
           
 java.lang.String[] getAgentInterfaceID()
           
 java.lang.String getAgentName()
           
 java.lang.String getCommandData()
           
 long getContext()
          Get the CommandElement Context
 long getDestination()
           
 java.lang.String getInterfaceID()
           
 long getProcessId()
           
 int getSize()
           
 long getSource()
           
 long getTag()
           
 int readFromBuffer(byte[] buffer, int offset)
          Read the command from the input buffer.
 void setAgentInterfaceID(int numCount, java.lang.String[] agentType)
           
 void setAgentName(java.lang.String agentName)
           
 void setCommandData(java.lang.String command)
           
 void setContext(long contextID)
           
 void setDestination(long dest)
           
 void setInterfaceID(java.lang.String interfaceID)
           
 void setProcessId(long processID)
           
 void setSource(long srcID)
           
 int writeToBuffer(byte[] buffer, int offset)
          Write the XML Command to the input buffer.
 
Methods inherited from class org.eclipse.tptp.platform.execution.util.internal.CommandElement
buildCommand, buildCommand
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_commandData

protected java.lang.String _commandData

_agentInterface

protected java.lang.String[] _agentInterface

_agentName

protected java.lang.String _agentName

_processID

protected long _processID
Constructor Detail

QueryRunningAgentsCommand

public QueryRunningAgentsCommand()
Method Detail

getSize

public int getSize()
Specified by:
getSize in interface org.eclipse.tptp.platform.execution.util.ICommandElement
Specified by:
getSize in class CommandElement
See Also:
ICommandElement.getSize()

getContext

public long getContext()
Description copied from class: CommandElement
Get the CommandElement Context

Specified by:
getContext in interface org.eclipse.tptp.platform.execution.util.ICommandElement
Overrides:
getContext in class CommandElement

setContext

public void setContext(long contextID)
Specified by:
setContext in interface org.eclipse.tptp.platform.execution.util.ICommandElement
Overrides:
setContext in class CommandElement

getProcessId

public long getProcessId()

setProcessId

public void setProcessId(long processID)

getAgentName

public java.lang.String getAgentName()

setAgentName

public void setAgentName(java.lang.String agentName)

setCommandData

public void setCommandData(java.lang.String command)

getCommandData

public java.lang.String getCommandData()

getSource

public long getSource()
Specified by:
getSource in interface org.eclipse.tptp.platform.execution.util.ICommandElement
Overrides:
getSource in class CommandElement

setSource

public void setSource(long srcID)
Specified by:
setSource in interface org.eclipse.tptp.platform.execution.util.ICommandElement
Overrides:
setSource in class CommandElement

getTag

public long getTag()
Specified by:
getTag in interface org.eclipse.tptp.platform.execution.util.ICommandElement
Overrides:
getTag in class CommandElement

getDestination

public long getDestination()
Overrides:
getDestination in class CommandElement

getInterfaceID

public java.lang.String getInterfaceID()
Specified by:
getInterfaceID in interface org.eclipse.tptp.platform.execution.util.ICommandElement
Overrides:
getInterfaceID in class CommandElement

setInterfaceID

public void setInterfaceID(java.lang.String interfaceID)
Specified by:
setInterfaceID in interface org.eclipse.tptp.platform.execution.util.ICommandElement
Overrides:
setInterfaceID in class CommandElement

getAgentInterfaceID

public java.lang.String[] getAgentInterfaceID()

setAgentInterfaceID

public void setAgentInterfaceID(int numCount,
                                java.lang.String[] agentType)

setDestination

public void setDestination(long dest)
Overrides:
setDestination in class CommandElement

buildCommand

public java.lang.String buildCommand()
Overrides:
buildCommand in class CommandElement

readFromBuffer

public int readFromBuffer(byte[] buffer,
                          int offset)
Read the command from the input buffer.

Specified by:
readFromBuffer in interface org.eclipse.tptp.platform.execution.util.ICommandElement
Specified by:
readFromBuffer in class CommandElement
Parameters:
buffer - byte[]
offset - int
Returns:
int

writeToBuffer

public int writeToBuffer(byte[] buffer,
                         int offset)
Write the XML Command to the input buffer.

Specified by:
writeToBuffer in interface org.eclipse.tptp.platform.execution.util.ICommandElement
Specified by:
writeToBuffer in class CommandElement
Parameters:
buffer - byte[]
offset - int
Returns:
int

TPTP 4.5.0 Platform Project
Internal API Specification