Package com.unboundid.ldap.sdk.unboundidds.monitors

Class LoadBalancingAlgorithmServerAvailabilityData

java.lang.Object
com.unboundid.ldap.sdk.unboundidds.monitors.LoadBalancingAlgorithmServerAvailabilityData
All Implemented Interfaces:
Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class LoadBalancingAlgorithmServerAvailabilityData extends Object implements Serializable
This class defines a data structure that provides information about the availability of an LDAP external server associated with a load-balancing algorithm.
NOTE: This class, and other classes within the com.unboundid.ldap.sdk.unboundidds package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.
See Also:

  • Method Details

    • getServerAddress

      @NotNull public String getServerAddress()
      Retrieves the address for the LDAP external server.
      Returns:
      The address for the LDAP external server.

    • getServerPort

      public int getServerPort()
      Retrieves the port number for the LDAP external server.
      Returns:
      The port number for the LDAP external server.

    • getHealthCheckState

      @NotNull public HealthCheckState getHealthCheckState()
      Retrieves the health check state for the LDAP external server.
      Returns:
      The health check state for the LDAP external server.

    • toString

      @NotNull public String toString()
      Retrieves a string representation of this server availability data object.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this server availability data object.

    • toString

      public void toString(@NotNull StringBuilder buffer)
      Appends a string representation of this server availability data object to the provided buffer.
      Parameters:
      buffer - The buffer to which the information should be appended.

    • toCompactString

      @NotNull public String toCompactString()
      Retrieves a compact representation of the server availability data, in the form in which it appears in the load-balancing algorithm monitor entry.
      Returns:
      A compact representation of the server availability data.