io.quarkus.deployment.steps

Class ConfigurationSetup

java.lang.Object

io.quarkus.deployment.steps.ConfigurationSetup

public class ConfigurationSetup
extends Object

Setup steps for configuration purposes.

Field Summary

Fields

Modifier and Type	Field and Description
static String	BUILD_TIME_CONFIG
static String	BUILD_TIME_CONFIG_ROOT
static io.quarkus.gizmo.MethodDescriptor	CREATE_RUN_TIME_CONFIG
static String	RUN_TIME_CONFIG
static String	RUN_TIME_CONFIG_ROOT

Constructor Summary

Constructors

Constructor and Description
ConfigurationSetup()

Method Summary

Modifier and Type	Method and Description
(package private) void	finalizeConfigLoader(RunTimeConfigurationBuildItem runTimeConfigItem, BuildTimeRunTimeFixedConfigurationBuildItem buildTimeRunTimeConfigItem, Consumer<GeneratedClassBuildItem> classConsumer, Consumer<RuntimeInitializedClassBuildItem> runTimeInitConsumer, Consumer<BytecodeRecorderObjectLoaderBuildItem> objectLoaderConsumer, List<ConfigurationCustomConverterBuildItem> converters, List<RunTimeConfigurationSourceBuildItem> runTimeSources) Generate the bytecode to load configuration objects at static init and run time.
void	initializeConfiguration(List<ConfigurationCustomConverterBuildItem> converters, Consumer<RunTimeConfigurationBuildItem> runTimeConfigConsumer, Consumer<BuildTimeConfigurationBuildItem> buildTimeConfigConsumer, Consumer<BuildTimeRunTimeFixedConfigurationBuildItem> buildTimeRunTimeConfigConsumer, Consumer<GeneratedResourceBuildItem> resourceConsumer, Consumer<SubstrateResourceBuildItem> niResourceConsumer, Consumer<RunTimeConfigurationDefaultBuildItem> runTimeDefaultConsumer, ExtensionClassLoaderBuildItem extensionClassLoaderBuildItem, ArchiveRootBuildItem archiveRootBuildItem) Run before anything that consumes configuration; sets up the main configuration definition instance.
(package private) void	setUpConfigFile(BuildProducer<RunTimeConfigurationSourceBuildItem> configSourceConsumer) Add a config sources for application.properties.
void	setUpConverters(BuildProducer<ConfigurationCustomConverterBuildItem> configurationTypes)
(package private) void	writeDefaultConfiguration()
(package private) RunTimeConfigurationSourceBuildItem	writeDefaults(List<RunTimeConfigurationDefaultBuildItem> defaults, Consumer<GeneratedResourceBuildItem> resourceConsumer, Consumer<SubstrateResourceBuildItem> niResourceConsumer) Write the default run time configuration.

Methods inherited from class java.lang.Object

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

Field Detail

BUILD_TIME_CONFIG

public static final String BUILD_TIME_CONFIG

See Also:

Constant Field Values

BUILD_TIME_CONFIG_ROOT

public static final String BUILD_TIME_CONFIG_ROOT

See Also:

Constant Field Values

RUN_TIME_CONFIG

public static final String RUN_TIME_CONFIG

See Also:

Constant Field Values

RUN_TIME_CONFIG_ROOT

public static final String RUN_TIME_CONFIG_ROOT

See Also:

Constant Field Values

CREATE_RUN_TIME_CONFIG

public static final io.quarkus.gizmo.MethodDescriptor CREATE_RUN_TIME_CONFIG

Constructor Detail

ConfigurationSetup

public ConfigurationSetup()

Method Detail

setUpConverters

public void setUpConverters(BuildProducer<ConfigurationCustomConverterBuildItem> configurationTypes)

initializeConfiguration

public void initializeConfiguration(List<ConfigurationCustomConverterBuildItem> converters,
                                    Consumer<RunTimeConfigurationBuildItem> runTimeConfigConsumer,
                                    Consumer<BuildTimeConfigurationBuildItem> buildTimeConfigConsumer,
                                    Consumer<BuildTimeRunTimeFixedConfigurationBuildItem> buildTimeRunTimeConfigConsumer,
                                    Consumer<GeneratedResourceBuildItem> resourceConsumer,
                                    Consumer<SubstrateResourceBuildItem> niResourceConsumer,
                                    Consumer<RunTimeConfigurationDefaultBuildItem> runTimeDefaultConsumer,
                                    ExtensionClassLoaderBuildItem extensionClassLoaderBuildItem,
                                    ArchiveRootBuildItem archiveRootBuildItem)
                             throws IOException,
                                    ClassNotFoundException

Run before anything that consumes configuration; sets up the main configuration definition instance.

Parameters:

converters - the converters to set up

runTimeConfigConsumer - the run time config consumer

buildTimeConfigConsumer - the build time config consumer

buildTimeRunTimeConfigConsumer - the build time/run time fixed config consumer

extensionClassLoaderBuildItem - the extension class loader build item

archiveRootBuildItem - the application archive root

Throws:

IOException

ClassNotFoundException

setUpConfigFile

void setUpConfigFile(BuildProducer<RunTimeConfigurationSourceBuildItem> configSourceConsumer)

Add a config sources for application.properties.

writeDefaults

RunTimeConfigurationSourceBuildItem writeDefaults(List<RunTimeConfigurationDefaultBuildItem> defaults,
                                                  Consumer<GeneratedResourceBuildItem> resourceConsumer,
                                                  Consumer<SubstrateResourceBuildItem> niResourceConsumer)
                                           throws IOException

Write the default run time configuration.

Throws:

IOException

finalizeConfigLoader

void finalizeConfigLoader(RunTimeConfigurationBuildItem runTimeConfigItem,
                          BuildTimeRunTimeFixedConfigurationBuildItem buildTimeRunTimeConfigItem,
                          Consumer<GeneratedClassBuildItem> classConsumer,
                          Consumer<RuntimeInitializedClassBuildItem> runTimeInitConsumer,
                          Consumer<BytecodeRecorderObjectLoaderBuildItem> objectLoaderConsumer,
                          List<ConfigurationCustomConverterBuildItem> converters,
                          List<RunTimeConfigurationSourceBuildItem> runTimeSources)

Generate the bytecode to load configuration objects at static init and run time.

Parameters:

runTimeConfigItem - the config build item

classConsumer - the consumer of generated classes

runTimeInitConsumer - the consumer of runtime init classes

writeDefaultConfiguration

void writeDefaultConfiguration()