jakarta.enterprise.inject.spi.BeforeBeanDiscovery Maven / Gradle / Ivy
Show all versions of jakarta.enterprise.cdi-api Show documentation
/*
* 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 jakarta.enterprise.context.NormalScope;
import jakarta.enterprise.context.spi.Context;
import jakarta.enterprise.inject.Stereotype;
import jakarta.enterprise.inject.spi.configurator.AnnotatedTypeConfigurator;
import jakarta.enterprise.util.Nonbinding;
import jakarta.inject.Qualifier;
import jakarta.inject.Scope;
import jakarta.interceptor.InterceptorBinding;
/**
*
* This event type is thrown by the container before the bean discovery process begins. If any observer method of the
* {@code BeforeBeanDiscovery} 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 Pete Muir
* @author David Allen
* @author Antoine Sabot-Durand
*/
public interface BeforeBeanDiscovery {
/**
*
* Declares an annotation type as a {@linkplain jakarta.inject.Qualifier} qualifier type.
*
*
*
* This is only required if you wish to make an annotation a qualifier without adding {@link Qualifier} to it.
*
*
* @param qualifier The annotation to treat as a qualifier
* @throws IllegalStateException if called outside of the observer method invocation
*/
public void addQualifier(Class qualifier);
/**
*
* Declares an annotation type as a {@linkplain jakarta.inject.Qualifier} qualifier type.
*
*
*
* This is only required if you wish to make an annotation a qualifier without adding {@link Qualifier} to it.
*
*
* @param qualifier The annotation to treat as a qualifier
* @throws IllegalStateException if called outside of the observer method invocation
* @since 1.1
*/
public void addQualifier(AnnotatedType qualifier);
/**
*
* Declares an annotation type as a {@linkplain jakarta.enterprise.context scope type}.
*
*
*
* This is only required if you wish to make an annotation a scope type without adding the {@link NormalScope} or
* {@link Scope} annotations to it. You can also use this method to override an existing normal scope definition.
*
*
* @see AfterBeanDiscovery#addContext(Context)
*
* @param scopeType The annotation type to treat as a {@linkplain jakarta.enterprise.context scope type}
* @param normal Indicates if the scope is normal
* @param passivating Indicates if the scope is {@linkplain PassivationCapable passivation
* capable}
* @throws IllegalStateException if called outside of the observer method invocation
*/
public void addScope(Class scopeType, boolean normal, boolean passivating);
/**
*
* Declares an annotation type as a {@linkplain Stereotype stereotype}, and specifies its
* meta-annotations.
*
*
*
* This is only required if you wish to make an annotation a stereotype without adding {@link Stereotype} to it. You can
* also use this method to override an existing stereotype definition.
*
*
* @param stereotype The annotation type to treat as a {@linkplain Stereotype stereotype}
* @param stereotypeDef An optional list of annotations defining the {@linkplain Stereotype
* stereotype}
* @throws IllegalStateException if called outside of the observer method invocation
*/
public void addStereotype(Class stereotype, Annotation... stereotypeDef);
/**
*
* Declares an annotation type as an {@linkplain Interceptor interceptor} binding type.
*
*
*
* This is only required if you wish to make an annotation an interceptor binding type without adding
* {@link InterceptorBinding} to it.
*
*
* @param bindingType The annotation type to treat as an interceptor binding type
* @throws IllegalStateException if called outside of the observer method invocation
*/
public void addInterceptorBinding(AnnotatedType bindingType);
/**
*
* Declares an annotation type as an {@linkplain Interceptor interceptor} binding type, and specifies its meta-annotations.
*
*
*
* This is only required if you wish to make an annotation an interceptor binding type without adding
* {@link InterceptorBinding} to it.
*
*
* @param bindingType The annotation type to treat as an interceptor binding type
* @param bindingTypeDef An optional list of annotations defining the {@linkplain Interceptor interceptor}
* @throws IllegalStateException if called outside of the observer method invocation
* @since 1.1
*/
public void addInterceptorBinding(Class bindingType, Annotation... bindingTypeDef);
/**
*
* Adds a given {@link AnnotatedType} to the set of types which will be scanned during bean discovery.
*
*
*
* Thanks to the id parameter, this method allows multiple annotated types, based on the same underlying type, to be
* defined. {@link AnnotatedType}s discovered by the container use the fully qualified class name of
* {@link AnnotatedType#getJavaClass()} to identify the type.
*
*
*
* {@link AfterBeanDiscovery#getAnnotatedType(Class, String)} and {@link AfterBeanDiscovery#getAnnotatedTypes(Class)} allows
* annotated types to be obtained by identifier.
*
*
* @param type The {@link AnnotatedType} to add for later scanning
* @param id the identifier used to distinguish this AnnotatedType from an other one based on the same underlying type
* @throws IllegalStateException if called outside of the observer method invocation
* @since 1.1
*/
public void addAnnotatedType(AnnotatedType type, String id);
/**
*
* Obtains a new {@link AnnotatedTypeConfigurator} to configure a new {@link AnnotatedType} and
* add it to the set of types which will be scanned during bean discovery at the end of the observer invocation
*
*
*
* Thanks to the id parameter, this method allows multiple annotated types, based on the same underlying type, to be defined
* with a builder.
* {@link AnnotatedType}s discovered by the container use the fully qualified class name of
* {@link AnnotatedType#getJavaClass()} to identify the type.
*
*
*
* {@link AfterBeanDiscovery#getAnnotatedType(Class, String)} and {@link AfterBeanDiscovery#getAnnotatedTypes(Class)} allows
* annotated types to be obtained by identifier.
*
*
* Each call returns a new AnnotatedTypeConfigurator
*
*
* @param class type
* @param type class used to initialized the type and annotations on the {@link AnnotatedTypeConfigurator}
* @param id the identifier used to distinguish this AnnotatedType from an other one based on the same underlying type
* @return a non reusable {@link AnnotatedTypeConfigurator} to configure the new AnnotatedType
* @throws IllegalStateException if called outside of the observer method invocation
* @since 2.0
*/
public AnnotatedTypeConfigurator addAnnotatedType(Class type, String id);
/**
*
*
* Obtains a new {@link AnnotatedTypeConfigurator} to configure a new {@link AnnotatedType}
* and declares it as a {@linkplain jakarta.inject.Qualifier} qualifier type.
*
*
*
* This is only required if you wish to make an annotation a qualifier without adding {@link Qualifier} to it and need to
* easily add other annotations (like {@link Nonbinding} on its members.
*
*
* @param qualifier type
* @param qualifier The annotation class used to initialized the configurator
* @throws IllegalStateException if called outside of the observer method invocation
* @return a non reusable {@link AnnotatedTypeConfigurator} to configure the qualifier
* @since 2.0
*/
AnnotatedTypeConfigurator configureQualifier(Class qualifier);
/**
*
*
* Obtains a new {@link AnnotatedTypeConfigurator} to configure a new {@link AnnotatedType}
* and declares it as an {@linkplain Interceptor interceptor} binding type.
*
*
*
* This is only required if you wish to make an annotation an interceptor binding type without adding
* {@link InterceptorBinding} to it and need to easily add other annotations
* (like {@link Nonbinding} on its members.
*
*
* @param binding class type
* @param bindingType The annotation class used to initialized the configurator
* @throws IllegalStateException if called outside of the observer method invocation
* @return a non reusable {@link AnnotatedTypeConfigurator} to configure the interceptor binding
* @since 2.0
*/
AnnotatedTypeConfigurator configureInterceptorBinding(Class bindingType);
}