diff options
Diffstat (limited to 'dcae-analytics/dcae-analytics-web/src/main/java/org/onap/dcae/analytics/web/spring')
2 files changed, 243 insertions, 0 deletions
diff --git a/dcae-analytics/dcae-analytics-web/src/main/java/org/onap/dcae/analytics/web/spring/ConfigBindingServiceEnvironmentPostProcessor.java b/dcae-analytics/dcae-analytics-web/src/main/java/org/onap/dcae/analytics/web/spring/ConfigBindingServiceEnvironmentPostProcessor.java new file mode 100644 index 0000000..2073127 --- /dev/null +++ b/dcae-analytics/dcae-analytics-web/src/main/java/org/onap/dcae/analytics/web/spring/ConfigBindingServiceEnvironmentPostProcessor.java @@ -0,0 +1,148 @@ +/* + * ================================================================================ + * Copyright (c) 2018 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + * + */ + +package org.onap.dcae.analytics.web.spring; + +import java.util.Arrays; +import java.util.Collections; +import java.util.Map; +import java.util.Optional; +import java.util.Set; +import java.util.stream.Collectors; + +import org.onap.dcae.analytics.model.AnalyticsProfile; +import org.onap.dcae.analytics.model.configbindingservice.ConfigBindingServiceConstants; +import org.onap.dcae.analytics.model.util.function.JsonStringToMapFunction; +import org.onap.dcae.analytics.model.util.supplier.ConfigBindingServiceJsonSupplier; +import org.onap.dcae.analytics.web.exception.AnalyticsValidationException; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.boot.SpringApplication; +import org.springframework.boot.env.EnvironmentPostProcessor; +import org.springframework.core.Ordered; +import org.springframework.core.env.ConfigurableEnvironment; +import org.springframework.core.env.MapPropertySource; +import org.springframework.core.env.MutablePropertySources; +import org.springframework.core.env.PropertySource; +import org.springframework.core.env.StandardEnvironment; +import org.springframework.util.ClassUtils; +import org.springframework.web.context.support.StandardServletEnvironment; + +/** + * A custom spring framework environment post processor which can fetch and populate spring context with + * Config Binding Service application properties. + * <p> + * Activated only when config binding service profile is active. + * + * @author Rajiv Singla + */ +public class ConfigBindingServiceEnvironmentPostProcessor implements EnvironmentPostProcessor, Ordered { + + private static final Logger logger = LoggerFactory.getLogger(ConfigBindingServiceEnvironmentPostProcessor.class); + private static final String SERVLET_ENVIRONMENT_CLASS = + "org.springframework.web.context.support.StandardServletEnvironment"; + + private static final int DEFAULT_ORDER = Ordered.HIGHEST_PRECEDENCE; + + @Override + public void postProcessEnvironment(final ConfigurableEnvironment environment, final SpringApplication application) { + + final boolean isConfigServiceProfilePresent = Arrays.stream(environment.getActiveProfiles()) + .anyMatch(p -> p.equalsIgnoreCase(AnalyticsProfile.CONFIG_BINDING_SERVICE_PROFILE_NAME)); + + if (!isConfigServiceProfilePresent) { + logger.info("Config Binding Service Profile is not active. " + + "Skipping Adding config binding service properties"); + return; + } + + logger.info("Config Binding Service Profile is active. " + + "Application properties will be fetched from config binding service"); + + // Fetch config binding service json + final Optional<String> configServiceJsonOptional = new ConfigBindingServiceJsonSupplier().get(); + + if (!configServiceJsonOptional.isPresent()) { + final String errorMessage = "Unable to get fetch application configuration from config binding service"; + throw new AnalyticsValidationException(errorMessage, new IllegalStateException(errorMessage)); + } + + final String configServicePropertiesKey = ConfigBindingServiceConstants.CONFIG_BINDING_SERVICE_PROPERTIES_KEY; + + // convert fetch config binding service json string to Map of property key and values + final Map<String, Object> configPropertiesMap = configServiceJsonOptional + .map(new JsonStringToMapFunction(configServicePropertiesKey)) + .orElse(Collections.emptyMap()); + + if (configPropertiesMap.isEmpty()) { + + logger.warn("No properties found in config binding service"); + + } else { + + // remove config service key prefix on spring reserved property key prefixes + final Set<String> springKeyPrefixes = ConfigBindingServiceConstants.SPRING_RESERVED_PROPERTIES_KEY_PREFIXES; + final Set<String> springKeys = springKeyPrefixes.stream() + .map(springKeyPrefix -> configServicePropertiesKey + "." + springKeyPrefix) + .collect(Collectors.toSet()); + + final Map<String, Object> filterKeyMap = configPropertiesMap.entrySet() + .stream() + .collect(Collectors.toMap( + (Map.Entry<String, Object> e) -> + springKeys.stream().anyMatch(springKey -> e.getKey().startsWith(springKey)) ? + e.getKey().substring(configServicePropertiesKey.toCharArray().length + 1) : + e.getKey(), + Map.Entry::getValue) + ); + + filterKeyMap.forEach((key, value) -> + logger.info("Adding property from config service in spring context: {} -> {}", key, value)); + + addJsonPropertySource(environment, new MapPropertySource(configServicePropertiesKey, filterKeyMap)); + } + + } + + @Override + public int getOrder() { + return DEFAULT_ORDER; + } + + + private void addJsonPropertySource(final ConfigurableEnvironment environment, final PropertySource<?> source) { + final MutablePropertySources sources = environment.getPropertySources(); + final String name = findPropertySource(sources); + if (sources.contains(name)) { + sources.addBefore(name, source); + } else { + sources.addFirst(source); + } + } + + private String findPropertySource(final MutablePropertySources sources) { + if (ClassUtils.isPresent(SERVLET_ENVIRONMENT_CLASS, null) && + sources.contains(StandardServletEnvironment.JNDI_PROPERTY_SOURCE_NAME)) { + return StandardServletEnvironment.JNDI_PROPERTY_SOURCE_NAME; + + } + return StandardEnvironment.SYSTEM_PROPERTIES_PROPERTY_SOURCE_NAME; + } + +} diff --git a/dcae-analytics/dcae-analytics-web/src/main/java/org/onap/dcae/analytics/web/spring/MongoAutoConfigurationPostProcessor.java b/dcae-analytics/dcae-analytics-web/src/main/java/org/onap/dcae/analytics/web/spring/MongoAutoConfigurationPostProcessor.java new file mode 100644 index 0000000..94f877e --- /dev/null +++ b/dcae-analytics/dcae-analytics-web/src/main/java/org/onap/dcae/analytics/web/spring/MongoAutoConfigurationPostProcessor.java @@ -0,0 +1,95 @@ +/* + * ================================================================================ + * Copyright (c) 2018 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + * + */ + +package org.onap.dcae.analytics.web.spring; + +import java.util.Arrays; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +import org.onap.dcae.analytics.model.AnalyticsProfile; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.boot.SpringApplication; +import org.springframework.boot.env.EnvironmentPostProcessor; +import org.springframework.core.Ordered; +import org.springframework.core.env.ConfigurableEnvironment; +import org.springframework.core.env.MapPropertySource; +import org.springframework.core.env.MutablePropertySources; +import org.springframework.core.env.PropertySource; + +/** + * Disables mongo auto configuration if {@link AnalyticsProfile#MONGO_PROFILE_NAME} is not present + * + * @author Rajiv Singla + */ +public class MongoAutoConfigurationPostProcessor implements EnvironmentPostProcessor, Ordered { + + private static final Logger logger = LoggerFactory.getLogger(MongoAutoConfigurationPostProcessor.class); + + private static final String PROPERTY_SOURCE_NAME = "defaultProperties"; + private static final String SPRING_AUTO_CONFIG_EXCLUDE_PROPERTY_KEY = "spring.autoconfigure.exclude"; + private static final List<String> MONGO_AUTO_CONFIG_PROPERTIES = Arrays.asList( + "org.springframework.boot.autoconfigure.mongo.MongoAutoConfiguration", + "org.springframework.boot.autoconfigure.data.mongo.MongoDataAutoConfiguration", + "org.springframework.boot.autoconfigure.data.mongo.MongoRepositoriesAutoConfiguration"); + + @Override + public void postProcessEnvironment(final ConfigurableEnvironment environment, final SpringApplication application) { + + final boolean isMongoProfileActive = Arrays.stream(environment.getActiveProfiles()) + .anyMatch(profile -> profile.equalsIgnoreCase(AnalyticsProfile.MONGO_PROFILE_NAME)); + + // if mongo profile is not active disable mongo auto configuration + if (!isMongoProfileActive) { + logger.info("Mongo Profile is not active - disabling Mongo Auto Configuration"); + final Map<String, Object> mongoExcludePropsMap = new HashMap<>(); + mongoExcludePropsMap.put(SPRING_AUTO_CONFIG_EXCLUDE_PROPERTY_KEY, MONGO_AUTO_CONFIG_PROPERTIES); + addMongoPropertiesIfAbsent(environment.getPropertySources(), mongoExcludePropsMap); + } + } + + private void addMongoPropertiesIfAbsent(final MutablePropertySources propertySources, + final Map<String, Object> mongoPropertiesMap) { + MapPropertySource target = null; + if (propertySources.contains(PROPERTY_SOURCE_NAME)) { + PropertySource<?> source = propertySources.get(PROPERTY_SOURCE_NAME); + if (source instanceof MapPropertySource) { + target = (MapPropertySource) source; + for (final Map.Entry<String, Object> entry : mongoPropertiesMap.entrySet()) { + if (!target.containsProperty(entry.getKey())) { + target.getSource().putIfAbsent(entry.getKey(), entry.getValue()); + } + } + } + } + if (target == null) { + target = new MapPropertySource(PROPERTY_SOURCE_NAME, mongoPropertiesMap); + } + if (!propertySources.contains(PROPERTY_SOURCE_NAME)) { + propertySources.addLast(target); + } + } + + @Override + public int getOrder() { + return Ordered.LOWEST_PRECEDENCE; + } +} |