Package Summary  Overview Summary

class:MBeanServer [NONE]

method:createMBean(java.lang.String,javax.management.ObjectName) [NONE]

  • createMBean

    ObjectInstance createMBean​(String className,
                               ObjectName name)
                        throws ReflectionException,
                               InstanceAlreadyExistsException,
                               MBeanRegistrationException,
                               MBeanException,
                               NotCompliantMBeanException
    

    Instantiates and registers an MBean in the MBean server. The MBean server will use its Default Loader Repository to load the class of the MBean. An object name is associated with the MBean. If the object name given is null, the MBean must provide its own name by implementing the MBeanRegistration interface and returning the name from the preRegister method.

    This method is equivalent to createMBean(className, name, (Object[]) null, (String[]) null) .

    If this method successfully creates an MBean, a notification is sent as described above.

    Specified by:
    createMBean in interface MBeanServerConnection
    Parameters:
    className - The class name of the MBean to be instantiated.
    name - The object name of the MBean. May be null.
    Returns:
    An ObjectInstance, containing the ObjectName and the Java class name of the newly instantiated MBean. If the contained ObjectName is n, the contained Java class name is getMBeanInfo(n).getClassName().
    Throws:
    RuntimeOperationsException - Wraps a java.lang.IllegalArgumentException: The className passed in parameter is null, the ObjectName passed in parameter contains a pattern or no ObjectName is specified for the MBean.
    RuntimeMBeanException - If the MBean's constructor or its preRegister or postRegister method threw a RuntimeException. If the postRegister (MBeanRegistration interface) method of the MBean throws a RuntimeException, the createMBean method will throw a RuntimeMBeanException, although the MBean creation and registration succeeded. In such a case, the MBean will be actually registered even though the createMBean method threw an exception. Note that RuntimeMBeanException can also be thrown by preRegister, in which case the MBean will not be registered.
    RuntimeErrorException - If the postRegister (MBeanRegistration interface) method of the MBean throws an Error, the createMBean method will throw a RuntimeErrorException, although the MBean creation and registration succeeded. In such a case, the MBean will be actually registered even though the createMBean method threw an exception. Note that RuntimeErrorException can also be thrown by preRegister, in which case the MBean will not be registered.
    ReflectionException - Wraps a java.lang.ClassNotFoundException or a java.lang.Exception that occurred when trying to invoke the MBean's constructor.
    InstanceAlreadyExistsException - The MBean is already under the control of the MBean server.
    MBeanRegistrationException - The preRegister (MBeanRegistration interface) method of the MBean has thrown an exception. The MBean will not be registered.
    MBeanException - The constructor of the MBean has thrown an exception
    NotCompliantMBeanException - This class is not a JMX compliant MBean
    See Also:
    MBeanRegistration

method:createMBean(java.lang.String,javax.management.ObjectName,javax.management.ObjectName) [NONE]

  • createMBean

    ObjectInstance createMBean​(String className,
                               ObjectName name,
                               ObjectName loaderName)
                        throws ReflectionException,
                               InstanceAlreadyExistsException,
                               MBeanRegistrationException,
                               MBeanException,
                               NotCompliantMBeanException,
                               InstanceNotFoundException
    

    Instantiates and registers an MBean in the MBean server. The class loader to be used is identified by its object name. An object name is associated with the MBean. If the object name of the loader is null, the ClassLoader that loaded the MBean server will be used. If the MBean's object name given is null, the MBean must provide its own name by implementing the MBeanRegistration interface and returning the name from the preRegister method.

    This method is equivalent to createMBean(className, name, loaderName, (Object[]) null, (String[]) null) .

    If this method successfully creates an MBean, a notification is sent as described above.

    Specified by:
    createMBean in interface MBeanServerConnection
    Parameters:
    className - The class name of the MBean to be instantiated.
    name - The object name of the MBean. May be null.
    loaderName - The object name of the class loader to be used.
    Returns:
    An ObjectInstance, containing the ObjectName and the Java class name of the newly instantiated MBean. If the contained ObjectName is n, the contained Java class name is getMBeanInfo(n).getClassName().
    Throws:
    RuntimeOperationsException - Wraps a java.lang.IllegalArgumentException: The className passed in parameter is null, the ObjectName passed in parameter contains a pattern or no ObjectName is specified for the MBean.
    RuntimeMBeanException - If the MBean's constructor or its preRegister or postRegister method threw a RuntimeException. If the postRegister (MBeanRegistration interface) method of the MBean throws a RuntimeException, the createMBean method will throw a RuntimeMBeanException, although the MBean creation and registration succeeded. In such a case, the MBean will be actually registered even though the createMBean method threw an exception. Note that RuntimeMBeanException can also be thrown by preRegister, in which case the MBean will not be registered.
    RuntimeErrorException - If the postRegister (MBeanRegistration interface) method of the MBean throws an Error, the createMBean method will throw a RuntimeErrorException, although the MBean creation and registration succeeded. In such a case, the MBean will be actually registered even though the createMBean method threw an exception. Note that RuntimeErrorException can also be thrown by preRegister, in which case the MBean will not be registered.
    ReflectionException - Wraps a java.lang.ClassNotFoundException or a java.lang.Exception that occurred when trying to invoke the MBean's constructor.
    InstanceAlreadyExistsException - The MBean is already under the control of the MBean server.
    MBeanRegistrationException - The preRegister (MBeanRegistration interface) method of the MBean has thrown an exception. The MBean will not be registered.
    MBeanException - The constructor of the MBean has thrown an exception
    NotCompliantMBeanException - This class is not a JMX compliant MBean
    InstanceNotFoundException - The specified class loader is not registered in the MBean server.
    See Also:
    MBeanRegistration

