Package io.quarkus.deployment.steps

Class ConfigGenerationBuildStep

java.lang.Object

io.quarkus.deployment.steps.ConfigGenerationBuildStep

public class ConfigGenerationBuildStep
extends Object

Constructor Summary

Constructors

Constructor	Description
ConfigGenerationBuildStep()

Method Summary

Modifier and Type	Method	Description
(package private) void	buildTimeRunTimeConfig(ConfigBuildTimeConfig configBuildTimeConfig, ConfigurationBuildItem configItem, BuildProducer<GeneratedClassBuildItem> generatedClass, BuildProducer<ReflectiveClassBuildItem> reflectiveClass, BuildProducer<StaticInitConfigBuilderBuildItem> staticInitConfigBuilder, BuildProducer<RunTimeConfigBuilderBuildItem> runTimeConfigBuilder)
void	checkForBuildTimeConfigChange(RecorderContext recorderContext, io.quarkus.runtime.configuration.ConfigRecorder recorder, ConfigurationBuildItem configItem, List<SuppressNonRuntimeConfigChangedWarningBuildItem> suppressNonRuntimeConfigChangedWarningItems)	Warns if build time config properties have been changed at runtime.
(package private) void	discoverConfigMappings(ConfigurationBuildItem configItem, CombinedIndexBuildItem combinedIndex, BuildProducer<ConfigMappingBuildItem> configMappings)
(package private) void	fixedAtBuildTimeSources(ConfigBuildTimeConfig config, BuildProducer<StaticInitConfigBuilderBuildItem> staticInitConfigBuilder, BuildProducer<RunTimeConfigBuilderBuildItem> runTimeConfigBuilder)
(package private) void	generateConfigBuilders(ConfigurationBuildItem configItem, CombinedIndexBuildItem combinedIndex, List<StaticInitConfigBuilderBuildItem> staticInitConfigBuilders, List<RunTimeConfigBuilderBuildItem> runTimeConfigBuilders, List<RunTimeConfigurationDefaultBuildItem> runTimeDefaults, Optional<ConfigMappingsRegistrarBuildItem> configMappings, Optional<ReproducibilityCheckBuildItem> reproducibilityCheck, BuildProducer<GeneratedClassBuildItem> generatedClass, BuildProducer<ReflectiveClassBuildItem> reflectiveClass)
(package private) void	generateConfigClass(ConfigurationBuildItem configItem, LaunchModeBuildItem launchModeBuildItem, BuildProducer<GeneratedClassBuildItem> generatedClass, LiveReloadBuildItem liveReloadBuildItem)	Generate the Config class that instantiates MP Config and holds all the config objects
(package private) void	generateConfigMappings(ConfigurationBuildItem configItem, List<ConfigMappingBuildItem> configMappings, BuildProducer<GeneratedConfigClassBuildItem> configClasses)
(package private) void	nativeServiceProviders(BuildProducer<ServiceProviderBuildItem> providerProducer)	Registers all config components descriptors for native image.
(package private) void	nativeSupport(BuildProducer<RuntimeInitializedClassBuildItem> runtimeInitializedClassProducer)
(package private) void	persistReadConfigOptions(BuildProducer<ArtifactResultBuildItem> dummy, QuarkusBuildCloseablesBuildItem closeables, BuildSystemTargetBuildItem buildSystemTargetBuildItem, ConfigurationBuildItem configBuildItem, ConfigTrackingConfig configTrackingConfig)
(package private) void	processGeneratedConfigClasses(List<GeneratedConfigClassBuildItem> generatedConfigClasses, BuildProducer<GeneratedClassBuildItem> generatedClasses, BuildProducer<ReflectiveClassBuildItem> reflectiveClasses, BuildProducer<ReflectiveMethodBuildItem> reflectiveMethods)
(package private) void	registerConfigInstanceBuilderLambdas(CombinedIndexBuildItem combinedIndex, List<GeneratedConfigClassBuildItem> generatedConfigClasses, BuildProducer<LambdaReflectionBuildItem> lambdaReflection)	Registers the lambda metadata required to support ConfigInstanceBuilder.forInterface in native mode.
void	releaseConfigOnShutdown(ShutdownContextBuildItem shutdownContext, io.quarkus.runtime.configuration.ConfigRecorder recorder)
(package private) void	reportDeprecatedMappingProperties(io.quarkus.runtime.configuration.ConfigRecorder configRecorder, ConfigurationBuildItem configBuildItem)
void	suppressNonRuntimeConfigChanged(BuildProducer<SuppressNonRuntimeConfigChangedWarningBuildItem> suppressNonRuntimeConfigChanged)
(package private) void	systemOnlySources(BuildProducer<StaticInitConfigBuilderBuildItem> staticInitConfigBuilder, BuildProducer<RunTimeConfigBuilderBuildItem> runTimeConfigBuilder)
(package private) void	unknownConfigFiles(ApplicationArchivesBuildItem applicationArchives, LaunchModeBuildItem launchModeBuildItem, io.quarkus.runtime.configuration.ConfigRecorder configRecorder)
(package private) void	warnDifferentProfileUsedBetweenBuildAndRunTime(io.quarkus.runtime.configuration.ConfigRecorder configRecorder)
void	watchConfigFiles(BuildProducer<HotDeploymentWatchedFileBuildItem> watchedFiles)

