fish.payara.nucleus.microprofile.config.spi.ConfigProviderResolverImpl Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-embedded-web Show documentation
Show all versions of payara-embedded-web Show documentation
Embedded-Web Distribution of the Payara Project
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) [2017-2023] 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.PayaraConfigBuilder.getTypeForConverter;
import java.io.IOException;
import java.io.InputStream;
import java.net.InetAddress;
import java.net.URL;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.OptionalDouble;
import java.util.OptionalInt;
import java.util.OptionalLong;
import java.util.Properties;
import java.util.ServiceLoader;
import java.util.Set;
import java.util.concurrent.TimeUnit;
import java.util.logging.Level;
import java.util.logging.Logger;
import jakarta.annotation.PostConstruct;
import jakarta.inject.Inject;
import jakarta.inject.Named;
import fish.payara.nucleus.executorservice.PayaraExecutorService;
import org.eclipse.microprofile.config.Config;
import org.eclipse.microprofile.config.spi.ConfigBuilder;
import org.eclipse.microprofile.config.spi.ConfigProviderResolver;
import org.eclipse.microprofile.config.spi.ConfigSource;
import org.eclipse.microprofile.config.spi.ConfigSourceProvider;
import org.eclipse.microprofile.config.spi.Converter;
import org.glassfish.api.StartupRunLevel;
import org.glassfish.api.admin.ServerEnvironment;
import org.glassfish.api.invocation.ComponentInvocation;
import org.glassfish.api.invocation.InvocationManager;
import org.glassfish.hk2.runlevel.RunLevel;
import org.glassfish.internal.api.ServerContext;
import org.glassfish.internal.data.ApplicationInfo;
import org.glassfish.internal.data.ApplicationRegistry;
import org.glassfish.internal.data.ModuleInfo;
import org.jvnet.hk2.annotations.ContractsProvided;
import org.jvnet.hk2.annotations.Optional;
import org.jvnet.hk2.annotations.Service;
import fish.payara.nucleus.microprofile.config.converters.BooleanConverter;
import fish.payara.nucleus.microprofile.config.converters.ByteConverter;
import fish.payara.nucleus.microprofile.config.converters.CharacterConverter;
import fish.payara.nucleus.microprofile.config.converters.ClassConverter;
import fish.payara.nucleus.microprofile.config.converters.DoubleConverter;
import fish.payara.nucleus.microprofile.config.converters.FloatConverter;
import fish.payara.nucleus.microprofile.config.converters.InetAddressConverter;
import fish.payara.nucleus.microprofile.config.converters.IntegerConverter;
import fish.payara.nucleus.microprofile.config.converters.LongConverter;
import fish.payara.nucleus.microprofile.config.converters.OptionalDoubleConverter;
import fish.payara.nucleus.microprofile.config.converters.OptionalIntConverter;
import fish.payara.nucleus.microprofile.config.converters.OptionalLongConverter;
import fish.payara.nucleus.microprofile.config.converters.ShortConverter;
import fish.payara.nucleus.microprofile.config.converters.StringConverter;
import fish.payara.nucleus.microprofile.config.source.JDBCConfigSource;
import fish.payara.nucleus.microprofile.config.source.ApplicationConfigSource;
import fish.payara.nucleus.microprofile.config.source.ClusterConfigSource;
import fish.payara.nucleus.microprofile.config.source.ConfigConfigSource;
import fish.payara.nucleus.microprofile.config.source.DomainConfigSource;
import fish.payara.nucleus.microprofile.config.source.EnvironmentConfigSource;
import fish.payara.nucleus.microprofile.config.source.JNDIConfigSource;
import fish.payara.nucleus.microprofile.config.source.ModuleConfigSource;
import fish.payara.nucleus.microprofile.config.source.PasswordAliasConfigSource;
import fish.payara.nucleus.microprofile.config.source.PayaraExpressionConfigSource;
import fish.payara.nucleus.microprofile.config.source.PayaraServerProperties;
import fish.payara.nucleus.microprofile.config.source.PropertiesConfigSource;
import fish.payara.nucleus.microprofile.config.source.DirConfigSource;
import fish.payara.nucleus.microprofile.config.source.ServerConfigSource;
import fish.payara.nucleus.microprofile.config.source.SystemPropertyConfigSource;
import fish.payara.nucleus.microprofile.config.source.extension.ExtensionConfigSourceService;
import org.glassfish.api.event.EventListener;
import org.glassfish.api.event.EventTypes;
import org.glassfish.api.event.Events;
/**
* This Service implements the Microprofile Config API and provides integration
* into the guts of Payara Server.
*
* @author Steve Millidge (Payara Foundation)
*/
@Service(name = "microprofile-config-provider")
@ContractsProvided({ConfigProviderResolver.class, ConfigProviderResolverImpl.class})
@RunLevel(StartupRunLevel.IMPLICITLY_RELIED_ON)
public class ConfigProviderResolverImpl extends ConfigProviderResolver implements EventListener {
private static final Logger LOG = Logger.getLogger(ConfigProviderResolverImpl.class.getName());
private static final String METADATA_KEY = "MICROPROFILE_APP_CONFIG";
private static final String CUSTOM_SOURCES_KEY = "MICROPROFILE_CUSTOM_SOURCES";
private static final String CUSTOM_CONVERTERS_KEY = "MICROPROFILE_CUSTOM_CONVERTERS";
private final static String APP_METADATA_KEY = "payara.microprofile.config";
private final static String APP_EXPRESSION_METADATA_KEY = "payara.microprofile.config.expression";
@Inject
private InvocationManager invocationManager;
@Inject
private ServerContext context;
// Some sources might want to execute background tasks in a controlled fashion
@Inject
private PayaraExecutorService executorService;
// Gives access to deployed applications
@Inject
private ApplicationRegistry applicationRegistry;
// This injects the configuration from the domain.xml magically
// and for the correct server configuation
@Inject
@Named(ServerEnvironment.DEFAULT_INSTANCE_NAME)
@Optional // PAYARA-2255 make optional due to race condition writing a missing entry into domain.xml
private MicroprofileConfigConfiguration configuration;
// a config used at the server level when there is no application associated with the thread
private PayaraConfig serverLevelConfig;
@Inject
private ExtensionConfigSourceService extensionService;
@Inject
private Events events;
/**
* Logs constructor as finest - may be useful to watch sequence of operations.
*/
public ConfigProviderResolverImpl() {
LOG.finest("ConfigProviderResolverImpl()");
}
/**
* Sets the global {@link ConfigProviderResolver#instance()} to this instance.
*/
@PostConstruct
public void postConstruct() {
// the setInstance is not synchronized, but instance() method body is.
// this will block possible concurrent access.
synchronized (ConfigProviderResolver.class) {
LOG.log(Level.CONFIG, "Setting global ConfigProviderResolver instance to {0}", this);
ConfigProviderResolver.setInstance(this);
}
// Register an event listener
if (events != null) {
events.register(this);
}
}
public MicroprofileConfigConfiguration getMPConfig() {
if (configuration == null) {
LOG.config("getMPConfig() - initialization of the configuration field (not set by @Inject annotation).");
configuration = context.getConfigBean().getConfig().getExtensionByType(MicroprofileConfigConfiguration.class);
}
return configuration;
}
long getCacheDurationSeconds() {
if (serverLevelConfig != null) {
return serverLevelConfig.getCacheDurationMilliSeconds() / 1_000;
}
return Integer.parseInt(getMPConfig().getCacheDurationSeconds());
}
@Override
public Config getConfig() {
return getConfig(Thread.currentThread().getContextClassLoader());
}
ApplicationInfo getAppInfo(ClassLoader loader) {
ApplicationInfo appInfo = null;
// fast check against current app
ComponentInvocation currentInvocation = invocationManager.getCurrentInvocation();
if (currentInvocation == null) {
// OK we are not a normal request see if we can find the app name from the
// app registry via the classloader
Set allApplicationNames = applicationRegistry.getAllApplicationNames();
for (String allApplicationName : allApplicationNames) {
ApplicationInfo testInfo = applicationRegistry.get(allApplicationName);
if (loader.equals(testInfo.getAppClassLoader())) {
appInfo = testInfo;
return appInfo;
} else {
// search the modules within the app info to see if they have the classloader
for (ModuleInfo mi : testInfo.getModuleInfos()) {
if (loader.equals(mi.getModuleClassLoader())) {
return testInfo;
}
}
}
}
} else {
String appName = currentInvocation.getAppName();
appInfo = applicationRegistry.get(appName);
}
if (appInfo != null && loader.equals(appInfo.getAppClassLoader())) {
return appInfo;
}
// search the modules
if (appInfo != null) {
for (ModuleInfo mInfo : appInfo.getModuleInfos()) {
if (loader.equals(mInfo.getModuleClassLoader())) {
return appInfo;
}
}
}
// fast check fails search the app registry
for (String name : applicationRegistry.getAllApplicationNames()) {
ApplicationInfo testInfo = applicationRegistry.get(name);
if (testInfo.getClassLoaders().contains(loader) ||
// when loading an application, no class loader is assigned
(testInfo.getAppClassLoader() != null && testInfo.getAppClassLoader().equals(loader))) {
return testInfo;
}
}
return appInfo;
}
Config getConfig(ApplicationInfo appInfo) {
LOG.log(Level.FINEST, "getConfig(appInfo={0})", appInfo);
Config result;
// manage server level config first
if (appInfo == null) {
result = serverLevelConfig;
if (result == null) {
LinkedList sources = new LinkedList<>();
Map, Converter> converters = new HashMap<>();
sources.addAll(getDefaultSources());
sources.addAll(extensionService.getExtensionSources());
converters.putAll(getDefaultConverters());
serverLevelConfig = new PayaraConfig(sources, converters, TimeUnit.SECONDS.toMillis(getCacheDurationSeconds()));
result = serverLevelConfig;
}
} else { // look for an application specific one
result = appInfo.getTransientAppMetaData(METADATA_KEY, Config.class);
if (result == null) {
// build an application specific configuration
initialiseApplicationConfig(appInfo);
LinkedList sources = new LinkedList<>();
Map, Converter> converters = new HashMap<>();
sources.addAll(getDefaultSources(appInfo));
sources.addAll(extensionService.getExtensionSources());
sources.addAll(getDiscoveredSources(appInfo));
converters.putAll(getDefaultConverters());
converters.putAll(getDiscoveredConverters(appInfo));
PayaraConfig appresult = new PayaraConfig(sources, converters, TimeUnit.SECONDS.toMillis(getCacheDurationSeconds()));
addProfileSource(appresult, appInfo.getAppClassLoader());
result = appresult;
appInfo.addTransientAppMetaData(METADATA_KEY, result);
}
}
return result;
}
@Override
public Config getConfig(ClassLoader loader) {
return getConfig(getAppInfo(loader));
}
@Override
public ConfigBuilder getBuilder() {
return new PayaraConfigBuilder(this);
}
public PayaraExecutorService getExecutor() {
return this.executorService;
}
Config getNamedConfig(String applicationName) {
Config result = null;
ApplicationInfo info = applicationRegistry.get(applicationName);
if (info != null) {
result = info.getTransientAppMetaData(METADATA_KEY, Config.class);
if (result == null) {
// rebuild it from scratch
result = getConfig(info);
}
}
return result;
}
private List getDefaultSources(String appName, String moduleName) {
LinkedList sources = new LinkedList<>();
String serverName = context.getInstanceName();
String configName = context.getConfigBean().getConfig().getName();
sources.add(new DomainConfigSource());
sources.add(new ClusterConfigSource());
sources.add(new ConfigConfigSource(configName));
sources.add(new ServerConfigSource(serverName));
sources.add(new EnvironmentConfigSource());
sources.add(new SystemPropertyConfigSource());
sources.add(new JNDIConfigSource());
sources.add(new PayaraServerProperties());
sources.add(new DirConfigSource());
sources.add(new PasswordAliasConfigSource());
sources.add(new JDBCConfigSource());
if (appName != null) {
sources.add(new ApplicationConfigSource(appName));
sources.add(new ModuleConfigSource(appName, moduleName));
for (Properties props : getDeployedApplicationProperties(appName)) {
sources.add(new PropertiesConfigSource(props));
}
for (Properties props : getDeployedApplicationPayaraExpressionConfigProperties(appName)) {
sources.add(new PayaraExpressionConfigSource(props));
}
}
return sources;
}
List getDefaultSources() {
return getDefaultSources(null);
}
private List getDefaultSources(ApplicationInfo appInfo) {
String appName = null;
String moduleName = null;
ComponentInvocation currentInvocation = invocationManager.getCurrentInvocation();
if (currentInvocation == null) {
if (appInfo == null) {
appInfo = getAppInfo(Thread.currentThread().getContextClassLoader());
}
if (appInfo != null) {
appName = appInfo.getName();
moduleName = appName;
}
} else {
appName = currentInvocation.getAppName();
moduleName = currentInvocation.getModuleName();
}
return getDefaultSources(appName, moduleName);
}
@Override
public void registerConfig(Config config, ClassLoader classLoader) {
ApplicationInfo appInfo = getAppInfo(classLoader);
appInfo.addTransientAppMetaData(METADATA_KEY, config);
}
@Override
public void releaseConfig(Config config) {
ApplicationInfo appInfo = getAppInfo(Thread.currentThread().getContextClassLoader());
appInfo.removeTransientAppMetaData(METADATA_KEY);
}
public List getDeployedApplicationProperties(String applicationName) {
ApplicationInfo info = applicationRegistry.get(applicationName);
List result = Collections.emptyList();
if (info != null) {
List transientAppMetaData = info.getTransientAppMetaData(APP_METADATA_KEY, LinkedList.class);
if (transientAppMetaData != null) {
result = transientAppMetaData;
}
}
return result;
}
public String getDeployedApplicationProperty(String applicationName, String name) {
String result = null;
ApplicationInfo info = applicationRegistry.get(applicationName);
if (info != null) {
LinkedList metadata = info.getTransientAppMetaData(APP_METADATA_KEY, LinkedList.class);
if (metadata != null) {
for (Properties properties : metadata) {
result = properties.getProperty(name);
if (result != null) {
break;
}
}
}
}
return result;
}
public List getDeployedApplicationPayaraExpressionConfigProperties(String applicationName) {
ApplicationInfo info = applicationRegistry.get(applicationName);
List result = Collections.emptyList();
if (info != null) {
List transientAppMetaData = info.getTransientAppMetaData(APP_EXPRESSION_METADATA_KEY, LinkedList.class);
if (transientAppMetaData != null) {
result = transientAppMetaData;
}
}
return result;
}
List getDiscoveredSources(ApplicationInfo appInfo) {
LinkedList sources = appInfo.getTransientAppMetaData(CUSTOM_SOURCES_KEY, LinkedList.class);
if (sources == null) {
sources = new LinkedList<>();
// resolve custom config sources
ServiceLoader serviceLoader = ServiceLoader.load(ConfigSource.class, appInfo.getAppClassLoader());
for (ConfigSource configSource : serviceLoader) {
sources.add(configSource);
}
//
ServiceLoader serviceProvideLoader = ServiceLoader.load(ConfigSourceProvider.class, appInfo.getAppClassLoader());
for (ConfigSourceProvider configSourceProvider : serviceProvideLoader) {
Iterable configSources = configSourceProvider.getConfigSources(appInfo.getAppClassLoader());
for (ConfigSource configSource : configSources) {
sources.add(configSource);
}
}
appInfo.addTransientAppMetaData(CUSTOM_SOURCES_KEY, sources);
}
return sources;
}
Map,Converter> getDefaultConverters() {
Map,Converter> result = new HashMap<>();
result.put(Boolean.class, new BooleanConverter());
result.put(Byte.class, new ByteConverter());
result.put(Integer.class, new IntegerConverter());
result.put(Long.class, new LongConverter());
result.put(Float.class, new FloatConverter());
result.put(Double.class, new DoubleConverter());
result.put(InetAddress.class, new InetAddressConverter());
result.put(Class.class, new ClassConverter());
result.put(String.class, new StringConverter());
result.put(Character.class, new CharacterConverter());
result.put(Short.class, new ShortConverter());
result.put(OptionalInt.class, new OptionalIntConverter());
result.put(OptionalDouble.class, new OptionalDoubleConverter());
result.put(OptionalLong.class, new OptionalLongConverter());
return result;
}
Map, Converter> getDiscoveredConverters(ApplicationInfo appInfo) {
Map, Converter> converters = appInfo.getTransientAppMetaData(CUSTOM_CONVERTERS_KEY, Map.class);
if (converters == null) {
converters = new HashMap<>();
// resolve custom config sources
ServiceLoader serviceLoader = ServiceLoader.load(Converter.class, appInfo.getAppClassLoader());
for (Converter converter : serviceLoader) {
Class type = getTypeForConverter(converter);
if (type != null) {
converters.put(type,converter);
}
}
appInfo.addTransientAppMetaData(CUSTOM_CONVERTERS_KEY, converters);
}
return converters;
}
private static void initialiseApplicationConfig(ApplicationInfo info) {
LinkedList appConfigProperties = new LinkedList<>();
info.addTransientAppMetaData(APP_METADATA_KEY, appConfigProperties);
try {
// Read application defined properties and add as transient metadata
appConfigProperties.addAll(getPropertiesFromFile(info.getAppClassLoader(), "META-INF/microprofile-config.properties"));
appConfigProperties.addAll(getPropertiesFromFile(info.getAppClassLoader(), "../../META-INF/microprofile-config.properties"));
} catch (IOException ex) {
LOG.log(Level.SEVERE, null, ex);
}
LinkedList appPayaraExpressionConfigProperties = new LinkedList<>();
info.addTransientAppMetaData(APP_EXPRESSION_METADATA_KEY, appPayaraExpressionConfigProperties);
try {
// Read application defined expression properties and add as transient metadata
appPayaraExpressionConfigProperties.addAll(getPropertiesFromFile(info.getAppClassLoader(), "META-INF/payara-expression-config.properties"));
appPayaraExpressionConfigProperties.addAll(getPropertiesFromFile(info.getAppClassLoader(), "../../META-INF/payara-expression-config.properties"));
} catch (IOException ex) {
LOG.log(Level.SEVERE, null, ex);
}
}
private static List getPropertiesFromFile(ClassLoader appClassLoader, String fileName) throws IOException {
List props = new ArrayList<>();
// Read application defined properties and add as transient metadata
Enumeration resources = appClassLoader.getResources(fileName);
while (resources.hasMoreElements()) {
URL url = resources.nextElement();
Properties p = new Properties();
try (InputStream is = url.openStream()) {
p.load(is);
}
props.add(p);
}
return props;
}
private static void addProfileSource(PayaraConfig config, ClassLoader appClassLoader) {
String profile = config.getProfile();
if (profile == null) {
return;
}
ArrayList appConfigProperties = new ArrayList<>();
try {
appConfigProperties.addAll(getPropertiesFromFile(appClassLoader, "META-INF/microprofile-config-" + profile + ".properties"));
appConfigProperties.addAll(getPropertiesFromFile(appClassLoader, "../../META-INF/microprofile-config-" + profile + ".properties"));
for (Properties props : appConfigProperties) {
props.putIfAbsent("config_ordinal", "101");
PropertiesConfigSource configSource = new PropertiesConfigSource(props);
config.addConfigSource(configSource);
}
} catch (IOException ex) {
LOG.log(Level.SEVERE, null, ex);
}
}
@Override
public void event(Event event) {
if (event.is(EventTypes.SERVER_STARTUP)) {
if (serverLevelConfig != null) {
serverLevelConfig.clearCache();
}
for (String appName : applicationRegistry.getAllApplicationNames()) {
PayaraConfig appConfig = applicationRegistry.get(appName).getTransientAppMetaData(METADATA_KEY, PayaraConfig.class);
//Server will have already populated cache in deployment before this point,
//cache needs clearing as config extensions have not yet been loaded and may have values
if (appConfig != null) {
appConfig.clearCache();
}
}
}
}
}