method:createMBean(java.lang.String,javax.management.ObjectName,java.lang.Object[],java.lang.String[]) [NONE]

  • createMBean

    ObjectInstance createMBean​(String className,
                               ObjectName name,
                               Object[] params,
                               String[] signature)
                        throws ReflectionException,
                               InstanceAlreadyExistsException,
                               MBeanRegistrationException,
                               MBeanException,
                               NotCompliantMBeanException
    
    Instantiates and registers an MBean in the MBean server. The MBean server will use its Default Loader Repository to load the class of the MBean. An object name is associated with the MBean. If the object name given is null, the MBean must provide its own name by implementing the MBeanRegistration interface and returning the name from the preRegister method.

    If this method successfully creates an MBean, a notification is sent as described above.

    Specified by:
    createMBean in interface MBeanServerConnection
    Parameters:
    className - The class name of the MBean to be instantiated.
    name - The object name of the MBean. May be null.
    params - An array containing the parameters of the constructor to be invoked.
    signature - An array containing the signature of the constructor to be invoked.
    Returns:
    An ObjectInstance, containing the ObjectName and the Java class name of the newly instantiated MBean. If the contained ObjectName is n, the contained Java class name is getMBeanInfo(n).getClassName().
    Throws:
    RuntimeOperationsException - Wraps a java.lang.IllegalArgumentException: The className passed in parameter is null, the ObjectName passed in parameter contains a pattern or no ObjectName is specified for the MBean.
    RuntimeMBeanException - If the MBean's constructor or its preRegister or postRegister method threw a RuntimeException. If the postRegister (MBeanRegistration interface) method of the MBean throws a RuntimeException, the createMBean method will throw a RuntimeMBeanException, although the MBean creation and registration succeeded. In such a case, the MBean will be actually registered even though the createMBean method threw an exception. Note that RuntimeMBeanException can also be thrown by preRegister, in which case the MBean will not be registered.
    RuntimeErrorException - If the postRegister (MBeanRegistration interface) method of the MBean throws an Error, the createMBean method will throw a RuntimeErrorException, although the MBean creation and registration succeeded. In such a case, the MBean will be actually registered even though the createMBean method threw an exception. Note that RuntimeErrorException can also be thrown by preRegister, in which case the MBean will not be registered.
    ReflectionException - Wraps a java.lang.ClassNotFoundException or a java.lang.Exception that occurred when trying to invoke the MBean's constructor.
    InstanceAlreadyExistsException - The MBean is already under the control of the MBean server.
    MBeanRegistrationException - The preRegister (MBeanRegistration interface) method of the MBean has thrown an exception. The MBean will not be registered.
    MBeanException - The constructor of the MBean has thrown an exception
    NotCompliantMBeanException - This class is not a JMX compliant MBean
    See Also:
    MBeanRegistration

