FileDocCategorySizeDatePackage
RuntimeMXBean.javaAPI DocJava SE 5 API11822Fri Aug 26 14:57:06 BST 2005java.lang.management

RuntimeMXBean

public interface RuntimeMXBean
The management interface for the runtime system of the Java virtual machine.

A Java virtual machine has a single instance of the implementation class of this interface. This instance implementing this interface is an MXBean that can be obtained by calling the {@link ManagementFactory#getRuntimeMXBean} method or from the {@link ManagementFactory#getPlatformMBeanServer platform MBeanServer} method.

The ObjectName for uniquely identifying the MXBean for the runtime system within an MBeanServer is:

{@link ManagementFactory#RUNTIME_MXBEAN_NAME java.lang:type=Runtime}

This interface defines several convenient methods for accessing system properties about the Java virtual machine.

see
JMX Specification.
see
Ways to Access MXBeans
author
Mandy Chung
version
1.13, 04/20/04
since
1.5

Fields Summary
Constructors Summary
Methods Summary
public java.lang.StringgetBootClassPath()
Returns the boot class path that is used by the bootstrap class loader to search for class files.

Multiple paths in the boot class path are separated by the path separator character of the platform on which the Java virtual machine is running.

A Java virtual machine implementation may not support the boot class path mechanism for the bootstrap class loader to search for class files. The {@link #isBootClassPathSupported} method can be used to determine if the Java virtual machine supports this method.

return
the boot class path.
throws
java.lang.UnsupportedOperationException if the Java virtual machine does not support this operation.
throws
java.lang.SecurityException if a security manager exists and the caller does not have ManagementPermission("monitor").

public java.lang.StringgetClassPath()
Returns the Java class path that is used by the system class loader to search for class files. This method is equivalent to {@link System#getProperty System.getProperty("java.class.path")}.

Multiple paths in the Java class path are separated by the path separator character of the platform of the Java virtual machine being monitored.

return
the Java class path.
throws
java.lang.SecurityException if a security manager exists and its checkPropertiesAccess method doesn't allow access to this system property.
see
java.lang.SecurityManager#checkPropertyAccess(java.lang.String)
see
java.lang.System#getProperty

public java.util.ListgetInputArguments()
Returns the input arguments passed to the Java virtual machine which does not include the arguments to the main method. This method returns an empty list if there is no input argument to the Java virtual machine.

Some Java virtual machine implementations may take input arguments from multiple different sources: for examples, arguments passed from the application that launches the Java virtual machine such as the 'java' command, environment variables, configuration files, etc.

Typically, not all command-line options to the 'java' command are passed to the Java virtual machine. Thus, the returned input arguments may not include all command-line options.

MBeanServer access:
The mapped type of List is String[].

return
a list of String objects; each element is an argument passed to the Java virtual machine.
throws
java.lang.SecurityException if a security manager exists and the caller does not have ManagementPermission("monitor").

public java.lang.StringgetLibraryPath()
Returns the Java library path. This method is equivalent to {@link System#getProperty System.getProperty("java.library.path")}.

Multiple paths in the Java library path are separated by the path separator character of the platform of the Java virtual machine being monitored.

return
the Java library path.
throws
java.lang.SecurityException if a security manager exists and its checkPropertiesAccess method doesn't allow access to this system property.
see
java.lang.SecurityManager#checkPropertyAccess(java.lang.String)
see
java.lang.System#getProperty

public java.lang.StringgetManagementSpecVersion()
Returns the version of the specification for the management interface implemented by the running Java virtual machine.

return
the version of the specification for the management interface implemented by the running Java virtual machine.

public java.lang.StringgetName()
Returns the name representing the running Java virtual machine. The returned name string can be any arbitrary string and a Java virtual machine implementation can choose to embed platform-specific useful information in the returned name string. Each running virtual machine could have a different name.

return
the name representing the running Java virtual machine.

public java.lang.StringgetSpecName()
Returns the Java virtual machine specification name. This method is equivalent to {@link System#getProperty System.getProperty("java.vm.specification.name")}.

return
the Java virtual machine specification name.
throws
java.lang.SecurityException if a security manager exists and its checkPropertiesAccess method doesn't allow access to this system property.
see
java.lang.SecurityManager#checkPropertyAccess(java.lang.String)
see
java.lang.System#getProperty

public java.lang.StringgetSpecVendor()
Returns the Java virtual machine specification vendor. This method is equivalent to {@link System#getProperty System.getProperty("java.vm.specification.vendor")}.

return
the Java virtual machine specification vendor.
throws
java.lang.SecurityException if a security manager exists and its checkPropertiesAccess method doesn't allow access to this system property.
see
java.lang.SecurityManager#checkPropertyAccess(java.lang.String)
see
java.lang.System#getProperty

public java.lang.StringgetSpecVersion()
Returns the Java virtual machine specification version. This method is equivalent to {@link System#getProperty System.getProperty("java.vm.specification.version")}.

return
the Java virtual machine specification version.
throws
java.lang.SecurityException if a security manager exists and its checkPropertiesAccess method doesn't allow access to this system property.
see
java.lang.SecurityManager#checkPropertyAccess(java.lang.String)
see
java.lang.System#getProperty

public longgetStartTime()
Returns the start time of the Java virtual machine in milliseconds. This method returns the approximate time when the Java virtual machine started.

return
start time of the Java virtual machine in milliseconds.

public java.util.MapgetSystemProperties()
Returns a map of names and values of all system properties. This method calls {@link System#getProperties} to get all system properties. Properties whose name or value is not a String are omitted.

MBeanServer access:
The mapped type of Map is {@link javax.management.openmbean.TabularData TabularData} with two items in each row as follows:

Item Name Item Type
key String
value String

return
a map of names and values of all system properties.
throws
java.lang.SecurityException if a security manager exists and its checkPropertiesAccess method doesn't allow access to the system properties.

public longgetUptime()
Returns the uptime of the Java virtual machine in milliseconds.

return
uptime of the Java virtual machine in milliseconds.

public java.lang.StringgetVmName()
Returns the Java virtual machine implementation name. This method is equivalent to {@link System#getProperty System.getProperty("java.vm.name")}.

return
the Java virtual machine implementation name.
throws
java.lang.SecurityException if a security manager exists and its checkPropertiesAccess method doesn't allow access to this system property.
see
java.lang.SecurityManager#checkPropertyAccess(java.lang.String)
see
java.lang.System#getProperty

public java.lang.StringgetVmVendor()
Returns the Java virtual machine implementation vendor. This method is equivalent to {@link System#getProperty System.getProperty("java.vm.vendor")}.

return
the Java virtual machine implementation vendor.
throws
java.lang.SecurityException if a security manager exists and its checkPropertiesAccess method doesn't allow access to this system property.
see
java.lang.SecurityManager#checkPropertyAccess(java.lang.String)
see
java.lang.System#getProperty

public java.lang.StringgetVmVersion()
Returns the Java virtual machine implementation version. This method is equivalent to {@link System#getProperty System.getProperty("java.vm.version")}.

return
the Java virtual machine implementation version.
throws
java.lang.SecurityException if a security manager exists and its checkPropertiesAccess method doesn't allow access to this system property.
see
java.lang.SecurityManager#checkPropertyAccess(java.lang.String)
see
java.lang.System#getProperty

public booleanisBootClassPathSupported()
Tests if the Java virtual machine supports the boot class path mechanism used by the bootstrap class loader to search for class files.

return
true if the Java virtual machine supports the class path mechanism; false otherwise.