Package com.uc4.communication.requests

Class GetAgentProperties

  • public class GetAgentProperties
extends XMLRequest
    Returns the properties of an Agent.

    • Constructor Detail

      • GetAgentProperties

        public GetAgentProperties​(UC4ObjectName agentName)
        Creates a new instance of the GetAgentProperties request.
        Parameters:
        agentName - Name of the Agent

    • Method Detail

      • getAgentProperty

        public java.lang.String getAgentProperty​(java.lang.String key)
        Returns the value of an Agent property or null if the key was not found.
        Parameters:
        key - Key as String
        Returns:
        Value or null if not found

      • getNumberOfAgentDetails

        public int getNumberOfAgentDetails()
        Returns the number of detail entries.
        Returns:
        Number of details

      • isHostAlive

        public boolean isHostAlive()
        Returns true if the Host is running or false if not.
        Returns:
        boolean

      • getAgentName

        public UC4ObjectName getAgentName()
        Returns the agents name
        Returns:
        UC4ObjectName

      • agentPropertyKeyIterator

        public java.util.Iterator<java.lang.String> agentPropertyKeyIterator()
        Returns an java.util.Iterator over Agent property keys. These keys can be used with the method getAgentProperty. The remove() method will throw an exception.
        Returns:
        Iterator over existing keys

      • 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

      • getTraceFlagText

        public java.lang.String getTraceFlagText​(int index)
        Returns the caption of a trace flag.
        Parameters:
        index - Index
        Returns:
        Text

      • getTraceFlag

        public int getTraceFlag​(int index)
        Returns the trace flag value. If the Agent is not running zero is returned.
        Parameters:
        index - Index of the trace setting
        Returns:
        value

      • getTraceFlagDescription

        public java.lang.String getTraceFlagDescription​(int index)
        Returns a detailed description of a trace flag.
        Parameters:
        index - Index
        Returns:
        Text which explains the different settings

      • isAgentAlive

        public boolean isAgentAlive()
        Returns true if this Agent is running, false if the Agent has been stopped.
        Returns:
        Is Agent active?

      • getMaxJobs

        public int getMaxJobs()
        Returns the maximum number of Jobs or -1 if the Agent 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 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 is not active.
        Returns:
        Number of report blocks

      • getCheckInterval

        public int getCheckInterval()
        Returns the interval in seconds in which the Agent 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

      • getHostTraceElement

        public org.w3c.dom.Element getHostTraceElement()
        Returns a value of the HostDetail section
        Returns:
        Element

      • getHostDetailElement

        public org.w3c.dom.Element getHostDetailElement()
        Returns a value of the HostDetail section
        Returns:
        Element

      • getOptionsElement

        public org.w3c.dom.Element getOptionsElement()
        Returns the option element
        Returns:
        Element

      • getHostPropertiesElement

        public org.w3c.dom.Element getHostPropertiesElement()
        Returns the host property element
        Returns:
        Element

      • getHostTraceOptions

        public HostTraceOptions getHostTraceOptions()
        Returns a HostTraceOptions Object
        Returns:
        HostTraceOptions

      • getTraceFlagsSize

        public int getTraceFlagsSize()
        returns the length of the trace flag array
        Returns:
        int

      • getMaxTraceSize

        public int getMaxTraceSize()
        returns the max trace size parameter
        Returns:
        int

      • getTriggerType

        public java.lang.String getTriggerType()
        returns the trigger type
        Returns:
        String

      • getTraceType

        public java.lang.String getTraceType()
        returns the trace type
        Returns:
        String

      • getTrigger

        public java.lang.String getTrigger()
        returns the trigger string
        Returns:
        String