io.quarkus.runtime.configuration.ConfigUtils Maven / Gradle / Ivy
package io.quarkus.runtime.configuration;
import java.util.ArrayList;
import java.util.Collection;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Optional;
import java.util.Set;
import java.util.SortedSet;
import java.util.TreeSet;
import java.util.UUID;
import java.util.function.IntFunction;
import org.eclipse.microprofile.config.Config;
import org.eclipse.microprofile.config.ConfigProvider;
import org.eclipse.microprofile.config.ConfigValue;
import org.eclipse.microprofile.config.spi.ConfigSource;
import io.quarkus.runtime.LaunchMode;
import io.smallrye.config.SmallRyeConfig;
import io.smallrye.config.SmallRyeConfigBuilder;
/**
*
*/
public final class ConfigUtils {
/**
* The name of the property associated with a random UUID generated at launch time.
*/
static final String UUID_KEY = "quarkus.uuid";
private ConfigUtils() {
}
public static IntFunction> listFactory() {
return ArrayList::new;
}
public static IntFunction> setFactory() {
return LinkedHashSet::new;
}
public static IntFunction> sortedSetFactory() {
return size -> new TreeSet<>();
}
public static SmallRyeConfigBuilder configBuilder(final boolean runTime, final LaunchMode launchMode) {
return configBuilder(runTime, true, launchMode);
}
/**
* Get the basic configuration builder.
*
* @param runTime {@code true} if the configuration is run time, {@code false} if build time
* @param addDiscovered {@code true} if the ConfigSource and Converter objects should be auto-discovered
* @return the configuration builder
*/
public static SmallRyeConfigBuilder configBuilder(final boolean runTime, final boolean addDiscovered,
final LaunchMode launchMode) {
SmallRyeConfigBuilder builder = emptyConfigBuilder();
if (launchMode.isDevOrTest() && runTime) {
builder.withSources(new RuntimeOverrideConfigSource(builder.getClassLoader()));
}
if (runTime) {
builder.withDefaultValue(UUID_KEY, UUID.randomUUID().toString());
}
if (addDiscovered) {
builder.addDiscoveredCustomizers().addDiscoveredSources();
}
return builder;
}
public static SmallRyeConfigBuilder emptyConfigBuilder() {
return new SmallRyeConfigBuilder()
.forClassLoader(Thread.currentThread().getContextClassLoader())
.withCustomizers(new QuarkusConfigBuilderCustomizer())
.addDiscoveredConverters()
.addDefaultInterceptors()
.addDiscoveredInterceptors()
.addDiscoveredSecretKeysHandlers()
.addDefaultSources();
}
public static List getProfiles() {
return ConfigProvider.getConfig().unwrap(SmallRyeConfig.class).getProfiles();
}
public static boolean isProfileActive(final String profile) {
return getProfiles().contains(profile);
}
/**
* Checks if a property is present in the current Configuration.
*
* Because the sources may not expose the property directly in {@link ConfigSource#getPropertyNames()}, we cannot
* reliably determine if the property is present in the properties list. The property needs to be retrieved to make
* sure it exists. Also, if the value is an expression, we want to ignore expansion, because this is not relevant
* for the check and the expansion value may not be available at this point.
*
* It may be interesting to expose such API in SmallRyeConfig directly.
*
* @param propertyName the property name.
* @return true if the property is present or false otherwise.
*/
public static boolean isPropertyPresent(String propertyName) {
return ConfigProvider.getConfig().unwrap(SmallRyeConfig.class).isPropertyPresent(propertyName);
}
/**
* Checks if a property has non-empty value in the current Configuration.
*
* This method is similar to {@link #isPropertyPresent(String)}, but does not ignore expression expansion.
*
* @param propertyName the property name.
* @return true if the property is present or false otherwise.
*/
public static boolean isPropertyNonEmpty(String propertyName) {
ConfigValue configValue = ConfigProvider.getConfig().getConfigValue(propertyName);
return configValue.getValue() != null && !configValue.getValue().isEmpty();
}
/**
* Checks if any of the given properties is present in the current Configuration.
*
* Because the sources may not expose the property directly in {@link ConfigSource#getPropertyNames()}, we cannot
* reliably determine if the property is present in the properties list. The property needs to be retrieved to make
* sure it exists. Also, if the value is an expression, we want to ignore expansion, because this is not relevant
* for the check and the expansion value may not be available at this point.
*
* It may be interesting to expose such API in SmallRyeConfig directly.
*
* @param propertyNames The configuration property names
* @return true if the property is present or false otherwise.
*/
public static boolean isAnyPropertyPresent(Collection propertyNames) {
for (String propertyName : propertyNames) {
if (isPropertyPresent(propertyName)) {
return true;
}
}
return false;
}
/**
* Get the value of the first given property present in the current Configuration,
* or {@link Optional#empty()} if none of the properties is present.
*
* @param The property type
* @param propertyNames The configuration property names
* @param propertyType The type that the resolved property value should be converted to
* @return true if the property is present or false otherwise.
*/
public static Optional getFirstOptionalValue(List propertyNames, Class propertyType) {
Config config = ConfigProvider.getConfig();
for (String propertyName : propertyNames) {
Optional value = config.getOptionalValue(propertyName, propertyType);
if (value.isPresent()) {
return value;
}
}
return Optional.empty();
}
}