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