OpenJDK 27 · javax.management.MBeanServerFactory · APIdia, the JavaDoc alternative

Provides MBean server references. There are no instances of this class.

Since JMX 1.2 this class makes it possible to replace the default MBeanServer implementation. This is done using the javax.management.MBeanServerBuilder class. The class of the initial MBeanServerBuilder to be instantiated can be specified through the javax.management.builder.initial system property. The specified class must be a public subclass of javax.management.MBeanServerBuilder, and must have a public empty constructor.

By default, if no value for that property is specified, an instance of javax.management.MBeanServerBuilder is created. Otherwise, the MBeanServerFactory attempts to load the specified class using Thread.currentThread().getContextClassLoader(), or if that is null, Class.forName(). Then it creates an initial instance of that Class using java.lang.Class#newInstance(). If any checked exception is raised during this process (e.g. java.lang.ClassNotFoundException, java.lang.InstantiationException) the MBeanServerFactory will propagate this exception from within a RuntimeException.

The javax.management.builder.initial system property is consulted every time a new MBeanServer needs to be created, and the class pointed to by that property is loaded. If that class is different from that of the current MBeanServerBuilder, then a new MBeanServerBuilder is created. Otherwise, the MBeanServerFactory may create a new MBeanServerBuilder or reuse the current one.

If the class pointed to by the property cannot be loaded, or does not correspond to a valid subclass of MBeanServerBuilder then an exception is propagated, and no MBeanServer can be created until the javax.management.builder.initial system property is reset to valid value.

The MBeanServerBuilder makes it possible to wrap the MBeanServers returned by the default MBeanServerBuilder implementation, for the purpose of e.g. adding an additional security layer.

Field Summary

Modifier and Type	Field and Description
private static MBeanServerBuilder	builder The builder that will be used to construct MBeanServers.
private static final ArrayList<MBeanServer>	mBeanServerList

Constructor Summary

Access	Constructor and Description
private	MBeanServerFactory()

Method Summary

Modifier and Type	Method and Description
private static synchronized void	addMBeanServer(MBeanServer mbs)
private static synchronized void	checkMBeanServerBuilder() Instantiate a new builder according to the javax.management.builder.initial System property - if needed.
public static MBeanServer	Returns: the newly created MBeanServer. createMBeanServer() Return a new object implementing the MBeanServer interface with a standard default domain name.
public static MBeanServer	Returns: the newly created MBeanServer. createMBeanServer(String the default domain name for the created MBeanServer. This is the value that will be returned by `MBeanServer#getDefaultDomain`. domain) Return a new object implementing the `MBeanServer` interface with the specified default domain name.
public static synchronized ArrayList<MBeanServer>	Returns: A list of MBeanServer objects. findMBeanServer(String The agent identifier of the MBeanServer to retrieve. If this parameter is null, all registered MBeanServers in this JVM are returned. Otherwise, only MBeanServers whose id is equal to `agentId` are returned. The id of an MBeanServer is the `MBeanServerId` attribute of its delegate MBean. agentId) Return a list of registered MBeanServer objects.
public static ClassLoaderRepository	Returns: The Class Loader Repository used by the given MBeanServer. getClassLoaderRepository(MBeanServer The MBeanServer under examination. Since JMX 1.2, if `server` is `null`, the result is a `NullPointerException`. This behavior differs from what was implemented in JMX 1.1 - where the possibility to use `null` was deprecated. server) Return the ClassLoaderRepository used by the given MBeanServer.
private static synchronized MBeanServerBuilder	Returns: the new current `javax.management.MBeanServerBuilder`. getNewMBeanServerBuilder() Get the current `javax.management.MBeanServerBuilder`, as specified by the current value of the javax.management.builder.initial property.
private static Class<?>	loadBuilderClass(String The name of the builder class. builderClassName) Load the builder class through the context class loader.
private static String	mBeanServerId(MBeanServer mbs)
private static MBeanServerBuilder	newBuilder(Class<?> builderClass) Creates the initial builder according to the javax.management.builder.initial System property - if specified.
public static MBeanServer	Returns: the newly created MBeanServer. newMBeanServer() Return a new object implementing the MBeanServer interface with a standard default domain name, without keeping an internal reference to this new object.
public static MBeanServer	Returns: the newly created MBeanServer. newMBeanServer(String the default domain name for the created MBeanServer. This is the value that will be returned by `MBeanServer#getDefaultDomain`. domain) Return a new object implementing the MBeanServer interface with the specified default domain name, without keeping an internal reference to this new object.
public static void	releaseMBeanServer(MBeanServer the MBeanServer object to remove. mbeanServer) Remove internal MBeanServerFactory references to a created MBeanServer.
private static synchronized void	removeMBeanServer(MBeanServer mbs)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

