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. |
protected void |
createRequest(com.uc4.util.XMLDocument doc,
org.w3c.dom.Element request,
ConnectionAttributes sessionInfo)
Creates the XML Document for the request.
|
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
|
protected java.lang.String |
getSrc()
Returns the request source.
|
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
|
protected void |
handleContent(com.uc4.util.XMLDocument doc,
ConnectionAttributes session) |
boolean |
isAgentAlive()
Returns
true if this Agent is running, false if
the Agent has been stopped. |
protected boolean |
isAllowedInClientZero()
This method is used internally.
|
boolean |
isHostAlive()
Returns true if the Host is running or false if not.
|
assertClientZero, assertServerVersion, checkClient, checkID, checkLnr, checkNull, checkSelStatisticsPrivilege, checkSystemOverviewPrivilege, checkUC4ObjectEmptyName, checkUC4ObjectName, createNATFor, createNATRequest, emptyAttributes, getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, ignoreMessageBox, send, setMessageBox, showQuarantineNotification
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.protected java.lang.String getSrc()
XMLRequest
getSrc
in class XMLRequest
protected void createRequest(com.uc4.util.XMLDocument doc, org.w3c.dom.Element request, ConnectionAttributes sessionInfo)
XMLRequest
createRequest
in class XMLRequest
doc
- Document, used to create new Elementsrequest
- Request Element - classes append information to this request elementsessionInfo
- Information about the sessionprotected void handleContent(com.uc4.util.XMLDocument doc, ConnectionAttributes session)
handleContent
in class XMLRequest
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()
protected boolean isAllowedInClientZero()
XMLRequest
XMLRequest
is allowed in client 0.
The default implementation returns false
, subclasses may override.isAllowedInClientZero
in class XMLRequest
true
if this request is allowed in client 0, false
otherwisepublic 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()