Package com.uc4.communication.requests

Class GetAgentGroupMonitorProperties

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.GetAgentGroupMonitorProperties

public class GetAgentGroupMonitorProperties
extends XMLRequest

This class is used to get AgentGroup options of a RunID.

Constructor Summary

Constructors

Constructor	Description
GetAgentGroupMonitorProperties(int runID)	Creates a request to read the AgentGroup monitor.

Method Summary

Modifier and Type	Method	Description
protected void	createRequest(com.uc4.util.XMLDocument doc, org.w3c.dom.Element request, ConnectionAttributes sessionInfo)	Creates the XML Document for the request.
java.lang.String	getHostGroupType()	Returns the Job type of all hosts in this HostGroup.
int	getMaxParallelJobs()	Returns the maximum number of parallel tasks when the execution mode is set to ALL.
int	getRunId()	Returns the same value that has been set in the constructor.
protected java.lang.String	getSrc()	Returns the request source.
protected void	handleContent(com.uc4.util.XMLDocument doc, ConnectionAttributes session)	Sub classes extract the values from the XML document and provide public getter methods.
protected boolean	isAllowedInClientZero()	This method is used internally.
boolean	isExecuteLoadDependent()
boolean	isExecuteOnAllHosts()
boolean	isExecuteOnAnyHost()
boolean	isExecuteOnFirstHost()
boolean	isExecuteOnNextHost()

Methods inherited from class com.uc4.communication.requests.XMLRequest

assertClientZero, assertServerVersion, checkClient, checkID, checkLnr, checkNull, checkSelStatisticsPrivilege, checkSystemOverviewPrivilege, checkUC4ObjectEmptyName, checkUC4ObjectName, createNATFor, createNATRequest, emptyAttributes, getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, ignoreMessageBox, send, setMessageBox, showQuarantineNotification

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GetAgentGroupMonitorProperties

public GetAgentGroupMonitorProperties(int runID)

Creates a request to read the AgentGroup monitor.

Parameters:

runID - RunID of the HOSTG object.

Method Detail

isAllowedInClientZero

protected boolean isAllowedInClientZero()

Description copied from class: XMLRequest

This method is used internally. Tests if this XMLRequest is allowed in client 0. The default implementation returns false, subclasses may override.

Overrides:

isAllowedInClientZero in class XMLRequest

Returns:

true if this request is allowed in client 0, false otherwise

getSrc

protected java.lang.String getSrc()

Description copied from class: XMLRequest

Returns the request source. This method is used internally.

Specified by:

getSrc in class XMLRequest

Returns:

Source

createRequest

protected void createRequest(com.uc4.util.XMLDocument doc,
                             org.w3c.dom.Element request,
                             ConnectionAttributes sessionInfo)

Description copied from class: XMLRequest

Creates the XML Document for the request. This method is used internally.

Specified by:

createRequest in class XMLRequest

Parameters:

doc - Document, used to create new Elements

request - Request Element - classes append information to this request element

sessionInfo - Information about the session

handleContent

protected void handleContent(com.uc4.util.XMLDocument doc,
                             ConnectionAttributes session)

Description copied from class: XMLRequest

Sub classes extract the values from the XML document and provide public getter methods.

Overrides:

handleContent in class XMLRequest

Parameters:

doc - XML Document

session - Info about the user session

getRunId

public int getRunId()

Returns the same value that has been set in the constructor.

Returns:

RunID of the task, never 0

getHostGroupType

public java.lang.String getHostGroupType()

Returns the Job type of all hosts in this HostGroup.

Returns:

Job type

getMaxParallelJobs

public int getMaxParallelJobs()

Returns the maximum number of parallel tasks when the execution mode is set to ALL.

Returns:

Parallel tasks

isExecuteOnAllHosts

public boolean isExecuteOnAllHosts()

Returns:

True if a task will be executed on all hosts of this HostGroup

isExecuteOnFirstHost

public boolean isExecuteOnFirstHost()

Returns:

True if a task will run on the first active host in this HostGroup

isExecuteOnNextHost

public boolean isExecuteOnNextHost()

Returns:

True if the execution mode is set to NEXT

isExecuteLoadDependent

public boolean isExecuteLoadDependent()

Returns:

True if the execution mode is set to LOAD_DEPENDENT

isExecuteOnAnyHost

public boolean isExecuteOnAnyHost()

Returns:

Returns true if the task should execute on any host