Methods inherited from class java.lang.Object

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

Constructor Details

ConfigGenerationBuildStep

public ConfigGenerationBuildStep()

Method Details

nativeSupport

void nativeSupport(BuildProducer<RuntimeInitializedClassBuildItem> runtimeInitializedClassProducer)

nativeServiceProviders

void nativeServiceProviders(BuildProducer<ServiceProviderBuildItem> providerProducer)
                     throws IOException

Registers all config components descriptors for native image.

The initialized Config used by Quarkus does not require them, but users may be instantiating their own Config.

Throws:

IOException

buildTimeRunTimeConfig

void buildTimeRunTimeConfig(ConfigBuildTimeConfig configBuildTimeConfig,
 ConfigurationBuildItem configItem,
 BuildProducer<GeneratedClassBuildItem> generatedClass,
 BuildProducer<ReflectiveClassBuildItem> reflectiveClass,
 BuildProducer<StaticInitConfigBuilderBuildItem> staticInitConfigBuilder,
 BuildProducer<RunTimeConfigBuilderBuildItem> runTimeConfigBuilder)

discoverConfigMappings

void discoverConfigMappings(ConfigurationBuildItem configItem,
 CombinedIndexBuildItem combinedIndex,
 BuildProducer<ConfigMappingBuildItem> configMappings)

generateConfigMappings

void generateConfigMappings(ConfigurationBuildItem configItem,
 List<ConfigMappingBuildItem> configMappings,
 BuildProducer<GeneratedConfigClassBuildItem> configClasses)

processGeneratedConfigClasses

void processGeneratedConfigClasses(List<GeneratedConfigClassBuildItem> generatedConfigClasses,
 BuildProducer<GeneratedClassBuildItem> generatedClasses,
 BuildProducer<ReflectiveClassBuildItem> reflectiveClasses,
 BuildProducer<ReflectiveMethodBuildItem> reflectiveMethods)

systemOnlySources

void systemOnlySources(BuildProducer<StaticInitConfigBuilderBuildItem> staticInitConfigBuilder,
 BuildProducer<RunTimeConfigBuilderBuildItem> runTimeConfigBuilder)

fixedAtBuildTimeSources

void fixedAtBuildTimeSources(ConfigBuildTimeConfig config,
 BuildProducer<StaticInitConfigBuilderBuildItem> staticInitConfigBuilder,
 BuildProducer<RunTimeConfigBuilderBuildItem> runTimeConfigBuilder)

generateConfigBuilders

