java.lang.management

Interface RuntimeMXBean

public interface RuntimeMXBean

Provides access to information about the underlying virtual machine. An instance of this bean is obtained by calling {@link ManagementFactory#getRuntimeMXBean()}.

Since: 1.5

Method Summary
StringgetBootClassPath()

Returns the boot classpath used by the virtual machine.

StringgetClassPath()
Returns the classpath used by the system classloader.
List<String>getInputArguments()
Returns a list of the arguments given to the virtual machine, excluding those that apply to the main() method of the class file being executed.
StringgetLibraryPath()
Returns the library path.
StringgetManagementSpecVersion()
Returns the version of the management specification implemented by the virtual machine.
StringgetName()
Returns the name of this virtual machine.
StringgetSpecName()
Returns the specification name of the virtual machine.
StringgetSpecVendor()
Returns the specification vendor of the virtual machine.
StringgetSpecVersion()
Returns the specification version of the virtual machine.
longgetStartTime()
Returns the approximate start time of the virtual machine in milliseconds.
Map<String,String>getSystemProperties()
Returns a map containing the keys and values of the system properties.
longgetUptime()
Returns the uptime of the virtual machine in milliseconds.
StringgetVmName()
Returns the implementation name of the virtual machine.
StringgetVmVendor()
Returns the implementation vendor of the virtual machine.
StringgetVmVersion()
Returns the implementation version of the virtual machine.
booleanisBootClassPathSupported()
Returns true if the virtual machine supports the boot classpath mechanism.

Method Detail

getBootClassPath

public String getBootClassPath()

Returns the boot classpath used by the virtual machine. This value follows the standard path syntax used by the underlying operating system (e.g. directories separated by ':' on UNIX or ';' on Windows).

Supplying this value is optional. Users should check the return value of {@link isBootClassPathSupported()} prior to calling this method.

Returns: the boot classpath of the virtual machine, if supported.

Throws: UnsupportedOperationException in cases where this functionality is not supported by the VM. SecurityException if a security manager exists and denies ManagementPermission("monitor").

See Also: isBootClassPathSupported ManagementPermission

getClassPath

public String getClassPath()
Returns the classpath used by the system classloader. This is equivalent to obtaining the java.class.path property via {@link System#getProperty(String)}. This value follows the standard path syntax used by the underlying operating system (e.g. directories separated by ':' on UNIX or ';' on Windows).

Returns: the classpath used by the system class loader.

Throws: SecurityException if a security manager exists which prevents access to the classpath property.

See Also: getProperty checkPropertyAccess

getInputArguments

public List<String> getInputArguments()
Returns a list of the arguments given to the virtual machine, excluding those that apply to the main() method of the class file being executed. These may not just be those specified at the command line, but may also include arguments from environment variables, configuration files, etc. All command line arguments may not reach the virtual machine, so these are not included in this list.

Returns: a list of arguments passed to the virtual machine.

Throws: SecurityException if a security manager exists and denies ManagementPermission("monitor").

See Also: ManagementPermission

getLibraryPath

public String getLibraryPath()
Returns the library path. This is equivalent to obtaining the java.library.path property via {@link System#getProperty(String)}. This value follows the standard path syntax used by the underlying operating system (e.g. directories separated by ':' on UNIX or ';' on Windows).

Returns: the library path.

Throws: SecurityException if a security manager exists which prevents access to the library path property.

See Also: getProperty checkPropertyAccess

getManagementSpecVersion

public String getManagementSpecVersion()
Returns the version of the management specification implemented by the virtual machine.

Returns: the version of the management specification implemented.

getName

public String getName()
Returns the name of this virtual machine. The content of this property is left up to the developer of the virtual machine. It may include a number of system attributes and may differ between instances of the same virtual machine (for example, it might include the process identifier or the host name of the machine on which it is running). The intention is that this name refers to the precise entity that the other data supplied by this bean refers to, rather than the VM in general.

Returns: the name of this virtual machine.

getSpecName

public String getSpecName()
Returns the specification name of the virtual machine. This is equivalent to obtaining the java.vm.specification.name property via {@link System#getProperty(String)}.

Returns: the specification name of the VM.

Throws: SecurityException if a security manager exists which prevents access to the VM specification name property.

See Also: getProperty checkPropertyAccess

getSpecVendor

public String getSpecVendor()
Returns the specification vendor of the virtual machine. This is equivalent to obtaining the java.vm.specification.vendor property via {@link System#getProperty(String)}.

Returns: the specification vendor of the VM.

Throws: SecurityException if a security manager exists which prevents access to the VM specification vendor property.

See Also: getProperty checkPropertyAccess

getSpecVersion

public String getSpecVersion()
Returns the specification version of the virtual machine. This is equivalent to obtaining the java.vm.specification.version property via {@link System#getProperty(String)}.

Returns: the specification version of the VM.

Throws: SecurityException if a security manager exists which prevents access to the VM specification version property.

See Also: getProperty checkPropertyAccess

getStartTime

public long getStartTime()
Returns the approximate start time of the virtual machine in milliseconds.

Returns: the start time of the virtual machine.

getSystemProperties

public Map<String,String> getSystemProperties()
Returns a map containing the keys and values of the system properties. This gives largely the same result as calling {@link System#getProperties()}, but the resulting map is filtered so as to only provide keys and values that are Strings.

Returns: the map of system properties.

getUptime

public long getUptime()
Returns the uptime of the virtual machine in milliseconds.

Returns: the uptime of the virtual machine.

getVmName

public String getVmName()
Returns the implementation name of the virtual machine. This is equivalent to obtaining the java.vm.name property via {@link System#getProperty(String)}.

Returns: the implementation name of the VM.

Throws: SecurityException if a security manager exists which prevents access to the VM name property.

See Also: getProperty checkPropertyAccess

getVmVendor

public String getVmVendor()
Returns the implementation vendor of the virtual machine. This is equivalent to obtaining the java.vm.vendor property via {@link System#getProperty(String)}.

Returns: the implementation vendor of the VM.

Throws: SecurityException if a security manager exists which prevents access to the VM vendor property.

See Also: getProperty checkPropertyAccess

getVmVersion

public String getVmVersion()
Returns the implementation version of the virtual machine. This is equivalent to obtaining the java.vm.version property via {@link System#getProperty(String)}.

Returns: the implementation version of the VM.

Throws: SecurityException if a security manager exists which prevents access to the VM version property.

See Also: getProperty checkPropertyAccess

isBootClassPathSupported

public boolean isBootClassPathSupported()
Returns true if the virtual machine supports the boot classpath mechanism.

Returns: true if the boot classpath property is supported by the virtual machine.