325N/A/*
325N/A * Copyright (c) 2009, 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/Apackage com.sun.org.glassfish.external.amx;
325N/A
325N/A/**
325N/A Constants reflecting the AMX specification.
325N/A See https://glassfish.dev.java.net/nonav/v3/admin/planning/V3Changes/V3_AMX_SPI.html
325N/A */
325N/Apublic final class AMX
325N/A{
325N/A private AMX()
325N/A {
325N/A // do not instantiate
325N/A }
325N/A
325N/A /** Attribute yielding the ObjectName of the parent MBean */
325N/A public static final String ATTR_PARENT = "Parent";
325N/A
325N/A /** Attribute yielding the children as an ObjectName[] */
325N/A public static final String ATTR_CHILDREN = "Children";
325N/A
325N/A /** Attribute yielding the name of the MBean,
325N/A possibly differing from the name as found in the ObjectName via the
325N/A property {@link #NAME_KEY} */
325N/A public static final String ATTR_NAME = "Name";
325N/A
325N/A /** ObjectName property for the type */
325N/A public static final String TYPE_KEY = "type";
325N/A
325N/A /** ObjectName property for the name */
325N/A public static final String NAME_KEY = "name";
325N/A
325N/A /** Implied name for singletons when the name property is not present */
325N/A public static final String NO_NAME = "";
325N/A
325N/A /**
325N/A The ObjectName property key denoting the path of the parent MBean.
325N/A Serves to disambiguitate the ObjectName from others
325N/A that might have the same type and/or name elsewhere in the hierarchy.
325N/A */
325N/A public static final String PARENT_PATH_KEY = "pp";
325N/A
325N/A /** Prefix for AMX descriptor fields */
325N/A public static final String DESC_PREFIX = "amx.";
325N/A
325N/A /** Prefix for AMX notification types */
325N/A public static final String NOTIFICATION_PREFIX = DESC_PREFIX;
325N/A
325N/A /**
325N/A Descriptor value defined by JMX standard: whether the MBeanInfo is *invariant* (immutable is a misnomer).
325N/A */
325N/A public static final String DESC_STD_IMMUTABLE_INFO = "immutableInfo";
325N/A
325N/A /**
325N/A Descriptor value defined by JMX standard, the classname of the interface for the MBean.
325N/A Mainly advisory, since client code might not have access to the class.
325N/A */
325N/A public static final String DESC_STD_INTERFACE_NAME = "interfaceName";
325N/A
325N/A /**
325N/A Descriptor value: The generic AMX interface to be used if the class found in {@link #DESC_STD_INTERFACE_NAME}
325N/A cannot be loaded. The class specified here must reside in the amx-core
325N/A module eg com.sun.org.glassfish.admin.amx.core eg AMXProxy or AMXConfigProxy.
325N/A */
325N/A public static final String DESC_GENERIC_INTERFACE_NAME = DESC_PREFIX + "genericInterfaceName";
325N/A
325N/A /**
325N/A Descriptor value: whether the MBean is a singleton, in spite of having a name property in its ObjectName.
325N/A This is mainly for compatibility; named singletons are strongly discouraged.
325N/A */
325N/A public static final String DESC_IS_SINGLETON = DESC_PREFIX + "isSingleton";
325N/A
325N/A /**
325N/A Descriptor value: whether the MBean is a global singleton eg whether in the AMX domain
325N/A it can be looked up by its type and is the only MBean of that type.
325N/A */
325N/A public static final String DESC_IS_GLOBAL_SINGLETON = DESC_PREFIX + "isGlobalSingleton";
325N/A
325N/A /**
325N/A Descriptor value: Arbitrary string denoting the general classification of MBean.
325N/A Predefined values include "configuration", "monitoring", "jsr77", "utility", "other".
325N/A */
325N/A public static final String DESC_GROUP = DESC_PREFIX + "group";
325N/A
325N/A /**
325N/A Descriptor value: whether new children may be added by code other than the implementation responsible for the MBean;
325N/A this allows extension points within the hierarchy.
325N/A Adding a new child means registering an MBean with an ObjectName that implies parentage via the ancestry type=name pairs.
325N/A */
325N/A public static final String DESC_SUPPORTS_ADOPTION = DESC_PREFIX + "supportsAdoption";
325N/A
325N/A /**
325N/A Descriptor value: denotes the possible types of MBeans that children might be. If present, SHOULD include all possible and pre-known types.
325N/A An empty array indicates that child MBeans might exist, but their types cannot be predicted.
325N/A */
325N/A public static final String DESC_SUB_TYPES = DESC_PREFIX + "subTypes";
325N/A
325N/A /**
325N/A Group value indicating that the AMX is a configuration MBean.
325N/A */
325N/A public static final String GROUP_CONFIGURATION = "configuration";
325N/A /**
325N/A Group value indicating that the AMX represents a monitoring MBean.
325N/A */
325N/A public static final String GROUP_MONITORING = "monitoring";
325N/A /**
325N/A Group value indicating that the AMX is a utility MBean.
325N/A */
325N/A public static final String GROUP_UTILITY = "utility";
325N/A /**
325N/A Group value indicating that the AMX is a JSR 77 MBean
325N/A (J2EE Management) .
325N/A */
325N/A public static final String GROUP_JSR77 = "jsr77";
325N/A /**
325N/A Group value indicating that the AMX is not one
325N/A of the other types.
325N/A */
325N/A public static final String GROUP_OTHER = "other";
325N/A}