Package io.quarkus.arc.deployment

Class ArcProcessor

java.lang.Object

io.quarkus.arc.deployment.ArcProcessor

public class ArcProcessor
extends Object

This class contains build steps that trigger various phases of the bean processing.

Other build steps can either register "configuring" build items, such as AdditionalBeanBuildItem or inject build items representing particular phases:

1. ContextRegistrationPhaseBuildItem
2. BeanRegistrationPhaseBuildItem
3. ObserverRegistrationPhaseBuildItem
4. ValidationPhaseBuildItem

These build items are especially useful if an extension needs to produce other build items within the given phase.

See Also:

• BeanProcessor

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	ArcProcessor.ExistingClasses	This tracks beans etc from the platform that have already been generated.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final org.jboss.jandex.DotName	ADDITIONAL_BEAN
(package private) static final org.jboss.jandex.DotName	ASYNC_OBSERVER_EXCEPTION_HANDLER

Constructor Summary

Constructors

Constructor	Description
ArcProcessor()

Method Summary

Modifier and Type	Method	Description
(package private) BuildCompatibleExtensionsBuildItem	buildCompatibleExtensions()
(package private) Predicate<org.jboss.jandex.ClassInfo>	createQuarkusComponentTestExcludePredicate(org.jboss.jandex.IndexView index)
(package private) CustomScopeAnnotationsBuildItem	exposeCustomScopeNames(List<CustomScopeBuildItem> customScopes)
(package private) FeatureBuildItem	feature()
void	generateResources(ArcConfig config, ValidationPhaseBuildItem validationPhase, List<ValidationPhaseBuildItem.ValidationErrorBuildItem> validationErrors, BuildProducer<ReflectiveClassBuildItem> reflectiveClasses, BuildProducer<ReflectiveMethodBuildItem> reflectiveMethods, BuildProducer<ReflectiveFieldBuildItem> reflectiveFields, BuildProducer<GeneratedClassBuildItem> generatedClass, LiveReloadBuildItem liveReloadBuildItem, BuildProducer<GeneratedResourceBuildItem> generatedResource, BuildProducer<BytecodeTransformerBuildItem> bytecodeTransformer, List<ReflectiveBeanClassBuildItem> reflectiveBeanClasses, ExecutorService buildExecutor)
ContextRegistrationPhaseBuildItem	initialize(ArcConfig arcConfig, BeanArchiveIndexBuildItem beanArchiveIndex, CombinedIndexBuildItem combinedIndex, ApplicationIndexBuildItem applicationIndex, BuildCompatibleExtensionsBuildItem buildCompatibleExtensions, List<ExcludedTypeBuildItem> excludedTypes, List<AnnotationsTransformerBuildItem> annotationTransformers, List<InjectionPointTransformerBuildItem> injectionPointTransformers, List<ObserverTransformerBuildItem> observerTransformers, List<InterceptorBindingRegistrarBuildItem> interceptorBindingRegistrars, List<QualifierRegistrarBuildItem> qualifierRegistrars, List<StereotypeRegistrarBuildItem> stereotypeRegistrars, List<ApplicationClassPredicateBuildItem> applicationClassPredicates, List<AdditionalBeanBuildItem> additionalBeans, List<ResourceAnnotationBuildItem> resourceAnnotations, List<BeanDefiningAnnotationBuildItem> additionalBeanDefiningAnnotations, List<SuppressConditionGeneratorBuildItem> suppressConditionGenerators, Optional<TestClassPredicateBuildItem> testClassPredicate, Capabilities capabilities, CustomScopeAnnotationsBuildItem customScopes, LaunchModeBuildItem launchModeBuildItem, BuildProducer<CompletedApplicationClassPredicateBuildItem> applicationClassPredicateProducer)
ArcContainerBuildItem	initializeContainer(ArcConfig config, ArcRecorder recorder, ShutdownContextBuildItem shutdown, Optional<CurrentContextFactoryBuildItem> currentContextFactory)
(package private) void	initTestApplicationClassPredicateBean(ArcRecorder recorder, BeanContainerBuildItem beanContainer, BeanDiscoveryFinishedBuildItem beanDiscoveryFinished, CompletedApplicationClassPredicateBuildItem predicate)
(package private) AdditionalBeanBuildItem	launchMode()
(package private) AdditionalBeanBuildItem	loggerProducer()
(package private) List<AdditionalApplicationArchiveMarkerBuildItem>	marker()
PreBeanContainerBuildItem	notifyBeanContainerListeners(ArcContainerBuildItem container, List<BeanContainerListenerBuildItem> beanContainerListenerBuildItems, ArcRecorder recorder)
(package private) AdditionalBeanBuildItem	quarkusApplication(CombinedIndexBuildItem combinedIndex)
(package private) BeanDefiningAnnotationBuildItem	quarkusMain()
BeanRegistrationPhaseBuildItem	registerBeans(ContextRegistrationPhaseBuildItem contextRegistrationPhase, List<ContextRegistrationPhaseBuildItem.ContextConfiguratorBuildItem> contextConfigurationRegistry, BuildProducer<InterceptorResolverBuildItem> interceptorResolver, BuildProducer<BeanDiscoveryFinishedBuildItem> beanDiscoveryFinished, BuildProducer<TransformedAnnotationsBuildItem> transformedAnnotations)
(package private) void	registerContextPropagation(ArcConfig config, BuildProducer<ThreadContextProviderBuildItem> threadContextProvider)
ObserverRegistrationPhaseBuildItem	registerSyntheticObservers(BeanRegistrationPhaseBuildItem beanRegistrationPhase, List<BeanRegistrationPhaseBuildItem.BeanConfiguratorBuildItem> beanConfigurators, BuildProducer<ReflectiveMethodBuildItem> reflectiveMethods, BuildProducer<ReflectiveFieldBuildItem> reflectiveFields, BuildProducer<UnremovableBeanBuildItem> unremovableBeans, BuildProducer<ValidationPhaseBuildItem.ValidationErrorBuildItem> validationErrors)
(package private) void	setupExecutor(ExecutorBuildItem executor, ArcRecorder recorder)
void	signalBeanContainerReady(AppCDSRecorder recorder, PreBeanContainerBuildItem bi, Optional<AppCDSRequestedBuildItem> appCDSRequested, BuildProducer<AppCDSControlPointBuildItem> appCDSControlPointProducer, BuildProducer<BeanContainerBuildItem> beanContainerProducer)
AdditionalBeanBuildItem	testApplicationClassPredicateBean()
(package private) UnremovableBeanBuildItem	unremovableAsyncObserverExceptionHandlers()
ValidationPhaseBuildItem	validate(ObserverRegistrationPhaseBuildItem observerRegistrationPhase, List<ObserverRegistrationPhaseBuildItem.ObserverConfiguratorBuildItem> observerConfigurationRegistry, List<UnremovableBeanBuildItem> unremovableBeans, BuildProducer<BytecodeTransformerBuildItem> bytecodeTransformer, BuildProducer<SynthesisFinishedBuildItem> synthesisFinished)
(package private) void	validateAsyncObserverExceptionHandlers(ValidationPhaseBuildItem validationPhase, BuildProducer<ValidationPhaseBuildItem.ValidationErrorBuildItem> errors)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ADDITIONAL_BEAN

