Save This Page
Home » openjdk-7 » java » lang » management » [javadoc | source]
java.lang.management
public class: ManagementFactory [javadoc | source]
java.lang.Object
   java.lang.management.ManagementFactory
The {@code ManagementFactory} class is a factory class for getting managed beans for the Java platform. This class consists of static methods each of which returns one or more platform MXBeans representing the management interface of a component of the Java virtual machine.

Platform MXBeans

A platform MXBean is a managed bean that conforms to the JMX Instrumentation Specification and only uses a set of basic data types. A JMX management application and the {@linkplain #getPlatformMBeanServer platform MBeanServer} can interoperate without requiring classes for MXBean specific data types. The data types being transmitted between the JMX connector server and the connector client are {@linkplain javax.management.openmbean.OpenType open types} and this allows interoperation across versions. See the specification of MXBeans for details.

Each platform MXBean is a PlatformManagedObject and it has a unique ObjectName for registration in the platform {@code MBeanServer} as returned by by the getObjectName method.

An application can access a platform MXBean in the following ways:

1. Direct access to an MXBean interface
2. Indirect access to an MXBean interface via MBeanServer

The getPlatformManagementInterfaces method returns all management interfaces supported in the Java virtual machine including the standard management interfaces listed in the tables below as well as the management interfaces extended by the JDK implementation.

A Java virtual machine has a single instance of the following management interfaces:

Management Interface ObjectName
ClassLoadingMXBean java.lang:type=ClassLoading
MemoryMXBean java.lang:type=Memory
ThreadMXBean java.lang:type=Threading
RuntimeMXBean java.lang:type=Runtime
OperatingSystemMXBean java.lang:type=OperatingSystem
PlatformLoggingMXBean java.util.logging:type=Logging

A Java virtual machine has zero or a single instance of the following management interfaces.

Management Interface ObjectName
CompilationMXBean java.lang:type=Compilation

A Java virtual machine may have one or more instances of the following management interfaces.

Management Interface ObjectName
GarbageCollectorMXBean java.lang:type=GarbageCollector ,name=collector's name
MemoryManagerMXBean java.lang:type=MemoryManager ,name=manager's name
MemoryPoolMXBean java.lang:type=MemoryPool ,name=pool's name
BufferPoolMXBean {@code java.nio:type=BufferPool,name=}pool name
Field Summary
public static final  String CLASS_LOADING_MXBEAN_NAME    String representation of the ObjectName for the ClassLoadingMXBean
public static final  String COMPILATION_MXBEAN_NAME    String representation of the ObjectName for the CompilationMXBean
public static final  String MEMORY_MXBEAN_NAME    String representation of the ObjectName for the MemoryMXBean
public static final  String OPERATING_SYSTEM_MXBEAN_NAME    String representation of the ObjectName for the OperatingSystemMXBean
public static final  String RUNTIME_MXBEAN_NAME    String representation of the ObjectName for the RuntimeMXBean
public static final  String THREAD_MXBEAN_NAME    String representation of the ObjectName for the ThreadMXBean
public static final  String GARBAGE_COLLECTOR_MXBEAN_DOMAIN_TYPE    The domain name and the type key property in the ObjectName for a GarbageCollectorMXBean . The unique ObjectName for a GarbageCollectorMXBean can be formed by appending this string with ",name=collector's name". 
public static final  String MEMORY_MANAGER_MXBEAN_DOMAIN_TYPE    The domain name and the type key property in the ObjectName for a MemoryManagerMXBean . The unique ObjectName for a MemoryManagerMXBean can be formed by appending this string with ",name=manager's name". 
public static final  String MEMORY_POOL_MXBEAN_DOMAIN_TYPE    The domain name and the type key property in the ObjectName for a MemoryPoolMXBean . The unique ObjectName for a MemoryPoolMXBean can be formed by appending this string with ,name=pool's name
Method from java.lang.management.ManagementFactory Summary:
getClassLoadingMXBean,   getCompilationMXBean,   getGarbageCollectorMXBeans,   getMemoryMXBean,   getMemoryManagerMXBeans,   getMemoryPoolMXBeans,   getOperatingSystemMXBean,   getPlatformMBeanServer,   getPlatformMXBean,   getPlatformMXBean,   getPlatformMXBeans,   getPlatformMXBeans,   getPlatformManagementInterfaces,   getRuntimeMXBean,   getThreadMXBean,   newPlatformMXBeanProxy
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from java.lang.management.ManagementFactory Detail:
 public static ClassLoadingMXBean getClassLoadingMXBean() 
    Returns the managed bean for the class loading system of the Java virtual machine.
 public static CompilationMXBean getCompilationMXBean() 
    Returns the managed bean for the compilation system of the Java virtual machine. This method returns null if the Java virtual machine has no compilation system.
 public static List<GarbageCollectorMXBean> getGarbageCollectorMXBeans() 
    Returns a list of GarbageCollectorMXBean objects in the Java virtual machine. The Java virtual machine may have one or more GarbageCollectorMXBean objects. It may add or remove GarbageCollectorMXBean during execution.
 public static MemoryMXBean getMemoryMXBean() 
    Returns the managed bean for the memory system of the Java virtual machine.
 public static List<MemoryManagerMXBean> getMemoryManagerMXBeans() 
    Returns a list of MemoryManagerMXBean objects in the Java virtual machine. The Java virtual machine can have one or more memory managers. It may add or remove memory managers during execution.
 public static List<MemoryPoolMXBean> getMemoryPoolMXBeans() 
    Returns a list of MemoryPoolMXBean objects in the Java virtual machine. The Java virtual machine can have one or more memory pools. It may add or remove memory pools during execution.
 public static OperatingSystemMXBean getOperatingSystemMXBean() 
    Returns the managed bean for the operating system on which the Java virtual machine is running.
 public static synchronized MBeanServer getPlatformMBeanServer() 
    Returns the platform MBeanServer . On the first call to this method, it first creates the platform {@code MBeanServer} by calling the MBeanServerFactory.createMBeanServer method and registers each platform MXBean in this platform {@code MBeanServer} with its ObjectName . This method, in subsequent calls, will simply return the initially created platform {@code MBeanServer}.

    MXBeans that get created and destroyed dynamically, for example, memory pools and managers , will automatically be registered and deregistered into the platform {@code MBeanServer}.

    If the system property {@code javax.management.builder.initial} is set, the platform {@code MBeanServer} creation will be done by the specified javax.management.MBeanServerBuilder .

    It is recommended that this platform MBeanServer also be used to register other application managed beans besides the platform MXBeans. This will allow all MBeans to be published through the same {@code MBeanServer} and hence allow for easier network publishing and discovery. Name conflicts with the platform MXBeans should be avoided.

 public static T getPlatformMXBean(Class<T> mxbeanInterface) 
    Returns the platform MXBean implementing the given {@code mxbeanInterface} which is specified to have one single instance in the Java virtual machine. This method may return {@code null} if the management interface is not implemented in the Java virtual machine (for example, a Java virtual machine with no compilation system does not implement CompilationMXBean ); otherwise, this method is equivalent to calling:
       getPlatformMXBeans(mxbeanInterface) .get(0);
    
 public static T getPlatformMXBean(MBeanServerConnection connection,
    Class<T> mxbeanInterface) throws IOException 
    Returns the platform MXBean proxy for {@code mxbeanInterface} which is specified to have one single instance in a Java virtual machine and the proxy will forward the method calls through the given {@code MBeanServerConnection}. This method may return {@code null} if the management interface is not implemented in the Java virtual machine being monitored (for example, a Java virtual machine with no compilation system does not implement CompilationMXBean ); otherwise, this method is equivalent to calling:
        Class)
           mxbeanInterface) .get(0);
    
 public static List<T> getPlatformMXBeans(Class<T> mxbeanInterface) 
    Returns the list of platform MXBeans implementing the given {@code mxbeanInterface} in the Java virtual machine. The returned list may contain zero, one, or more instances. The number of instances in the returned list is defined in the specification of the given management interface. The order is undefined and there is no guarantee that the list returned is in the same order as previous invocations.
 public static List<T> getPlatformMXBeans(MBeanServerConnection connection,
    Class<T> mxbeanInterface) throws IOException 
    Returns the list of the platform MXBean proxies for forwarding the method calls of the {@code mxbeanInterface} through the given {@code MBeanServerConnection}. The returned list may contain zero, one, or more instances. The number of instances in the returned list is defined in the specification of the given management interface. The order is undefined and there is no guarantee that the list returned is in the same order as previous invocations.
 public static Set<PlatformManagedObject> getPlatformManagementInterfaces() 
    Returns the set of {@code Class} objects, subinterface of PlatformManagedObject , representing all management interfaces for monitoring and managing the Java platform.
 public static RuntimeMXBean getRuntimeMXBean() 
    Returns the managed bean for the runtime system of the Java virtual machine.
 public static ThreadMXBean getThreadMXBean() 
    Returns the managed bean for the thread system of the Java virtual machine.
 public static T newPlatformMXBeanProxy(MBeanServerConnection connection,
    String mxbeanName,
    Class<T> mxbeanInterface) throws IOException 
    Returns a proxy for a platform MXBean interface of a given MXBean name that forwards its method calls through the given MBeanServerConnection.

    This method is equivalent to:

    Proxy.newProxyInstance (mxbeanInterface.getClassLoader(), new Class[] { mxbeanInterface }, handler)
    where handler is an InvocationHandler to which method invocations to the MXBean interface are dispatched. This handler converts an input parameter from an MXBean data type to its mapped open type before forwarding to the MBeanServer and converts a return value from an MXBean method call through the MBeanServer from an open type to the corresponding return type declared in the MXBean interface.

    If the MXBean is a notification emitter (i.e., it implements NotificationEmitter ), both the mxbeanInterface and NotificationEmitter will be implemented by this proxy.

    Notes:

    1. Using an MXBean proxy is a convenience remote access to a platform MXBean of a running virtual machine. All method calls to the MXBean proxy are forwarded to an MBeanServerConnection where IOException may be thrown when the communication problem occurs with the connector server. An application remotely accesses the platform MXBeans using proxy should prepare to catch IOException as if accessing with the MBeanServerConnector interface.
    2. When a client application is designed to remotely access MXBeans for a running virtual machine whose version is different than the version on which the application is running, it should prepare to catch InvalidObjectException which is thrown when an MXBean proxy receives a name of an enum constant which is missing in the enum class loaded in the client application.
    3. MBeanServerInvocationHandler or its newProxyInstance method cannot be used to create a proxy for a platform MXBean. The proxy object created by MBeanServerInvocationHandler does not handle the properties of the platform MXBeans described in the class specification.