builder	back to summary
private static MBeanServerBuilder builder The builder that will be used to construct MBeanServers.

mBeanServerList	back to summary
private static final ArrayList<MBeanServer> mBeanServerList

Constructor Detail

MBeanServerFactory	back to summary
private MBeanServerFactory()

Method Detail

addMBeanServer	back to summary
private static synchronized void addMBeanServer(MBeanServer mbs)

checkMBeanServerBuilder	back to summary
private static synchronized void checkMBeanServerBuilder() Instantiate a new builder according to the javax.management.builder.initial System property - if needed.

createMBeanServer back to summary

createMBeanServer	back to summary
public static MBeanServer createMBeanServer() Return a new object implementing the MBeanServer interface with a standard default domain name. The default domain name is used as the domain part in the ObjectName of MBeans when the domain is specified by the user is null. The standard default domain name is `DefaultDomain`. The MBeanServer reference is internally kept. This will allow `findMBeanServer` to return a reference to this MBeanServer object. This method is equivalent to `createMBeanServer(null)`. Returns:MBeanServer the newly created MBeanServer. Exceptions JMRuntimeException: if the property `javax.management.builder.initial` exists but the class it names cannot be instantiated through a public no-argument constructor; or if the instantiated builder returns null from its `newMBeanServerDelegate` or `newMBeanServer` methods. ClassCastException: if the property `javax.management.builder.initial` exists and can be instantiated but is not assignment compatible with `MBeanServerBuilder`.

public static MBeanServer createMBeanServer()

Return a new object implementing the MBeanServer interface with a standard default domain name. The default domain name is used as the domain part in the ObjectName of MBeans when the domain is specified by the user is null.

The standard default domain name is DefaultDomain.

The MBeanServer reference is internally kept. This will allow findMBeanServer to return a reference to this MBeanServer object.

This method is equivalent to createMBeanServer(null).

Returns:MBeanServer

the newly created MBeanServer.

Exceptions

JMRuntimeException:: if the property javax.management.builder.initial exists but the class it names cannot be instantiated through a public no-argument constructor; or if the instantiated builder returns null from its newMBeanServerDelegate or newMBeanServer methods.
ClassCastException:: if the property javax.management.builder.initial exists and can be instantiated but is not assignment compatible with MBeanServerBuilder.

createMBeanServer back to summary

createMBeanServer	back to summary
public static MBeanServer createMBeanServer(String domain) Return a new object implementing the `MBeanServer` interface with the specified default domain name. The given domain name is used as the domain part in the ObjectName of MBeans when the domain is specified by the user is null. The MBeanServer reference is internally kept. This will allow `findMBeanServer` to return a reference to this MBeanServer object. Parameters domain:String the default domain name for the created MBeanServer. This is the value that will be returned by `MBeanServer#getDefaultDomain`. Returns:MBeanServer the newly created MBeanServer. Exceptions JMRuntimeException: if the property `javax.management.builder.initial` exists but the class it names cannot be instantiated through a public no-argument constructor; or if the instantiated builder returns null from its `newMBeanServerDelegate` or `newMBeanServer` methods. ClassCastException: if the property `javax.management.builder.initial` exists and can be instantiated but is not assignment compatible with `MBeanServerBuilder`.

public static MBeanServer createMBeanServer(String domain)

Return a new object implementing the MBeanServer interface with the specified default domain name. The given domain name is used as the domain part in the ObjectName of MBeans when the domain is specified by the user is null.

The MBeanServer reference is internally kept. This will allow findMBeanServer to return a reference to this MBeanServer object.

Parameters

domain:String: the default domain name for the created MBeanServer. This is the value that will be returned by MBeanServer#getDefaultDomain.

Returns:MBeanServer

the newly created MBeanServer.

Exceptions

JMRuntimeException:: if the property javax.management.builder.initial exists but the class it names cannot be instantiated through a public no-argument constructor; or if the instantiated builder returns null from its newMBeanServerDelegate or newMBeanServer methods.
ClassCastException:: if the property javax.management.builder.initial exists and can be instantiated but is not assignment compatible with MBeanServerBuilder.

findMBeanServer back to summary

