policy-agent/src/main/java/org/oransc/policyagent/tasks/RicRecoveryTask.java

   1 /*-
   2  * ========================LICENSE_START=================================
   3  * O-RAN-SC
   4  * %%
   5  * Copyright (C) 2019 Nordix Foundation
   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.oransc.policyagent.tasks;
  22
  23 import java.util.Vector;
  24
  25 import org.oransc.policyagent.clients.A1Client;
  26 import org.oransc.policyagent.clients.A1ClientFactory;
  27 import org.oransc.policyagent.clients.AsyncRestClient;
  28 import org.oransc.policyagent.exceptions.ServiceException;
  29 import org.oransc.policyagent.repository.ImmutablePolicyType;
  30 import org.oransc.policyagent.repository.Policies;
  31 import org.oransc.policyagent.repository.Policy;
  32 import org.oransc.policyagent.repository.PolicyType;
  33 import org.oransc.policyagent.repository.PolicyTypes;
  34 import org.oransc.policyagent.repository.Ric;
  35 import org.oransc.policyagent.repository.Service;
  36 import org.oransc.policyagent.repository.Services;
  37 import org.slf4j.Logger;
  38 import org.slf4j.LoggerFactory;
  39
  40 import reactor.core.publisher.Flux;
  41 import reactor.core.publisher.Mono;
  42
  43 /**
  44  * Recovery handling of RIC.
  45  * This means:
  46  * - load all policy types
  47  * - send all policy instances to the RIC
  48  * --- if that fails remove all policy instances
  49  * - Notify subscribing services
  50  */
  51 public class RicRecoveryTask {
  52
  53     private static final Logger logger = LoggerFactory.getLogger(RicRecoveryTask.class);
  54
  55     private final A1ClientFactory a1ClientFactory;
  56     private final PolicyTypes policyTypes;
  57     private final Policies policies;
  58     private final Services services;
  59
  60     public RicRecoveryTask(A1ClientFactory a1ClientFactory, PolicyTypes policyTypes, Policies policies,
  61         Services services) {
  62         this.a1ClientFactory = a1ClientFactory;
  63         this.policyTypes = policyTypes;
  64         this.policies = policies;
  65         this.services = services;
  66     }
  67
  68     public void run(Ric ric) {
  69         logger.debug("Handling ric: {}", ric.getConfig().name());
  70
  71         synchronized (ric) {
  72             if (ric.getState() == Ric.RicState.RECOVERING) {
  73                 logger.debug("Recovery ric: {} is already running", ric.getConfig().name());
  74                 return;
  75             }
  76             ric.setState(Ric.RicState.RECOVERING);
  77         }
  78         this.a1ClientFactory.createA1Client(ric)//
  79             .flatMapMany(client -> startRecover(ric, client)) //
  80             .subscribe(x -> logger.debug("Recover: " + x), //
  81                 throwable -> onRecoveryError(ric, throwable), //
  82                 () -> onRecoveryComplete(ric));
  83     }
  84
  85     private Flux<Object> startRecover(Ric ric, A1Client a1Client) {
  86         Flux<PolicyType> recoverTypes = recoverPolicyTypes(ric, a1Client);
  87         Flux<?> deletePoliciesInRic = a1Client.deleteAllPolicies();
  88         Flux<?> recreatePoliciesInRic = recreateAllPoliciesInRic(ric, a1Client);
  89
  90         return Flux.concat(recoverTypes, deletePoliciesInRic, recreatePoliciesInRic);
  91     }
  92
  93     private void onRecoveryComplete(Ric ric) {
  94         logger.debug("Recovery completed for:" + ric.name());
  95         ric.setState(Ric.RicState.IDLE);
  96         notifyAllServices("Recovery completed for:" + ric.name());
  97     }
  98
  99     private void notifyAllServices(String body) {
 100         synchronized (services) {
 101             for (Service service : services.getAll()) {
 102                 String url = service.getCallbackUrl();
 103                 if (service.getCallbackUrl().length() > 0) {
 104                     createClient(url) //
 105                         .put("", body) //
 106                         .subscribe(rsp -> logger.debug("Service called"),
 107                             throwable -> logger.warn("Service called failed", throwable),
 108                             () -> logger.debug("Service called complete"));
 109                 }
 110             }
 111         }
 112     }
 113
 114     private void onRecoveryError(Ric ric, Throwable t) {
 115         logger.warn("Recovery failed for: {}, reason: {}", ric.name(), t.getMessage());
 116         // If recovery fails, try to remove all instances
 117         deleteAllPolicies(ric);
 118         Flux<PolicyType> recoverTypes = this.a1ClientFactory.createA1Client(ric) //
 119             .flatMapMany(a1Client -> recoverPolicyTypes(ric, a1Client));
 120         Flux<?> deletePoliciesInRic = this.a1ClientFactory.createA1Client(ric) //
 121             .flatMapMany(a1Client -> a1Client.deleteAllPolicies());
 122
 123         Flux.merge(recoverTypes, deletePoliciesInRic) //
 124             .subscribe(x -> logger.debug("Brute recover: " + x), //
 125                 throwable -> onRemoveAllError(ric, throwable), //
 126                 () -> onRecoveryComplete(ric));
 127     }
 128
 129     private void onRemoveAllError(Ric ric, Throwable t) {
 130         logger.warn("Remove all failed for: {}, reason: {}", ric.name(), t.getMessage());
 131         ric.setState(Ric.RicState.UNDEFINED);
 132     }
 133
 134     private AsyncRestClient createClient(final String url) {
 135         return new AsyncRestClient(url);
 136     }
 137
 138     private Flux<PolicyType> recoverPolicyTypes(Ric ric, A1Client a1Client) {
 139         ric.clearSupportedPolicyTypes();
 140         return a1Client.getPolicyTypeIdentities() //
 141             .flatMapMany(types -> Flux.fromIterable(types)) //
 142             .doOnNext(typeId -> logger.debug("For ric: {}, handling type: {}", ric.getConfig().name(), typeId)) //
 143             .flatMap((policyTypeId) -> getPolicyType(ric, policyTypeId, a1Client)) //
 144             .doOnNext(policyType -> ric.addSupportedPolicyType(policyType)); //
 145     }
 146
 147     private Mono<PolicyType> getPolicyType(Ric ric, String policyTypeId, A1Client a1Client) {
 148         if (policyTypes.contains(policyTypeId)) {
 149             try {
 150                 return Mono.just(policyTypes.getType(policyTypeId));
 151             } catch (ServiceException e) {
 152                 return Mono.error(e);
 153             }
 154         }
 155         return a1Client.getPolicyTypeSchema(policyTypeId) //
 156             .flatMap(schema -> createPolicyType(policyTypeId, schema));
 157     }
 158
 159     private Mono<PolicyType> createPolicyType(String policyTypeId, String schema) {
 160         PolicyType pt = ImmutablePolicyType.builder().name(policyTypeId).schema(schema).build();
 161         policyTypes.put(pt);
 162         return Mono.just(pt);
 163     }
 164
 165     private void deleteAllPolicies(Ric ric) {
 166         synchronized (policies) {
 167             for (Policy policy : policies.getForRic(ric.name())) {
 168                 this.policies.remove(policy);
 169             }
 170         }
 171     }
 172
 173     private Flux<String> recreateAllPoliciesInRic(Ric ric, A1Client a1Client) {
 174         synchronized (policies) {
 175             return Flux.fromIterable(new Vector<>(policies.getForRic(ric.name()))) //
 176                 .doOnNext(
 177                     policy -> logger.debug("Recreating policy: {}, for ric: {}", policy.id(), ric.getConfig().name()))
 178                 .flatMap(policy -> a1Client.putPolicy(policy));
 179         }
 180     }
 181
 182 }