001package ca.uhn.fhir.interceptor.api;
002
003/*-
004 * #%L
005 * HAPI FHIR - Core Library
006 * %%
007 * Copyright (C) 2014 - 2019 University Health Network
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.Retention;
025import java.lang.annotation.RetentionPolicy;
026import java.lang.annotation.Target;
027
028/**
029 * This annotation should be placed on
030 * {@link Interceptor}
031 * bean methods.
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 interceptor type level will take precedence.
050         * </p>
051         */
052        int order() default Interceptor.DEFAULT_ORDER;
053}