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

Class LoadBalancingAlgorithmMonitorEntry

java.lang.Object
com.unboundid.ldap.sdk.unboundidds.monitors.MonitorEntry
com.unboundid.ldap.sdk.unboundidds.monitors.LoadBalancingAlgorithmMonitorEntry
All Implemented Interfaces:
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.
The server should present a load-balancing algorithm monitor entry for each load-balancing algorithm used by a proxying request processor. These entries can be retrieved using the 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 the MonitorManager class documentation for an example that demonstrates the use of the generic API for accessing monitor data.
See Also:

  • Field Details

  • Constructor Details

    • 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 be null.

  • Method Details

    • getAlgorithmName

      @Nullable public 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 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 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 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 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 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 String getMonitorDisplayName()
      Retrieves a human-readable display name for this monitor entry.
      Overrides:
      getMonitorDisplayName in class MonitorEntry
      Returns:
      A human-readable display name for this monitor entry.

    • getMonitorDescription

      @NotNull public String getMonitorDescription()
      Retrieves a human-readable description name for this monitor entry.
      Overrides:
      getMonitorDescription in class MonitorEntry
      Returns:
      A human-readable description name for this monitor entry.

    • getMonitorAttributes

      @NotNull public Map<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 class MonitorEntry
      Returns:
      The set of parsed monitor attributes for this monitor entry.