Class DiskSpaceUsageMonitorEntry
- java.lang.Object
-
- com.unboundid.ldap.sdk.unboundidds.monitors.MonitorEntry
-
- com.unboundid.ldap.sdk.unboundidds.monitors.DiskSpaceUsageMonitorEntry
-
- All Implemented Interfaces:
java.io.Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class DiskSpaceUsageMonitorEntry extends MonitorEntry
This class defines a monitor entry that provides information about the disk space usage of 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 disk space usage monitor entry. It can be retrieved using theMonitorManager.getDiskSpaceUsageMonitorEntry(com.unboundid.ldap.sdk.LDAPConnection)
method. ThegetDiskSpaceInfo()
method may be used to retrieve information about the components which may consume significant amounts of disk space, and thegetCurrentState()
method may be used to obtain the current state of the server. 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 DiskSpaceUsageMonitorEntry(Entry entry)
Creates a new disk space usage monitor entry from the provided entry.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getCurrentState()
Retrieves the current disk space state for the Directory Server.java.util.List<DiskSpaceInfo>
getDiskSpaceInfo()
Retrieves a list of information about the disk space consumers defined 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.-
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
-
DiskSpaceUsageMonitorEntry
public DiskSpaceUsageMonitorEntry(@NotNull Entry entry)
Creates a new disk space usage monitor entry from the provided entry.- Parameters:
entry
- The entry to be parsed as a disk space usage monitor entry. It must not benull
.
-
-
Method Detail
-
getCurrentState
@Nullable public java.lang.String getCurrentState()
Retrieves the current disk space state for the Directory Server. It may be one of "normal", "low space warning", "low space error", or "out of space error".- Returns:
- The current disk space state for the Directory Server, or
null
if that information is not available.
-
getDiskSpaceInfo
@NotNull public java.util.List<DiskSpaceInfo> getDiskSpaceInfo()
Retrieves a list of information about the disk space consumers defined in the Directory Server.- Returns:
- A list of information about the disk space consumers defined in the Directory Server.
-
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.
-
-