com.unboundid.ldap.sdk.unboundidds.monitors

Class MonitorManager

java.lang.Object

com.unboundid.ldap.sdk.unboundidds.monitors.MonitorManager

@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class MonitorManager
extends java.lang.Object

This class provides a set of methods for retrieving Directory Server monitor entries. In particular, it provides methods for retrieving all monitor entries from the server, as well as retrieving monitor entries of specific types.

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.

Example

The following example demonstrates the process for retrieving all monitor entries published by the directory server and printing the information contained in each using the generic API for accessing monitor entry data:

 List<MonitorEntry> allMonitorEntries =
      MonitorManager.getMonitorEntries(connection);
 for (MonitorEntry e : allMonitorEntries)
 {
   String monitorName = e.getMonitorName();
   String displayName = e.getMonitorDisplayName();
   Map<String,MonitorAttribute> monitorAttributes =
        e.getMonitorAttributes();
 }
 

Method Summary

Modifier and Type	Method and Description
static ActiveOperationsMonitorEntry	getActiveOperationsMonitorEntry(LDAPConnection connection) Retrieves the active operations monitor entry from the Directory Server.
static ActiveOperationsMonitorEntry	getActiveOperationsMonitorEntry(LDAPInterface connection) Retrieves the active operations monitor entry from the Directory Server.
static java.util.List<BackendMonitorEntry>	getBackendMonitorEntries(LDAPConnection connection) Retrieves a list of all backend monitor entries available in the Directory Server.
static java.util.List<BackendMonitorEntry>	getBackendMonitorEntries(LDAPInterface connection) Retrieves a list of all backend monitor entries available in the Directory Server.
static ClientConnectionMonitorEntry	getClientConnectionMonitorEntry(LDAPConnection connection) Retrieves the client connection monitor entry from the Directory Server.
static ClientConnectionMonitorEntry	getClientConnectionMonitorEntry(LDAPInterface connection) Retrieves the client connection monitor entry from the Directory Server.
static java.util.List<ConnectionHandlerMonitorEntry>	getConnectionHandlerMonitorEntries(LDAPConnection connection) Retrieves a list of all connection handler monitor entries available in the Directory Server.
static java.util.List<ConnectionHandlerMonitorEntry>	getConnectionHandlerMonitorEntries(LDAPInterface connection) Retrieves a list of all connection handler monitor entries available in the Directory Server.
static DiskSpaceUsageMonitorEntry	getDiskSpaceUsageMonitorEntry(LDAPConnection connection) Retrieves the disk space usage monitor entry from the Directory Server.
static DiskSpaceUsageMonitorEntry	getDiskSpaceUsageMonitorEntry(LDAPInterface connection) Retrieves the disk space usage monitor entry from the Directory Server.
static EntryCacheMonitorEntry	getEntryCacheMonitorEntry(LDAPConnection connection) Retrieves the entry cache monitor entry from the Directory Server.
static EntryCacheMonitorEntry	getEntryCacheMonitorEntry(LDAPInterface connection) Retrieves the entry cache monitor entry from the Directory Server.
static java.util.List<FIFOEntryCacheMonitorEntry>	getFIFOEntryCacheMonitorEntries(LDAPConnection connection) Retrieves the FIFO entry cache monitor entries from the Directory Server.
static java.util.List<FIFOEntryCacheMonitorEntry>	getFIFOEntryCacheMonitorEntries(LDAPInterface connection) Retrieves the FIFO entry cache monitor entries from the Directory Server.
static java.util.List<GaugeMonitorEntry>	getGaugeMonitorEntries(LDAPInterface connection) Retrieves a list of all gauge monitor entries available in the Directory Server.
static GeneralMonitorEntry	getGeneralMonitorEntry(LDAPConnection connection) Retrieves the general monitor entry from the Directory Server.
static GeneralMonitorEntry	getGeneralMonitorEntry(LDAPInterface connection) Retrieves the general monitor entry from the Directory Server.
static GroupCacheMonitorEntry	getGroupCacheMonitorEntry(LDAPInterface connection) Retrieves the group cache monitor entry from the Directory Server.
static HostSystemRecentCPUAndMemoryMonitorEntry	getHostSystemRecentCPUAndMemoryMonitorEntry(LDAPInterface connection) Retrieves the host system recent CPU and memory monitor entry from the Directory Server.
static java.util.List<IndexMonitorEntry>	getIndexMonitorEntries(LDAPConnection connection) Retrieves a list of all index monitor entries available in the Directory Server.
static java.util.List<IndexMonitorEntry>	getIndexMonitorEntries(LDAPInterface connection) Retrieves a list of all index monitor entries available in the Directory Server.
static java.util.List<IndicatorGaugeMonitorEntry>	getIndicatorGaugeMonitorEntries(LDAPInterface connection) Retrieves a list of all indicator gauge monitor entries available in the Directory Server.
static java.util.List<JEEnvironmentMonitorEntry>	getJEEnvironmentMonitorEntries(LDAPConnection connection) Retrieves a list of all JE environment monitor entries available in the Directory Server.
static java.util.List<JEEnvironmentMonitorEntry>	getJEEnvironmentMonitorEntries(LDAPInterface connection) Retrieves a list of all JE environment monitor entries available in the Directory Server.
static java.util.List<LDAPExternalServerMonitorEntry>	getLDAPExternalServerMonitorEntries(LDAPConnection connection) Retrieves a list of all LDAP external server monitor entries available in the Directory Server.
static java.util.List<LDAPExternalServerMonitorEntry>	getLDAPExternalServerMonitorEntries(LDAPInterface connection) Retrieves a list of all LDAP external server monitor entries available in the Directory Server.
static java.util.List<LDAPStatisticsMonitorEntry>	getLDAPStatisticsMonitorEntries(LDAPConnection connection) Retrieves a list of all LDAP statistics monitor entries available in the Directory Server.
static java.util.List<LDAPStatisticsMonitorEntry>	getLDAPStatisticsMonitorEntries(LDAPInterface connection) Retrieves a list of all LDAP statistics monitor entries available in the Directory Server.
static java.util.List<LoadBalancingAlgorithmMonitorEntry>	getLoadBalancingAlgorithmMonitorEntries(LDAPConnection connection) Retrieves a list of all load-balancing algorithm monitor entries available in the Directory Proxy Server.
static java.util.List<LoadBalancingAlgorithmMonitorEntry>	getLoadBalancingAlgorithmMonitorEntries(LDAPInterface connection) Retrieves a list of all load-balancing algorithm monitor entries available in the Directory Proxy Server.
static MemoryUsageMonitorEntry	getMemoryUsageMonitorEntry(LDAPConnection connection) Retrieves the memory usage monitor entry from the Directory Server.
static MemoryUsageMonitorEntry	getMemoryUsageMonitorEntry(LDAPInterface connection) Retrieves the memory usage monitor entry from the Directory Server.
static java.util.List<MonitorEntry>	getMonitorEntries(LDAPConnection connection) Retrieves a list of all monitor entries available in the Directory Server.
static java.util.List<MonitorEntry>	getMonitorEntries(LDAPInterface connection) Retrieves a list of all monitor entries available in the Directory Server.
static java.util.List<NumericGaugeMonitorEntry>	getNumericGaugeMonitorEntries(LDAPInterface connection) Retrieves a list of all numeric gauge monitor entries available in the Directory Server.
static java.util.List<PerApplicationProcessingTimeHistogramMonitorEntry>	getPerApplicationProcessingTimeHistogramMonitorEntries(LDAPConnection connection) Retrieves the per application processing time histogram monitor entries from the Directory Server.
static java.util.List<PerApplicationProcessingTimeHistogramMonitorEntry>	getPerApplicationProcessingTimeHistogramMonitorEntries(LDAPInterface connection) Retrieves the per application processing time histogram monitor entries from the Directory Server.
static ProcessingTimeHistogramMonitorEntry	getProcessingTimeHistogramMonitorEntry(LDAPConnection connection) Retrieves the processing time histogram monitor entry from the Directory Server.
static ProcessingTimeHistogramMonitorEntry	getProcessingTimeHistogramMonitorEntry(LDAPInterface connection) Retrieves the processing time histogram monitor entry from the Directory Server.
static java.util.List<ReplicaMonitorEntry>	getReplicaMonitorEntries(LDAPConnection connection) Retrieves a list of all replica monitor entries available in the Directory Server.
static java.util.List<ReplicaMonitorEntry>	getReplicaMonitorEntries(LDAPInterface connection) Retrieves a list of all replica monitor entries available in the Directory Server.
static ReplicationServerMonitorEntry	getReplicationServerMonitorEntry(LDAPConnection connection) Retrieves the replication server monitor entry from the Directory Server.
static ReplicationServerMonitorEntry	getReplicationServerMonitorEntry(LDAPInterface connection) Retrieves the replication server monitor entry from the Directory Server.
static java.util.List<ReplicationSummaryMonitorEntry>	getReplicationSummaryMonitorEntries(LDAPConnection connection) Retrieves a list of all replication summary monitor entries available in the Directory Server.
static java.util.List<ReplicationSummaryMonitorEntry>	getReplicationSummaryMonitorEntries(LDAPInterface connection) Retrieves a list of all replication summary monitor entries available in the Directory Server.
static ResultCodeMonitorEntry	getResultCodeMonitorEntry(LDAPInterface connection) Retrieves the result code monitor entry from the Directory Server.
static StackTraceMonitorEntry	getStackTraceMonitorEntry(LDAPConnection connection) Retrieves the stack trace monitor entry from the Directory Server.
static StackTraceMonitorEntry	getStackTraceMonitorEntry(LDAPInterface connection) Retrieves the stack trace monitor entry from the Directory Server.
static SystemInfoMonitorEntry	getSystemInfoMonitorEntry(LDAPConnection connection) Retrieves the system info monitor entry from the Directory Server.
static SystemInfoMonitorEntry	getSystemInfoMonitorEntry(LDAPInterface connection) Retrieves the system info monitor entry from the Directory Server.
static TraditionalWorkQueueMonitorEntry	getTraditionalWorkQueueMonitorEntry(LDAPConnection connection) Retrieves the traditional work queue monitor entry from the Directory Server.
static TraditionalWorkQueueMonitorEntry	getTraditionalWorkQueueMonitorEntry(LDAPInterface connection) Retrieves the traditional work queue monitor entry from the Directory Server.
static UnboundIDWorkQueueMonitorEntry	getUnboundIDWorkQueueMonitorEntry(LDAPConnection connection) Retrieves the UnboundID work queue monitor entry from the Directory Server.
static UnboundIDWorkQueueMonitorEntry	getUnboundIDWorkQueueMonitorEntry(LDAPInterface connection) Retrieves the UnboundID work queue monitor entry from the Directory Server.
static VersionMonitorEntry	getVersionMonitorEntry(LDAPConnection connection) Retrieves the version monitor entry from the Directory Server.
static VersionMonitorEntry	getVersionMonitorEntry(LDAPInterface connection) Retrieves the version monitor entry from the Directory Server.
static java.util.List<X509CertificateMonitorEntry>	getX509CertificateMonitorEntries(LDAPConnection connection) Retrieves a list of all X.509 certificate monitor entries available in the Directory Server.
static java.util.List<X509CertificateMonitorEntry>	getX509CertificateMonitorEntries(LDAPInterface connection) Retrieves a list of all X.509 certificate monitor entries available in the Directory Server.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getMonitorEntries

