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.Inherited;
025import java.lang.annotation.Retention;
026import java.lang.annotation.RetentionPolicy;
027import java.lang.annotation.Target;
028
029/**
030 * This annotation declares a bean as a subscription interceptor. This interceptor
031 * is not mandatory for interceptor classes, but is added as a marker by convention.
032 */
033@Retention(RetentionPolicy.RUNTIME)
034@Target(ElementType.TYPE)
035@Inherited
036public @interface Interceptor {
037
038        /**
039         * @see #order() 
040         */
041        int DEFAULT_ORDER = 0;
042
043        /**
044         * The order that interceptors should be called in. Lower numbers happen before higher numbers. Default is 0
045         * and allowable values can be positive or negative or 0.
046         */
047        int order() default DEFAULT_ORDER;
048}