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 <code>@ManagedAttribute</code> 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 @Retention(RetentionPolicy.RUNTIME)
37 @Documented
38 @Target( { ElementType.METHOD } )
39 public @interface ManagedAttribute
40 {
41 /**
42 * Description of the Managed Attribute
43 *
44 * @return value
45 */
46 String value() default "Not Specified";
47
48 /**
49 * name to use for the attribute
50 *
51 * @return the name of the attribute
52 */
53 String name() default "";
54
55 /**
56 * Is the managed field read-only?
57 *
58 * Required only when a setter exists but should not be exposed via JMX
59 *
60 * @return true if readonly
61 */
62 boolean readonly() default false;
63
64 /**
65 * Does the managed field exist on a proxy object?
66 *
67 *
68 * @return true if a proxy object is involved
69 */
70 boolean proxied() default false;
71
72
73 /**
74 * If is a field references a setter that doesn't conform to standards for discovery
75 * it can be set here.
76 *
77 * @return the full name of the setter in question
78 */
79 String setter() default "";
80
81 }