|
|||||||||
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.SystemInfoMonitorEntry
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class SystemInfoMonitorEntry
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 the system and JVM on which the Directory Server is running. In particular, the information that may be available includes:
MonitorManager.getSystemInfoMonitorEntry(com.unboundid.ldap.sdk.LDAPConnection)
method.
This entry provides specific methods for accessing this system information
(e.g., the getOperatingSystem()
method can be used to retrieve the name of the operating system).
Alternately, this 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.
Constructor Summary | |
---|---|
SystemInfoMonitorEntry(Entry entry)
Creates a new system info monitor entry from the provided entry. |
Method Summary | |
---|---|
java.lang.Long |
getAvailableCPUs()
Retrieves the number of CPUs available to the JVM. |
java.lang.String |
getClassPath()
Retrieves the server's Java classpath. |
java.util.Map<java.lang.String,java.lang.String> |
getEnvironmentVariables()
Retrieves the environment variables available to the server process, mapped from variable name to the corresponding value. |
java.lang.Long |
getFreeMemory()
Retrieves the amount of memory in bytes held by the JVM that is currently marked as free. |
java.lang.String |
getHostname()
Retrieves the server's hostname. |
java.lang.String |
getInstanceRoot()
Retrieves the path to the directory in which the Directory Server is installed. |
java.lang.String |
getJavaHome()
Retrieves the path to the Java installation used by the server. |
java.lang.String |
getJavaVendor()
Retrieves the server's Java vendor string. |
java.lang.String |
getJavaVersion()
Retrieves the server's Java version string. |
java.lang.String |
getJVMArchitectureDataModel()
Retrieves the server's JVM architecture data mode, which should indicate whether the server is running a 32-bit or 64-bit JVM. |
java.lang.String |
getJVMArguments()
Retrieves a list of the arguments provided to the JVM when the server was started. |
java.lang.Long |
getJVMPID()
Retrieves the process ID of the JVM in which the server is running. |
java.lang.String |
getJVMVendor()
Retrieves the server's JVM vendor string. |
java.lang.String |
getJVMVersion()
Retrieves the server's JVM version string. |
java.lang.Long |
getMaxMemory()
Retrieves the maximum amount of memory in bytes that the JVM will be allowed to use. |
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.String |
getOperatingSystem()
Retrieves information about the operating system on which the server is running. |
java.lang.String |
getSSLContextProtocol()
Retrieves the name of the default SSL context protocol that has been selected by the server. |
java.util.Map<java.lang.String,java.lang.String> |
getSystemProperties()
Retrieves the system properties defined in the server JVM, mapped from property name to the corresponding value. |
java.lang.Long |
getUsedMemory()
Retrieves the amount of memory in bytes currently held by the JVM used to run the server. |
java.lang.String |
getUserName()
Retrieves the name of the user as whom the server is running. |
java.lang.String |
getWorkingDirectory()
Retrieves the path to the server's current working directory. |
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 |
Constructor Detail |
---|
public SystemInfoMonitorEntry(Entry entry)
entry
- The entry to be parsed as a system info monitor entry. It
must not be null
.Method Detail |
---|
public java.lang.Long getAvailableCPUs()
null
if it was
not included in the monitor entry.public java.lang.String getClassPath()
null
if it was not
included in the monitor entry.public java.util.Map<java.lang.String,java.lang.String> getEnvironmentVariables()
public java.lang.Long getFreeMemory()
null
if it was not included in the
monitor entry.public java.lang.String getHostname()
null
if it was not included in
the monitor entry.public java.lang.String getInstanceRoot()
null
if it was not included in the monitor
entry.public java.lang.String getJavaHome()
null
if it was not included in the monitor entry.public java.lang.String getJavaVendor()
null
if it was not
included in the monitor entry.public java.lang.String getJavaVersion()
null
if it was not
included in the monitor entry.public java.lang.String getJVMArchitectureDataModel()
null
if it
was not included in the monitor entry.public java.lang.String getJVMArguments()
null
if it was not included in the monitor
entry.public java.lang.Long getJVMPID()
null
if it was not included in the monitor entry.public java.lang.String getJVMVendor()
null
if it was not
included in the monitor entry.public java.lang.String getJVMVersion()
null
if it was not
included in the monitor entry.public java.lang.Long getMaxMemory()
null
if it was not included in the monitor
entry.public java.lang.String getOperatingSystem()
null
if it was not included in the monitor
entry.public java.lang.String getSSLContextProtocol()
public java.util.Map<java.lang.String,java.lang.String> getSystemProperties()
public java.lang.Long getUsedMemory()
null
if it was not included in the
monitor entrypublic java.lang.String getUserName()
null
if it was not included in the monitor entry.public java.lang.String getWorkingDirectory()
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 |