@NotNull
public static java.util.List<MonitorEntry> getMonitorEntries(@NotNull
                                                                      LDAPConnection connection)
                                                               throws LDAPSearchException

Retrieves a list of all monitor entries available in the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

A list of all monitor entries available in the Directory Server.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getMonitorEntries

@NotNull
public static java.util.List<MonitorEntry> getMonitorEntries(@NotNull
                                                                      LDAPInterface connection)
                                                               throws LDAPSearchException

Retrieves a list of all monitor entries available in the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

A list of all monitor entries available in the Directory Server.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getGeneralMonitorEntry

@Nullable
public static GeneralMonitorEntry getGeneralMonitorEntry(@NotNull
                                                                   LDAPConnection connection)
                                                            throws LDAPSearchException

Retrieves the general monitor entry from the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

The general monitor entry from the Directory Server, or null if it is not available.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getGeneralMonitorEntry

@Nullable
public static GeneralMonitorEntry getGeneralMonitorEntry(@NotNull
                                                                   LDAPInterface connection)
                                                            throws LDAPSearchException

Retrieves the general monitor entry from the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

The general monitor entry from the Directory Server, or null if it is not available.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getActiveOperationsMonitorEntry

@Nullable
public static ActiveOperationsMonitorEntry getActiveOperationsMonitorEntry(@NotNull
                                                                                     LDAPConnection connection)
                                                                              throws LDAPSearchException

