public class GetAgentProperties extends XMLRequest
Constructor and Description |
---|
GetAgentProperties(UC4ObjectName agentName)
Creates a new instance of the
GetAgentProperties request. |
Modifier and Type | Method and Description |
---|---|
java.util.Iterator<java.lang.String> |
agentPropertyKeyIterator()
Returns an
java.util.Iterator over Agent property keys. |
UC4ObjectName |
getAgentName()
Returns the agents name
|
java.lang.String |
getAgentProperty(java.lang.String key)
Returns the value of an Agent property or
null if the key
was not found. |
int |
getCheckInterval()
Returns the interval in seconds in which the Agent tries to contact the
Automation Engine.
|
org.w3c.dom.Element |
getHostDetailElement()
Returns a value of the HostDetail section
|
org.w3c.dom.Element |
getHostPropertiesElement()
Returns the host property element
|
org.w3c.dom.Element |
getHostTraceElement()
Returns a value of the HostDetail section
|
HostTraceOptions |
getHostTraceOptions()
Returns a HostTraceOptions Object
|
int |
getMaxFileTransfer()
Returns the maximum number of FileTransfers,
-1 if the Agent
is not active or the setting is unlimited. |
int |
getMaxJobs()
Returns the maximum number of Jobs or
-1 if the Agent is not
active or the setting is unlimited. |
int |
getMaxReportBlocks()
Returns the maximum number of report blocks;
-1 if the Agent
is not active. |
int |
getMaxTraceSize()
returns the max trace size parameter
|
int |
getNumberOfAgentDetails()
Returns the number of detail entries.
|
org.w3c.dom.Element |
getOptionsElement()
Returns the option element
|
int |
getTraceFlag(int index)
Returns the trace flag value.
|
java.lang.String |
getTraceFlagDescription(int index)
Returns a detailed description of a trace flag.
|
int |
getTraceFlagsSize()
returns the length of the trace flag array
|
java.lang.String |
getTraceFlagText(int index)
Returns the caption of a trace flag.
|
java.lang.String |
getTraceType()
returns the trace type
|
java.lang.String |
getTrigger()
returns the trigger string
|
java.lang.String |
getTriggerType()
returns the trigger type
|
boolean |
isAgentAlive()
Returns
true if this Agent is running, false if
the Agent has been stopped. |
boolean |
isHostAlive()
Returns true if the Host is running or false if not.
|
getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, send
public GetAgentProperties(UC4ObjectName agentName)
GetAgentProperties
request.agentName
- Name of the Agentpublic java.lang.String getAgentProperty(java.lang.String key)
null
if the key
was not found.key
- Key as Stringnull
if not foundpublic int getNumberOfAgentDetails()
public boolean isHostAlive()
public UC4ObjectName getAgentName()
public java.util.Iterator<java.lang.String> agentPropertyKeyIterator()
java.util.Iterator
over Agent property keys.
These keys can be used with the method getAgentProperty
. The
remove()
method will throw an exception.public java.lang.String getTraceFlagText(int index)
index
- Indexpublic int getTraceFlag(int index)
index
- Index of the trace settingpublic java.lang.String getTraceFlagDescription(int index)
index
- Indexpublic boolean isAgentAlive()
true
if this Agent is running, false
if
the Agent has been stopped.public int getMaxJobs()
-1
if the Agent is not
active or the setting is unlimited.public int getMaxFileTransfer()
-1
if the Agent
is not active or the setting is unlimited.public int getMaxReportBlocks()
-1
if the Agent
is not active.public int getCheckInterval()
public org.w3c.dom.Element getHostTraceElement()
public org.w3c.dom.Element getHostDetailElement()
public org.w3c.dom.Element getOptionsElement()
public org.w3c.dom.Element getHostPropertiesElement()
public HostTraceOptions getHostTraceOptions()
public int getTraceFlagsSize()
public int getMaxTraceSize()
public java.lang.String getTriggerType()
public java.lang.String getTraceType()
public java.lang.String getTrigger()