325N/A/*
325N/A * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
325N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
325N/A *
325N/A * This code is free software; you can redistribute it and/or modify it
325N/A * under the terms of the GNU General Public License version 2 only, as
325N/A * published by the Free Software Foundation. Oracle designates this
325N/A * particular file as subject to the "Classpath" exception as provided
325N/A * by Oracle in the LICENSE file that accompanied this code.
325N/A *
325N/A * This code is distributed in the hope that it will be useful, but WITHOUT
325N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
325N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
325N/A * version 2 for more details (a copy is included in the LICENSE file that
325N/A * accompanied this code).
325N/A *
325N/A * You should have received a copy of the GNU General Public License version
325N/A * 2 along with this work; if not, write to the Free Software Foundation,
325N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
325N/A *
325N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
325N/A * or visit www.oracle.com if you need additional information or have any
325N/A * questions.
325N/A */
325N/A
325N/A
325N/A
325N/Apackage com.sun.org.glassfish.gmbal;
325N/A
325N/Aimport java.util.Map;
325N/Aimport com.sun.org.glassfish.external.amx.AMX;
325N/A
325N/A
325N/A/** Base interface supported by all AMXMBeanInterface MBeans. All MBeans generated by
325N/A * gmbal comply with this interface, which means that the attributes and
325N/A * operations defined in this Java interface all appear in each
325N/A * MBean generated by calling ManagedObjectManager.register.
325N/A *
325N/A * @author LLoyd Chambers
325N/A * @author Ken Cavanaugh
325N/A *
325N/A */
325N/A@ManagedObject
325N/A@Description( "Base interface for any MBean that works in the AMX framework" )
325N/Apublic interface AMXMBeanInterface {
325N/A /** Get all metadata about this MBean.
325N/A * @return The descriptor, which will be a ModelMBeanInfoSupport instance.
325N/A */
325N/A public Map<String,?> getMeta();
325N/A
325N/A /** Usually the same as the ObjectName 'name' property, but can differ
325N/A if the actual name contains characters that must be escaped for an ObjectName and/or
325N/A if the MBean has a mutable name attribute.
325N/A The type property can be obtained from the ObjectName */
325N/A @ManagedAttribute( id=AMX.ATTR_NAME )
325N/A @Description( "Return the name of this MBean.")
325N/A public String getName();
325N/A
325N/A /** "go up one level": the MBean containing this one, can be null for root
325N/A * @return The container of this MBean (null if already at root).
325N/A */
325N/A @ManagedAttribute( id=AMX.ATTR_PARENT )
325N/A @Description( "The container that contains this MBean" )
325N/A public AMXMBeanInterface getParent();
325N/A
325N/A /** Containment hierarchy:
325N/A Get all AMXMBeanInterface contained by this one, in no particular order.
325N/A Valid only if isContainer().
325N/A * Note that using an array sidesteps Map/Set/OpenType issues
325N/A * @return All children of this AMXMBeanInterface MBean.
325N/A */
325N/A @ManagedAttribute( id=AMX.ATTR_CHILDREN )
325N/A @Description( "All children of this AMX MBean")
325N/A public AMXMBeanInterface[] getChildren();
325N/A}