method:createMBean(java.lang.String,javax.management.ObjectName,javax.management.ObjectName,java.lang.Object[],java.lang.String[]) [NONE]

  • createMBean

    ObjectInstance createMBean​(String className,
                               ObjectName name,
                               ObjectName loaderName,
                               Object[] params,
                               String[] signature)
                        throws ReflectionException,
                               InstanceAlreadyExistsException,
                               MBeanRegistrationException,
                               MBeanException,
                               NotCompliantMBeanException,
                               InstanceNotFoundException
    

    Instantiates and registers an MBean in the MBean server. The class loader to be used is identified by its object name. An object name is associated with the MBean. If the object name of the loader is not specified, the ClassLoader that loaded the MBean server will be used. If the MBean object name given is null, the MBean must provide its own name by implementing the MBeanRegistration interface and returning the name from the preRegister method.

    If this method successfully creates an MBean, a notification is sent as described above.

    Specified by:
    createMBean in interface MBeanServerConnection
    Parameters:
    className - The class name of the MBean to be instantiated.
    name - The object name of the MBean. May be null.
    loaderName - The object name of the class loader to be used.
    params - An array containing the parameters of the constructor to be invoked.
    signature - An array containing the signature of the constructor to be invoked.
    Returns:
    An ObjectInstance, containing the ObjectName and the Java class name of the newly instantiated MBean. If the contained ObjectName is n, the contained Java class name is getMBeanInfo(n).getClassName().
    Throws:
    RuntimeOperationsException - Wraps a java.lang.IllegalArgumentException: The className passed in parameter is null, the ObjectName passed in parameter contains a pattern or no ObjectName is specified for the MBean.
    RuntimeMBeanException - The MBean's constructor or its preRegister or postRegister method threw a RuntimeException. If the postRegister (MBeanRegistration interface) method of the MBean throws a RuntimeException, the createMBean method will throw a RuntimeMBeanException, although the MBean creation and registration succeeded. In such a case, the MBean will be actually registered even though the createMBean method threw an exception. Note that RuntimeMBeanException can also be thrown by preRegister, in which case the MBean will not be registered.
    RuntimeErrorException - If the postRegister method (MBeanRegistration interface) method of the MBean throws an Error, the createMBean method will throw a RuntimeErrorException, although the MBean creation and registration succeeded. In such a case, the MBean will be actually registered even though the createMBean method threw an exception. Note that RuntimeErrorException can also be thrown by preRegister, in which case the MBean will not be registered.
    ReflectionException - Wraps a java.lang.ClassNotFoundException or a java.lang.Exception that occurred when trying to invoke the MBean's constructor.
    InstanceAlreadyExistsException - The MBean is already under the control of the MBean server.
    MBeanRegistrationException - The preRegister (MBeanRegistration interface) method of the MBean has thrown an exception. The MBean will not be registered.
    MBeanException - The constructor of the MBean has thrown an exception
    NotCompliantMBeanException - This class is not a JMX compliant MBean
    InstanceNotFoundException - The specified class loader is not registered in the MBean server.
    See Also:
    MBeanRegistration

method:registerMBean(java.lang.Object,javax.management.ObjectName) [NONE]

  • registerMBean

    ObjectInstance registerMBean​(Object object,
                                 ObjectName name)
                          throws InstanceAlreadyExistsException,
                                 MBeanRegistrationException,
                                 NotCompliantMBeanException
    

    Registers a pre-existing object as an MBean with the MBean server. If the object name given is null, the MBean must provide its own name by implementing the MBeanRegistration interface and returning the name from the preRegister method.

    If this method successfully registers an MBean, a notification is sent as described above.

    Parameters:
    object - The MBean to be registered as an MBean.
    name - The object name of the MBean. May be null.
    Returns:
    An ObjectInstance, containing the ObjectName and the Java class name of the newly registered MBean. If the contained ObjectName is n, the contained Java class name is getMBeanInfo(n).getClassName().
    Throws:
    InstanceAlreadyExistsException - The MBean is already under the control of the MBean server.
    MBeanRegistrationException - The preRegister (MBeanRegistration interface) method of the MBean has thrown an exception. The MBean will not be registered.
    RuntimeMBeanException - If the postRegister (MBeanRegistration interface) method of the MBean throws a RuntimeException, the registerMBean method will throw a RuntimeMBeanException, although the MBean registration succeeded. In such a case, the MBean will be actually registered even though the registerMBean method threw an exception. Note that RuntimeMBeanException can also be thrown by preRegister, in which case the MBean will not be registered.
    RuntimeErrorException - If the postRegister (MBeanRegistration interface) method of the MBean throws an Error, the registerMBean method will throw a RuntimeErrorException, although the MBean registration succeeded. In such a case, the MBean will be actually registered even though the registerMBean method threw an exception. Note that RuntimeErrorException can also be thrown by preRegister, in which case the MBean will not be registered.
    NotCompliantMBeanException - This object is not a JMX compliant MBean
    RuntimeOperationsException - Wraps a java.lang.IllegalArgumentException: The object passed in parameter is null or no object name is specified.
    See Also:
    MBeanRegistration

