Class ManagementFactory
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 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 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 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
- Get an MXBean instance by calling the
getPlatformMXBean
orgetPlatformMXBeans
method and access the MXBean locally in the running virtual machine. - Construct an MXBean proxy instance that forwards the
method calls to a given
MBeanServer
by calling thegetPlatformMXBean(MBeanServerConnection, Class)
orgetPlatformMXBeans(MBeanServerConnection, Class)
method. ThenewPlatformMXBeanProxy
method can also be used to construct an MXBean proxy instance of a givenObjectName
. A proxy is typically constructed to remotely access an MXBean of another running virtual machine.
2. Indirect access to an MXBean interface via MBeanServer
- Go through the platform
MBeanServer
to access MXBeans locally or a specificMBeanServerConnection
to access MXBeans remotely. The attributes and operations of an MXBean use only JMX open types which include basic data types,CompositeData
, andTabularData
defined inOpenType
. The mapping is specified in the MXBean specification for details.
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:
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 |
java.nio:type=BufferPool,name= pool name |
- Since:
- 1.5
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
String representation of theObjectName
for theClassLoadingMXBean
.static final String
String representation of theObjectName
for theCompilationMXBean
.static final String
The domain name and the type key property in theObjectName
for aGarbageCollectorMXBean
.static final String
The domain name and the type key property in theObjectName
for aMemoryManagerMXBean
.static final String
String representation of theObjectName
for theMemoryMXBean
.static final String
The domain name and the type key property in theObjectName
for aMemoryPoolMXBean
.static final String
String representation of theObjectName
for theOperatingSystemMXBean
.static final String
String representation of theObjectName
for theRuntimeMXBean
.static final String
String representation of theObjectName
for theThreadMXBean
. -
Method Summary
Modifier and TypeMethodDescriptionstatic ClassLoadingMXBean
Returns the managed bean for the class loading system of the Java virtual machine.static CompilationMXBean
Returns the managed bean for the compilation system of the Java virtual machine.static List
<GarbageCollectorMXBean> Returns a list ofGarbageCollectorMXBean
objects in the Java virtual machine.static List
<MemoryManagerMXBean> Returns a list ofMemoryManagerMXBean
objects in the Java virtual machine.static MemoryMXBean
Returns the managed bean for the memory system of the Java virtual machine.static List
<MemoryPoolMXBean> Returns a list ofMemoryPoolMXBean
objects in the Java virtual machine.static OperatingSystemMXBean
Returns the managed bean for the operating system on which the Java virtual machine is running.static Set
<Class<? extends PlatformManagedObject>> Returns the set ofClass
objects, subinterface ofPlatformManagedObject
, representing all management interfaces for monitoring and managing the Java platform.static MBeanServer
Returns the platformMBeanServer
.static <T extends PlatformManagedObject>
TgetPlatformMXBean
(Class<T> mxbeanInterface) Returns the platform MXBean implementing the givenmxbeanInterface
which is specified to have one single instance in the Java virtual machine.static <T extends PlatformManagedObject>
TgetPlatformMXBean
(MBeanServerConnection connection, Class<T> mxbeanInterface) Returns the platform MXBean proxy formxbeanInterface
which is specified to have one single instance in a Java virtual machine and the proxy will forward the method calls through the givenMBeanServerConnection
.static <T extends PlatformManagedObject>
List<T> getPlatformMXBeans
(Class<T> mxbeanInterface) Returns the list of platform MXBeans implementing the givenmxbeanInterface
in the Java virtual machine.static <T extends PlatformManagedObject>
List<T> getPlatformMXBeans
(MBeanServerConnection connection, Class<T> mxbeanInterface) Returns the list of the platform MXBean proxies for forwarding the method calls of themxbeanInterface
through the givenMBeanServerConnection
.static RuntimeMXBean
Returns the managed bean for the runtime system of the Java virtual machine.static ThreadMXBean
Returns the managed bean for the thread system of the Java virtual machine.static <T> T
newPlatformMXBeanProxy
(MBeanServerConnection connection, String mxbeanName, Class<T> mxbeanInterface) Returns a proxy for a platform MXBean interface of a given MXBean name that forwards its method calls through the givenMBeanServerConnection
.
-
Field Details
-
CLASS_LOADING_MXBEAN_NAME
String representation of theObjectName
for theClassLoadingMXBean
.- See Also:
-
COMPILATION_MXBEAN_NAME
String representation of theObjectName
for theCompilationMXBean
.- See Also:
-
MEMORY_MXBEAN_NAME
String representation of theObjectName
for theMemoryMXBean
.- See Also:
-
OPERATING_SYSTEM_MXBEAN_NAME
String representation of theObjectName
for theOperatingSystemMXBean
.- See Also:
-
RUNTIME_MXBEAN_NAME
String representation of theObjectName
for theRuntimeMXBean
.- See Also:
-
THREAD_MXBEAN_NAME
String representation of theObjectName
for theThreadMXBean
.- See Also:
-
GARBAGE_COLLECTOR_MXBEAN_DOMAIN_TYPE
The domain name and the type key property in theObjectName
for aGarbageCollectorMXBean
. The uniqueObjectName
for aGarbageCollectorMXBean
can be formed by appending this string with ",name=
collector's name".- See Also:
-
MEMORY_MANAGER_MXBEAN_DOMAIN_TYPE
The domain name and the type key property in theObjectName
for aMemoryManagerMXBean
. The uniqueObjectName
for aMemoryManagerMXBean
can be formed by appending this string with ",name=
manager's name".- See Also:
-
MEMORY_POOL_MXBEAN_DOMAIN_TYPE
The domain name and the type key property in theObjectName
for aMemoryPoolMXBean
. The uniqueObjectName
for aMemoryPoolMXBean
can be formed by appending this string with,name=
pool's name.- See Also:
-
-
Method Details
-
getClassLoadingMXBean
Returns the managed bean for the class loading system of the Java virtual machine.- Returns:
- a
ClassLoadingMXBean
object for the Java virtual machine.
-
getMemoryMXBean
Returns the managed bean for the memory system of the Java virtual machine.- Returns:
- a
MemoryMXBean
object for the Java virtual machine.
-
getThreadMXBean
Returns the managed bean for the thread system of the Java virtual machine.- Returns:
- a
ThreadMXBean
object for the Java virtual machine.
-
getRuntimeMXBean
Returns the managed bean for the runtime system of the Java virtual machine.- Returns:
- a
RuntimeMXBean
object for the Java virtual machine.
-
getCompilationMXBean
Returns the managed bean for the compilation system of the Java virtual machine. This method returnsnull
if the Java virtual machine has no compilation system.- Returns:
- a
CompilationMXBean
object for the Java virtual machine ornull
if the Java virtual machine has no compilation system.
-
getOperatingSystemMXBean
Returns the managed bean for the operating system on which the Java virtual machine is running.- Returns:
- an
OperatingSystemMXBean
object for the Java virtual machine.
-
getMemoryPoolMXBeans
Returns a list ofMemoryPoolMXBean
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.- Returns:
- a list of
MemoryPoolMXBean
objects.
-
getMemoryManagerMXBeans
Returns a list ofMemoryManagerMXBean
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.- Returns:
- a list of
MemoryManagerMXBean
objects.
-
getGarbageCollectorMXBeans
Returns a list ofGarbageCollectorMXBean
objects in the Java virtual machine. The Java virtual machine may have one or moreGarbageCollectorMXBean
objects. It may add or removeGarbageCollectorMXBean
during execution.- Returns:
- a list of
GarbageCollectorMXBean
objects.
-
getPlatformMBeanServer
Returns the platformMBeanServer
. On the first call to this method, it first creates the platformMBeanServer
by calling theMBeanServerFactory.createMBeanServer
method and registers each platform MXBean in this platformMBeanServer
with itsObjectName
. This method, in subsequent calls, will simply return the initially created platformMBeanServer
.MXBeans that get created and destroyed dynamically, for example, memory
pools
andmanagers
, will automatically be registered and deregistered into the platformMBeanServer
.If the system property
javax.management.builder.initial
is set, the platformMBeanServer
creation will be done by the specifiedMBeanServerBuilder
.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
MBeanServer
and hence allow for easier network publishing and discovery. Name conflicts with the platform MXBeans should be avoided.- Returns:
- the platform
MBeanServer
; the platform MXBeans are registered into the platformMBeanServer
at the first time this method is called. - See Also:
-
newPlatformMXBeanProxy
public static <T> 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 givenMBeanServerConnection
.This method is equivalent to:
Proxy.newProxyInstance
(mxbeanInterface.getClassLoader(), new Class[] { mxbeanInterface }, handler)
handler
is anInvocationHandler
to which method invocations to the MXBean interface are dispatched. Thishandler
converts an input parameter from an MXBean data type to its mapped open type before forwarding to theMBeanServer
and converts a return value from an MXBean method call through theMBeanServer
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 themxbeanInterface
andNotificationEmitter
will be implemented by this proxy.Notes:
- 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
whereIOException
may be thrown when the communication problem occurs with the connector server. If thrown,IOException
will be wrappped inUndeclaredThrowableException
. An application remotely accessing the platform MXBeans using proxy should prepare to catchUndeclaredThrowableException
and handle its cause as if that cause had been thrown by theMBeanServerConnection
interface. - 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. If thrown,InvalidObjectException
will be wrappped inUndeclaredThrowableException
. MBeanServerInvocationHandler
or itsnewProxyInstance
method cannot be used to create a proxy for a platform MXBean. The proxy object created byMBeanServerInvocationHandler
does not handle the properties of the platform MXBeans described in the class specification.
- Type Parameters:
T
- anmxbeanInterface
type parameter- Parameters:
connection
- theMBeanServerConnection
to forward to.mxbeanName
- the name of a platform MXBean withinconnection
to forward to.mxbeanName
must be in the format ofObjectName
.mxbeanInterface
- the MXBean interface to be implemented by the proxy.- Returns:
- a proxy for a platform MXBean interface of a
given MXBean name
that forwards its method calls through the given
MBeanServerConnection
, ornull
if not exist. - Throws:
IllegalArgumentException
- ifmxbeanName
is not with a validObjectName
format, or- the named MXBean in the
connection
is not a MXBean provided by the platform, or - the named MXBean is not registered in the
MBeanServerConnection
, or - the named MXBean is not an instance of the given
mxbeanInterface
IOException
- if a communication problem occurred when accessing theMBeanServerConnection
.
- 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
-
getPlatformMXBean
Returns the platform MXBean implementing the givenmxbeanInterface
which is specified to have one single instance in the Java virtual machine. This method may returnnull
if the management interface is not implemented in the Java virtual machine (for example, a Java virtual machine with no compilation system does not implementCompilationMXBean
); otherwise, this method is equivalent to calling:getPlatformMXBeans(mxbeanInterface)
.get(0);- Type Parameters:
T
- anmxbeanInterface
type parameter- Parameters:
mxbeanInterface
- a management interface for a platform MXBean with one single instance in the Java virtual machine if implemented.- Returns:
- the platform MXBean that implements
mxbeanInterface
, ornull
if not exist. - Throws:
IllegalArgumentException
- ifmxbeanInterface
is not a platform management interface or not a singleton platform MXBean.- Since:
- 1.7
-
getPlatformMXBeans
public static <T extends PlatformManagedObject> List<T> getPlatformMXBeans(Class<T> mxbeanInterface) Returns the list of platform MXBeans implementing the givenmxbeanInterface
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.- Type Parameters:
T
- anmxbeanInterface
type parameter- Parameters:
mxbeanInterface
- a management interface for a platform MXBean- Returns:
- the list of platform MXBeans that implement
mxbeanInterface
. - Throws:
IllegalArgumentException
- ifmxbeanInterface
is not a platform management interface.- Since:
- 1.7
-
getPlatformMXBean
public static <T extends PlatformManagedObject> T getPlatformMXBean(MBeanServerConnection connection, Class<T> mxbeanInterface) throws IOException Returns the platform MXBean proxy formxbeanInterface
which is specified to have one single instance in a Java virtual machine and the proxy will forward the method calls through the givenMBeanServerConnection
. This method may returnnull
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 implementCompilationMXBean
); otherwise, this method is equivalent to calling:getPlatformMXBeans(connection, mxbeanInterface)
.get(0);- Type Parameters:
T
- anmxbeanInterface
type parameter- Parameters:
connection
- theMBeanServerConnection
to forward to.mxbeanInterface
- a management interface for a platform MXBean with one single instance in the Java virtual machine being monitored, if implemented.- Returns:
- the platform MXBean proxy for
forwarding the method calls of the
mxbeanInterface
through the givenMBeanServerConnection
, ornull
if not exist. - Throws:
IllegalArgumentException
- ifmxbeanInterface
is not a platform management interface or not a singleton platform MXBean.IOException
- if a communication problem occurred when accessing theMBeanServerConnection
.- Since:
- 1.7
- See Also:
-
getPlatformMXBeans
public static <T extends PlatformManagedObject> List<T> getPlatformMXBeans(MBeanServerConnection connection, Class<T> mxbeanInterface) throws IOException Returns the list of the platform MXBean proxies for forwarding the method calls of themxbeanInterface
through the givenMBeanServerConnection
. 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.- Type Parameters:
T
- anmxbeanInterface
type parameter- Parameters:
connection
- theMBeanServerConnection
to forward to.mxbeanInterface
- a management interface for a platform MXBean- Returns:
- the list of platform MXBean proxies for
forwarding the method calls of the
mxbeanInterface
through the givenMBeanServerConnection
. - Throws:
IllegalArgumentException
- ifmxbeanInterface
is not a platform management interface.IOException
- if a communication problem occurred when accessing theMBeanServerConnection
.- Since:
- 1.7
- See Also:
-
getPlatformManagementInterfaces
Returns the set ofClass
objects, subinterface ofPlatformManagedObject
, representing all management interfaces for monitoring and managing the Java platform.- Returns:
- the set of
Class
objects, subinterface ofPlatformManagedObject
representing the management interfaces for monitoring and managing the Java platform. - Since:
- 1.7
-