com.unboundid.ldap.sdk.unboundidds.monitors
Class LoadBalancingAlgorithmServerAvailabilityData

java.lang.Object
  extended by com.unboundid.ldap.sdk.unboundidds.monitors.LoadBalancingAlgorithmServerAvailabilityData
All Implemented Interfaces:
java.io.Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class LoadBalancingAlgorithmServerAvailabilityData
extends java.lang.Object
implements java.io.Serializable

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 defines a data structure that provides information about the availability of an LDAP external server associated with a load-balancing algorithm.

See Also:
Serialized Form

Method Summary
 HealthCheckState getHealthCheckState()
          Retrieves the health check state for the LDAP external server.
 java.lang.String getServerAddress()
          Retrieves the address for the LDAP external server.
 int getServerPort()
          Retrieves the port number for the LDAP external server.
 java.lang.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.
 java.lang.String toString()
          Retrieves a string representation of this server availability data object.
 void toString(java.lang.StringBuilder buffer)
          Appends a string representation of this server availability data object to the provided buffer.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getServerAddress

public java.lang.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

public HealthCheckState getHealthCheckState()
Retrieves the health check state for the LDAP external server.

Returns:
The health check state for the LDAP external server.

toString

public java.lang.String toString()
Retrieves a string representation of this server availability data object.

Overrides:
toString in class java.lang.Object
Returns:
A string representation of this server availability data object.

toString

public void toString(java.lang.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

public java.lang.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.