Enum CohortConnectionStatus

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<CohortConnectionStatus>

    public enum CohortConnectionStatus
    extends java.lang.Enum<CohortConnectionStatus>
    implements java.io.Serializable
    CohortConnectionStatus defines the status of the local server's connection to the metadata highway for a specific cohort.
    • NOT_INITIALIZED: the local components for communicating with other members of the cohort are not initialized. This should never been seen on the adminservices console since it is the value for the cohort manager used on the variable declaration.
    • INITIALIZING: the local components for communicating with the other members of the cohort are initializing. It the server is working properly this status is only set for a split-second. If it is seen on the admin services console it probably means one of the underlying connectors is hanging during its initialization.
    • NEW: the local components for the cohort are initialized but they have not yet exchanged messages with the other members of the cohort. At this point, the local metadata collection id may be changed.
    • CONFIGURATION_ERROR: means there is an error in the configuration and connection is not possible. The administrator needs to either fix the config or fix the system's infrastructure around the server.
    • CONNECTED: means the server is connected to the metadata highway for this cohort and is exchanging messages.
    • DISCONNECTING: means the server is disconnecting from the metadata highway and is in the process of shutting down the local components that manage communication with the other members of this cohort.
    • DISCONNECTED: means the server is disconnected from the metadata highway for this cohort. This may be because the local server is shutting down or the configuration is being adjusted.
    • Method Detail

      • values

        public static CohortConnectionStatus[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (CohortConnectionStatus c : CohortConnectionStatus.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static CohortConnectionStatus valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • getStatusCode

        public int getStatusCode()
        Return the numeric code for the enum.
        Returns:
        int code
      • getStatusName

        public java.lang.String getStatusName()
        Return the name for the enum.
        Returns:
        String name
      • getStatusDescription

        public java.lang.String getStatusDescription()
        Return the description of the enum.
        Returns:
        String description