javax.interceptor.Interceptor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jakarta.interceptor-api Show documentation
Jakarta Interceptors defines a means of interposing on business method invocations and specific events—such as lifecycle events and timeout events—that occur on instances of Jakarta EE components and other managed classes.
There is a newer version: 62
Show newest version
/*
 * Copyright (c) 1997, 2018 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package javax.interceptor;

import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

/**
 * Specifies that a class is an interceptor.
 *
 *  * @Validated @Interceptor
 * public class ValidationInterceptor { ... }
 * 
 *
 * 
 * Use of this annotation is required when declaring an interceptor using interceptor binding annotations. It is ignored
 * during the processing of classes bound using the {@link javax.interceptor.Interceptors Interceptors} annotation (or
 * when the Jakarta Enterprise Beans deployment descriptor is used to associate the interceptor with the target class).
 * 
 *
 * @see javax.interceptor.Interceptors
 *
 * @since Jakarta Interceptors 1.1
 */
@Retention(RUNTIME)
@Target(TYPE)
@Documented
public @interface Interceptor {
    /**
     * 
     * Priorities that define the order in which interceptors are invoked. These values are intended to be used with the
     * {@link javax.annotation.Priority Priority} annotation for interceptors that are defined by means of interceptor
     * binding.
     *
     * 

     * Interceptors with smaller priority values are called first. If more than one interceptor has the same priority, the
     * relative order of those interceptors is undefined.
     * 
     *
     * 
     * Interceptors defined by platform specifications that are to be executed at the beginning of the interceptor chain
     * should have priority values in the range PLATFORM_BEFORE up until
     * LIBRARY_BEFORE.
     *
     * Interceptors defined by extension libraries that are intended to be executed earlier in the interceptor chain,
     * but after any interceptors in the range up until LIBRARY_BEFORE should have priority
     * values in the range LIBRARY_BEFORE up until
     * APPLICATION.
     *
     * Interceptors defined by applications should have priority values in the range
     * APPLICATION up until LIBRARY_AFTER.
     *
     * Interceptors defined by extension libraries that are intended to be executed later in the interceptor chain
     * should have priority values in the range LIBRARY_AFTER up until
     * PLATFORM_AFTER.
     *
     * Interceptors defined by platform specifications that are intended to be executed at the end of the interceptor
     * chain should have priority values at PLATFORM_AFTER or higher.
     * 
     *
     * 
     * An interceptor that must be invoked before or after another defined interceptor can choose any appropriate value.
     * 
     *
     *
     * 
     * For example, an extension library might define an interceptor like this:
     * 
     *
     *      * @Priority(Interceptor.Priority.LIBRARY_BEFORE+10)
     * @Validated @Interceptor
     * public class ValidationInterceptor { ... }
     * 
     *
     * The {@link javax.annotation.Priority Priority} annotation is ignored when computing the invocation order of
     * interceptors bound to a target using the {@link javax.interceptor.Interceptors Interceptors} annotation.
     *
     * @see javax.annotation.Priority
     * 
     * @since Jakarta Interceptors 1.2
     */
    public static class Priority {
        private Priority() {
        } // don't allow instances

        /**
         * Start of range for early interceptors defined by platform specifications.
         */
        public static final int PLATFORM_BEFORE = 0;

        /**
         * Start of range for early interceptors defined by extension libraries.
         */
        public static final int LIBRARY_BEFORE = 1000;

        /**
         * Start of range for interceptors defined by applications.
         */
        public static final int APPLICATION = 2000;

        /**
         * Start of range for late interceptors defined by extension libraries.
         */
        public static final int LIBRARY_AFTER = 3000;

        /**
         * Start of range for late interceptors defined by platform specifications.
         */
        public static final int PLATFORM_AFTER = 4000;
    }
}