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	CONFIG_HELPER
static String	CONFIG_HELPER_DATA
static String	CONFIG_ROOT
static io.quarkus.gizmo.FieldDescriptor	CONFIG_ROOT_FIELD
static io.quarkus.gizmo.MethodDescriptor	GET_ROOT_METHOD

Constructor Summary

Constructors

Constructor and Description
ConfigurationSetup()

Method Summary

Modifier and Type	Method and Description
(package private) void	finalizeConfigLoader(ConfigurationBuildItem configurationBuildItem, Consumer<GeneratedClassBuildItem> classConsumer, Consumer<RuntimeReinitializedClassBuildItem> runTimeInitConsumer, Consumer<BytecodeRecorderObjectLoaderBuildItem> objectLoaderConsumer, List<ConfigurationCustomConverterBuildItem> converters, List<RunTimeConfigurationSourceBuildItem> runTimeSources) Generate the bytecode to load configuration objects at static init and run time.
ConfigurationBuildItem	initializeConfiguration(List<ConfigurationCustomConverterBuildItem> converters, ExtensionClassLoaderBuildItem extensionClassLoaderBuildItem) 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) 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

CONFIG_HELPER

public static final String CONFIG_HELPER

See Also:

Constant Field Values

CONFIG_HELPER_DATA

public static final String CONFIG_HELPER_DATA

See Also:

Constant Field Values

CONFIG_ROOT

public static final String CONFIG_ROOT

See Also:

Constant Field Values

CONFIG_ROOT_FIELD

public static final io.quarkus.gizmo.FieldDescriptor CONFIG_ROOT_FIELD

GET_ROOT_METHOD

public static final io.quarkus.gizmo.MethodDescriptor GET_ROOT_METHOD

Constructor Detail

ConfigurationSetup

public ConfigurationSetup()

Method Detail

setUpConverters

public void setUpConverters(BuildProducer<ConfigurationCustomConverterBuildItem> configurationTypes)

initializeConfiguration

public ConfigurationBuildItem initializeConfiguration(List<ConfigurationCustomConverterBuildItem> converters,
                                                      ExtensionClassLoaderBuildItem extensionClassLoaderBuildItem)
                                               throws IOException,
                                                      ClassNotFoundException

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

Parameters:

converters - the converters to set up

Returns:

the configuration build item

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)
                                           throws IOException

Write the default run time configuration.

Throws:

IOException

finalizeConfigLoader

void finalizeConfigLoader(ConfigurationBuildItem configurationBuildItem,
                          Consumer<GeneratedClassBuildItem> classConsumer,
                          Consumer<RuntimeReinitializedClassBuildItem> runTimeInitConsumer,
                          Consumer<BytecodeRecorderObjectLoaderBuildItem> objectLoaderConsumer,
                          List<ConfigurationCustomConverterBuildItem> converters,
                          List<RunTimeConfigurationSourceBuildItem> runTimeSources)

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

Parameters:

configurationBuildItem - the config build item

classConsumer - the consumer of generated classes

runTimeInitConsumer - the consumer of runtime init classes

writeDefaultConfiguration

void writeDefaultConfiguration()