/*
 * Copyright (c) 2007, 2018 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Distribution License v. 1.0, which is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */

package 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 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.
Note that supportsAdoption is not included here, because that attribute
is always false for gmbal.
Author:
ken/** 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
Returns:
whether or not this MBean must be the only one of its type./** 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.
Returns:
The group type./** 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.
Returns:
Array of child types/** 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.
Returns:
name of interface to use./** Return the generic AMXMBeanInterface interface to be used.
     * @return name of interface to use.
     */
    @DescriptorKey( AMX.DESC_GENERIC_INTERFACE_NAME )
    String genericInterfaceName() default "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.
Returns:
True if the MBeanInfo is invariant/** 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.
Returns:
The interface class name for a proxy./** 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.  

Note that this is NOT part of the AMXMBeanInterface-defined metadata, but gmbal
needs it here to have a place to override the type.

Gmbal determines the type name as follows:

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.
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.
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.
Otherwise, if the stripPackagePrefix method was called on the
ManagedObjectManager, the type name is the class name without any
package prefixes.
Otherwise, the type name is the class name.

Returns:
The type for this MBean./** 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 "" ;
}