findMBeanServer	back to summary
public static synchronized ArrayList<MBeanServer> findMBeanServer(String agentId) Return a list of registered MBeanServer objects. A registered MBeanServer object is one that was created by one of the `createMBeanServer` methods and not subsequently released with `releaseMBeanServer`. Parameters agentId:String The agent identifier of the MBeanServer to retrieve. If this parameter is null, all registered MBeanServers in this JVM are returned. Otherwise, only MBeanServers whose id is equal to `agentId` are returned. The id of an MBeanServer is the `MBeanServerId` attribute of its delegate MBean. Returns:ArrayList<MBeanServer> A list of MBeanServer objects.

public static synchronized ArrayList<MBeanServer> findMBeanServer(String agentId)

Return a list of registered MBeanServer objects. A registered MBeanServer object is one that was created by one of the createMBeanServer methods and not subsequently released with releaseMBeanServer.

Parameters

agentId:String: The agent identifier of the MBeanServer to retrieve. If this parameter is null, all registered MBeanServers in this JVM are returned. Otherwise, only MBeanServers whose id is equal to agentId are returned. The id of an MBeanServer is the MBeanServerId attribute of its delegate MBean.

Returns:ArrayList<MBeanServer>

A list of MBeanServer objects.

getClassLoaderRepository back to summary

getClassLoaderRepository	back to summary
public static ClassLoaderRepository getClassLoaderRepository(MBeanServer server) Return the ClassLoaderRepository used by the given MBeanServer. This method is equivalent to `server.getClassLoaderRepository()`. Parameters server:MBeanServer The MBeanServer under examination. Since JMX 1.2, if `server` is `null`, the result is a `NullPointerException`. This behavior differs from what was implemented in JMX 1.1 - where the possibility to use `null` was deprecated. Returns:ClassLoaderRepository The Class Loader Repository used by the given MBeanServer. Exceptions NullPointerException: if `server` is null.

public static ClassLoaderRepository getClassLoaderRepository(MBeanServer server)

Return the ClassLoaderRepository used by the given MBeanServer. This method is equivalent to server.getClassLoaderRepository().

Parameters

server:MBeanServer: The MBeanServer under examination. Since JMX 1.2, if server is null, the result is a NullPointerException. This behavior differs from what was implemented in JMX 1.1 - where the possibility to use null was deprecated.

Returns:ClassLoaderRepository

The Class Loader Repository used by the given MBeanServer.

Exceptions

NullPointerException:: if server is null.

getNewMBeanServerBuilder back to summary

getNewMBeanServerBuilder	back to summary
private static synchronized MBeanServerBuilder getNewMBeanServerBuilder() Get the current `javax.management.MBeanServerBuilder`, as specified by the current value of the javax.management.builder.initial property. This method consults the property and instantiates a new builder if needed. Returns:MBeanServerBuilder the new current `javax.management.MBeanServerBuilder`. Exceptions JMRuntimeException: if the builder instantiation fails with a checked exception - `java.lang.ClassNotFoundException` etc...

private static synchronized MBeanServerBuilder getNewMBeanServerBuilder()

Get the current javax.management.MBeanServerBuilder, as specified by the current value of the javax.management.builder.initial property. This method consults the property and instantiates a new builder if needed.

Returns:MBeanServerBuilder

the new current javax.management.MBeanServerBuilder.

Exceptions

JMRuntimeException:: if the builder instantiation fails with a checked exception - java.lang.ClassNotFoundException etc...

loadBuilderClass	back to summary
private static Class<?> loadBuilderClass(String builderClassName) throws ClassNotFoundException Load the builder class through the context class loader. Parameters builderClassName:String The name of the builder class.

loadBuilderClass

back to summary

private static Class<?> loadBuilderClass(String builderClassName) throws ClassNotFoundException

Load the builder class through the context class loader.

Parameters

builderClassName:String: The name of the builder class.

mBeanServerId	back to summary
private static String mBeanServerId(MBeanServer mbs)

newBuilder	back to summary
private static MBeanServerBuilder newBuilder(Class<?> builderClass) Creates the initial builder according to the javax.management.builder.initial System property - if specified. If any checked exception needs to be thrown, it is embedded in a JMRuntimeException.

newMBeanServer back to summary