Retrieves the active operations monitor entry from the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

The active operations monitor entry from the Directory Server, or null if it is not available.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getActiveOperationsMonitorEntry

@Nullable
public static ActiveOperationsMonitorEntry getActiveOperationsMonitorEntry(@NotNull
                                                                                     LDAPInterface connection)
                                                                              throws LDAPSearchException

Retrieves the active operations monitor entry from the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

The active operations monitor entry from the Directory Server, or null if it is not available.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getBackendMonitorEntries

@NotNull
public static java.util.List<BackendMonitorEntry> getBackendMonitorEntries(@NotNull
                                                                                    LDAPConnection connection)
                                                                             throws LDAPSearchException

Retrieves a list of all backend monitor entries available in the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

A list of all backend monitor entries available in the Directory Server.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getBackendMonitorEntries

@NotNull
public static java.util.List<BackendMonitorEntry> getBackendMonitorEntries(@NotNull
                                                                                    LDAPInterface connection)
                                                                             throws LDAPSearchException

Retrieves a list of all backend monitor entries available in the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

A list of all backend monitor entries available in the Directory Server.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getClientConnectionMonitorEntry

@Nullable
public static ClientConnectionMonitorEntry getClientConnectionMonitorEntry(@NotNull
                                                                                     LDAPConnection connection)
                                                                              throws LDAPSearchException

