001/*
002 * ============================================================================
003 * Copyright © 2002-2022 by Thomas Thrien.
004 * All Rights Reserved.
005 * ============================================================================
006 * Licensed to the public under the agreements of the GNU Lesser General Public
007 * License, version 3.0 (the "License"). You may obtain a copy of the License at
008 *
009 *      http://www.gnu.org/licenses/lgpl.html
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
013 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
014 * License for the specific language governing permissions and limitations
015 * under the License.
016 */
017
018package org.tquadrat.foundation.mgmt;
019
020import static org.apiguardian.api.API.Status.STABLE;
021
022import javax.management.MBeanOperationInfo;
023import java.lang.annotation.Documented;
024import java.lang.annotation.ElementType;
025import java.lang.annotation.Inherited;
026import java.lang.annotation.Retention;
027import java.lang.annotation.RetentionPolicy;
028import java.lang.annotation.Target;
029
030import org.apiguardian.api.API;
031import org.tquadrat.foundation.annotation.ClassVersion;
032
033/**
034 *  This annotation will be used to mark a method as an action (operation) for
035 *  an MBean implementation.
036 *
037 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
038 *  @version $Id: MBeanAction.java 995 2022-01-23 01:09:35Z tquadrat $
039 *  @since 0.0.1
040 */
041@ClassVersion( sourceVersion = "$Id: MBeanAction.java 995 2022-01-23 01:09:35Z tquadrat $" )
042@API( status = STABLE, since = "0.0.1" )
043@Documented
044@Retention( RetentionPolicy.RUNTIME )
045@Target( ElementType.METHOD )
046@Inherited
047public @interface MBeanAction
048{
049        /*------------*\
050    ====** Attributes **=======================================================
051        \*------------*/
052    /**
053     *  Returns the action's name.
054     *
055     *  @return The name of the action.
056     */
057    String action();
058
059    /**
060     *  Returns the description for the action.
061     *
062     *  @return The description.
063     */
064    String description() default "";
065
066    /**
067     *  <p>{@summary The impact of the action.} Valid values are</p>
068     *  <ul>
069     *      <li>{@link javax.management.MBeanOperationInfo#ACTION ACTION}</li>
070     *      <li>{@link javax.management.MBeanOperationInfo#ACTION_INFO ACTION_INFO}</li>
071     *      <li>{@link javax.management.MBeanOperationInfo#INFO INFO}</li>
072     *      <li>{@link javax.management.MBeanOperationInfo#UNKNOWN UNKNOWN}</li>
073     *  </ul>
074     *
075     *  @return The impact code; the default is {@code UNKNOWN}.
076     *
077     *  @see javax.management.MBeanOperationInfo
078     */
079    int impact() default MBeanOperationInfo.UNKNOWN;
080}
081//  @interface MBeanAction
082
083/*
084 *  End of File
085 */