1 /*

     2  * Copyright 2007-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 javax.management;

    27 

    28 import java.lang.annotation.Documented;

    29 import java.lang.annotation.ElementType;

    30 import java.lang.annotation.Retention;

    31 import java.lang.annotation.RetentionPolicy;

    32 import java.lang.annotation.Target;

    33 

    34 /**

    35  * <p>Indicates that a method in an MBean class defines an MBean operation.

    36  * This annotation can be applied to:</p>

    37  *

    38  * <ul>

    39  * <li>A public method of a public class

    40  * that is itself annotated with an {@link MBean @MBean} or

    41  * {@link MXBean @MXBean} annotation, or inherits such an annotation from

    42  * a superclass.</li>

    43  * <li>A method of an MBean or MXBean interface.

    44  * </ul>

    45  *

    46  * <p>Every method in an MBean or MXBean interface defines an MBean

    47  * operation even without this annotation, but the annotation allows

    48  * you to specify the impact of the operation:</p>

    49  *

    50  * <pre>

    51  * public interface ConfigurationMBean {

    52  *     {@code @ManagedOperation}(impact = {@link Impact#ACTION Impact.ACTION})

    53  *     public void save();

    54  *     ...

    55  * }

    56  * </pre>

    57  */

    58 @Retention(RetentionPolicy.RUNTIME)

    59 @Target(ElementType.METHOD)

    60 @Documented

    61 public @interface ManagedOperation {

    62     /**

    63      * <p>The impact of this operation, as shown by

    64      * {@link MBeanOperationInfo#getImpact()}.

    65      */

    66     Impact impact() default Impact.UNKNOWN;

    67 }