Class LoadBalancingAlgorithmMonitorEntry
- java.lang.Object
-
- com.unboundid.ldap.sdk.unboundidds.monitors.MonitorEntry
-
- com.unboundid.ldap.sdk.unboundidds.monitors.LoadBalancingAlgorithmMonitorEntry
-
- All Implemented Interfaces:
java.io.Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class LoadBalancingAlgorithmMonitorEntry extends MonitorEntry
This class defines a monitor entry that provides information about a load-balancing algorithm used by the Directory Proxy Server.
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.
Information that it may make available includes:- The aggregate health check state for servers associated with the load-balancing algorithm.
- Information about each server associated with the load-balancing algorithm, including the address, port, and health check state for the server.
- The number of available, degraded, and unavailable servers associated with the load-balancing algorithm.
MonitorManager.getLoadBalancingAlgorithmMonitorEntries(com.unboundid.ldap.sdk.LDAPConnection)
method. These entries provide specific methods for accessing this information. Alternately, the information may be accessed using the generic API. See theMonitorManager
class documentation for an example that demonstrates the use of the generic API for accessing monitor data.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected static java.lang.String
LOAD_BALANCING_ALGORITHM_MONITOR_OC
The structural object class used in LDAP external server monitor entries.
-
Constructor Summary
Constructors Constructor Description LoadBalancingAlgorithmMonitorEntry(Entry entry)
Creates a new load-balancing algorithm monitor entry from the provided entry.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getAlgorithmName()
Retrieves the name of the load-balancing algorithm.java.lang.String
getConfigEntryDN()
Retrieves the DN of the configuration entry for the load-balancing algorithm.HealthCheckState
getHealthCheckState()
Retrieves the aggregate health check state for the load-balancing algorithm.HealthCheckState
getLocalServersHealthCheckState()
Retrieves the aggregate health check state for local servers for the load-balancing algorithm.java.util.Map<java.lang.String,MonitorAttribute>
getMonitorAttributes()
Retrieves the set of parsed monitor attributes for this monitor entry, mapped from a unique identifier (in all lowercase characters) to the corresponding monitor attribute.java.lang.String
getMonitorDescription()
Retrieves a human-readable description name for this monitor entry.java.lang.String
getMonitorDisplayName()
Retrieves a human-readable display name for this monitor entry.HealthCheckState
getNonLocalServersHealthCheckState()
Retrieves the aggregate health check state for non-local servers for the load-balancing algorithm.java.lang.Long
getNumAvailableServers()
Retrieves the number of servers associated with the load-balancing algorithm that have a health check state of AVAILABLE.java.lang.Long
getNumDegradedServers()
Retrieves the number of servers associated with the load-balancing algorithm that have a health check state of DEGRADED.java.lang.Long
getNumUnavailableServers()
Retrieves the number of servers associated with the load-balancing algorithm that have a health check state of UNAVAILABLE.java.util.List<LoadBalancingAlgorithmServerAvailabilityData>
getServerAvailabilityData()
Retrieves a list with information about the healths of the individual LDAP external servers associated with the load-balancing algorithm.-
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.monitors.MonitorEntry
addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, decode, getBoolean, getDate, getDN, getDouble, getEntry, getInteger, getLong, getMonitorClass, getMonitorName, getString, getStrings, toString, toString
-
-
-
-
Field Detail
-
LOAD_BALANCING_ALGORITHM_MONITOR_OC
@NotNull protected static final java.lang.String LOAD_BALANCING_ALGORITHM_MONITOR_OC
The structural object class used in LDAP external server monitor entries.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
LoadBalancingAlgorithmMonitorEntry
public LoadBalancingAlgorithmMonitorEntry(@NotNull Entry entry)
Creates a new load-balancing algorithm monitor entry from the provided entry.- Parameters:
entry
- The entry to be parsed as a load-balancing algorithm monitor entry. It must not benull
.
-
-
Method Detail
-
getAlgorithmName
@Nullable public java.lang.String getAlgorithmName()
Retrieves the name of the load-balancing algorithm.- Returns:
- The name of the load-balancing algorithm, or
null
if it was not included in the monitor entry.
-
getConfigEntryDN
@Nullable public java.lang.String getConfigEntryDN()
Retrieves the DN of the configuration entry for the load-balancing algorithm.- Returns:
- The DN of the configuration entry for the load-balancing
algorithm, or
null
if it was not included in the monitor entry.
-
getHealthCheckState
@Nullable public HealthCheckState getHealthCheckState()
Retrieves the aggregate health check state for the load-balancing algorithm.- Returns:
- The aggregate health check state for the load-balancing algorithm,
or
null
if it was not included in the monitor entry.
-
getLocalServersHealthCheckState
@Nullable public HealthCheckState getLocalServersHealthCheckState()
Retrieves the aggregate health check state for local servers for the load-balancing algorithm.- Returns:
- The aggregate health check state for local servers for the
load-balancing algorithm, or
null
if it was not included in the monitor entry.
-
getNonLocalServersHealthCheckState
@Nullable public HealthCheckState getNonLocalServersHealthCheckState()
Retrieves the aggregate health check state for non-local servers for the load-balancing algorithm.- Returns:
- The aggregate health check state for non-local servers for the
load-balancing algorithm, or
null
if it was not included in the monitor entry.
-
getServerAvailabilityData
@NotNull public java.util.List<LoadBalancingAlgorithmServerAvailabilityData> getServerAvailabilityData()
Retrieves a list with information about the healths of the individual LDAP external servers associated with the load-balancing algorithm.- Returns:
- A list with information about the healths of the individual LDAP external servers associated with the load-balancing algorithm, or an empty list if it was not included in the monitor entry.
-
getNumAvailableServers
@Nullable public java.lang.Long getNumAvailableServers()
Retrieves the number of servers associated with the load-balancing algorithm that have a health check state of AVAILABLE.- Returns:
- The number of servers associated with the load-balancing algorithm
that have a health check state of AVAILABLE, or
null
if it was not included in the monitor entry.
-
getNumDegradedServers
@Nullable public java.lang.Long getNumDegradedServers()
Retrieves the number of servers associated with the load-balancing algorithm that have a health check state of DEGRADED.- Returns:
- The number of servers associated with the load-balancing algorithm
that have a health check state of DEGRADED, or
null
if it was not included in the monitor entry.
-
getNumUnavailableServers
@Nullable public java.lang.Long getNumUnavailableServers()
Retrieves the number of servers associated with the load-balancing algorithm that have a health check state of UNAVAILABLE.- Returns:
- The number of servers associated with the load-balancing algorithm
that have a health check state of UNAVAILABLE, or
null
if it was not included in the monitor entry.
-
getMonitorDisplayName
@NotNull public java.lang.String getMonitorDisplayName()
Retrieves a human-readable display name for this monitor entry.- Overrides:
getMonitorDisplayName
in classMonitorEntry
- Returns:
- A human-readable display name for this monitor entry.
-
getMonitorDescription
@NotNull public java.lang.String getMonitorDescription()
Retrieves a human-readable description name for this monitor entry.- Overrides:
getMonitorDescription
in classMonitorEntry
- Returns:
- A human-readable description name for this monitor entry.
-
getMonitorAttributes
@NotNull public java.util.Map<java.lang.String,MonitorAttribute> getMonitorAttributes()
Retrieves the set of parsed monitor attributes for this monitor entry, mapped from a unique identifier (in all lowercase characters) to the corresponding monitor attribute.- Overrides:
getMonitorAttributes
in classMonitorEntry
- Returns:
- The set of parsed monitor attributes for this monitor entry.
-
-