/* * Copyright 2017 Graz University of Technology EAAF-Core Components has been developed in a * cooperation between EGIZ, A-SIT Plus, A-SIT, and Graz University of Technology. * * Licensed under the EUPL, Version 1.2 or - as soon they will be approved by the European * Commission - subsequent versions of the EUPL (the "Licence"); You may not use this work except in * compliance with the Licence. You may obtain a copy of the Licence at: * https://joinup.ec.europa.eu/news/understanding-eupl-v12 * * Unless required by applicable law or agreed to in writing, software distributed under the Licence * is distributed on an "AS IS" basis, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express * or implied. See the Licence for the specific language governing permissions and limitations under * the Licence. * * This product combines work with different licenses. See the "NOTICE" text file for details on the * various modules and licenses. The "NOTICE" text file is part of the distribution. Any derivative * works that you distribute must include a readable copy of the "NOTICE" text file. */ package at.gv.egiz.eaaf.core.impl.idp.conf; import java.net.URI; import java.net.URISyntaxException; import java.util.Arrays; import java.util.HashMap; import java.util.Map; import java.util.Map.Entry; import javax.annotation.PostConstruct; import org.apache.commons.lang3.StringUtils; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.core.env.CompositePropertySource; import org.springframework.core.env.ConfigurableEnvironment; import org.springframework.core.env.EnumerablePropertySource; import org.springframework.core.env.Environment; import org.springframework.core.env.PropertySource; import at.gv.egiz.eaaf.core.api.idp.IConfigurationWithSP; import at.gv.egiz.eaaf.core.exceptions.EaafConfigurationException; import at.gv.egiz.eaaf.core.impl.utils.KeyValueUtils; public abstract class AbstractSpringBootConfigurationImpl implements IConfigurationWithSP { private static final Logger log = LoggerFactory.getLogger(AbstractSpringBootConfigurationImpl.class); @Autowired private Environment env; public static final String PROP_CONFIG_ROOT_DIR = "core.configRootDir"; @PostConstruct private void initialize() throws EaafConfigurationException { if (getConfigurationRootDirectory() == null) { throw new EaafConfigurationException("config.08", new Object[] { addPrefixToKey( PROP_CONFIG_ROOT_DIR) }); } } @Override public String getBasicConfiguration(final String key) { if (StringUtils.isNotEmpty(key)) { final String value = env.getProperty(addPrefixToKey(key)); if (value != null) { return value.trim(); } } return null; } @Override public String getBasicConfiguration(final String key, final String defaultValue) { if (StringUtils.isNotEmpty(key)) { final String value = env.getProperty(addPrefixToKey(key), defaultValue); if (value != null) { return value.trim(); } } return defaultValue; } @Override public Map getBasicConfigurationWithPrefix(final String prefix) { final Map configProps = getPropertiesStartingWith((ConfigurableEnvironment) env, addPrefixToKey(prefix)); return KeyValueUtils.removePrefixFromKeys(configProps, addPrefixToKey(prefix) + "."); } @Override public boolean getBasicConfigurationBoolean(final String key) { return getBasicConfigurationBoolean(key, false); } @Override public boolean getBasicConfigurationBoolean(final String key, final boolean defaultValue) { final String value = getBasicConfiguration(key); if (StringUtils.isNotEmpty(value)) { return Boolean.valueOf(value.trim()); } else { return defaultValue; } } @Override public URI getConfigurationRootDirectory() { try { return new URI(env.getRequiredProperty(addPrefixToKey(PROP_CONFIG_ROOT_DIR))); } catch (IllegalStateException | URISyntaxException e) { log.warn("ConfigRootDirectory is NOT set", e); return null; } } /** * Get the path to backup configuration. * * @return A filepath file: or a classpath classpath: */ protected abstract String getBackupConfigPath(); /** * Get a specific configuration-key prefix for this software implementation. * * @return */ public abstract String getApplicationSpecificKeyPrefix(); private String addPrefixToKey(final String key) { if (StringUtils.isNotEmpty(getApplicationSpecificKeyPrefix())) { if (getApplicationSpecificKeyPrefix().endsWith(KeyValueUtils.KEY_DELIMITER)) { return getApplicationSpecificKeyPrefix() + key; } else { return getApplicationSpecificKeyPrefix() + KeyValueUtils.KEY_DELIMITER + key; } } return key; } private static Map getPropertiesStartingWith(final ConfigurableEnvironment aenv, final String akeyPrefix) { final Map result = new HashMap<>(); final Map map = getAllProperties(aenv); for (final Entry entry : map.entrySet()) { final String key = entry.getKey(); if (key.startsWith(akeyPrefix)) { result.put(key, (String) entry.getValue()); } } return result; } private static Map getAllProperties(final ConfigurableEnvironment aenv) { final Map result = new HashMap<>(); aenv.getPropertySources().forEach(ps -> addAll(result, getAllProperties(ps))); return result; } private static Map getAllProperties(final PropertySource apropSource) { final Map result = new HashMap<>(); if (apropSource instanceof CompositePropertySource) { final CompositePropertySource cps = (CompositePropertySource) apropSource; cps.getPropertySources().forEach(ps -> addAll(result, getAllProperties(ps))); return result; } if (apropSource instanceof EnumerablePropertySource) { final EnumerablePropertySource ps = (EnumerablePropertySource) apropSource; Arrays.asList(ps.getPropertyNames()).forEach(key -> result.put(key, ps.getProperty(key))); return result; } // note: Most descendants of PropertySource are EnumerablePropertySource. There // are some // few others like JndiPropertySource or StubPropertySource log.trace("Given PropertySource is instanceof " + apropSource.getClass().getName() + " and cannot be iterated"); return result; } private static void addAll(final Map abase, final Map atoBeAdded) { for (final Entry entry : atoBeAdded.entrySet()) { if (abase.containsKey(entry.getKey())) { continue; } abase.put(entry.getKey(), entry.getValue()); } } }