Retrieves the client connection monitor entry from the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

The client connection monitor entry from the Directory Server, or null if it is not available.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getClientConnectionMonitorEntry

@Nullable
public static ClientConnectionMonitorEntry getClientConnectionMonitorEntry(@NotNull
                                                                                     LDAPInterface connection)
                                                                              throws LDAPSearchException

Retrieves the client connection monitor entry from the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

The client connection monitor entry from the Directory Server, or null if it is not available.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getConnectionHandlerMonitorEntries

@NotNull
public static java.util.List<ConnectionHandlerMonitorEntry> getConnectionHandlerMonitorEntries(@NotNull
                                                                                                        LDAPConnection connection)
                                                                                                 throws LDAPSearchException

Retrieves a list of all connection handler monitor entries available in the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

A list of all connection handler monitor entries available in the Directory Server.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getConnectionHandlerMonitorEntries

@NotNull
public static java.util.List<ConnectionHandlerMonitorEntry> getConnectionHandlerMonitorEntries(@NotNull
                                                                                                        LDAPInterface connection)
                                                                                                 throws LDAPSearchException

Retrieves a list of all connection handler monitor entries available in the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

A list of all connection handler monitor entries available in the Directory Server.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getDiskSpaceUsageMonitorEntry

@Nullable
public static DiskSpaceUsageMonitorEntry getDiskSpaceUsageMonitorEntry(@NotNull
                                                                                 LDAPConnection connection)
                                                                          throws LDAPSearchException

Retrieves the disk space usage monitor entry from the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

The disk space usage monitor entry from the Directory Server, or null if it is not available.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getDiskSpaceUsageMonitorEntry

@Nullable
public static DiskSpaceUsageMonitorEntry getDiskSpaceUsageMonitorEntry(@NotNull
                                                                                 LDAPInterface connection)
                                                                          throws LDAPSearchException

Retrieves the disk space usage monitor entry from the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

The disk space usage monitor entry from the Directory Server, or null if it is not available.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getEntryCacheMonitorEntry

@Nullable
public static EntryCacheMonitorEntry getEntryCacheMonitorEntry(@NotNull
                                                                         LDAPConnection connection)
                                                                  throws LDAPSearchException

Retrieves the entry cache monitor entry from the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

The entry cache monitor entry from the Directory Server, or null if it is not available.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getEntryCacheMonitorEntry

