Java example source code file (ModelMBean.java)

This example Java source code file (ModelMBean.java) is included in the alvinalexander.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" ^TM.

Learn more about this Java project at its project page.

Java - Java tags/keywords

dynamicmbean, instancenotfoundexception, invalidtargetobjecttypeexception, management, mbeanexception, modelmbean, modelmbeannotificationbroadcaster, persistentmbean, runtimeoperationsexception, string

The ModelMBean.java Java example source code

/*
 * Copyright (c) 2000, 2006, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code 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
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
/*
 * @author    IBM Corp.
 *
 * Copyright IBM Corp. 1999-2000.  All rights reserved.
 */

package javax.management.modelmbean;

import javax.management.DynamicMBean;
import javax.management.InstanceNotFoundException;
import javax.management.MBeanException;
import javax.management.PersistentMBean;
import javax.management.RuntimeOperationsException;

/**
 * This interface must be implemented by the ModelMBeans. An implementation of this interface
 * must be shipped with every JMX Agent.
 * <P>
 * Java resources wishing to be manageable instantiate the ModelMBean using the MBeanServer's
 * createMBean method.  The resource then sets the ModelMBeanInfo (with Descriptors) for the ModelMBean
 * instance. The attributes and operations exposed via the ModelMBeanInfo for the ModelMBean are accessible
 * from MBeans, connectors/adaptors like other MBeans. Through the ModelMBeanInfo Descriptors, values and methods in
 * the managed application can be defined and mapped to attributes and operations of the ModelMBean.
 * This mapping can be defined during development in an XML formatted file or dynamically and
 * programmatically at runtime.
 * <P>
 * Every ModelMBean which is instantiated in the MBeanServer becomes manageable:
 * its attributes and operations
 * become remotely accessible through the connectors/adaptors connected to that MBeanServer.
 * A Java object cannot be registered in the MBeanServer unless it is a JMX compliant MBean.
 * By instantiating a ModelMBean, resources are guaranteed that the MBean is valid.
 * <P>
 * MBeanException and RuntimeOperationsException must be thrown on every public method.  This allows
 * for wrapping exceptions from distributed communications (RMI, EJB, etc.).  These exceptions do
 * not have to be thrown by the implementation except in the scenarios described in the specification
 * and javadoc.
 *
 * @since 1.5
 */

public interface ModelMBean extends
         DynamicMBean,
         PersistentMBean,
         ModelMBeanNotificationBroadcaster
{

        /**
         * Initializes a ModelMBean object using ModelMBeanInfo passed in.
         * This method makes it possible to set a customized ModelMBeanInfo on
         * the ModelMBean as long as it is not registered with the MBeanServer.
         * <br>
         * Once the ModelMBean's ModelMBeanInfo (with Descriptors) are
         * customized and set on the ModelMBean, the  ModelMBean can be
         * registered with the MBeanServer.
         * <P>
         * If the ModelMBean is currently registered, this method throws
         * a {@link javax.management.RuntimeOperationsException} wrapping an
         * {@link IllegalStateException}
         *
         * @param inModelMBeanInfo The ModelMBeanInfo object to be used
         *        by the ModelMBean.
         *
         * @exception MBeanException Wraps a distributed communication
         *        Exception.
         * @exception RuntimeOperationsException
         * <ul>
Wraps an {@link IllegalArgumentException} if
         *         the MBeanInfo passed in parameter is null.</li>
         *     <li>Wraps an {@link IllegalStateException} if the ModelMBean
         *         is currently registered in the MBeanServer.</li>
         * </ul>
         *
         **/
        public void setModelMBeanInfo(ModelMBeanInfo inModelMBeanInfo)
            throws MBeanException, RuntimeOperationsException;

        /**
         * Sets the instance handle of the object against which to
         * execute all methods in this ModelMBean management interface
         * (MBeanInfo and Descriptors).
         *
         * @param mr Object that is the managed resource
         * @param mr_type The type of reference for the managed resource.  Can be: ObjectReference,
         *               Handle, IOR, EJBHandle, RMIReference.
         *               If the MBeanServer cannot process the mr_type passed in, an InvalidTargetTypeException
         *               will be thrown.
         *
         *
         * @exception MBeanException The initializer of the object has thrown an exception.
         * @exception RuntimeOperationsException Wraps an IllegalArgumentException:
         *       The managed resource type passed in parameter is null.
         * @exception InstanceNotFoundException The managed resource object could not be found
         * @exception InvalidTargetObjectTypeException The managed resource type cannot be processed by the
         * ModelMBean or JMX Agent.
         */
        public void setManagedResource(Object mr, String mr_type)
        throws MBeanException, RuntimeOperationsException,
                 InstanceNotFoundException, InvalidTargetObjectTypeException ;

}