1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
/* * @(#)OperatingSystemMXBean.java 1.11 05/12/09 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package java.lang.management; /** * The management interface for the operating system on which * the Java virtual machine is running. * * <p> A Java virtual machine has a single instance of the implementation * class of this interface. This instance implementing this interface is * an <a href="ManagementFactory.html#MXBean">MXBean</a> * that can be obtained by calling * the {@link ManagementFactory#getOperatingSystemMXBean} method or * from the {@link ManagementFactory#getPlatformMBeanServer * platform <tt>MBeanServer</tt>} method. * * <p>The <tt>ObjectName</tt> for uniquely identifying the MXBean for * the operating system within an MBeanServer is: * <blockquote> * {@link ManagementFactory#OPERATING_SYSTEM_MXBEAN_NAME * <tt>java.lang:type=OperatingSystem</tt>} * </blockquote> * * <p> This interface defines several convenient methods for accessing * system properties about the operating system on which the Java * virtual machine is running. * * @see <a href="../../../javax/management/package-summary.html"> * JMX Specification.</a> * @see <a href="package-summary.html#examples"> * Ways to Access MXBeans</a> * * @author Mandy Chung * @version 1.11, 12/09/05 * @since 1.5 */ public interface OperatingSystemMXBean { /** * Returns the operating system name. * This method is equivalent to <tt>System.getProperty("os.name")</tt>. * * @return the operating system name. * * @throws java.lang.SecurityException * if a security manager exists and its * <code>checkPropertiesAccess</code> method doesn't allow access * to this system property. * @see java.lang.SecurityManager#checkPropertyAccess(java.lang.String) * @see java.lang.System#getProperty */ public String getName(); /** * Returns the operating system architecture. * This method is equivalent to <tt>System.getProperty("os.arch")</tt>. * * @return the operating system architecture. * * @throws java.lang.SecurityException * if a security manager exists and its * <code>checkPropertiesAccess</code> method doesn't allow access * to this system property. * @see java.lang.SecurityManager#checkPropertyAccess(java.lang.String) * @see java.lang.System#getProperty */ public String getArch(); /** * Returns the operating system version. * This method is equivalent to <tt>System.getProperty("os.version")</tt>. * * @return the operating system version. * * @throws java.lang.SecurityException * if a security manager exists and its * <code>checkPropertiesAccess</code> method doesn't allow access * to this system property. * @see java.lang.SecurityManager#checkPropertyAccess(java.lang.String) * @see java.lang.System#getProperty */ public String getVersion(); /** * Returns the number of processors available to the Java virtual machine. * This method is equivalent to the {@link Runtime#availableProcessors()} * method. * <p> 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 int getAvailableProcessors(); /** * 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. * <p> * If the load average is not available, a negative value is returned. * <p> * 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 double getSystemLoadAverage(); }