com.unboundid.ldap.sdk.unboundidds.monitors

Class LoadBalancingAlgorithmServerAvailabilityData

java.lang.Object

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

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:

Serialized Form

Method Summary

Modifier and Type	Method and Description
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

@NotNull
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

@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 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(@NotNull
                     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

@NotNull
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.