1 /*
   2  * Copyright 2008 Sun Microsystems, Inc.  All Rights Reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Sun designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Sun in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  22  * CA 95054 USA or visit www.sun.com if you need additional information or
  23  * have any questions.
  24  */
  25 
  26 package java.lang.management;
  27 
  28 import javax.management.ObjectName;
  29 
  30 /**
  31  * A platform managed object is a {@linkplain javax.management.MXBean JMX MXBean}
  32  * for monitoring and managing a component in the Java platform.
  33  * Each platform managed object has a unique
  34  * <a href="ManagementFactory.html#MXBean">object name</a>
  35  * for the {@linkplain ManagementFactory.getPlatformMBeanServer
  36  * platform MBeanServer} access.
  37  * All platform MXBeans will implement this interface.
  38  *
  39  * <p>
  40  * Note:
  41  * The platform MXBean interfaces (i.e. all subinterfaces
  42  * of {@code PlatformManagedObject}) are implemented
  43  * by the Java platform only.  New methods may be added in these interfaces
  44  * in future Java SE releases.
  45  * In addition, this {@code PlatformManagedObject} interface is only
  46  * intended for the management interfaces for the platform to extend but
  47  * not for applications.
  48  *
  49  * @see <a href="ManagementFactory.html#MXBean">Platform MXBeans</a>
  50  * @since 1.7
  51  */
  52 public interface PlatformManagedObject {
  53     /**
  54      * Returns an {@link ObjectName ObjectName} instance representing
  55      * the object name of this platform managed object.
  56      *
  57      * @return an {@link ObjectName ObjectName} instance representing
  58      * the object name of this platform managed object.
  59      */
  60     public ObjectName getObjectName();
  61 }