method:unregisterMBean(javax.management.ObjectName) [NONE]

  • unregisterMBean

    void unregisterMBean​(ObjectName name)
                  throws InstanceNotFoundException,
                         MBeanRegistrationException
    
    Unregisters an MBean from the MBean server. The MBean is identified by its object name. Once the method has been invoked, the MBean may no longer be accessed by its object name.

    If this method successfully unregisters an MBean, a notification is sent as described above.

    Specified by:
    unregisterMBean in interface MBeanServerConnection
    Parameters:
    name - The object name of the MBean to be unregistered.
    Throws:
    RuntimeOperationsException - Wraps a java.lang.IllegalArgumentException: The object name in parameter is null or the MBean you are when trying to unregister is the MBeanServerDelegate MBean.
    RuntimeMBeanException - If the postDeregister (MBeanRegistration interface) method of the MBean throws a RuntimeException, the unregisterMBean method will throw a RuntimeMBeanException, although the MBean unregistration succeeded. In such a case, the MBean will be actually unregistered even though the unregisterMBean method threw an exception. Note that RuntimeMBeanException can also be thrown by preDeregister, in which case the MBean will remain registered.
    RuntimeErrorException - If the postDeregister (MBeanRegistration interface) method of the MBean throws an Error, the unregisterMBean method will throw a RuntimeErrorException, although the MBean unregistration succeeded. In such a case, the MBean will be actually unregistered even though the unregisterMBean method threw an exception. Note that RuntimeMBeanException can also be thrown by preDeregister, in which case the MBean will remain registered.
    InstanceNotFoundException - The MBean specified is not registered in the MBean server.
    MBeanRegistrationException - The preDeregister ((MBeanRegistration interface) method of the MBean has thrown an exception.
    See Also:
    MBeanRegistration

method:getObjectInstance(javax.management.ObjectName) [NONE]

method:queryMBeans(javax.management.ObjectName,javax.management.QueryExp) [NONE]

  • queryMBeans

    Set<ObjectInstance> queryMBeans​(ObjectName name,
                                    QueryExp query)
    Gets MBeans controlled by the MBean server. This method allows any of the following to be obtained: All MBeans, a set of MBeans specified by pattern matching on the ObjectName and/or a Query expression, a specific MBean. When the object name is null or no domain and key properties are specified, all objects are to be selected (and filtered if a query is specified). It returns the set of ObjectInstance objects (containing the ObjectName and the Java Class name) for the selected MBeans.
    Specified by:
    queryMBeans in interface MBeanServerConnection
    Parameters:
    name - The object name pattern identifying the MBeans to be retrieved. If null or no domain and key properties are specified, all the MBeans registered will be retrieved.
    query - The query expression to be applied for selecting MBeans. If null no query expression will be applied for selecting MBeans.
    Returns:
    A set containing the ObjectInstance objects for the selected MBeans. If no MBean satisfies the query an empty list is returned.
    Throws:
    RuntimeOperationsException

method:queryNames(javax.management.ObjectName,javax.management.QueryExp) [NONE]

  • queryNames

    Set<ObjectName> queryNames​(ObjectName name,
                               QueryExp query)
    Gets the names of MBeans controlled by the MBean server. This method enables any of the following to be obtained: The names of all MBeans, the names of a set of MBeans specified by pattern matching on the ObjectName and/or a Query expression, a specific MBean name (equivalent to testing whether an MBean is registered). When the object name is null or no domain and key properties are specified, all objects are selected (and filtered if a query is specified). It returns the set of ObjectNames for the MBeans selected.
    Specified by:
    queryNames in interface MBeanServerConnection
    Parameters:
    name - The object name pattern identifying the MBean names to be retrieved. If null or no domain and key properties are specified, the name of all registered MBeans will be retrieved.
    query - The query expression to be applied for selecting MBeans. If null no query expression will be applied for selecting MBeans.
    Returns:
    A set containing the ObjectNames for the MBeans selected. If no MBean satisfies the query, an empty list is returned.
    Throws:
    RuntimeOperationsException

method:isRegistered(javax.management.ObjectName) [NONE]

  • isRegistered

    boolean isRegistered​(ObjectName name)
    Description copied from interface: MBeanServerConnection
    Checks whether an MBean, identified by its object name, is already registered with the MBean server.
    Specified by:
    isRegistered in interface MBeanServerConnection
    Parameters:
    name - The object name of the MBean to be checked.
    Returns:
    True if the MBean is already registered in the MBean server, false otherwise.
    Throws:
    RuntimeOperationsException - Wraps a java.lang.IllegalArgumentException: The object name in parameter is null.

method:getMBeanCount() [NONE]

  • getMBeanCount

    Integer getMBeanCount()
    Returns the number of MBeans registered in the MBean server.
    Specified by:
    getMBeanCount in interface MBeanServerConnection
    Returns:
    the number of registered MBeans, wrapped in an Integer. If the caller's permissions are restricted, this number may be greater than the number of MBeans the caller can access.

method:getAttribute(javax.management.ObjectName,java.lang.String) [NONE]

method:getAttributes(javax.management.ObjectName,java.lang.String[]) [NONE]

  • getAttributes

    AttributeList getAttributes​(ObjectName name,
                                String[] attributes)
                         throws InstanceNotFoundException,
                                ReflectionException
    
    Description copied from interface: MBeanServerConnection

    Retrieves the values of several attributes of a named MBean. The MBean is identified by its object name.

    If one or more attributes cannot be retrieved for some reason, they will be omitted from the returned AttributeList. The caller should check that the list is the same size as the attributes array. To discover what problem prevented a given attribute from being retrieved, call getAttribute for that attribute.

    Here is an example of calling this method and checking that it succeeded in retrieving all the requested attributes:

     String[] attrNames = ...;
     AttributeList list = mbeanServerConnection.getAttributes(objectName, attrNames);
     if (list.size() == attrNames.length)
         System.out.println("All attributes were retrieved successfully");
     else {
         List<String> missing = new ArrayList<String>(Arrays.asList(attrNames));
         for (Attribute a : list.asList())
             missing.remove(a.getName());
         System.out.println("Did not retrieve: " + missing);
     }
     
    Specified by:
    getAttributes in interface MBeanServerConnection
    Parameters:
    name - The object name of the MBean from which the attributes are retrieved.
    attributes - A list of the attributes to be retrieved.
    Returns:
    The list of the retrieved attributes.
    Throws:
    RuntimeOperationsException - Wrap a java.lang.IllegalArgumentException: The object name in parameter is null or attributes in parameter is null.
    InstanceNotFoundException - The MBean specified is not registered in the MBean server.
    ReflectionException - An exception occurred when trying to invoke the getAttributes method of a Dynamic MBean.
    See Also:
    MBeanServerConnection.setAttributes(javax.management.ObjectName, javax.management.AttributeList)

method:setAttribute(javax.management.ObjectName,javax.management.Attribute) [NONE]

method:setAttributes(javax.management.ObjectName,javax.management.AttributeList) [NONE]

  • setAttributes

    AttributeList setAttributes​(ObjectName name,
                                AttributeList attributes)
                         throws InstanceNotFoundException,
                                ReflectionException
    
    Description copied from interface: MBeanServerConnection

    Sets the values of several attributes of a named MBean. The MBean is identified by its object name.

    If one or more attributes cannot be set for some reason, they will be omitted from the returned AttributeList. The caller should check that the input AttributeList is the same size as the output one. To discover what problem prevented a given attribute from being retrieved, it will usually be possible to call setAttribute for that attribute, although this is not guaranteed to work. (For example, the values of two attributes may have been rejected because they were inconsistent with each other. Setting one of them alone might be allowed.)

    Here is an example of calling this method and checking that it succeeded in setting all the requested attributes:

     AttributeList inputAttrs = ...;
     AttributeList outputAttrs = mbeanServerConnection.setAttributes(objectName, inputAttrs);
     if (inputAttrs.size() == outputAttrs.size())
         System.out.println("All attributes were set successfully");
     else {
         List<String> missing = new ArrayList<String>();
         for (Attribute a : inputAttrs.asList())
             missing.add(a.getName());
         for (Attribute a : outputAttrs.asList())
             missing.remove(a.getName());
         System.out.println("Did not set: " + missing);
     }
     
    Specified by:
    setAttributes in interface MBeanServerConnection
    Parameters:
    name - The object name of the MBean within which the attributes are to be set.
    attributes - A list of attributes: The identification of the attributes to be set and the values they are to be set to.
    Returns:
    The list of attributes that were set, with their new values.
    Throws:
    RuntimeOperationsException - Wraps a java.lang.IllegalArgumentException: The object name in parameter is null or attributes in parameter is null.
    InstanceNotFoundException - The MBean specified is not registered in the MBean server.
    ReflectionException - An exception occurred when trying to invoke the getAttributes method of a Dynamic MBean.
    See Also:
    MBeanServerConnection.getAttributes(javax.management.ObjectName, java.lang.String[])

method:invoke(javax.management.ObjectName,java.lang.String,java.lang.Object[],java.lang.String[]) [NONE]

  • invoke

    Object invoke​(ObjectName name,
                  String operationName,
                  Object[] params,
                  String[] signature)
           throws InstanceNotFoundException,
                  MBeanException,
                  ReflectionException
    
    Description copied from interface: MBeanServerConnection

    Invokes an operation on an MBean.

    Because of the need for a signature to differentiate possibly-overloaded operations, it is much simpler to invoke operations through an MBean proxy where possible. For example, suppose you have a Standard MBean interface like this:

     public interface FooMBean {
         public int countMatches(String[] patterns, boolean ignoreCase);
     }
     

    The countMatches operation can be invoked as follows:

     String[] myPatterns = ...;
     int count = (Integer) mbeanServerConnection.invoke(
             objectName,
             "countMatches",
             new Object[] {myPatterns, true},
             new String[] {String[].class.getName(), boolean.class.getName()});
     

    Alternatively, it can be invoked through a proxy as follows:

     String[] myPatterns = ...;
     FooMBean fooProxy = JMX.newMBeanProxy(
             mbeanServerConnection, objectName, FooMBean.class);
     int count = fooProxy.countMatches(myPatterns, true);
     
    Specified by:
    invoke in interface MBeanServerConnection
    Parameters:
    name - The object name of the MBean on which the method is to be invoked.
    operationName - The name of the operation to be invoked.
    params - An array containing the parameters to be set when the operation is invoked
    signature - An array containing the signature of the operation, an array of class names in the format returned by Class.getName(). The class objects will be loaded using the same class loader as the one used for loading the MBean on which the operation was invoked.
    Returns:
    The object returned by the operation, which represents the result of invoking the operation on the MBean specified.
    Throws:
    InstanceNotFoundException - The MBean specified is not registered in the MBean server.
    MBeanException - Wraps an exception thrown by the MBean's invoked method.
    ReflectionException - Wraps a java.lang.Exception thrown while trying to invoke the method.

method:getDefaultDomain() [NONE]

  • getDefaultDomain

    String getDefaultDomain()
    Description copied from interface: MBeanServerConnection
    Returns the default domain used for naming the MBean. The default domain name is used as the domain part in the ObjectName of MBeans if no domain is specified by the user.
    Specified by:
    getDefaultDomain in interface MBeanServerConnection
    Returns:
    the default domain.

method:getDomains() [NONE]

  • getDomains

    String[] getDomains()
    Description copied from interface: MBeanServerConnection

    Returns the list of domains in which any MBean is currently registered. A string is in the returned array if and only if there is at least one MBean registered with an ObjectName whose getDomain() is equal to that string. The order of strings within the returned array is not defined.

    Specified by:
    getDomains in interface MBeanServerConnection
    Returns:
    the list of domains.

method:addNotificationListener(javax.management.ObjectName,javax.management.NotificationListener,javax.management.NotificationFilter,java.lang.Object) [NONE]

method:addNotificationListener(javax.management.ObjectName,javax.management.ObjectName,javax.management.NotificationFilter,java.lang.Object) [NONE]

method:removeNotificationListener(javax.management.ObjectName,javax.management.ObjectName) [NONE]

method:removeNotificationListener(javax.management.ObjectName,javax.management.ObjectName,javax.management.NotificationFilter,java.lang.Object) [NONE]

method:removeNotificationListener(javax.management.ObjectName,javax.management.NotificationListener) [NONE]

method:removeNotificationListener(javax.management.ObjectName,javax.management.NotificationListener,javax.management.NotificationFilter,java.lang.Object) [NONE]

method:getMBeanInfo(javax.management.ObjectName) [NONE]

method:isInstanceOf(javax.management.ObjectName,java.lang.String) [NONE]

  • isInstanceOf

    boolean isInstanceOf​(ObjectName name,
                         String className)
                  throws InstanceNotFoundException
    
    Description copied from interface: MBeanServerConnection

    Returns true if the MBean specified is an instance of the specified class, false otherwise.

    If name does not name an MBean, this method throws InstanceNotFoundException.

    Otherwise, let
    X be the MBean named by name,
    L be the ClassLoader of X,
    N be the class name in X's MBeanInfo.

    If N equals className, the result is true.

    Otherwise, if L successfully loads className and X is an instance of this class, the result is true.

    Otherwise, if L successfully loads both N and className, and the second class is assignable from the first, the result is true.

    Otherwise, the result is false.

    Specified by:
    isInstanceOf in interface MBeanServerConnection
    Parameters:
    name - The ObjectName of the MBean.
    className - The name of the class.
    Returns:
    true if the MBean specified is an instance of the specified class according to the rules above, false otherwise.
    Throws:
    InstanceNotFoundException - The MBean specified is not registered in the MBean server.
    See Also:
    Class.isInstance(java.lang.Object)

method:instantiate(java.lang.String) [NONE]

  • instantiate

    Object instantiate​(String className)
                throws ReflectionException,
                       MBeanException
    

    Instantiates an object using the list of all class loaders registered in the MBean server's Class Loader Repository . The object's class should have a public constructor. This method returns a reference to the newly created object. The newly created object is not registered in the MBean server.

    This method is equivalent to instantiate(className, (Object[]) null, (String[]) null) .

    Parameters:
    className - The class name of the object to be instantiated.
    Returns:
    The newly instantiated object.
    Throws:
    ReflectionException - Wraps a java.lang.ClassNotFoundException or the java.lang.Exception that occurred when trying to invoke the object's constructor.
    MBeanException - The constructor of the object has thrown an exception
    RuntimeOperationsException - Wraps a java.lang.IllegalArgumentException: The className passed in parameter is null.

method:instantiate(java.lang.String,javax.management.ObjectName) [NONE]

  • instantiate

    Object instantiate​(String className,
                       ObjectName loaderName)
                throws ReflectionException,
                       MBeanException,
                       InstanceNotFoundException
    

    Instantiates an object using the class Loader specified by its ObjectName. If the loader name is null, the ClassLoader that loaded the MBean Server will be used. The object's class should have a public constructor. This method returns a reference to the newly created object. The newly created object is not registered in the MBean server.

    This method is equivalent to instantiate(className, loaderName, (Object[]) null, (String[]) null) .

    Parameters:
    className - The class name of the MBean to be instantiated.
    loaderName - The object name of the class loader to be used.
    Returns:
    The newly instantiated object.
    Throws:
    ReflectionException - Wraps a java.lang.ClassNotFoundException or the java.lang.Exception that occurred when trying to invoke the object's constructor.
    MBeanException - The constructor of the object has thrown an exception.
    InstanceNotFoundException - The specified class loader is not registered in the MBeanServer.
    RuntimeOperationsException - Wraps a java.lang.IllegalArgumentException: The className passed in parameter is null.

method:instantiate(java.lang.String,java.lang.Object[],java.lang.String[]) [NONE]

  • instantiate

    Object instantiate​(String className,
                       Object[] params,
                       String[] signature)
                throws ReflectionException,
                       MBeanException
    

    Instantiates an object using the list of all class loaders registered in the MBean server Class Loader Repository . The object's class should have a public constructor. The call returns a reference to the newly created object. The newly created object is not registered in the MBean server.

    Parameters:
    className - The class name of the object to be instantiated.
    params - An array containing the parameters of the constructor to be invoked.
    signature - An array containing the signature of the constructor to be invoked.
    Returns:
    The newly instantiated object.
    Throws:
    ReflectionException - Wraps a java.lang.ClassNotFoundException or the java.lang.Exception that occurred when trying to invoke the object's constructor.
    MBeanException - The constructor of the object has thrown an exception
    RuntimeOperationsException - Wraps a java.lang.IllegalArgumentException: The className passed in parameter is null.

method:instantiate(java.lang.String,javax.management.ObjectName,java.lang.Object[],java.lang.String[]) [NONE]

  • instantiate

    Object instantiate​(String className,
                       ObjectName loaderName,
                       Object[] params,
                       String[] signature)
                throws ReflectionException,
                       MBeanException,
                       InstanceNotFoundException
    

    Instantiates an object. The class loader to be used is identified by its object name. If the object name of the loader is null, the ClassLoader that loaded the MBean server will be used. The object's class should have a public constructor. The call returns a reference to the newly created object. The newly created object is not registered in the MBean server.

    Parameters:
    className - The class name of the object to be instantiated.
    params - An array containing the parameters of the constructor to be invoked.
    signature - An array containing the signature of the constructor to be invoked.
    loaderName - The object name of the class loader to be used.
    Returns:
    The newly instantiated object.
    Throws:
    ReflectionException - Wraps a java.lang.ClassNotFoundException or the java.lang.Exception that occurred when trying to invoke the object's constructor.
    MBeanException - The constructor of the object has thrown an exception
    InstanceNotFoundException - The specified class loader is not registered in the MBean server.
    RuntimeOperationsException - Wraps a java.lang.IllegalArgumentException: The className passed in parameter is null.

method:deserialize(javax.management.ObjectName,byte[]) [NONE]

method:deserialize(java.lang.String,byte[]) [NONE]

method:deserialize(java.lang.String,javax.management.ObjectName,byte[]) [NONE]

  • deserialize

    @Deprecated(since="1.5")
    default ObjectInputStream deserialize​(String className,
                                          ObjectName loaderName,
                                          byte[] data)
                                   throws InstanceNotFoundException,
                                          OperationsException,
                                          ReflectionException
    
    Deprecated.
    Use getClassLoader to obtain the class loader for deserialization.

    De-serializes a byte array in the context of a given MBean class loader. The class loader is the one that loaded the class with name "className". The name of the class loader to be used for loading the specified class is specified. If null, the MBean Server's class loader will be used.

    Implementation Requirements:
    This method throws UnsupportedOperationException by default.
    Parameters:
    className - The name of the class whose class loader should be used for the de-serialization.
    data - The byte array to be de-sererialized.
    loaderName - The name of the class loader to be used for loading the specified class. If null, the MBean Server's class loader will be used.
    Returns:
    The de-serialized object stream.
    Throws:
    InstanceNotFoundException - The specified class loader MBean is not found.
    OperationsException - Any of the usual Input/Output related exceptions.
    ReflectionException - The specified class could not be loaded by the specified class loader.

method:getClassLoaderFor(javax.management.ObjectName) [NONE]

  • getClassLoaderFor

    ClassLoader getClassLoaderFor​(ObjectName mbeanName)
                           throws InstanceNotFoundException
    

    Return the ClassLoader that was used for loading the class of the named MBean.

    Parameters:
    mbeanName - The ObjectName of the MBean.
    Returns:
    The ClassLoader used for that MBean. If l is the MBean's actual ClassLoader, and r is the returned value, then either: What this means is that the ClassLoader may be wrapped in another ClassLoader for security or other reasons.
    Throws:
    InstanceNotFoundException - if the named MBean is not found.

method:getClassLoader(javax.management.ObjectName) [NONE]

  • getClassLoader

    ClassLoader getClassLoader​(ObjectName loaderName)
                        throws InstanceNotFoundException
    

    Return the named ClassLoader.

    Parameters:
    loaderName - The ObjectName of the ClassLoader. May be null, in which case the MBean server's own ClassLoader is returned.
    Returns:
    The named ClassLoader. If l is the actual ClassLoader with that name, and r is the returned value, then either: What this means is that the ClassLoader may be wrapped in another ClassLoader for security or other reasons.
    Throws:
    InstanceNotFoundException - if the named ClassLoader is not found.

method:getClassLoaderRepository() [NONE]

  • getClassLoaderRepository

    ClassLoaderRepository getClassLoaderRepository()

    Return the ClassLoaderRepository for this MBeanServer.

    Returns:
    The ClassLoaderRepository for this MBeanServer.

© 2018 Oracle Corporation and/or its affiliates