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