Package com.uc4.api.systemoverview

Class AgentListItem

  • public class AgentListItem
extends java.lang.Object
    This class describes one item of the Agent list in the system overview.

    • Constructor Summary

      Constructors 
      Constructor Description
      AgentListItem​(com.uc4.util.XMLDocument doc, org.w3c.dom.Element row, int simulationOffset, ConnectionAttributes session)
      Constructs a AgentListItem using the specified Element.

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      java.lang.String getAgentType()
      Returns the type (HostAttrType) of the agent.
      java.lang.String getAuthorizations()
      Returns the rights assigned to the Agent.
      java.lang.String getCompression()
      Returns the Compression type.
      java.lang.String getCp()
      Returns the linked communication process.
      java.lang.String getGwName()
      Returns the name of the TLS-Gateway, which the Agent uses as CP Port.
      java.lang.String getHardware()
      Returns the computer's hardware information (i.e.
      java.lang.String getId()
      Returns the ID of the Agent.
      java.lang.String getIpAddress()
      Returns the Agent's TCP/IP address.
      java.lang.String getJclVariant()
      Returns the JCL (Job Control Language) variant.
      int getKeepAlive()
      Returns the interval in which the server queries the Agent to test if the Agent is alive.
      DateTime getLastCheck()
      Returns the time of last check or null if this host is not active.
      DateTime getLastLogoff()  
      java.lang.String getLicenseCategory()
      Deprecated.
      the license check has been removed in version 12.2 and higher
      char getLicenseClass()
      Deprecated.
      the license check has been removed in version 12.2 and higher
      java.lang.String getMaxFileTransferResources()  
      java.lang.String getMaxJobResources()  
      java.lang.String getMib()
      Returns the Agent's MIB information.
      UC4HostName getName()
      Returns the name of the Agent.
      java.lang.String getNetArea()  
      int getNumberOfClients()  
      int getPort()
      Returns the Agent's port number.
      java.lang.String getProcessID()
      Returns the process ID of this Agent.
      java.lang.String getRoles()  
      java.lang.String getService()
      Returns the services of the Agent (Mail or Database).
      java.lang.String getSoftware()
      Returns Computer's operating system.
      java.lang.String getSoftwareVersion()
      Returns the version of the operating system.
      java.lang.String getTimeDifference()
      Returns the time difference between Agent and Automation Engine system.
      java.lang.String getVersion()
      Returns the Agent version including patch level.
      java.lang.String getZduVersion()  
      boolean isActive()
      Returns true if the Agent is running.
      boolean isAuthenticated()
      Returns true if the agent is authenticated, false otherwise.
      boolean isLinked()
      Returns true if this process is linked to the service manager.
      boolean isTls()
      Returns true, if this is a TLS Agent.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • AgentListItem

        public AgentListItem​(com.uc4.util.XMLDocument doc,
                     org.w3c.dom.Element row,
                     int simulationOffset,
                     ConnectionAttributes session)
        Constructs a AgentListItem using the specified Element. Internal use only.
        Parameters:
        doc - XML document
        row - Element
        simulationOffset - Simulation offset
        session - Session info

    • Method Detail

      • getId

        public java.lang.String getId()
        Returns the ID of the Agent.
        Returns:
        ID

      • getNetArea

        public java.lang.String getNetArea()
        Returns:
        Net area

      • getProcessID

        public java.lang.String getProcessID()
        Returns the process ID of this Agent.
        Returns:
        Process ID

      • isLinked

        public boolean isLinked()
        Returns true if this process is linked to the service manager.
        Returns:
        true if linked false otherwise

      • getNumberOfClients

        public int getNumberOfClients()
        Returns:
        Number of clients in which the Agent can be used

      • getLastLogoff

        public DateTime getLastLogoff()
        Returns:
        Last logoff date and time

      • isAuthenticated

        public boolean isAuthenticated()
        Returns true if the agent is authenticated, false otherwise.
        Returns:
        True if authenticated

      • getRoles

        public java.lang.String getRoles()
        Returns:
        Returns the roles of this host or an empty String if no roles where assigned

      • getKeepAlive

        public int getKeepAlive()
        Returns the interval in which the server queries the Agent to test if the Agent is alive.
        Returns:
        Keep alive interval in seconds

      • getMaxFileTransferResources

        public java.lang.String getMaxFileTransferResources()
        Returns:
        Maximum FileTransfer Resources

      • getMaxJobResources

        public java.lang.String getMaxJobResources()
        Returns:
        Maximum Job Resources

      • getLicenseCategory

        @Deprecated
public java.lang.String getLicenseCategory()
        Deprecated.
        the license check has been removed in version 12.2 and higher
        Returns the name of the license category assigned to the Agent.
        Returns:
        license category

      • isActive

        public boolean isActive()
        Returns true if the Agent is running.
        Returns:
        Agent status

      • getCompression

        public java.lang.String getCompression()
        Returns the Compression type. The value is read from the Variable UC_HOSTCHAR_DEFAULT.
        Returns:
        Compression Type

      • getCp

        public java.lang.String getCp()
        Returns the linked communication process.
        Returns:
        CP

      • getHardware

        public java.lang.String getHardware()
        Returns the computer's hardware information (i.e. system type, number of processors, processor type)
        Returns:
        Hardware

      • getIpAddress

        public java.lang.String getIpAddress()
        Returns the Agent's TCP/IP address.
        Returns:
        IP Address

      • getJclVariant

        public java.lang.String getJclVariant()
        Returns the JCL (Job Control Language) variant.
        Returns:
        JCL Variant

      • getLastCheck

        public DateTime getLastCheck()
        Returns the time of last check or null if this host is not active.
        Returns:
        last check

      • getLicenseClass

        @Deprecated
public char getLicenseClass()
        Deprecated.
        the license check has been removed in version 12.2 and higher
        Returns the Agent's license class.
        Returns:
        license class

      • getService

        public java.lang.String getService()
        Returns the services of the Agent (Mail or Database).
        Returns:
        String containing agent services

      • getMib

        public java.lang.String getMib()
        Returns the Agent's MIB information.
        Returns:
        MIB

      • getAuthorizations

        public java.lang.String getAuthorizations()
        Returns the rights assigned to the Agent.
        Returns:
        Authorizations

      • getName

        public UC4HostName getName()
        Returns the name of the Agent.
        Returns:
        Name of the Agent

      • getPort

        public int getPort()
        Returns the Agent's port number.
        Returns:
        Port

      • getSoftware

        public java.lang.String getSoftware()
        Returns Computer's operating system.
        Returns:
        Software

      • getSoftwareVersion

        public java.lang.String getSoftwareVersion()
        Returns the version of the operating system.
        Returns:
        Software version

      • getTimeDifference

        public java.lang.String getTimeDifference()
        Returns the time difference between Agent and Automation Engine system.
        Returns:
        time difference

      • getVersion

        public java.lang.String getVersion()
        Returns the Agent version including patch level.
        Returns:
        Agent version

      • getZduVersion

        public java.lang.String getZduVersion()
        Returns:
        ZDU version

      • getAgentType

        public java.lang.String getAgentType()
        Returns the type (HostAttrType) of the agent.
        Returns:
        agent type

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • isTls

        public boolean isTls()
        Returns true, if this is a TLS Agent.
        Returns:
        is tls agent

      • getGwName

        public java.lang.String getGwName()
        Returns the name of the TLS-Gateway, which the Agent uses as CP Port.