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 @ManagedOperation annotation is used to indicate that a given method
41 * should be considered a JMX operation.
42 *
43 */
44 @Retention(RetentionPolicy.RUNTIME)
45 @Documented
46 @Target( { ElementType.METHOD } )
47 public @interface ManagedOperation
48 {
49 /**
50 * Description of the Managed Object
51 *
52 * @return
53 */
54 String value() default "Not Specified";
55
56 /**
57 * The impact of an operation.
58 *
59 * NOTE: Valid values are UNKNOWN, ACTION, INFO, ACTION_INFO
60 *
61 * NOTE: applies to METHOD
62 *
63 * @return String representing the impact of the operation
64 */
65 String impact() default "UNKNOWN";
66
67 /**
68 * Does the managed field exist on a proxy object?
69 *
70 *
71 * @return true if a proxy object is involved
72 */
73 boolean proxied() default false;
74 }