@Nullable
public static EntryCacheMonitorEntry getEntryCacheMonitorEntry(@NotNull
                                                                         LDAPInterface connection)
                                                                  throws LDAPSearchException

Retrieves the entry cache monitor entry from the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

The entry cache monitor entry from the Directory Server, or null if it is not available.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getFIFOEntryCacheMonitorEntries

@NotNull
public static java.util.List<FIFOEntryCacheMonitorEntry> getFIFOEntryCacheMonitorEntries(@NotNull
                                                                                                  LDAPConnection connection)
                                                                                           throws LDAPSearchException

Retrieves the FIFO entry cache monitor entries from the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

The entry cache monitor entry from the Directory Server, or null if it is not available.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getFIFOEntryCacheMonitorEntries

@NotNull
public static java.util.List<FIFOEntryCacheMonitorEntry> getFIFOEntryCacheMonitorEntries(@NotNull
                                                                                                  LDAPInterface connection)
                                                                                           throws LDAPSearchException

Retrieves the FIFO entry cache monitor entries from the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

The entry cache monitor entry from the Directory Server, or null if it is not available.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getGaugeMonitorEntries

@NotNull
public static java.util.List<GaugeMonitorEntry> getGaugeMonitorEntries(@NotNull
                                                                                LDAPInterface connection)
                                                                         throws LDAPSearchException

Retrieves a list of all gauge monitor entries available in the Directory Server. This may include monitor entries for gauges of different types (e.g., numeric gauges and indicator gauges).

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

A list of all gauge monitor entries available in the Directory Server.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getGroupCacheMonitorEntry

@Nullable
public static GroupCacheMonitorEntry getGroupCacheMonitorEntry(@NotNull
                                                                         LDAPInterface connection)
                                                                  throws LDAPSearchException

Retrieves the group cache monitor entry from the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

The group cache monitor entry from the Directory Server, or null if it is not available.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getHostSystemRecentCPUAndMemoryMonitorEntry

@Nullable
public static HostSystemRecentCPUAndMemoryMonitorEntry getHostSystemRecentCPUAndMemoryMonitorEntry(@NotNull
                                                                                                             LDAPInterface connection)
                                                                                                      throws LDAPSearchException

Retrieves the host system recent CPU and memory monitor entry from the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

The host system recent CPU and memory monitor entry from the Directory Server, or null if it is not available.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getIndexMonitorEntries

@NotNull
public static java.util.List<IndexMonitorEntry> getIndexMonitorEntries(@NotNull
                                                                                LDAPConnection connection)
                                                                         throws LDAPSearchException

Retrieves a list of all index monitor entries available in the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

A list of all index monitor entries available in the Directory Server.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getIndexMonitorEntries

@NotNull
public static java.util.List<IndexMonitorEntry> getIndexMonitorEntries(@NotNull
                                                                                LDAPInterface connection)
                                                                         throws LDAPSearchException

Retrieves a list of all index monitor entries available in the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

A list of all index monitor entries available in the Directory Server.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getIndicatorGaugeMonitorEntries

@NotNull
public static java.util.List<IndicatorGaugeMonitorEntry> getIndicatorGaugeMonitorEntries(@NotNull
                                                                                                  LDAPInterface connection)
                                                                                           throws LDAPSearchException

Retrieves a list of all indicator gauge monitor entries available in the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

A list of all indicator gauge monitor entries available in the Directory Server.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getJEEnvironmentMonitorEntries

@NotNull
public static java.util.List<JEEnvironmentMonitorEntry> getJEEnvironmentMonitorEntries(@NotNull
                                                                                                LDAPConnection connection)
                                                                                         throws LDAPSearchException

Retrieves a list of all JE environment monitor entries available in the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

A list of all JE environment monitor entries available in the Directory Server.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getJEEnvironmentMonitorEntries

@NotNull
public static java.util.List<JEEnvironmentMonitorEntry> getJEEnvironmentMonitorEntries(@NotNull
                                                                                                LDAPInterface connection)
                                                                                         throws LDAPSearchException

Retrieves a list of all JE environment monitor entries available in the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

A list of all JE environment monitor entries available in the Directory Server.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getLDAPExternalServerMonitorEntries

