001package ca.uhn.fhir.interceptor.api;
002
003/*-
004 * #%L
005 * HAPI FHIR - Core Library
006 * %%
007 * Copyright (C) 2014 - 2021 Smile CDR, Inc.
008 * %%
009 * Licensed under the Apache License, Version 2.0 (the "License");
010 * you may not use this file except in compliance with the License.
011 * You may obtain a copy of the License at
012 *
013 *      http://www.apache.org/licenses/LICENSE-2.0
014 *
015 * Unless required by applicable law or agreed to in writing, software
016 * distributed under the License is distributed on an "AS IS" BASIS,
017 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
018 * See the License for the specific language governing permissions and
019 * limitations under the License.
020 * #L%
021 */
022
023import java.lang.annotation.ElementType;
024import java.lang.annotation.Repeatable;
025import java.lang.annotation.Retention;
026import java.lang.annotation.RetentionPolicy;
027import java.lang.annotation.Target;
028
029/**
030 * This annotation should be placed on interceptor methods. The
031 * {@link Pointcut value=Pointcut} property determines which event
032 * is actually being invoked. See the Pointcut JavaDoc for information
033 * on available method parameters for a given hook.
034 *
035 * @see Interceptor
036 */
037@Target(ElementType.METHOD)
038@Retention(RetentionPolicy.RUNTIME)
039public @interface Hook {
040
041        /**
042         * Provides the specific point where this method should be invoked
043         */
044        Pointcut value();
045
046        /**
047         * The order that interceptors should be called in. Lower numbers happen before higher numbers. Default is 0
048         * and allowable values can be positive or negative or 0.
049         * <p>
050         * If no order is specified, or the order is set to <code>0</code> (the default order),
051         * the order specified at the interceptor type level will take precedence.
052         * </p>
053         */
054        int order() default Interceptor.DEFAULT_ORDER;
055}