FileDocCategorySizeDatePackage
OperatingSystemMXBean.javaAPI DocJava SE 6 API4537Tue Jun 10 00:25:38 BST 2008java.lang.management

OperatingSystemMXBean

public interface OperatingSystemMXBean
The management interface for the operating system on which the Java virtual machine is running.

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#getOperatingSystemMXBean} method or from the {@link ManagementFactory#getPlatformMBeanServer platform MBeanServer} method.

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

{@link ManagementFactory#OPERATING_SYSTEM_MXBEAN_NAME java.lang:type=OperatingSystem}

This interface defines several convenient methods for accessing system properties about the operating system on which the Java virtual machine is running.

see
JMX Specification.
see
Ways to Access MXBeans
author
Mandy Chung
version
1.11, 12/09/05
since
1.5

Fields Summary
Constructors Summary
Methods Summary
public java.lang.StringgetArch()
Returns the operating system architecture. This method is equivalent to System.getProperty("os.arch").

return
the operating system architecture.
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 intgetAvailableProcessors()
Returns the number of processors available to the Java virtual machine. This method is equivalent to the {@link Runtime#availableProcessors()} method.

This value may change during a particular invocation of the virtual machine.

return
the number of processors available to the virtual machine; never smaller than one.

public java.lang.StringgetName()
Returns the operating system name. This method is equivalent to System.getProperty("os.name").

return
the operating system 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 doublegetSystemLoadAverage()
Returns the system load average for the last minute. The system load average is the sum of the number of runnable entities queued to the {@linkplain #getAvailableProcessors available processors} and the number of runnable entities running on the available processors averaged over a period of time. The way in which the load average is calculated is operating system specific but is typically a damped time-dependent average.

If the load average is not available, a negative value is returned.

This method is designed to provide a hint about the system load and may be queried frequently. The load average may be unavailable on some platform where it is expensive to implement this method.

return
the system load average; or a negative value if not available.
since
1.6

public java.lang.StringgetVersion()
Returns the operating system version. This method is equivalent to System.getProperty("os.version").

return
the operating system 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