001/*
002 * Copyright 2002-2015 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      https://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.jmx.export.annotation;
018
019import java.lang.annotation.Documented;
020import java.lang.annotation.ElementType;
021import java.lang.annotation.Retention;
022import java.lang.annotation.RetentionPolicy;
023import java.lang.annotation.Target;
024
025import org.springframework.jmx.support.MetricType;
026
027/**
028 * Method-level annotation that indicates to expose a given bean property as a
029 * JMX attribute, with added descriptor properties to indicate that it is a metric.
030 * Only valid when used on a JavaBean getter.
031 *
032 * @author Jennifer Hickey
033 * @since 3.0
034 * @see org.springframework.jmx.export.metadata.ManagedMetric
035 */
036@Target(ElementType.METHOD)
037@Retention(RetentionPolicy.RUNTIME)
038@Documented
039public @interface ManagedMetric {
040
041        String category() default "";
042
043        int currencyTimeLimit() default -1;
044
045        String description() default "";
046
047        String displayName() default "";
048
049        MetricType metricType() default MetricType.GAUGE;
050
051        int persistPeriod() default -1;
052
053        String persistPolicy() default "";
054
055        String unit() default "";
056
057}