1 //
2 // ========================================================================
3 // Copyright (c) 1995-2013 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 //Copyright 2011-2012 Mort Bay Consulting Pty. Ltd.
22 //------------------------------------------------------------------------
23 //All rights reserved. This program and the accompanying materials
24 //are made available under the terms of the Eclipse Public License v1.0
25 //and Apache License v2.0 which accompanies this distribution.
26 //The Eclipse Public License is available at
27 //http://www.eclipse.org/legal/epl-v10.html
28 //The Apache License v2.0 is available at
29 //http://www.opensource.org/licenses/apache2.0.php
30 //You may elect to redistribute this code under either of these licenses.
31 //========================================================================
32
33 import java.lang.annotation.Documented;
34 import java.lang.annotation.ElementType;
35 import java.lang.annotation.Retention;
36 import java.lang.annotation.RetentionPolicy;
37 import java.lang.annotation.Target;
38
39 /**
40 * The @ManagedAttribute annotation is used to indicate that a given method
41 * exposes a JMX attribute. This annotation is placed always on the reader
42 * method of a given attribute. Unless it is marked as read-only in the
43 * configuration of the annotation a corresponding setter is looked for
44 * following normal naming conventions. For example if this annotation is
45 * on a method called getFoo() then a method called setFoo() would be looked
46 * for and if found wired automatically into the jmx attribute.
47 *
48 */
49 @Retention(RetentionPolicy.RUNTIME)
50 @Documented
51 @Target( { ElementType.METHOD } )
52 public @interface ManagedAttribute
53 {
54 /**
55 * Description of the Managed Attribute
56 *
57 * @returngit checkout
58 */
59 String value() default "Not Specified";
60
61 /**
62 * name to use for the attribute
63 *
64 * @return the name of the attribute
65 */
66 String name() default "";
67
68 /**
69 * Is the managed field read-only?
70 *
71 * Required only when a setter exists but should not be exposed via JMX
72 *
73 * @return true if readonly
74 */
75 boolean readonly() default false;
76
77 /**
78 * Does the managed field exist on a proxy object?
79 *
80 *
81 * @return true if a proxy object is involved
82 */
83 boolean proxied() default false;
84
85
86 /**
87 * If is a field references a setter that doesn't conform to standards for discovery
88 * it can be set here.
89 *
90 * @return the full name of the setter in question
91 */
92 String setter() default "";
93
94 }