001    /*
002      GRANITE DATA SERVICES
003      Copyright (C) 2011 GRANITE DATA SERVICES S.A.S.
004    
005      This file is part of Granite Data Services.
006    
007      Granite Data Services is free software; you can redistribute it and/or modify
008      it under the terms of the GNU Library General Public License as published by
009      the Free Software Foundation; either version 2 of the License, or (at your
010      option) any later version.
011    
012      Granite Data Services is distributed in the hope that it will be useful, but
013      WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
014      FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public License
015      for more details.
016    
017      You should have received a copy of the GNU Library General Public License
018      along with this library; if not, see <http://www.gnu.org/licenses/>.
019    */
020    
021    package org.granite.jmx;
022    
023    import java.lang.annotation.Documented;
024    import java.lang.annotation.ElementType;
025    import java.lang.annotation.Inherited;
026    import java.lang.annotation.Retention;
027    import java.lang.annotation.RetentionPolicy;
028    import java.lang.annotation.Target;
029    
030    @Documented
031    @Inherited
032    @Retention(value=RetentionPolicy.RUNTIME)
033    @Target(ElementType.TYPE)
034    /**
035     * The MBean annotation may be placed on any class (or interface) that
036     * will act as an OpenMBean.
037     * 
038     * @author Franck WOLFF
039     */
040    public @interface MBean {
041    
042            /**
043             * The description that will be shown in a JMX console for this MBean.
044             * 
045             * @return the description that will be shown in a JMX console for
046             *              this MBean.
047             */
048            String description();
049    }