net.bull.javamelody.Monitored Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of javamelody-core Show documentation

Monitoring of JavaEE applications

There is a newer version: 2.3.0

/*
 * Copyright 2008-2019 by Emeric Vernat
 *
 *     This file is part of Java Melody.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package net.bull.javamelody;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import javax.interceptor.InterceptorBinding;

/**
 * Annotation to mark classes and/or methods that should be monitored by {@link MonitoringCdiInterceptor}.
 * 
 * A method is monitored when it is annotated, or when it is in a class that is annotated.
 * 

 * The monitor name consists of 2 parts, concatenated with a dot ".":
 * -1- the class name
 * -2- the method name
 * 

 * If the name attribute is specified on a class it will override the class name part.
 * Default: the simple class name.
 * 
 * If the name attribute is specified on a method it will override the method name part.
 * Default: the name of the method.
 *
 * @author Emeric Vernat
 */
@InterceptorBinding
@Target({ ElementType.TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
public @interface Monitored {
	/**
	 * @see Monitored
	 * @return String
	 */
	String name() default "";
}