javax.interceptor.InterceptorBinding Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2018 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://oss.oracle.com/licenses/CDDL+GPL-1.1
* or LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.interceptor;
import static java.lang.annotation.ElementType.ANNOTATION_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 an annotation type is an interceptor binding type.
*
*
* @Inherited
* @InterceptorBinding
* @Target({TYPE, METHOD, CONSTRUCTOR})
* @Retention(RUNTIME)
* public @interface Valid {}
*
*
* Interceptor bindings
* are intermediate annotations that may be used to associate
* interceptors with target beans.
*
* The interceptor bindings of an interceptor are specified by annotating
* the interceptor class with the binding types and the
* {@link javax.interceptor.Interceptor Interceptor} annotation.
*
*
* @Valid @Interceptor
* public class ValidationInterceptor { ... }
*
*
* An interceptor may specify multiple interceptor bindings.
*
* An interceptor binding of a bean
* may be declared by annotating the bean class, a method of the bean class,
* or a constructor of the bean class with the interceptor binding type.
*
*
* @Valid
* public class Order { ... }
*
*
*
* @Valid @Secure
* public void updateOrder(Order order) { ... }
*
*
*
* @Valid
* public Order(...) { ... }
*
*
* A bean class or method of a bean class may declare multiple interceptor
* bindings.
*
* An interceptor binding type may declare other interceptor bindings.
*
*
* @Inherited
* @InterceptorBinding
* @Target({TYPE, METHOD})
* @Retention(RUNTIME)
* @Valid
* public @interface Secure {}
*
*
* Interceptor bindings are transitive—an interceptor binding declared
* by an interceptor binding type is inherited by all beans and other interceptor
* binding types that declare that interceptor binding type.
*
* @see javax.interceptor.Interceptor
*
* @since Interceptors 1.1
*/
@Target(ANNOTATION_TYPE)
@Retention(RUNTIME)
@Documented
public @interface InterceptorBinding {}