1/*
2 * Copyright (c) 2007, 2012, Oracle and/or its affiliates. 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.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26
27package com.sun.org.glassfish.gmbal;
28
29import java.lang.annotation.Documented ;
30import java.lang.annotation.Inherited ;
31import java.lang.annotation.Target ;
32import java.lang.annotation.ElementType ;
33import java.lang.annotation.Retention ;
34import java.lang.annotation.RetentionPolicy ;
35
36import com.sun.org.glassfish.external.amx.AMX ;
37
38/** Annotation to contol exactly how the type value in the ObjectName
39 * is extracted from a class when registering an instance of that class.
40 * The absence of this annotation is the same as the default values.
41 * Note that this is simply an application of the general @DescriptorKey
42 * mechanism, but these particular metadata attributes control some of the
43 * behavior of the AMXMBeanInterface API.
44 * <p>Note that supportsAdoption is not included here, because that attribute
45 * is always false for gmbal.
46 *
47 * @author ken
48 */
49@Documented
50@Target(ElementType.TYPE)
51@Retention(RetentionPolicy.RUNTIME)
52@Inherited
53public @interface AMXMetadata {
54    /** True if only one MBean of this type may be created inside the same
55     * parent container
56     *
57     * @return whether or not this MBean must be the only one of its type.
58     */
59    @DescriptorKey( AMX.DESC_IS_SINGLETON )
60    boolean isSingleton() default false ;
61
62    /** String denoting classification of MBean.  Predefined values are
63     * configuration, monitoring, jsr77, utility, and other.
64     * @return The group type.
65     */
66    @DescriptorKey( AMX.DESC_GROUP )
67    String group() default "other" ;
68
69    /** Return the list of types that are legal as types of children of this
70     * type.  If unknown, must be an empty array.
71     * @return Array of child types
72     */
73    @DescriptorKey( AMX.DESC_SUB_TYPES )
74    String[] subTypes() default {} ;
75
76    /** Return the generic AMXMBeanInterface interface to be used.
77     * @return name of interface to use.
78     */
79    @DescriptorKey( AMX.DESC_GENERIC_INTERFACE_NAME )
80    String genericInterfaceName() default "com.sun.org.glassfish.admin.amx.core.AMXProxy" ;
81
82    /** True if the MBeanInfo is invariant, that is, has the same
83     * value for the lifetime of the MBean.  This may be used as a hint
84     * to clients that the MBeanInfo can be cached.
85     *
86     * @return True if the MBeanInfo is invariant
87     */
88    @DescriptorKey( AMX.DESC_STD_IMMUTABLE_INFO )
89    boolean immutableInfo() default true ;
90
91    /** Defines the name of the interface to use when generating a proxy
92     * for this class.  Defaults to a generic interface.
93     * @return The interface class name for a proxy.
94     */
95    @DescriptorKey( AMX.DESC_STD_INTERFACE_NAME )
96    String interfaceClassName() default "" ;
97
98    /** An explicit type to use for the MBean.
99     * <p>
100     * Note that this is NOT part of the AMXMBeanInterface-defined metadata, but gmbal
101     * needs it here to have a place to override the type.
102     * <p>
103     * Gmbal determines the type name as follows:
104     * <ol>
105     * <li>If the class has a final static field of type String with the
106     * name "AMX_TYPE", the value of the field is the type name.
107     * <li>Otherwise, if the class has an @AMXMetadata annotations, and the
108     * value of the type is not "", the value of the type is the type name.
109     * <li>Otherwise, if the package prefix of the class name matches one of
110     * the type prefixes added by an stripPrefix call to the ManagedObjectManager,
111     * the type name is the full class name with the matching prefix removed.
112     * <li>Otherwise, if the stripPackagePrefix method was called on the
113     * ManagedObjectManager, the type name is the class name without any
114     * package prefixes.
115     * <li>Otherwise, the type name is the class name.
116     * </ol>
117     * @return The type for this MBean.
118     */
119    @DescriptorKey( "type" )
120    String type() default "" ;
121}
122