jakarta.enterprise.inject.spi.ProcessManagedBean 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 jakarta.enterprise.invoke.Invoker;
import jakarta.enterprise.invoke.InvokerBuilder;

/**
 * 
 * The container fires an event of this type for each enabled managed bean, before registering the
 * {@link Bean} object.
 * 
 * 
 * If any observer method of a {@code ProcessManagedBean} event throws an exception, the exception is treated as a definition
 * error by the container.
 * 
 *
 * 
 * CDI Lite implementations are not required to provide support for Portable Extensions.
 * 
 *
 * @author David Allen
 * @param  The class of the bean
 */
public interface ProcessManagedBean extends ProcessBean {
    /**
     * Returns the {@link AnnotatedType} representing the bean class.
     *
     * @return the {@link AnnotatedType} for the bean being registered
     * @throws IllegalStateException if called outside of the observer method invocation
     */
    public AnnotatedType getAnnotatedBeanClass();

    /**
     * Returns a new {@link InvokerBuilder} for given method. The builder eventually produces an invoker
     * for the given method.
     * 
     * The {@code method} must be declared on the bean class or inherited from a supertype
     * of the bean class of the bean being registered, otherwise an exception is thrown.
     *
     * @param method method of the bean being registered, must not be {@code null}
     * @return the invoker builder, never {@code null}
     * @since 4.1
     */
    public InvokerBuilder> createInvoker(AnnotatedMethod method);
}