lib/jetty/org/eclipse/jetty/util/annotation/ManagedOperation.java

   1 //
   2 //  ========================================================================
   3 //  Copyright (c) 1995-2016 Mort Bay Consulting Pty. Ltd.
   4 //  ------------------------------------------------------------------------
   5 //  All rights reserved. This program and the accompanying materials
   6 //  are made available under the terms of the Eclipse Public License v1.0
   7 //  and Apache License v2.0 which accompanies this distribution.
   8 //
   9 //      The Eclipse Public License is available at
  10 //      http://www.eclipse.org/legal/epl-v10.html
  11 //
  12 //      The Apache License v2.0 is available at
  13 //      http://www.opensource.org/licenses/apache2.0.php
  14 //
  15 //  You may elect to redistribute this code under either of these licenses.
  16 //  ========================================================================
  17 //
  18
  19 package org.eclipse.jetty.util.annotation;
  20
  21 import java.lang.annotation.Documented;
  22 import java.lang.annotation.ElementType;
  23 import java.lang.annotation.Retention;
  24 import java.lang.annotation.RetentionPolicy;
  25 import java.lang.annotation.Target;
  26
  27 /**
  28  * The @ManagedOperation annotation is used to indicate that a given method
  29  * should be considered a JMX operation.
  30  *
  31  */
  32 @Retention(RetentionPolicy.RUNTIME)
  33 @Documented
  34 @Target( { ElementType.METHOD } )
  35 public @interface ManagedOperation
  36 {
  37     /**
  38      * Description of the Managed Object
  39      */
  40     String value() default "Not Specified";
  41
  42     /**
  43      * The impact of an operation.
  44      *
  45      * NOTE: Valid values are UNKNOWN, ACTION, INFO, ACTION_INFO
  46      *
  47      * NOTE: applies to METHOD
  48      *
  49      * @return String representing the impact of the operation
  50      */
  51     String impact() default "UNKNOWN";
  52
  53     /**
  54      * Does the managed field exist on a proxy object?
  55      *
  56      *
  57      * @return true if a proxy object is involved
  58      */
  59     boolean proxied() default false;
  60 }