com.unboundid.ldap.sdk.unboundidds.monitors
Class SystemInfoMonitorEntry

java.lang.Object
  extended by com.unboundid.ldap.sdk.unboundidds.monitors.MonitorEntry
      extended by com.unboundid.ldap.sdk.unboundidds.monitors.SystemInfoMonitorEntry
All Implemented Interfaces:
java.io.Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class SystemInfoMonitorEntry
extends MonitorEntry

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: The server should present at most one system info monitor entry. It can be retrieved using the 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.

See Also:
Serialized Form

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

SystemInfoMonitorEntry

public SystemInfoMonitorEntry(Entry entry)
Creates a new system info monitor entry from the provided entry.

Parameters:
entry - The entry to be parsed as a system info monitor entry. It must not be null.
Method Detail

getAvailableCPUs

public java.lang.Long getAvailableCPUs()
Retrieves the number of CPUs available to the JVM.

Returns:
The number of CPUs available to the JVM, or null if it was not included in the monitor entry.

getClassPath

public java.lang.String getClassPath()
Retrieves the server's Java classpath.

Returns:
The server's Java classpath, or null if it was not included in the monitor entry.

getEnvironmentVariables

public 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.

Returns:
The environment variables available to the server process, or an empty map if it was not included in the monitor entry.

getFreeMemory

public java.lang.Long getFreeMemory()
Retrieves the amount of memory in bytes held by the JVM that is currently marked as free.

Returns:
The amount of memory in bytes held by the JVM that is currently marked as free, or null if it was not included in the monitor entry.

getHostname

public java.lang.String getHostname()
Retrieves the server's hostname.

Returns:
The server's hostname, or null if it was not included in the monitor entry.

getInstanceRoot

public java.lang.String getInstanceRoot()
Retrieves the path to the directory in which the Directory Server is installed.

Returns:
The path to the directory in which the Directory Server is installed, or null if it was not included in the monitor entry.

getJavaHome

public java.lang.String getJavaHome()
Retrieves the path to the Java installation used by the server.

Returns:
The path to the Java installation used by the server, or null if it was not included in the monitor entry.

getJavaVendor

public java.lang.String getJavaVendor()
Retrieves the server's Java vendor string.

Returns:
The server's Java vendor string, or null if it was not included in the monitor entry.

getJavaVersion

public java.lang.String getJavaVersion()
Retrieves the server's Java version string.

Returns:
The server's Java version string, or null if it was not included in the monitor entry.

getJVMArchitectureDataModel

public 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.

Returns:
The server's JVM architecture data model, or null if it was not included in the monitor entry.

getJVMArguments

public java.lang.String getJVMArguments()
Retrieves a list of the arguments provided to the JVM when the server was started.

Returns:
A list of the arguments provided to the JVM when the server was started, or null if it was not included in the monitor entry.

getJVMPID

public java.lang.Long getJVMPID()
Retrieves the process ID of the JVM in which the server is running.

Returns:
The process ID of the JVM in which the server is running, or null if it was not included in the monitor entry.

getJVMVendor

public java.lang.String getJVMVendor()
Retrieves the server's JVM vendor string.

Returns:
The server's JVM vendor string, or null if it was not included in the monitor entry.

getJVMVersion

public java.lang.String getJVMVersion()
Retrieves the server's JVM version string.

Returns:
The server's JVM version string, or null if it was not included in the monitor entry.

getMaxMemory

public java.lang.Long getMaxMemory()
Retrieves the maximum amount of memory in bytes that the JVM will be allowed to use.

Returns:
The maximum amount of memory in bytes that the JVM will be allowed to use, or null if it was not included in the monitor entry.

getOperatingSystem

public java.lang.String getOperatingSystem()
Retrieves information about the operating system on which the server is running.

Returns:
Information about the operating system on which the server is running, or null if it was not included in the monitor entry.

getSSLContextProtocol

public java.lang.String getSSLContextProtocol()
Retrieves the name of the default SSL context protocol that has been selected by the server.

Returns:
The name of the default SSL context protocol that has been selected by the server.

getSystemProperties

public 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.

Returns:
The system properties defined in the server JVM, or an empty map if it was not included in the monitor entry.

getUsedMemory

public java.lang.Long getUsedMemory()
Retrieves the amount of memory in bytes currently held by the JVM used to run the server.

Returns:
The amount of memory in bytes currently held by the JVM used to run the server, or null if it was not included in the monitor entry

getUserName

public java.lang.String getUserName()
Retrieves the name of the user as whom the server is running.

Returns:
The name of the user as whom the server is running, or null if it was not included in the monitor entry.

getWorkingDirectory

public java.lang.String getWorkingDirectory()
Retrieves the path to the server's current working directory. This is generally the path to the directory from which the server was started.

Returns:
The path to the server's current working directory, or null 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 class MonitorEntry
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 class MonitorEntry
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 class MonitorEntry
Returns:
The set of parsed monitor attributes for this monitor entry.