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 static org.onap.ccsdk.oran.a1policymanagementservice.repository.Ric.RicState;
  24
  25 import org.onap.ccsdk.oran.a1policymanagementservice.clients.A1Client;
  26 import org.onap.ccsdk.oran.a1policymanagementservice.clients.A1ClientFactory;
  27 import org.onap.ccsdk.oran.a1policymanagementservice.clients.AsyncRestClientFactory;
  28 import org.onap.ccsdk.oran.a1policymanagementservice.controllers.ServiceCallbacks;
  29 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Lock.LockType;
  30 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Policies;
  31 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Policy;
  32 import org.onap.ccsdk.oran.a1policymanagementservice.repository.PolicyType;
  33 import org.onap.ccsdk.oran.a1policymanagementservice.repository.PolicyTypes;
  34 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Ric;
  35 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Rics;
  36 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Services;
  37 import org.slf4j.Logger;
  38 import org.slf4j.LoggerFactory;
  39 import org.springframework.web.reactive.function.client.WebClientResponseException;
  40
  41 import reactor.core.publisher.Flux;
  42 import reactor.core.publisher.Mono;
  43 import reactor.core.publisher.SignalType;
  44
  45 /**
  46  * Synchronizes the content of a Near-RT RIC with the content in the repository.
  47  * This means:
  48  * <p>
  49  * load all policy types
  50  * <p>
  51  * send all policy instances to the Near-RT RIC
  52  * <p>
  53  * if that fails remove all policy instances
  54  * <p>
  55  * Notify subscribing services
  56  */
  57 @SuppressWarnings("squid:S2629") // Invoke method(s) only conditionally
  58 public class RicSynchronizationTask {
  59
  60     private static final Logger logger = LoggerFactory.getLogger(RicSynchronizationTask.class);
  61     static final int CONCURRENCY_RIC = 1; // How many paralell requests that is sent to one NearRT RIC
  62
  63     private final A1ClientFactory a1ClientFactory;
  64     private final PolicyTypes policyTypes;
  65     private final Policies policies;
  66     private final Services services;
  67     private final Rics rics;
  68     private final AsyncRestClientFactory restClientFactory;
  69
  70     public RicSynchronizationTask(A1ClientFactory a1ClientFactory, PolicyTypes policyTypes, Policies policies,
  71             Services services, AsyncRestClientFactory restClientFactory, Rics rics) {
  72         this.a1ClientFactory = a1ClientFactory;
  73         this.policyTypes = policyTypes;
  74         this.policies = policies;
  75         this.services = services;
  76         this.restClientFactory = restClientFactory;
  77         this.rics = rics;
  78     }
  79
  80     public void run(Ric ric) {
  81         logger.debug("Ric synchronization task created: {}", ric.getConfig().getRicId());
  82
  83         if (ric.getState() == RicState.SYNCHRONIZING) {
  84             logger.debug("Ric: {} is already being synchronized", ric.getConfig().getRicId());
  85             return;
  86         }
  87
  88         ric.getLock().lock(LockType.EXCLUSIVE, "RicSynchronizationTask") //
  89                 .flatMap(notUsed -> synchronizeRic(ric)) //
  90                 .doFinally(sig -> ric.getLock().unlockBlocking()) //
  91                 .subscribe();
  92     }
  93
  94     public Mono<Ric> synchronizeRic(Ric ric) {
  95         return this.a1ClientFactory.createA1Client(ric) //
  96                 .doOnNext(client -> ric.setState(RicState.SYNCHRONIZING)) //
  97                 .flatMapMany(client -> runSynchronization(ric, client)) //
  98                 .doOnError(t -> { //
  99                     logger.warn("Synchronization failure for ric: {}, reason: {}", ric.id(), t.getMessage()); //
 100                     deletePoliciesIfNotRecreatable(t, ric);
 101                 }) //
 102                 .collectList() //
 103                 .flatMap(notUsed -> onSynchronizationComplete(ric)) //
 104                 .onErrorResume(t -> Mono.just(ric)) //
 105                 .doFinally(signal -> onFinally(signal, ric));
 106     }
 107
 108     private void onFinally(SignalType signal, Ric ric) {
 109         if (ric.getState().equals(RicState.SYNCHRONIZING)) {
 110             logger.debug("Resetting ric state after failed synch, ric: {}, signal: {}", ric.id(), signal);
 111             ric.setState(RicState.UNAVAILABLE); //
 112         }
 113     }
 114
 115     /**
 116      * If a 4xx error is received, allpolicies are deleted. This is just to avoid
 117      * cyclical receovery due to that the NearRT RIC cannot accept a previously
 118      * policy.
 119      */
 120     private void deletePoliciesIfNotRecreatable(Throwable throwable, Ric ric) {
 121         if (throwable instanceof WebClientResponseException) {
 122             WebClientResponseException responseException = (WebClientResponseException) throwable;
 123             if (responseException.getStatusCode().is4xxClientError()) {
 124                 deleteAllPoliciesInRepository(ric);
 125             }
 126         }
 127     }
 128
 129     private void deleteAllPoliciesInRepository(Ric ric) {
 130         for (Policy policy : policies.getForRic(ric.id())) {
 131             this.policies.remove(policy);
 132         }
 133     }
 134
 135     public Flux<PolicyType> synchronizePolicyTypes(Ric ric, A1Client a1Client) {
 136         return a1Client.getPolicyTypeIdentities() //
 137                 .doOnNext(x -> ric.clearSupportedPolicyTypes()) //
 138                 .flatMapMany(Flux::fromIterable) //
 139                 .doOnNext(typeId -> logger.debug("For ric: {}, handling type: {}", ric.getConfig().getRicId(), typeId)) //
 140                 .flatMap(policyTypeId -> getPolicyType(policyTypeId, a1Client), CONCURRENCY_RIC) //
 141                 .doOnNext(ric::addSupportedPolicyType); //
 142     }
 143
 144     private Flux<Object> runSynchronization(Ric ric, A1Client a1Client) {
 145         Flux<PolicyType> synchronizedTypes = synchronizePolicyTypes(ric, a1Client);
 146         Flux<?> policiesDeletedInRic = a1Client.deleteAllPolicies();
 147         Flux<Policy> policiesRecreatedInRic = recreateAllPoliciesInRic(ric, a1Client);
 148
 149         return Flux.concat(synchronizedTypes, policiesDeletedInRic, policiesRecreatedInRic);
 150     }
 151
 152     private Mono<Ric> onSynchronizationComplete(Ric ric) {
 153         if (this.rics.get(ric.id()) == null) {
 154             logger.debug("Policies removed in removed ric: {}", ric.id());
 155             return Mono.empty();
 156         }
 157         logger.debug("Synchronization completed for: {}", ric.id());
 158         ric.setState(RicState.AVAILABLE);
 159         ServiceCallbacks callbacks = new ServiceCallbacks(this.restClientFactory);
 160         return callbacks.notifyServicesRicAvailable(ric, services) //
 161                 .collectList() //
 162                 .map(list -> ric);
 163     }
 164
 165     private Mono<PolicyType> getPolicyType(String policyTypeId, A1Client a1Client) {
 166         if (policyTypes.contains(policyTypeId)) {
 167             return Mono.just(policyTypes.get(policyTypeId));
 168         }
 169         return a1Client.getPolicyTypeSchema(policyTypeId) //
 170                 .map(schema -> createPolicyType(policyTypeId, schema));
 171     }
 172
 173     private PolicyType createPolicyType(String policyTypeId, String schema) {
 174         PolicyType pt = PolicyType.builder().id(policyTypeId).schema(schema).build();
 175         policyTypes.put(pt);
 176         return pt;
 177     }
 178
 179     private Flux<Policy> putPolicy(Policy policy, Ric ric, A1Client a1Client) {
 180         logger.trace("Recreating policy: {}, for ric: {}", policy.getId(), ric.getConfig().getRicId());
 181         return a1Client.putPolicy(policy) //
 182                 .flatMapMany(notUsed -> Flux.just(policy));
 183     }
 184
 185     private boolean checkTransient(Policy policy) {
 186         if (policy.isTransient()) {
 187             this.policies.remove(policy);
 188         }
 189         return policy.isTransient();
 190     }
 191
 192     private Flux<Policy> recreateAllPoliciesInRic(Ric ric, A1Client a1Client) {
 193         return Flux.fromIterable(policies.getForRic(ric.id())) //
 194                 .doOnNext(policy -> logger.debug("Recreating policy: {}, ric: {}", policy.getId(), ric.id())) //
 195                 .filter(policy -> !checkTransient(policy)) //
 196                 .flatMap(policy -> putPolicy(policy, ric, a1Client), CONCURRENCY_RIC)
 197                 .doOnError(t -> logger.warn("Recreating policy failed, ric: {}, reason: {}", ric.id(), t.getMessage()));
 198     }
 199
 200 }