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

   1 //
   2 //  ========================================================================
   3 //  Copyright (c) 1995-2014 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 @ManagedAttribute annotation is used to indicate that a given method
  29  * exposes a JMX attribute. This annotation is placed always on the reader
  30  * method of a given attribute. Unless it is marked as read-only in the
  31  * configuration of the annotation a corresponding setter is looked for
  32  * following normal naming conventions. For example if this annotation is
  33  * on a method called getFoo() then a method called setFoo() would be looked
  34  * for and if found wired automatically into the jmx attribute.
  35  *
  36  */
  37 @Retention(RetentionPolicy.RUNTIME)
  38 @Documented
  39 @Target( { ElementType.METHOD } )
  40 public @interface ManagedAttribute
  41 {
  42     /**
  43      * Description of the Managed Attribute
  44      *
  45      * @returngit checkout
  46      */
  47     String value() default "Not Specified";
  48
  49     /**
  50      * name to use for the attribute
  51      *
  52      * @return the name of the attribute
  53      */
  54     String name() default "";
  55
  56     /**
  57      * Is the managed field read-only?
  58      *
  59      * Required only when a setter exists but should not be exposed via JMX
  60      *
  61      * @return true if readonly
  62      */
  63     boolean readonly() default false;
  64
  65     /**
  66      * Does the managed field exist on a proxy object?
  67      *
  68      *
  69      * @return true if a proxy object is involved
  70      */
  71     boolean proxied() default false;
  72
  73
  74     /**
  75      * If is a field references a setter that doesn't conform to standards for discovery
  76      * it can be set here.
  77      *
  78      * @return the full name of the setter in question
  79      */
  80     String setter() default "";
  81
  82 }