com.unboundid.ldap.sdk.unboundidds.monitors
Enum HealthCheckState

java.lang.Object
  extended by java.lang.Enum<HealthCheckState>
      extended by com.unboundid.ldap.sdk.unboundidds.monitors.HealthCheckState
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<HealthCheckState>

@ThreadSafety(level=COMPLETELY_THREADSAFE)
public enum HealthCheckState
extends java.lang.Enum<HealthCheckState>

NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.
This class provides information about the health check states that may be held by an LDAP external server.


Enum Constant Summary
AVAILABLE
          The health check state that indicates that the associated LDAP external server is available.
DEGRADED
          The health check state that indicates that the associated LDAP external server is in a degraded state.
NO_LOCAL_SERVERS
          The health check state that indicates that there are no local servers defined, and therefore no health information is available for local servers.
NO_REMOTE_SERVERS
          The health check state that indicates that there are no local servers defined, and therefore no health information is available for remote servers.
UNAVAILABLE
          The health check state that indicates that the associated LDAP external server is unavailable.
 
Method Summary
static HealthCheckState forName(java.lang.String name)
          Retrieves the health check state with the specified name.
 java.lang.String getName()
          Retrieves the name for this health check state.
 java.lang.String toString()
          Retrieves a string representation of this health check state.
static HealthCheckState valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static HealthCheckState[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

AVAILABLE

public static final HealthCheckState AVAILABLE
The health check state that indicates that the associated LDAP external server is available.


DEGRADED

public static final HealthCheckState DEGRADED
The health check state that indicates that the associated LDAP external server is in a degraded state.


UNAVAILABLE

public static final HealthCheckState UNAVAILABLE
The health check state that indicates that the associated LDAP external server is unavailable.


NO_LOCAL_SERVERS

public static final HealthCheckState NO_LOCAL_SERVERS
The health check state that indicates that there are no local servers defined, and therefore no health information is available for local servers.


NO_REMOTE_SERVERS

public static final HealthCheckState NO_REMOTE_SERVERS
The health check state that indicates that there are no local servers defined, and therefore no health information is available for remote servers.

Method Detail

values

public static HealthCheckState[] 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 (HealthCheckState c : HealthCheckState.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static HealthCheckState 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

getName

public java.lang.String getName()
Retrieves the name for this health check state.

Returns:
The name for this health check state.

forName

public static HealthCheckState forName(java.lang.String name)
Retrieves the health check state with the specified name.

Parameters:
name - The name of the health check state to retrieve.
Returns:
The health check state with the specified name, or null if there is no health check state with the given name.

toString

public java.lang.String toString()
Retrieves a string representation of this health check state.

Overrides:
toString in class java.lang.Enum<HealthCheckState>
Returns:
A string representation of this health check state.