| /* |
| * Copyright (c) 2007, 2010, 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. |
| */ |
| |
| |
| package com.sun.org.glassfish.gmbal; |
| |
| import java.lang.annotation.Documented ; |
| import java.lang.annotation.Inherited ; |
| import java.lang.annotation.Target ; |
| import java.lang.annotation.ElementType ; |
| import java.lang.annotation.Retention ; |
| import java.lang.annotation.RetentionPolicy ; |
| |
| import com.sun.org.glassfish.external.amx.AMX ; |
| |
| /** Annotation to contol exactly how the type value in the ObjectName |
| * is extracted from a class when registering an instance of that class. |
| * The absence of this annotation is the same as the default values. |
| * Note that this is simply an application of the general @DescriptorKey |
| * mechanism, but these particular metadata attributes control some of the |
| * behavior of the AMXMBeanInterface API. |
| * <p>Note that supportsAdoption is not included here, because that attribute |
| * is always false for gmbal. |
| * |
| * @author ken |
| */ |
| @Documented |
| @Target(ElementType.TYPE) |
| @Retention(RetentionPolicy.RUNTIME) |
| @Inherited |
| public @interface AMXMetadata { |
| /** True if only one MBean of this type may be created inside the same |
| * parent container |
| * |
| * @return whether or not this MBean must be the only one of its type. |
| */ |
| @DescriptorKey( AMX.DESC_IS_SINGLETON ) |
| boolean isSingleton() default false ; |
| |
| /** String denoting classification of MBean. Predefined values are |
| * configuration, monitoring, jsr77, utility, and other. |
| * @return The group type. |
| */ |
| @DescriptorKey( AMX.DESC_GROUP ) |
| String group() default "other" ; |
| |
| /** Return the list of types that are legal as types of children of this |
| * type. If unknown, must be an empty array. |
| * @return Array of child types |
| */ |
| @DescriptorKey( AMX.DESC_SUB_TYPES ) |
| String[] subTypes() default {} ; |
| |
| /** Return the generic AMXMBeanInterface interface to be used. |
| * @return name of interface to use. |
| */ |
| @DescriptorKey( AMX.DESC_GENERIC_INTERFACE_NAME ) |
| String genericInterfaceName() default "com.sun.org.glassfish.admin.amx.core.AMXProxy" ; |
| |
| /** True if the MBeanInfo is invariant, that is, has the same |
| * value for the lifetime of the MBean. This may be used as a hint |
| * to clients that the MBeanInfo can be cached. |
| * |
| * @return True if the MBeanInfo is invariant |
| */ |
| @DescriptorKey( AMX.DESC_STD_IMMUTABLE_INFO ) |
| boolean immutableInfo() default true ; |
| |
| /** Defines the name of the interface to use when generating a proxy |
| * for this class. Defaults to a generic interface. |
| * @return The interface class name for a proxy. |
| */ |
| @DescriptorKey( AMX.DESC_STD_INTERFACE_NAME ) |
| String interfaceClassName() default "" ; |
| |
| /** An explicit type to use for the MBean. |
| * <p> |
| * Note that this is NOT part of the AMXMBeanInterface-defined metadata, but gmbal |
| * needs it here to have a place to override the type. |
| * <p> |
| * Gmbal determines the type name as follows: |
| * <ol> |
| * <li>If the class has a final static field of type String with the |
| * name "AMX_TYPE", the value of the field is the type name. |
| * <li>Otherwise, if the class has an @AMXMetadata annotations, and the |
| * value of the type is not "", the value of the type is the type name. |
| * <li>Otherwise, if the package prefix of the class name matches one of |
| * the type prefixes added by an stripPrefix call to the ManagedObjectManager, |
| * the type name is the full class name with the matching prefix removed. |
| * <li>Otherwise, if the stripPackagePrefix method was called on the |
| * ManagedObjectManager, the type name is the class name without any |
| * package prefixes. |
| * <li>Otherwise, the type name is the class name. |
| * </ol> |
| * @return The type for this MBean. |
| */ |
| @DescriptorKey( "type" ) |
| String type() default "" ; |
| } |