Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

javax.management

Class MBeanServerFactory

public class MBeanServerFactory
extends Object
Creates and maintains a set of MBeanServer instances. Server instances, as of JMX 1.2, are created using a subclass of MBeanServerBuilder. The exact class used is controlled by the property javax.management.builder.initial, and allows the instances created by MBeanServerBuilder to be wrapped, thus providing additional functionality.

The property is used as follows:

  1. If the property has no value, then an instance of MBeanServerBuilder is used.
  2. If a value is given, then:
    1. The class is loaded using Thread.currentThread().getContextClassLoader(), or, if this is null, by Class.forName().
    2. Class.newInstance() is used to create an instance of the class. The class must be public and have a public empty constructor. If an exception is thrown, it is propogated as a JMRuntimeException and no new server instances may be created until the property is set to a valid value.
  3. The value is checked on each successive request for a server. If it differs from the class of the existing instance of MBeanServerBuilder, then the value is used to create a new instance.

    4. Method Summary

    static MBeanServer
    createMBeanServer()
    Returns a server implementation using the default domain name of "DefaultDomain".
    static MBeanServer
    createMBeanServer(String domain)
    Returns a server implementation using the default domain name given, or "DefaultDomain" if this is null.
    static ArrayList
    findMBeanServer(String id)
    Returns the specified server, or, if id is null, a list of all registered servers.
    static ClassLoaderRepository
    getClassLoaderRepository(MBeanServer server)
    Returns the class loader repository used by the specified server.
    static MBeanServer
    newMBeanServer()
    Returns a server implementation using the default domain name of "DefaultDomain".
    static MBeanServer
    newMBeanServer(String domain)
    Returns a server implementation using the default domain name given, or "DefaultDomain" if this is null.
    static void
    releaseMBeanServer(MBeanServer server)
    Removes the reference to the specified server, thus allowing it to be garbage collected.

    Methods inherited from class java.lang.Object

    clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

    Method Details

    createMBeanServer

    public static MBeanServer createMBeanServer()
    Returns a server implementation using the default domain name of "DefaultDomain". The default domain name is used when the domain name specified by the user is nullfindMBeanServer(String). Calling this method is equivalent to calling createMBeanServer(String) with a null value.
    Returns:
    a new MBeanServer instance.
    Throws:
    SecurityException - if a security manager exists and the caller's permissions don't imply MBeanServerPermission(String)("createMBeanServer")
    JMRuntimeException - if the property javax.management.builder.initial exists but names a class which either can not be instantiated or provides an implementation that returns null from either MBeanServerBuilder.newMBeanServerDelegate() or MBeanServerBuilder.newMBeanServer()
    ClassCastException - if the property javax.management.builder.initial exists but names a class which is not a subclass of MBeanServerBuilder.
    See Also:
    createMBeanServer(String)

    createMBeanServer

    public static MBeanServer createMBeanServer(String domain)
    Returns a server implementation using the default domain name given, or "DefaultDomain" if this is null. The default domain name is used when the domain name specified by the user is nullfindMBeanServer(String).
    Parameters:
    domain - the default domain name of the server.
    Returns:
    a new MBeanServer instance.
    Throws:
    SecurityException - if a security manager exists and the caller's permissions don't imply MBeanServerPermission(String)("createMBeanServer")
    JMRuntimeException - if the property javax.management.builder.initial exists but names a class which either can not be instantiated or provides an implementation that returns null from either MBeanServerBuilder.newMBeanServerDelegate() or MBeanServerBuilder.newMBeanServer()
    ClassCastException - if the property javax.management.builder.initial exists but names a class which is not a subclass of MBeanServerBuilder.

    findMBeanServer

    public static ArrayList findMBeanServer(String id)
    Returns the specified server, or, if id is null, a list of all registered servers. A registered server is one that was created using createMBeanServer() or createMBeanServer(String) and has not yet been released using releaseMBeanServer(MBeanServer).
    Parameters:
    id - the id of the server to retrieve, or null to return all servers.
    Returns:
    a list of MBeanServers.
    Throws:
    SecurityException - if a security manager exists and the caller's permissions don't imply MBeanServerPermission(String)("findMBeanServer")

    getClassLoaderRepository

    public static ClassLoaderRepository getClassLoaderRepository(MBeanServer server)
    Returns the class loader repository used by the specified server. This is equivalent to calling MBeanServer.getClassLoaderRepository() on the given server.
    Parameters:
    server - the server whose class loader repository should be retrieved.
    Throws:
    NullPointerException - if server is null.
    SecurityException - if a security manager exists and the caller's permissions don't imply MBeanPermission(null, null, null, "getClassLoaderRepository")

    newMBeanServer

    public static MBeanServer newMBeanServer()
    Returns a server implementation using the default domain name of "DefaultDomain". The default domain name is used when the domain name specified by the user is nullfindMBeanServer(String). Calling this method is equivalent to calling newMBeanServer(String) with a null value.
    Returns:
    a new MBeanServer instance.
    Throws:
    SecurityException - if a security manager exists and the caller's permissions don't imply MBeanServerPermission(String)("newMBeanServer")
    JMRuntimeException - if the property javax.management.builder.initial exists but names a class which either can not be instantiated or provides an implementation that returns null from either MBeanServerBuilder.newMBeanServerDelegate() or MBeanServerBuilder.newMBeanServer()
    ClassCastException - if the property javax.management.builder.initial exists but names a class which is not a subclass of MBeanServerBuilder.
    See Also:
    newMBeanServer(String)

    newMBeanServer

    public static MBeanServer newMBeanServer(String domain)
    Returns a server implementation using the default domain name given, or "DefaultDomain" if this is null. The default domain name is used when the domain name specified by the user is nullfindMBeanServer(String).
    Parameters:
    domain - the default domain name of the server.
    Returns:
    a new MBeanServer instance.
    Throws:
    SecurityException - if a security manager exists and the caller's permissions don't imply MBeanServerPermission(String)("newMBeanServer")
    JMRuntimeException - if the property javax.management.builder.initial exists but names a class which either can not be instantiated or provides an implementation that returns null from either MBeanServerBuilder.newMBeanServerDelegate() or MBeanServerBuilder.newMBeanServer()
    ClassCastException - if the property javax.management.builder.initial exists but names a class which is not a subclass of MBeanServerBuilder.

    releaseMBeanServer

    public static void releaseMBeanServer(MBeanServer server)
    Removes the reference to the specified server, thus allowing it to be garbage collected.
    Parameters:
    server - the server to remove.
    Throws:
    IllegalArgumentException - if a reference to the server is not held (i.e. it wasn't created by createMBeanServer(String) or this method has already been called on it.
    SecurityException - if a security manager exists and the caller's permissions don't imply MBeanServerPermission(String)("releaseMBeanServer")
    MBeanServerFactory.java -- Manages server instances. Copyright (C) 2006 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

    Overview Package Class Use Source Tree Index Deprecated About