@NotNull
public static java.util.List<LDAPExternalServerMonitorEntry> getLDAPExternalServerMonitorEntries(@NotNull
                                                                                                          LDAPConnection connection)
                                                                                                   throws LDAPSearchException

Retrieves a list of all LDAP external server monitor entries available in the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

A list of all LDAP external server monitor entries available in the Directory Server.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getLDAPExternalServerMonitorEntries

@NotNull
public static java.util.List<LDAPExternalServerMonitorEntry> getLDAPExternalServerMonitorEntries(@NotNull
                                                                                                          LDAPInterface connection)
                                                                                                   throws LDAPSearchException

Retrieves a list of all LDAP external server monitor entries available in the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

A list of all LDAP external server monitor entries available in the Directory Server.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getLDAPStatisticsMonitorEntries

@NotNull
public static java.util.List<LDAPStatisticsMonitorEntry> getLDAPStatisticsMonitorEntries(@NotNull
                                                                                                  LDAPConnection connection)
                                                                                           throws LDAPSearchException

Retrieves a list of all LDAP statistics monitor entries available in the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

A list of all LDAP statistics monitor entries available in the Directory Server.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getLDAPStatisticsMonitorEntries

@NotNull
public static java.util.List<LDAPStatisticsMonitorEntry> getLDAPStatisticsMonitorEntries(@NotNull
                                                                                                  LDAPInterface connection)
                                                                                           throws LDAPSearchException

Retrieves a list of all LDAP statistics monitor entries available in the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

A list of all LDAP statistics monitor entries available in the Directory Server.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getLoadBalancingAlgorithmMonitorEntries

@NotNull
public static java.util.List<LoadBalancingAlgorithmMonitorEntry> getLoadBalancingAlgorithmMonitorEntries(@NotNull
                                                                                                                  LDAPConnection connection)
                                                                                                           throws LDAPSearchException

Retrieves a list of all load-balancing algorithm monitor entries available in the Directory Proxy Server.

Parameters:

connection - The connection to use to communicate with the Directory Proxy Server.

Returns:

A list of all load-balancing algorithm monitor entries available in the Directory Proxy Server.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Proxy Server.

getLoadBalancingAlgorithmMonitorEntries

@NotNull
public static java.util.List<LoadBalancingAlgorithmMonitorEntry> getLoadBalancingAlgorithmMonitorEntries(@NotNull
                                                                                                                  LDAPInterface connection)
                                                                                                           throws LDAPSearchException

Retrieves a list of all load-balancing algorithm monitor entries available in the Directory Proxy Server.

Parameters:

connection - The connection to use to communicate with the Directory Proxy Server.

Returns:

A list of all load-balancing algorithm monitor entries available in the Directory Proxy Server.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Proxy Server.

getMemoryUsageMonitorEntry

@Nullable
public static MemoryUsageMonitorEntry getMemoryUsageMonitorEntry(@NotNull
                                                                           LDAPConnection connection)
                                                                    throws LDAPSearchException

Retrieves the memory usage monitor entry from the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

The memory usage monitor entry from the Directory Server, or null if it is not available.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getMemoryUsageMonitorEntry

@Nullable
public static MemoryUsageMonitorEntry getMemoryUsageMonitorEntry(@NotNull
                                                                           LDAPInterface connection)
                                                                    throws LDAPSearchException

Retrieves the memory usage monitor entry from the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

The memory usage monitor entry from the Directory Server, or null if it is not available.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getNumericGaugeMonitorEntries

@NotNull
public static java.util.List<NumericGaugeMonitorEntry> getNumericGaugeMonitorEntries(@NotNull
                                                                                              LDAPInterface connection)
                                                                                       throws LDAPSearchException

Retrieves a list of all numeric gauge monitor entries available in the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

A list of all numeric gauge monitor entries available in the Directory Server.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getPerApplicationProcessingTimeHistogramMonitorEntries

@NotNull
public static java.util.List<PerApplicationProcessingTimeHistogramMonitorEntry> getPerApplicationProcessingTimeHistogramMonitorEntries(@NotNull
                                                                                                                                                LDAPConnection connection)
                                                                                                                                         throws LDAPSearchException

