jakarta.enterprise.inject.spi.Interceptor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jakarta.enterprise.cdi-api Show documentation
APIs for CDI (Contexts and Dependency Injection for Java)
The newest version!
/*
 * Copyright 2010, Red Hat, Inc., and individual contributors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * http://www.apache.org/licenses/LICENSE-2.0
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package jakarta.enterprise.inject.spi;

import java.lang.annotation.Annotation;
import java.util.Set;

import jakarta.interceptor.InvocationContext;

/**
 * 
 * Represents an enabled {@linkplain jakarta.interceptor.Interceptor interceptor}.
 * 
 * 
 * Since CDI 2.0, an implementation of this interface may implement {@link Prioritized} in order to enable the interceptor with
 * given priority value for entire application.
 * 
 *
 * @author Gavin King
 * @author Pete Muir
 * @author David Allen
 *
 * @param  the interceptor bean class
 */
public interface Interceptor extends Bean {

    /**
     * 
     * Obtains the {@linkplain jakarta.interceptor.InterceptorBinding interceptor bindings} of the interceptor.
     * 
     *
     * @return the set of {@linkplain jakarta.interceptor.InterceptorBinding interceptor bindings}
     */
    public Set getInterceptorBindings();

    /**
     * 
     * Determines if the interceptor intercepts the specified {@linkplain InterceptionType kind of lifecycle callback or method
     * invocation}.
     * 
     *
     * @param type the {@linkplain InterceptionType kind of interception}
     * @return returns true if the interceptor intercepts callbacks or business methods of the given type, and
     *         false otherwise.
     */
    public boolean intercepts(InterceptionType type);

    /**
     * 
     * Invokes the specified {@linkplain InterceptionType kind of lifecycle callback or method invocation interception} upon the
     * given interceptor instance.
     * 
     *
     * @param type the {@linkplain InterceptionType kind of interception}
     * @param instance the interceptor instance to invoke
     * @param ctx the context for the invocation
     * @return the invocation return value
     * @throws Exception thrown by the target method and/or the following interceptors in the chain
     */
    public Object intercept(InterceptionType type, T instance, InvocationContext ctx) throws Exception;

}