Package com.uc4.api.systemoverview

Class ServerListItem

  • public class ServerListItem
extends java.lang.Object
    This class describes a single row in the server list of the system overview.

    • Constructor Summary

      Constructors 
      Constructor Description
      ServerListItem​(org.w3c.dom.Element row, ConnectionAttributes session)
      Constructs a ServerListEntry from an Element.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object other)  
      int getB01()
      Returns the percentage of server process utilization over the last minute.
      int getB10()
      Percentage of server process utilization over the last 10 minutes.
      int getB60()
      Percentage of server process utilization over the last 60 minutes.
      int getConnections()
      Returns the number of connections to clients of communication processes.
      java.lang.String getHostName()
      Returns the name of the computer on which the server process is running.
      java.lang.String getId()
      Returns the ID of this server process.
      java.lang.String getIpAddress()
      Returns the TCP/IP address of the server process.
      java.lang.String getMqSetActive()
      Returns the name of the message queue set for new message.
      java.lang.String getMqSetOwn()
      Returns the name of the message queue set that is used by this server.
      java.lang.String getName()
      Returns the Server process name.
      java.lang.String getNetArea()  
      int getPort()
      Returns the Server process port number.
      java.lang.String getProcessId()
      Returns the process identification number of the server process.
      java.lang.String getRole()
      Returns the role of the work process.
      java.lang.String[] getRoles()
      Returns all roles that the work process has assigned.
      DateTime getServerTime()
      Returns the Date and time of the computer on which the server process is running or null if the server process is not active.
      java.lang.String getTimeDifference()
      Returns the time difference between the computer on which the server process is running and the Automation Engine.
      char getType()
      Returns the process type.
      java.lang.String getVersion()
      Returns the server process version including the patch level.
      java.lang.String getZduVersion()  
      int hashCode()  
      boolean isActive()
      Returns true if the process is active.
      boolean isDedicated()
      Returns if a process is started with a dedicated role.
      boolean isLinked()
      Returns true if this process is linked to the service manager.
      boolean isMqSetActive()
      Returns true if mqSetActive = mqSetOwn.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • ServerListItem

        public ServerListItem​(org.w3c.dom.Element row,
                      ConnectionAttributes session)
        Constructs a ServerListEntry from an Element.
        Parameters:
        row - Element
        session - Session info

    • Method Detail

      • getId

        public java.lang.String getId()
        Returns the ID of this server process.
        Returns:
        ID

      • getNetArea

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

      • isMqSetActive

        public boolean isMqSetActive()
        Returns true if mqSetActive = mqSetOwn.
        Returns:
        true if active false otherwise

      • isLinked

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

      • getRole

        public java.lang.String getRole()
        Returns the role of the work process.
        Returns:
        Role, for example R, O or RO

      • getRoles

        public java.lang.String[] getRoles()
        Returns all roles that the work process has assigned.
        Returns:
        Roles of this work process

      • getTimeDifference

        public java.lang.String getTimeDifference()
        Returns the time difference between the computer on which the server process is running and the Automation Engine.
        Returns:
        time difference

      • getB01

        public int getB01()
        Returns the percentage of server process utilization over the last minute.
        Returns:
        B01

      • getB10

        public int getB10()
        Percentage of server process utilization over the last 10 minutes.
        Returns:
        B10

      • getB60

        public int getB60()
        Percentage of server process utilization over the last 60 minutes.
        Returns:
        B60

      • getHostName

        public java.lang.String getHostName()
        Returns the name of the computer on which the server process is running.
        Returns:
        server host

      • getIpAddress

        public java.lang.String getIpAddress()
        Returns the TCP/IP address of the server process.
        Returns:
        TCP address

      • getName

        public java.lang.String getName()
        Returns the Server process name. This name is a combination of the system name, #, process type and the consecutive 3-digit process type number.
        Returns:
        Server name

      • getConnections

        public int getConnections()
        Returns the number of connections to clients of communication processes.
        Returns:
        Number of clients

      • getPort

        public int getPort()
        Returns the Server process port number.
        Returns:
        Port

      • getProcessId

        public java.lang.String getProcessId()
        Returns the process identification number of the server process.
        Returns:
        Process ID

      • getServerTime

        public DateTime getServerTime()
        Returns the Date and time of the computer on which the server process is running or null if the server process is not active.
        Returns:
        Server Time

      • getType

        public char getType()
        Returns the process type.
        • C ... Communication Process
        • P ... Primary Work Process
        • W ... Work Process
        • D ... Dialog Process
        • J ... Java Server Process
        • A ... REST API
        • T ... JCP (TLS)
        Returns:
        process type

      • getVersion

        public java.lang.String getVersion()
        Returns the server process version including the patch level.
        Returns:
        Version

      • getZduVersion

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

      • isActive

        public boolean isActive()
        Returns true if the process is active.
        Returns:
        process state

      • getMqSetOwn

        public java.lang.String getMqSetOwn()
        Returns the name of the message queue set that is used by this server. The PWP always uses both message queue sets.
        Returns:
        MQ-Set of this server process or an empty String if the server is not active. The return value is never null.

      • getMqSetActive

        public java.lang.String getMqSetActive()
        Returns the name of the message queue set for new message. This set is different from the own MQ set in case of a zero downtime update.
        Returns:
        Active Set of message queue tables or an empty String if the server is not running

      • isDedicated

        public boolean isDedicated()
        Returns if a process is started with a dedicated role. This can is currently possible for JWPs only. The process can take his dedicated role only.
        Returns:
        if a process is started with a dedicated role

      • equals

        public boolean equals​(java.lang.Object other)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

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