001    /**
002     *   GRANITE DATA SERVICES
003     *   Copyright (C) 2006-2013 GRANITE DATA SERVICES S.A.S.
004     *
005     *   This file is part of the Granite Data Services Platform.
006     *
007     *   Granite Data Services is free software; you can redistribute it and/or
008     *   modify it under the terms of the GNU Lesser General Public
009     *   License as published by the Free Software Foundation; either
010     *   version 2.1 of the License, or (at your option) any later version.
011     *
012     *   Granite Data Services is distributed in the hope that it will be useful,
013     *   but WITHOUT ANY WARRANTY; without even the implied warranty of
014     *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
015     *   General Public License for more details.
016     *
017     *   You should have received a copy of the GNU Lesser General Public
018     *   License along with this library; if not, write to the Free Software
019     *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
020     *   USA, or see <http://www.gnu.org/licenses/>.
021     */
022    package org.granite.jmx;
023    
024    import java.lang.annotation.Documented;
025    import java.lang.annotation.ElementType;
026    import java.lang.annotation.Inherited;
027    import java.lang.annotation.Retention;
028    import java.lang.annotation.RetentionPolicy;
029    import java.lang.annotation.Target;
030    
031    @Documented
032    @Inherited
033    @Retention(value=RetentionPolicy.RUNTIME)
034    @Target(ElementType.METHOD)
035    /**
036     * The MBeanOperation annotation may be placed on any method that
037     * will act as an OpenMBeanOperation.
038     * 
039     * @author Franck WOLFF
040     */
041    public @interface MBeanOperation {
042    
043            /**
044             * The description that will be shown in a JMX console for this MBean operation.
045             * 
046             * @return the description that will be shown in a JMX console for
047             *              this MBean operation.
048             */
049            String description();
050            
051            /**
052             * The impact of this MBean operation.
053             * 
054             * @return the impact of this MBean operation.
055             */
056            Impact impact() default Impact.UNKNOWN;
057            
058            /**
059             * Operation impact. See {@link javax.management.MBeanOperationInfo}.
060             * 
061             * @author Franck WOLFF
062             */
063            public static enum Impact {
064                    ACTION,
065                    ACTION_INFO,
066                    INFO,
067                    UNKNOWN
068            }
069    }