Retrieves the per application processing time histogram monitor entries from the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

The per application processing time histogram monitor entries from the Directory Server. If none are available, an empty list is returned.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getPerApplicationProcessingTimeHistogramMonitorEntries

@NotNull
public static java.util.List<PerApplicationProcessingTimeHistogramMonitorEntry> getPerApplicationProcessingTimeHistogramMonitorEntries(@NotNull
                                                                                                                                                LDAPInterface connection)
                                                                                                                                         throws LDAPSearchException

Retrieves the per application processing time histogram monitor entries from the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

The per application processing time histogram monitor entries from the Directory Server. If none are available, an empty list is returned.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getProcessingTimeHistogramMonitorEntry

@Nullable
public static ProcessingTimeHistogramMonitorEntry getProcessingTimeHistogramMonitorEntry(@NotNull
                                                                                                   LDAPConnection connection)
                                                                                            throws LDAPSearchException

Retrieves the processing time histogram monitor entry from the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

The processing time histogram monitor entry from the Directory Server, or null if it is not available.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getProcessingTimeHistogramMonitorEntry

@Nullable
public static ProcessingTimeHistogramMonitorEntry getProcessingTimeHistogramMonitorEntry(@NotNull
                                                                                                   LDAPInterface connection)
                                                                                            throws LDAPSearchException

Retrieves the processing time histogram monitor entry from the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

The processing time histogram monitor entry from the Directory Server, or null if it is not available.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getReplicaMonitorEntries

@NotNull
public static java.util.List<ReplicaMonitorEntry> getReplicaMonitorEntries(@NotNull
                                                                                    LDAPConnection connection)
                                                                             throws LDAPSearchException

Retrieves a list of all replica monitor entries available in the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

A list of all replica monitor entries available in the Directory Server.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getReplicaMonitorEntries

@NotNull
public static java.util.List<ReplicaMonitorEntry> getReplicaMonitorEntries(@NotNull
                                                                                    LDAPInterface connection)
                                                                             throws LDAPSearchException

Retrieves a list of all replica monitor entries available in the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

A list of all replica monitor entries available in the Directory Server.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getReplicationServerMonitorEntry

@Nullable
public static ReplicationServerMonitorEntry getReplicationServerMonitorEntry(@NotNull
                                                                                       LDAPConnection connection)
                                                                                throws LDAPSearchException

Retrieves the replication server monitor entry from the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

The replication server monitor entry from the Directory Server, or null if it is not available.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getReplicationServerMonitorEntry

@Nullable
public static ReplicationServerMonitorEntry getReplicationServerMonitorEntry(@NotNull
                                                                                       LDAPInterface connection)
                                                                                throws LDAPSearchException

Retrieves the replication server monitor entry from the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

The replication server monitor entry from the Directory Server, or null if it is not available.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getReplicationSummaryMonitorEntries

@NotNull
public static java.util.List<ReplicationSummaryMonitorEntry> getReplicationSummaryMonitorEntries(@NotNull
                                                                                                          LDAPConnection connection)
                                                                                                   throws LDAPSearchException

Retrieves a list of all replication summary monitor entries available in the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

A list of all replication summary monitor entries available in the Directory Server.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getReplicationSummaryMonitorEntries

@NotNull
public static java.util.List<ReplicationSummaryMonitorEntry> getReplicationSummaryMonitorEntries(@NotNull
                                                                                                          LDAPInterface connection)
                                                                                                   throws LDAPSearchException

Retrieves a list of all replication summary monitor entries available in the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

A list of all replication summary monitor entries available in the Directory Server.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getResultCodeMonitorEntry

@Nullable
public static ResultCodeMonitorEntry getResultCodeMonitorEntry(@NotNull
                                                                         LDAPInterface connection)
                                                                  throws LDAPSearchException

Retrieves the result code monitor entry from the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

The result code monitor entry from the Directory Server, or null if it is not available.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getSystemInfoMonitorEntry

@Nullable
public static SystemInfoMonitorEntry getSystemInfoMonitorEntry(@NotNull
                                                                         LDAPConnection connection)
                                                                  throws LDAPSearchException

Retrieves the system info monitor entry from the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