static final org.jboss.jandex.DotName ADDITIONAL_BEAN

ASYNC_OBSERVER_EXCEPTION_HANDLER

static final org.jboss.jandex.DotName ASYNC_OBSERVER_EXCEPTION_HANDLER

Constructor Details

ArcProcessor

public ArcProcessor()

Method Details

feature

FeatureBuildItem feature()

buildCompatibleExtensions

BuildCompatibleExtensionsBuildItem buildCompatibleExtensions()

quarkusApplication

AdditionalBeanBuildItem quarkusApplication(CombinedIndexBuildItem combinedIndex)

initialize

public ContextRegistrationPhaseBuildItem initialize(ArcConfig arcConfig,
 BeanArchiveIndexBuildItem beanArchiveIndex,
 CombinedIndexBuildItem combinedIndex,
 ApplicationIndexBuildItem applicationIndex,
 BuildCompatibleExtensionsBuildItem buildCompatibleExtensions,
 List<ExcludedTypeBuildItem> excludedTypes,
 List<AnnotationsTransformerBuildItem> annotationTransformers,
 List<InjectionPointTransformerBuildItem> injectionPointTransformers,
 List<ObserverTransformerBuildItem> observerTransformers,
 List<InterceptorBindingRegistrarBuildItem> interceptorBindingRegistrars,
 List<QualifierRegistrarBuildItem> qualifierRegistrars,
 List<StereotypeRegistrarBuildItem> stereotypeRegistrars,
 List<ApplicationClassPredicateBuildItem> applicationClassPredicates,
 List<AdditionalBeanBuildItem> additionalBeans,
 List<ResourceAnnotationBuildItem> resourceAnnotations,
 List<BeanDefiningAnnotationBuildItem> additionalBeanDefiningAnnotations,
 List<SuppressConditionGeneratorBuildItem> suppressConditionGenerators,
 Optional<TestClassPredicateBuildItem> testClassPredicate,
 Capabilities capabilities,
 CustomScopeAnnotationsBuildItem customScopes,
 LaunchModeBuildItem launchModeBuildItem,
 BuildProducer<CompletedApplicationClassPredicateBuildItem> applicationClassPredicateProducer)

registerBeans

public BeanRegistrationPhaseBuildItem registerBeans(ContextRegistrationPhaseBuildItem contextRegistrationPhase,
 List<ContextRegistrationPhaseBuildItem.ContextConfiguratorBuildItem> contextConfigurationRegistry,
 BuildProducer<InterceptorResolverBuildItem> interceptorResolver,
 BuildProducer<BeanDiscoveryFinishedBuildItem> beanDiscoveryFinished,
 BuildProducer<TransformedAnnotationsBuildItem> transformedAnnotations)