newMBeanServer	back to summary
public static MBeanServer newMBeanServer() Return a new object implementing the MBeanServer interface with a standard default domain name, without keeping an internal reference to this new object. The default domain name is used as the domain part in the ObjectName of MBeans when the domain is specified by the user is null. The standard default domain name is `DefaultDomain`. No reference is kept. `findMBeanServer` will not be able to return a reference to this MBeanServer object, but the garbage collector will be able to remove the MBeanServer object when it is no longer referenced. This method is equivalent to `newMBeanServer(null)`. Returns:MBeanServer the newly created MBeanServer. Exceptions JMRuntimeException: if the property `javax.management.builder.initial` exists but the class it names cannot be instantiated through a public no-argument constructor; or if the instantiated builder returns null from its `newMBeanServerDelegate` or `newMBeanServer` methods. ClassCastException: if the property `javax.management.builder.initial` exists and can be instantiated but is not assignment compatible with `MBeanServerBuilder`.

public static MBeanServer newMBeanServer()

Return a new object implementing the MBeanServer interface with a standard default domain name, without keeping an internal reference to this new object. The default domain name is used as the domain part in the ObjectName of MBeans when the domain is specified by the user is null.

The standard default domain name is DefaultDomain.

No reference is kept. findMBeanServer will not be able to return a reference to this MBeanServer object, but the garbage collector will be able to remove the MBeanServer object when it is no longer referenced.

This method is equivalent to newMBeanServer(null).

Returns:MBeanServer

the newly created MBeanServer.

Exceptions

JMRuntimeException:: if the property javax.management.builder.initial exists but the class it names cannot be instantiated through a public no-argument constructor; or if the instantiated builder returns null from its newMBeanServerDelegate or newMBeanServer methods.
ClassCastException:: if the property javax.management.builder.initial exists and can be instantiated but is not assignment compatible with MBeanServerBuilder.

newMBeanServer back to summary

newMBeanServer	back to summary
public static MBeanServer newMBeanServer(String domain) Return a new object implementing the MBeanServer interface with the specified default domain name, without keeping an internal reference to this new object. The given domain name is used as the domain part in the ObjectName of MBeans when the domain is specified by the user is null. No reference is kept. `findMBeanServer` will not be able to return a reference to this MBeanServer object, but the garbage collector will be able to remove the MBeanServer object when it is no longer referenced. Parameters domain:String the default domain name for the created MBeanServer. This is the value that will be returned by `MBeanServer#getDefaultDomain`. Returns:MBeanServer the newly created MBeanServer. Exceptions JMRuntimeException: if the property `javax.management.builder.initial` exists but the class it names cannot be instantiated through a public no-argument constructor; or if the instantiated builder returns null from its `newMBeanServerDelegate` or `newMBeanServer` methods. ClassCastException: if the property `javax.management.builder.initial` exists and can be instantiated but is not assignment compatible with `MBeanServerBuilder`.

public static MBeanServer newMBeanServer(String domain)

Return a new object implementing the MBeanServer interface with the specified default domain name, without keeping an internal reference to this new object. The given domain name is used as the domain part in the ObjectName of MBeans when the domain is specified by the user is null.

Parameters

domain:String: the default domain name for the created MBeanServer. This is the value that will be returned by MBeanServer#getDefaultDomain.

Returns:MBeanServer

the newly created MBeanServer.

Exceptions

JMRuntimeException:: if the property javax.management.builder.initial exists but the class it names cannot be instantiated through a public no-argument constructor; or if the instantiated builder returns null from its newMBeanServerDelegate or newMBeanServer methods.
ClassCastException:: if the property javax.management.builder.initial exists and can be instantiated but is not assignment compatible with MBeanServerBuilder.

releaseMBeanServer back to summary

releaseMBeanServer	back to summary
public static void releaseMBeanServer(MBeanServer mbeanServer) Remove internal MBeanServerFactory references to a created MBeanServer. This allows the garbage collector to remove the MBeanServer object. Parameters mbeanServer:MBeanServer the MBeanServer object to remove. Exceptions IllegalArgumentException: if `mbeanServer` was not generated by one of the `createMBeanServer` methods, or if `releaseMBeanServer` was already called on it.

public static void releaseMBeanServer(MBeanServer mbeanServer)

Remove internal MBeanServerFactory references to a created MBeanServer. This allows the garbage collector to remove the MBeanServer object.

Parameters

mbeanServer:MBeanServer: the MBeanServer object to remove.

Exceptions

IllegalArgumentException:: if mbeanServer was not generated by one of the createMBeanServer methods, or if releaseMBeanServer was already called on it.

removeMBeanServer	back to summary
private static synchronized void removeMBeanServer(MBeanServer mbs)

public Class MBeanServerFactory

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail