javax.interceptor.Interceptors 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.CONSTRUCTOR;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

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

/**
 * Declares an ordered list of interceptors for a target class, or for a method or a constructor of a target class.
 *
 *  * @Interceptors(ValidationInterceptor.class)
 * public class Order { ... }
 * 
 *
 *  * @Interceptors({ValidationInterceptor.class, SecurityInterceptor.class})
 * public void updateOrder(Order order) { ... }
 * 
 *
 * 
 * Only business method interception or timeout method interception may be specified by a method-level
 * Interceptors declaration.
 * 
 *
 * 
 * Constructor interception may be specified by a constructor-level Interceptors declaration.
 * 
 *
 * @see javax.interceptor.ExcludeClassInterceptors
 * @see javax.interceptor.ExcludeDefaultInterceptors
 *
 * @since Jakarta Interceptors 1.0
 */
@Target({ TYPE, METHOD, CONSTRUCTOR })
@Retention(RUNTIME)
public @interface Interceptors {

    /**
     * An ordered list of interceptors.
     *
     * @return an array representing the interceptor classes
     */
    Class[] value();
}