Package com.uc4.communication.requests

Class GetAgentGroupProperties

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.GetAgentGroupProperties

public class GetAgentGroupProperties
extends XMLRequest

Returns the properties of an Agent Group.

Constructor Summary

Constructors

Constructor	Description
GetAgentGroupProperties(UC4ObjectName agentName)	Creates a new instance of the GetAgentGroupProperties request.

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.
UC4ObjectName	getAgentGroupName()	Returns the agents name
int	getCheckInterval()	Returns the interval in seconds in which the Agent Group tries to contact the Automation Engine.
org.w3c.dom.Element	getHostgPropertiesElement()	Returns the host group property element
int	getMaxFileTransfer()	Returns the maximum number of FileTransfers, -1 if the Agent Group is not active or the setting is unlimited.
int	getMaxJobs()	Returns the maximum number of Jobs or -1 if the Agent Group is not active or the setting is unlimited.
int	getMaxReportBlocks()	Returns the maximum number of report blocks; -1 if the Agent Group is not active.
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.
boolean	isAgentAlive()	Returns true if this Agent Group 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.

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

GetAgentGroupProperties

public GetAgentGroupProperties(UC4ObjectName agentName)

Creates a new instance of the GetAgentGroupProperties request.

Parameters:

agentName - Name of the Agent

Method Detail

isHostAlive

public boolean isHostAlive()

Returns true if the Host is running or false if not.

Returns:

boolean

getAgentGroupName

public UC4ObjectName getAgentGroupName()

Returns the agents name

Returns:

UC4ObjectName

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

isAgentAlive

public boolean isAgentAlive()

Returns true if this Agent Group is running, false if the Agent has been stopped.

Returns:

Is Agent Group active?

getMaxJobs

public int getMaxJobs()

Returns the maximum number of Jobs or -1 if the Agent Group is not active or the setting is unlimited.

Returns:

Max number of Jobs

getMaxFileTransfer

public int getMaxFileTransfer()

Returns the maximum number of FileTransfers, -1 if the Agent Group is not active or the setting is unlimited.

Returns:

Max number of FileTransfers

getMaxReportBlocks

public int getMaxReportBlocks()

Returns the maximum number of report blocks; -1 if the Agent Group is not active.

Returns:

Number of report blocks

getCheckInterval

public int getCheckInterval()

Returns the interval in seconds in which the Agent Group tries to contact the Automation Engine. If this alive check is not successful the Agent will disconnect.

Returns:

Server check interval in seconds

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

getHostgPropertiesElement

public org.w3c.dom.Element getHostgPropertiesElement()

Returns the host group property element

Returns:

Element