|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.unboundidds.monitors.MonitorEntry
com.unboundid.ldap.sdk.unboundidds.monitors.LoadBalancingAlgorithmMonitorEntry
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class LoadBalancingAlgorithmMonitorEntry
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 monitor entry that provides information about a load-balancing algorithm used by the UnboundID Directory Proxy Server. Information that it may make available includes:
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.
Field Summary | |
---|---|
protected static java.lang.String |
LOAD_BALANCING_ALGORITHM_MONITOR_OC
The structural object class used in LDAP external server monitor entries. |
Constructor Summary | |
---|---|
LoadBalancingAlgorithmMonitorEntry(Entry entry)
Creates a new load-balancing algorithm monitor entry from the provided entry. |
Method Summary | |
---|---|
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 |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected static final java.lang.String LOAD_BALANCING_ALGORITHM_MONITOR_OC
Constructor Detail |
---|
public LoadBalancingAlgorithmMonitorEntry(Entry entry)
entry
- The entry to be parsed as a load-balancing algorithm monitor
entry. It must not be null
.Method Detail |
---|
public java.lang.String getAlgorithmName()
null
if it
was not included in the monitor entry.public java.lang.String getConfigEntryDN()
null
if it was not included in the monitor
entry.public HealthCheckState getHealthCheckState()
null
if it was not included in the monitor
entry.public HealthCheckState getLocalServersHealthCheckState()
null
if it was not included
in the monitor entry.public HealthCheckState getNonLocalServersHealthCheckState()
null
if it was not included
in the monitor entry.public java.util.List<LoadBalancingAlgorithmServerAvailabilityData> getServerAvailabilityData()
public java.lang.Long getNumAvailableServers()
null
if it
was not included in the monitor entry.public java.lang.Long getNumDegradedServers()
null
if it
was not included in the monitor entry.public java.lang.Long getNumUnavailableServers()
null
if
it was not included in the monitor entry.public java.lang.String getMonitorDisplayName()
getMonitorDisplayName
in class MonitorEntry
public java.lang.String getMonitorDescription()
getMonitorDescription
in class MonitorEntry
public java.util.Map<java.lang.String,MonitorAttribute> getMonitorAttributes()
getMonitorAttributes
in class MonitorEntry
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |