gerrit.onap Code Review - ccsdk/oran.git/blob

   1 /*-
   2  * ========================LICENSE_START=================================
   3  * ONAP : ccsdk oran
   4  * ======================================================================
   5  * Copyright (C) 2019-2020 Nordix Foundation. All rights reserved.
   6  * ======================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ========================LICENSE_END===================================
  19  */
  20
  21 package org.onap.ccsdk.oran.a1policymanagementservice.tasks;
  22
  23 import com.google.gson.JsonObject;
  24
  25 import java.time.Duration;
  26 import java.util.Optional;
  27 import java.util.Properties;
  28
  29 import lombok.AccessLevel;
  30 import lombok.Getter;
  31
  32 import org.onap.ccsdk.oran.a1policymanagementservice.clients.A1ClientFactory;
  33 import org.onap.ccsdk.oran.a1policymanagementservice.clients.AsyncRestClientFactory;
  34 import org.onap.ccsdk.oran.a1policymanagementservice.clients.SecurityContext;
  35 import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ApplicationConfig;
  36 import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ApplicationConfig.RicConfigUpdate;
  37 import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ApplicationConfigParser;
  38 import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ConfigurationFile;
  39 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Policies;
  40 import org.onap.ccsdk.oran.a1policymanagementservice.repository.PolicyTypes;
  41 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Ric;
  42 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Rics;
  43 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Services;
  44 import org.slf4j.Logger;
  45 import org.slf4j.LoggerFactory;
  46 import org.springframework.beans.factory.annotation.Autowired;
  47 import org.springframework.beans.factory.annotation.Value;
  48 import org.springframework.stereotype.Component;
  49
  50 import reactor.core.Disposable;
  51 import reactor.core.publisher.Flux;
  52 import reactor.core.publisher.Mono;
  53 import reactor.util.annotation.Nullable;
  54
  55 /**
  56  * Regularly refreshes the component configuration from a configuration file.
  57  */
  58 @Component
  59 @SuppressWarnings("squid:S2629") // Invoke method(s) only conditionally
  60 public class RefreshConfigTask {
  61
  62     private static final Logger logger = LoggerFactory.getLogger(RefreshConfigTask.class);
  63
  64     @Value("#{systemEnvironment}")
  65     public Properties systemEnvironment;
  66
  67     /**
  68      * The time between refreshes of the configuration. Not final so tests can
  69      * modify it.
  70      */
  71     private static Duration configRefreshInterval = Duration.ofMinutes(1);
  72
  73     final ConfigurationFile configurationFile;
  74     final ApplicationConfig appConfig;
  75
  76     @Getter(AccessLevel.PROTECTED)
  77     private Disposable refreshTask = null;
  78
  79     private final Rics rics;
  80     private final A1ClientFactory a1ClientFactory;
  81     private final Policies policies;
  82     private final Services services;
  83     private final PolicyTypes policyTypes;
  84     private final AsyncRestClientFactory restClientFactory;
  85
  86     private long fileLastModified = 0;
  87
  88     @Autowired
  89     public RefreshConfigTask(ConfigurationFile configurationFile, ApplicationConfig appConfig, Rics rics,
  90             Policies policies, Services services, PolicyTypes policyTypes, A1ClientFactory a1ClientFactory,
  91             SecurityContext securityContext) {
  92         this.configurationFile = configurationFile;
  93         this.appConfig = appConfig;
  94         this.rics = rics;
  95         this.policies = policies;
  96         this.services = services;
  97         this.policyTypes = policyTypes;
  98         this.a1ClientFactory = a1ClientFactory;
  99         this.restClientFactory = new AsyncRestClientFactory(appConfig.getWebClientConfig(), securityContext);
 100     }
 101
 102     public void start() {
 103         logger.debug("Starting refreshConfigTask");
 104         stop();
 105         refreshTask = createRefreshTask() //
 106                 .subscribe(
 107                         notUsed -> logger.debug("Refreshed configuration data"), throwable -> logger
 108                                 .error("Configuration refresh terminated due to exception {}", throwable.toString()),
 109                         () -> logger.error("Configuration refresh terminated"));
 110     }
 111
 112     public void stop() {
 113         if (refreshTask != null) {
 114             refreshTask.dispose();
 115         }
 116     }
 117
 118     Flux<RicConfigUpdate.Type> createRefreshTask() {
 119         Flux<JsonObject> loadFromFile = regularInterval() //
 120                 .flatMap(notUsed -> loadConfigurationFromFile()) //
 121                 .onErrorResume(this::ignoreErrorFlux) //
 122                 .doOnNext(json -> logger.debug("loadFromFile succeeded")) //
 123                 .doOnTerminate(() -> logger.error("loadFromFile Terminate"));
 124
 125         final int CONCURRENCY = 50; // Number of RIC synched in paralell
 126
 127         return loadFromFile //
 128                 .flatMap(this::parseConfiguration) //
 129                 .flatMap(this::updateConfig, CONCURRENCY) //
 130                 .flatMap(this::handleUpdatedRicConfig) //
 131                 .doFinally(signal -> logger.error("Configuration refresh task is terminated: {}", signal));
 132     }
 133
 134     private Flux<Long> regularInterval() {
 135         return Flux.interval(Duration.ZERO, configRefreshInterval) //
 136                 .onBackpressureDrop() //
 137                 .limitRate(1); // Limit so that only one event is emitted at a time
 138     }
 139
 140     private <R> Flux<R> ignoreErrorFlux(Throwable throwable) {
 141         String errMsg = throwable.toString();
 142         logger.warn("Could not refresh application configuration. {}", errMsg);
 143         return Flux.empty();
 144     }
 145
 146     private Mono<ApplicationConfigParser.ConfigParserResult> parseConfiguration(JsonObject jsonObject) {
 147         try {
 148             ApplicationConfigParser parser = new ApplicationConfigParser(this.appConfig);
 149             return Mono.just(parser.parse(jsonObject));
 150         } catch (Exception e) {
 151             String str = e.toString();
 152             logger.error("Could not parse configuration {}", str);
 153             return Mono.empty();
 154         }
 155     }
 156
 157     private Flux<RicConfigUpdate> updateConfig(ApplicationConfigParser.ConfigParserResult config) {
 158         return this.appConfig.setConfiguration(config);
 159     }
 160
 161     private void removePoliciciesInRic(@Nullable Ric ric) {
 162         if (ric != null) {
 163             synchronizationTask().run(ric);
 164         }
 165     }
 166
 167     private RicSynchronizationTask synchronizationTask() {
 168         return new RicSynchronizationTask(a1ClientFactory, policyTypes, policies, services, restClientFactory, rics);
 169     }
 170
 171     public Mono<RicConfigUpdate.Type> handleUpdatedRicConfig(RicConfigUpdate updatedInfo) {
 172         synchronized (this.rics) {
 173             String ricId = updatedInfo.getRicConfig().getRicId();
 174             RicConfigUpdate.Type event = updatedInfo.getType();
 175             if (event == RicConfigUpdate.Type.ADDED) {
 176                 logger.debug("RIC added {}", ricId);
 177                 Ric ric = new Ric(updatedInfo.getRicConfig());
 178                 this.addRic(ric);
 179                 return this.synchronizationTask().synchronizeRic(ric) //
 180                         .map(notUsed -> event);
 181             } else if (event == RicConfigUpdate.Type.REMOVED) {
 182                 logger.debug("RIC removed {}", ricId);
 183                 Ric ric = rics.remove(ricId);
 184                 this.policies.removePoliciesForRic(ricId);
 185                 removePoliciciesInRic(ric);
 186             } else if (event == RicConfigUpdate.Type.CHANGED) {
 187                 logger.debug("RIC config updated {}", ricId);
 188                 Ric ric = this.rics.get(ricId);
 189                 if (ric == null) {
 190                     logger.error("An non existing RIC config is changed, should not happen (just for robustness)");
 191                     addRic(new Ric(updatedInfo.getRicConfig()));
 192                 } else {
 193                     ric.setRicConfig(updatedInfo.getRicConfig());
 194                 }
 195             }
 196             return Mono.just(event);
 197         }
 198     }
 199
 200     void addRic(Ric ric) {
 201         this.rics.put(ric);
 202         if (this.appConfig.getVardataDirectory() != null) {
 203             this.policies.restoreFromDatabase(ric, this.policyTypes);
 204         }
 205         logger.debug("Added RIC: {}", ric.id());
 206     }
 207
 208     /**
 209      * Reads the configuration from file.
 210      */
 211     Flux<JsonObject> loadConfigurationFromFile() {
 212         if (configurationFile.getLastModified() == fileLastModified) {
 213             return Flux.empty();
 214         }
 215         fileLastModified = configurationFile.getLastModified();
 216         Optional<JsonObject> readJson = configurationFile.readFile();
 217         if (readJson.isPresent()) {
 218             return Flux.just(readJson.get());
 219         }
 220         return Flux.empty();
 221     }
 222 }