Class ActiveOperationsMonitorEntry
- java.lang.Object
-
- com.unboundid.ldap.sdk.unboundidds.monitors.MonitorEntry
-
- com.unboundid.ldap.sdk.unboundidds.monitors.ActiveOperationsMonitorEntry
-
- All Implemented Interfaces:
java.io.Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class ActiveOperationsMonitorEntry extends MonitorEntry
This class defines a monitor entry that provides information about the operations currently being processed by the Directory 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.
The server should present at most one active operations monitor entry. It can be retrieved using theMonitorManager.getActiveOperationsMonitorEntry(com.unboundid.ldap.sdk.LDAPConnection)
method. ThegetActiveOperations()
method may be used to retrieve information for each operation in progress. Alternately, this 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
-
-
Constructor Summary
Constructors Constructor Description ActiveOperationsMonitorEntry(Entry entry)
Creates a new active operations monitor entry from the provided entry.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.List<java.lang.String>
getActiveOperations()
Retrieves a list of the string representations of the operations in progress in the Directory Server.java.util.List<java.lang.String>
getActivePersistentSearches()
Retrieves a list of the string representations of the persistent searches in progress in the Directory Server.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.java.lang.Long
getNumOperationsInProgress()
Retrieves the number of operations currently in progress in the Directory Server.java.lang.Long
getNumPersistentSearchesInProgress()
Retrieves the number of persistent searches currently in progress in the Directory Server.-
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
-
-
-
-
Constructor Detail
-
ActiveOperationsMonitorEntry
public ActiveOperationsMonitorEntry(Entry entry)
Creates a new active operations monitor entry from the provided entry.- Parameters:
entry
- The entry to be parsed as a active operations monitor entry. It must not benull
.
-
-
Method Detail
-
getNumOperationsInProgress
public java.lang.Long getNumOperationsInProgress()
Retrieves the number of operations currently in progress in the Directory Server.- Returns:
- The number of operations currently in progress in the Directory
Server, or
null
if it was not included in the monitor entry.
-
getActiveOperations
public java.util.List<java.lang.String> getActiveOperations()
Retrieves a list of the string representations of the operations in progress in the Directory Server.- Returns:
- A list of the string representations of the operations in progress in the Directory Server, or an empty list if it was not included in the monitor entry.
-
getNumPersistentSearchesInProgress
public java.lang.Long getNumPersistentSearchesInProgress()
Retrieves the number of persistent searches currently in progress in the Directory Server.- Returns:
- The number of persistent searches currently in progress in the
Directory Server, or
null
if it was not included in the monitor entry.
-
getActivePersistentSearches
public java.util.List<java.lang.String> getActivePersistentSearches()
Retrieves a list of the string representations of the persistent searches in progress in the Directory Server.- Returns:
- A list of the string representations of the persistent searches in progress in the Directory Server, or an empty list if it was not included in the monitor entry.
-
getMonitorDisplayName
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
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
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.
-
-