fish.payara.nucleus.microprofile.config.spi.ConfigValueResolverImpl Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-micro Show documentation
Show all versions of payara-micro Show documentation
Micro Distribution of the Payara Project
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2020 Payara Foundation and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://github.com/payara/Payara/blob/master/LICENSE.txt
* See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* The Payara Foundation designates this particular file as subject to the "Classpath"
* exception as provided by the Payara Foundation in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package fish.payara.nucleus.microprofile.config.spi;
import static fish.payara.nucleus.microprofile.config.spi.PayaraConfig.boxedTypeOf;
import static java.util.Collections.emptyList;
import static java.util.Collections.emptySet;
import java.util.Arrays;
import java.util.HashSet;
import java.util.List;
import java.util.NoSuchElementException;
import java.util.Optional;
import java.util.Set;
import java.util.function.Function;
import java.util.function.Supplier;
import org.eclipse.microprofile.config.ConfigValue;
import org.eclipse.microprofile.config.inject.ConfigProperty;
import org.eclipse.microprofile.config.spi.Converter;
import fish.payara.nucleus.microprofile.config.converters.ArrayConverter;
/**
* Implementation for the {@link ConfigValueResolver} which uses the non public API of
* {@link PayaraConfig#getValue(String, String, Long, String, Supplier)} to implement its utility methods.
*
* @author Jan Bernitt
*/
final class ConfigValueResolverImpl implements ConfigValueResolver {
private final PayaraConfig config;
private final String propertyName;
private boolean throwsOnMissingProperty;
private boolean throwOnFailedConversion;
private boolean trim = true;
private ElementPolicy policy = ElementPolicy.SKIP;
private Long ttl;
private String rawDefault;
ConfigValueResolverImpl(PayaraConfig config, String propertyName) {
this.config = config;
this.propertyName = propertyName;
}
@Override
public ConfigValueResolver withTTL(long ttl) {
this.ttl = ttl < 0 ? null : ttl;
return this;
}
@Override
public ConfigValueResolver withDefault(String value) {
rawDefault = ConfigProperty.UNCONFIGURED_VALUE.equals(value) ? null : value;
return this;
}
@Override
public ConfigValueResolver withTrimming(boolean trim) {
this.trim = trim;
return this;
}
@Override
public ConfigValueResolver withPolicy(ElementPolicy policy) {
this.policy = policy;
return this;
}
@Override
public ConfigValueResolver throwOnMissingProperty(boolean throwOnMissingProperty) {
this.throwsOnMissingProperty = throwOnMissingProperty;
return this;
}
@Override
public ConfigValueResolver throwOnFailedConversion(boolean throwOnFailedConversion) {
this.throwOnFailedConversion = throwOnFailedConversion;
return this;
}
@SuppressWarnings("unchecked")
@Override
public T as(Class type, T defaultValue) {
if (type == ConfigValue.class) {
return (T) asConfigValue(propertyName, getCacheKey(propertyName, type), ttl, null);
}
return asValue(propertyName, getCacheKey(propertyName, type), ttl, defaultValue,
() -> Optional.ofNullable(
type.isArray()
? (Converter) getArrayConverter(type.getComponentType(), false)
: getConverter(type)
));
}
@Override
public Optional as(Class type) {
return Optional.ofNullable(as(type, null));
}
@Override
public List asList(Class elementType) {
return asList(elementType, emptyList());
}
@Override
public List asList(Class elementType, List defaultValue) {
return asValue(propertyName, getCacheKey(propertyName, List.class, elementType), ttl, defaultValue,
() -> Optional.of(createListConverter(getArrayConverter(elementType, true))));
}
@Override
public Supplier asSupplier(Class elementType) {
return () -> as(elementType, null);
}
@Override
public Set asSet(Class elementType) {
return asSet(elementType, emptySet());
}
@Override
public Set asSet(Class elementType, Set defaultValue) {
return asValue(propertyName, getCacheKey(propertyName, Set.class, elementType), ttl, defaultValue,
() -> Optional.of(createSetConverter(getArrayConverter(elementType, true))));
}
@Override
public T asConvertedBy(Function converter, T defaultValue) {
String sourceValue = asValue(propertyName, getCacheKey(propertyName, String.class), ttl, null,
() -> Optional.of(value -> value));
if (sourceValue == null) {
if (throwsOnMissingProperty) {
throwWhenNotExists(propertyName, null);
}
return defaultValue;
}
try {
return converter.apply(sourceValue);
} catch (Exception ex) {
if (rawDefault != null) {
try {
return converter.apply(rawDefault);
} catch (Exception e) {
// fall through
}
}
if (throwOnFailedConversion) {
throw new IllegalArgumentException(ex);
}
return defaultValue;
}
}
private T asValue(String propertyName, String cacheKey, Long ttl, T defaultValue, Supplier>> converter) {
try {
T value = config.getValue(propertyName, cacheKey, ttl, getRawDefault(), converter);
if (value != null) {
return value;
}
if (throwsOnMissingProperty) {
throwWhenNotExists(propertyName, null);
}
return defaultValue;
} catch (IllegalArgumentException ex) {
if (throwOnFailedConversion) {
throw ex;
}
return defaultValue;
}
}
private ConfigValue asConfigValue(String propertyName, String cacheKey, Long ttl, String defaultValue) {
try {
final String resolvedDefault;
if (defaultValue != null && !defaultValue.isEmpty()) {
resolvedDefault = defaultValue;
} else {
resolvedDefault = getRawDefault();
}
ConfigValue value = config.getConfigValue(propertyName, cacheKey, ttl, resolvedDefault);
if (value != null) {
return value;
}
if (throwsOnMissingProperty) {
throwWhenNotExists(propertyName, null);
}
} catch (IllegalArgumentException ex) {
if (throwOnFailedConversion) {
throw ex;
}
}
return null;
}
private String getRawDefault() {
return throwsOnMissingProperty ? null : rawDefault;
}
private Converter getConverter(Class type) {
Optional> converter = config.getConverter(type);
if (!converter.isPresent()) {
return null;
}
return trim ? new TrimConverter<>(converter.get()) : converter.get();
}
@SuppressWarnings("unchecked")
private Converter getArrayConverter(Class elementType, boolean box) {
Converter elementConverter = getConverter(elementType);
if (box)
elementType = (Class) boxedTypeOf(elementType);
Converter arrayConverter = new ArrayConverter<>(elementType, elementConverter, policy);
return (Converter) arrayConverter;
}
static void throwWhenNotExists(String propertyName, Object value) {
if (value == null) {
throw new NoSuchElementException("Unable to find property with name " + propertyName);
}
}
static String getCacheKey(String propertyName, Class propertyType) {
String key = propertyType.getName() + ":" + propertyName;
return key;
}
static String getCacheKey(String propertyName, Class collectionType, Class elementType) {
return collectionType.getName() + ":" + getCacheKey(propertyName, elementType);
}
static Converter> createListConverter(Converter arrayConverter) {
return sourceValue -> Arrays.asList(arrayConverter.convert(sourceValue));
}
static Converter> createSetConverter(Converter arrayConverter) {
return sourceValue -> new HashSet<>(Arrays.asList(arrayConverter.convert(sourceValue)));
}
private static final class TrimConverter implements Converter {
private static final long serialVersionUID = 1L;
private final Converter wrapped;
TrimConverter(Converter wrapped) {
this.wrapped = wrapped;
}
@Override
public T convert(String value) {
return wrapped.convert(value.trim());
}
}
}