void generateConfigBuilders(ConfigurationBuildItem configItem,
 CombinedIndexBuildItem combinedIndex,
 List<StaticInitConfigBuilderBuildItem> staticInitConfigBuilders,
 List<RunTimeConfigBuilderBuildItem> runTimeConfigBuilders,
 List<RunTimeConfigurationDefaultBuildItem> runTimeDefaults,
 Optional<ConfigMappingsRegistrarBuildItem> configMappings,
 Optional<ReproducibilityCheckBuildItem> reproducibilityCheck,
 BuildProducer<GeneratedClassBuildItem> generatedClass,
 BuildProducer<ReflectiveClassBuildItem> reflectiveClass)
                     throws Exception

Throws:

Exception

generateConfigClass

void generateConfigClass(ConfigurationBuildItem configItem,
 LaunchModeBuildItem launchModeBuildItem,
 BuildProducer<GeneratedClassBuildItem> generatedClass,
 LiveReloadBuildItem liveReloadBuildItem)

Generate the Config class that instantiates MP Config and holds all the config objects

registerConfigInstanceBuilderLambdas

void registerConfigInstanceBuilderLambdas(CombinedIndexBuildItem combinedIndex,
 List<GeneratedConfigClassBuildItem> generatedConfigClasses,
 BuildProducer<LambdaReflectionBuildItem> lambdaReflection)

Registers the lambda metadata required to support ConfigInstanceBuilder.forInterface in native mode.

The builder resolves a configuration property name from a method reference (for instance Server::host) by reading the serialized lambda. In native mode, the lambda metadata must be registered in reachability-metadata.json, otherwise writeReplaceForSerialization returns null and the property name cannot be resolved (SRCFG00060).

The capturing class always references the configuration interface, because the method reference embeds a handle to one of the interface methods. We start from the known users of each configuration interface and confirm, by scanning the bytecode, that they actually create a serializable method reference to a configuration interface method before registering them.

suppressNonRuntimeConfigChanged

public void suppressNonRuntimeConfigChanged(BuildProducer<SuppressNonRuntimeConfigChangedWarningBuildItem> suppressNonRuntimeConfigChanged)

releaseConfigOnShutdown

public void releaseConfigOnShutdown(ShutdownContextBuildItem shutdownContext,
 io.quarkus.runtime.configuration.ConfigRecorder recorder)

checkForBuildTimeConfigChange

public void checkForBuildTimeConfigChange(RecorderContext recorderContext,
 io.quarkus.runtime.configuration.ConfigRecorder recorder,
 ConfigurationBuildItem configItem,
 List<SuppressNonRuntimeConfigChangedWarningBuildItem> suppressNonRuntimeConfigChangedWarningItems)

Warns if build time config properties have been changed at runtime.

watchConfigFiles

public void watchConfigFiles(BuildProducer<HotDeploymentWatchedFileBuildItem> watchedFiles)

reportDeprecatedMappingProperties

void reportDeprecatedMappingProperties(io.quarkus.runtime.configuration.ConfigRecorder configRecorder,
 ConfigurationBuildItem configBuildItem)

unknownConfigFiles

void unknownConfigFiles(ApplicationArchivesBuildItem applicationArchives,
 LaunchModeBuildItem launchModeBuildItem,
 io.quarkus.runtime.configuration.ConfigRecorder configRecorder)
                 throws Exception

Throws:

Exception

warnDifferentProfileUsedBetweenBuildAndRunTime

void warnDifferentProfileUsedBetweenBuildAndRunTime(io.quarkus.runtime.configuration.ConfigRecorder configRecorder)

persistReadConfigOptions

void persistReadConfigOptions(BuildProducer<ArtifactResultBuildItem> dummy,
 QuarkusBuildCloseablesBuildItem closeables,
 BuildSystemTargetBuildItem buildSystemTargetBuildItem,
 ConfigurationBuildItem configBuildItem,
 ConfigTrackingConfig configTrackingConfig)