The system info monitor entry from the Directory Server, or null if it is not available.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getSystemInfoMonitorEntry

@Nullable
public static SystemInfoMonitorEntry getSystemInfoMonitorEntry(@NotNull
                                                                         LDAPInterface connection)
                                                                  throws LDAPSearchException

Retrieves the system info monitor entry from the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

The system info monitor entry from the Directory Server, or null if it is not available.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getStackTraceMonitorEntry

@Nullable
public static StackTraceMonitorEntry getStackTraceMonitorEntry(@NotNull
                                                                         LDAPConnection connection)
                                                                  throws LDAPSearchException

Retrieves the stack trace monitor entry from the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

The stack trace monitor entry from the Directory Server, or null if it is not available.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getStackTraceMonitorEntry

@Nullable
public static StackTraceMonitorEntry getStackTraceMonitorEntry(@NotNull
                                                                         LDAPInterface connection)
                                                                  throws LDAPSearchException

Retrieves the stack trace monitor entry from the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

The stack trace monitor entry from the Directory Server, or null if it is not available.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getTraditionalWorkQueueMonitorEntry

@Nullable
public static TraditionalWorkQueueMonitorEntry getTraditionalWorkQueueMonitorEntry(@NotNull
                                                                                             LDAPConnection connection)
                                                                                      throws LDAPSearchException

Retrieves the traditional work queue monitor entry from the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

The traditional work queue monitor entry from the Directory Server, or null if it is not available.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getTraditionalWorkQueueMonitorEntry

@Nullable
public static TraditionalWorkQueueMonitorEntry getTraditionalWorkQueueMonitorEntry(@NotNull
                                                                                             LDAPInterface connection)
                                                                                      throws LDAPSearchException

Retrieves the traditional work queue monitor entry from the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

The traditional work queue monitor entry from the Directory Server, or null if it is not available.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getUnboundIDWorkQueueMonitorEntry

@Nullable
public static UnboundIDWorkQueueMonitorEntry getUnboundIDWorkQueueMonitorEntry(@NotNull
                                                                                         LDAPConnection connection)
                                                                                  throws LDAPSearchException

Retrieves the UnboundID work queue monitor entry from the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

The UnboundID work queue monitor entry from the Directory Server, or null if it is not available.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getUnboundIDWorkQueueMonitorEntry

@Nullable
public static UnboundIDWorkQueueMonitorEntry getUnboundIDWorkQueueMonitorEntry(@NotNull
                                                                                         LDAPInterface connection)
                                                                                  throws LDAPSearchException

Retrieves the UnboundID work queue monitor entry from the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

The UnboundID work queue monitor entry from the Directory Server, or null if it is not available.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getVersionMonitorEntry

@Nullable
public static VersionMonitorEntry getVersionMonitorEntry(@NotNull
                                                                   LDAPConnection connection)
                                                            throws LDAPSearchException

Retrieves the version monitor entry from the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

The version monitor entry from the Directory Server, or null if it is not available.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getVersionMonitorEntry

@Nullable
public static VersionMonitorEntry getVersionMonitorEntry(@NotNull
                                                                   LDAPInterface connection)
                                                            throws LDAPSearchException

Retrieves the version monitor entry from the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

The version monitor entry from the Directory Server, or null if it is not available.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getX509CertificateMonitorEntries

@NotNull
public static java.util.List<X509CertificateMonitorEntry> getX509CertificateMonitorEntries(@NotNull
                                                                                                    LDAPConnection connection)
                                                                                             throws LDAPSearchException

Retrieves a list of all X.509 certificate monitor entries available in the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

A list of all X.509 certificate monitor entries available in the Directory Server.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.

getX509CertificateMonitorEntries

@NotNull
public static java.util.List<X509CertificateMonitorEntry> getX509CertificateMonitorEntries(@NotNull
                                                                                                    LDAPInterface connection)
                                                                                             throws LDAPSearchException

Retrieves a list of all X.509 certificate monitor entries available in the Directory Server.

Parameters:

connection - The connection to use to communicate with the Directory Server.

Returns:

A list of all X.509 certificate monitor entries available in the Directory Server.

Throws:

LDAPSearchException - If a problem occurs while communicating with the Directory Server.