2 * ========================LICENSE_START=================================
5 * Copyright (C) 2020 Nordix Foundation
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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===================================
21 package org.oransc.policyagent.tasks;
23 import java.util.Collection;
25 import org.oransc.policyagent.clients.A1Client;
26 import org.oransc.policyagent.clients.A1ClientFactory;
27 import org.oransc.policyagent.repository.Lock.LockType;
28 import org.oransc.policyagent.repository.Policies;
29 import org.oransc.policyagent.repository.PolicyTypes;
30 import org.oransc.policyagent.repository.Ric;
31 import org.oransc.policyagent.repository.Ric.RicState;
32 import org.oransc.policyagent.repository.Rics;
33 import org.oransc.policyagent.repository.Services;
34 import org.slf4j.Logger;
35 import org.slf4j.LoggerFactory;
36 import org.springframework.beans.factory.annotation.Autowired;
37 import org.springframework.scheduling.annotation.EnableScheduling;
38 import org.springframework.scheduling.annotation.Scheduled;
39 import org.springframework.stereotype.Component;
41 import reactor.core.publisher.Flux;
42 import reactor.core.publisher.Mono;
45 * Regularly checks the existing rics towards the local repository to keep it
46 * consistent. When the policy types or instances in the Near-RT RIC is not
47 * consistent, a synchronization is performed.
51 @SuppressWarnings("squid:S2629") // Invoke method(s) only conditionally
52 public class RicSupervision {
53 private static final Logger logger = LoggerFactory.getLogger(RicSupervision.class);
55 private final Rics rics;
56 private final Policies policies;
57 private final PolicyTypes policyTypes;
58 private final A1ClientFactory a1ClientFactory;
59 private final Services services;
62 public RicSupervision(Rics rics, Policies policies, A1ClientFactory a1ClientFactory, PolicyTypes policyTypes,
65 this.policies = policies;
66 this.a1ClientFactory = a1ClientFactory;
67 this.policyTypes = policyTypes;
68 this.services = services;
72 * Regularly contacts all Rics to check if they are alive and synchronized.
74 @Scheduled(fixedRate = 1000 * 60)
75 public void checkAllRics() {
76 logger.debug("Checking Rics starting");
77 createTask().subscribe( //
78 ric -> logger.debug("Ric: {} checked", ric.ric.name()), //
80 () -> logger.debug("Checking Rics completed") //
84 private Flux<RicData> createTask() {
85 return Flux.fromIterable(rics.getRics()) //
86 .flatMap(this::createRicData) //
87 .flatMap(this::checkOneRic) //
88 .onErrorResume(throwable -> Mono.empty());
92 private Mono<RicData> checkOneRic(RicData ricData) {
93 return checkRicState(ricData) //
94 .flatMap(x -> ricData.ric.getLock().lock(LockType.EXCLUSIVE)) //
95 .flatMap(x -> checkRicPolicies(ricData)) //
96 .flatMap(x -> ricData.ric.getLock().unlock()) //
97 .doOnError(throwable -> ricData.ric.getLock().unlockBlocking()) //
98 .flatMap(x -> checkRicPolicyTypes(ricData)); //
101 private static class RicData {
102 RicData(Ric ric, A1Client a1Client) {
104 this.a1Client = a1Client;
108 final A1Client a1Client;
111 private Mono<RicData> createRicData(Ric ric) {
112 return Mono.just(ric) //
113 .flatMap(aRic -> this.a1ClientFactory.createA1Client(ric)) //
114 .flatMap(a1Client -> Mono.just(new RicData(ric, a1Client)));
117 private Mono<RicData> checkRicState(RicData ric) {
118 if (ric.ric.getState() == RicState.UNAVAILABLE) {
119 return startSynchronization(ric) //
120 .onErrorResume(t -> Mono.empty());
121 } else if (ric.ric.getState() == RicState.SYNCHRONIZING) {
124 return Mono.just(ric);
128 private Mono<RicData> checkRicPolicies(RicData ric) {
129 return ric.a1Client.getPolicyIdentities() //
130 .flatMap(ricP -> validateInstances(ricP, ric));
133 private Mono<RicData> validateInstances(Collection<String> ricPolicies, RicData ric) {
134 synchronized (this.policies) {
135 if (ricPolicies.size() != policies.getForRic(ric.ric.name()).size()) {
136 return startSynchronization(ric);
139 for (String policyId : ricPolicies) {
140 if (!policies.containsPolicy(policyId)) {
141 return startSynchronization(ric);
144 return Mono.just(ric);
148 private Mono<RicData> checkRicPolicyTypes(RicData ric) {
149 return ric.a1Client.getPolicyTypeIdentities() //
150 .flatMap(ricTypes -> validateTypes(ricTypes, ric));
153 private Mono<RicData> validateTypes(Collection<String> ricTypes, RicData ric) {
154 if (ricTypes.size() != ric.ric.getSupportedPolicyTypes().size()) {
155 return startSynchronization(ric);
157 for (String typeName : ricTypes) {
158 if (!ric.ric.isSupportingType(typeName)) {
159 return startSynchronization(ric);
162 return Mono.just(ric);
165 private Mono<RicData> startSynchronization(RicData ric) {
166 RicSynchronizationTask synchronizationTask = createSynchronizationTask();
167 synchronizationTask.run(ric.ric);
168 return Mono.error(new Exception("Syncronization started"));
171 RicSynchronizationTask createSynchronizationTask() {
172 return new RicSynchronizationTask(a1ClientFactory, policyTypes, policies, services);