registerSyntheticObservers

public ObserverRegistrationPhaseBuildItem registerSyntheticObservers(BeanRegistrationPhaseBuildItem beanRegistrationPhase,
 List<BeanRegistrationPhaseBuildItem.BeanConfiguratorBuildItem> beanConfigurators,
 BuildProducer<ReflectiveMethodBuildItem> reflectiveMethods,
 BuildProducer<ReflectiveFieldBuildItem> reflectiveFields,
 BuildProducer<UnremovableBeanBuildItem> unremovableBeans,
 BuildProducer<ValidationPhaseBuildItem.ValidationErrorBuildItem> validationErrors)

validate

public ValidationPhaseBuildItem validate(ObserverRegistrationPhaseBuildItem observerRegistrationPhase,
 List<ObserverRegistrationPhaseBuildItem.ObserverConfiguratorBuildItem> observerConfigurationRegistry,
 List<UnremovableBeanBuildItem> unremovableBeans,
 BuildProducer<BytecodeTransformerBuildItem> bytecodeTransformer,
 BuildProducer<SynthesisFinishedBuildItem> synthesisFinished)

generateResources

public void generateResources(ArcConfig config,
 ValidationPhaseBuildItem validationPhase,
 List<ValidationPhaseBuildItem.ValidationErrorBuildItem> validationErrors,
 BuildProducer<ReflectiveClassBuildItem> reflectiveClasses,
 BuildProducer<ReflectiveMethodBuildItem> reflectiveMethods,
 BuildProducer<ReflectiveFieldBuildItem> reflectiveFields,
 BuildProducer<GeneratedClassBuildItem> generatedClass,
 LiveReloadBuildItem liveReloadBuildItem,
 BuildProducer<GeneratedResourceBuildItem> generatedResource,
 BuildProducer<BytecodeTransformerBuildItem> bytecodeTransformer,
 List<ReflectiveBeanClassBuildItem> reflectiveBeanClasses,
 ExecutorService buildExecutor)
                       throws Exception

Throws:

Exception

initializeContainer

public ArcContainerBuildItem initializeContainer(ArcConfig config,
 ArcRecorder recorder,
 ShutdownContextBuildItem shutdown,
 Optional<CurrentContextFactoryBuildItem> currentContextFactory)
                                          throws Exception

Throws:

Exception

notifyBeanContainerListeners

public PreBeanContainerBuildItem notifyBeanContainerListeners(ArcContainerBuildItem container,
 List<BeanContainerListenerBuildItem> beanContainerListenerBuildItems,
 ArcRecorder recorder)
                                                       throws Exception

Throws:

Exception

signalBeanContainerReady

public void signalBeanContainerReady(AppCDSRecorder recorder,
 PreBeanContainerBuildItem bi,
 Optional<AppCDSRequestedBuildItem> appCDSRequested,
 BuildProducer<AppCDSControlPointBuildItem> appCDSControlPointProducer,
 BuildProducer<BeanContainerBuildItem> beanContainerProducer)

testApplicationClassPredicateBean

public AdditionalBeanBuildItem testApplicationClassPredicateBean()

initTestApplicationClassPredicateBean

void initTestApplicationClassPredicateBean(ArcRecorder recorder,
 BeanContainerBuildItem beanContainer,
 BeanDiscoveryFinishedBuildItem beanDiscoveryFinished,
 CompletedApplicationClassPredicateBuildItem predicate)

marker

List<AdditionalApplicationArchiveMarkerBuildItem> marker()

setupExecutor

void setupExecutor(ExecutorBuildItem executor,
 ArcRecorder recorder)

launchMode

AdditionalBeanBuildItem launchMode()

loggerProducer

AdditionalBeanBuildItem loggerProducer()

exposeCustomScopeNames

CustomScopeAnnotationsBuildItem exposeCustomScopeNames(List<CustomScopeBuildItem> customScopes)

quarkusMain

BeanDefiningAnnotationBuildItem quarkusMain()

unremovableAsyncObserverExceptionHandlers

UnremovableBeanBuildItem unremovableAsyncObserverExceptionHandlers()

validateAsyncObserverExceptionHandlers

void validateAsyncObserverExceptionHandlers(ValidationPhaseBuildItem validationPhase,
 BuildProducer<ValidationPhaseBuildItem.ValidationErrorBuildItem> errors)

registerContextPropagation

void registerContextPropagation(ArcConfig config,
 BuildProducer<ThreadContextProviderBuildItem> threadContextProvider)

createQuarkusComponentTestExcludePredicate

Predicate<org.jboss.jandex.ClassInfo> createQuarkusComponentTestExcludePredicate(org.jboss.jandex.IndexView index)