Fix bug in A1 clients
[nonrtric.git] / policy-agent / src / main / java / org / oransc / policyagent / clients / A1ClientFactory.java
1 /*-
2  * ========================LICENSE_START=================================
3  * O-RAN-SC
4  * %%
5  * Copyright (C) 2020 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.clients;
22
23 import org.oransc.policyagent.clients.A1Client.A1ProtocolType;
24 import org.oransc.policyagent.configuration.ApplicationConfig;
25 import org.oransc.policyagent.configuration.ControllerConfig;
26 import org.oransc.policyagent.exceptions.ServiceException;
27 import org.oransc.policyagent.repository.Ric;
28 import org.slf4j.Logger;
29 import org.slf4j.LoggerFactory;
30 import org.springframework.beans.factory.annotation.Autowired;
31 import reactor.core.publisher.Mono;
32
33 /**
34  * Factory for A1 clients that supports four different protocol versions of the
35  * A1 api.
36  */
37 public class A1ClientFactory {
38
39     private static final Logger logger = LoggerFactory.getLogger(A1ClientFactory.class);
40
41     private final ApplicationConfig appConfig;
42
43     @Autowired
44     public A1ClientFactory(ApplicationConfig appConfig) {
45         this.appConfig = appConfig;
46     }
47
48     /**
49      * Creates an A1 client with the correct A1 protocol for the provided Ric.
50      *
51      * <p>
52      * It detects the protocol version by trial and error, since there is no
53      * getVersion method specified in the A1 api yet.
54      *
55      * <p>
56      * As a side effect it also sets the protocol version in the provided Ric. This
57      * means that after the first successful creation it won't have to try which
58      * protocol to use, but can create the client directly.
59      *
60      * @param ric The RIC to get a client for.
61      * @return a client with the correct protocol, or a ServiceException if none of
62      *         the protocols are supported by the Ric.
63      */
64     public Mono<A1Client> createA1Client(Ric ric) {
65         return getProtocolVersion(ric) //
66             .flatMap(version -> createA1ClientMono(ric, version));
67     }
68
69     A1Client createClient(Ric ric, A1ProtocolType version) throws ServiceException {
70         if (version == A1ProtocolType.STD_V1_1) {
71             assertNoControllerConfig(ric, version);
72             return new StdA1ClientVersion1(ric.getConfig(), this.appConfig.getWebClientConfig());
73         } else if (version == A1ProtocolType.OSC_V1) {
74             assertNoControllerConfig(ric, version);
75             return new OscA1Client(ric.getConfig(), this.appConfig.getWebClientConfig());
76         } else if (version == A1ProtocolType.SDNC_OSC_STD_V1_1 || version == A1ProtocolType.SDNC_OSC_OSC_V1) {
77             return new SdncOscA1Client(version, ric.getConfig(), getControllerConfig(ric),
78                 this.appConfig.getWebClientConfig());
79         } else if (version == A1ProtocolType.SDNC_ONAP) {
80             return new SdncOnapA1Client(ric.getConfig(), getControllerConfig(ric), this.appConfig.getWebClientConfig());
81         } else {
82             logger.error("Unhandled protocol: {}", version);
83             throw new ServiceException("Unhandled protocol");
84         }
85     }
86
87     private ControllerConfig getControllerConfig(Ric ric) throws ServiceException {
88         String controllerName = ric.getConfig().controllerName();
89         if (controllerName.isEmpty()) {
90             ric.setProtocolVersion(A1ProtocolType.UNKNOWN);
91             throw new ServiceException("No controller configured for RIC: " + ric.name());
92         }
93         try {
94             return this.appConfig.getControllerConfig(controllerName);
95         } catch (ServiceException e) {
96             ric.setProtocolVersion(A1ProtocolType.UNKNOWN);
97             throw e;
98         }
99     }
100
101     private void assertNoControllerConfig(Ric ric, A1ProtocolType version) throws ServiceException {
102         if (!ric.getConfig().controllerName().isEmpty()) {
103             ric.setProtocolVersion(A1ProtocolType.UNKNOWN);
104             throw new ServiceException(
105                 "Controller config should be empty, ric: " + ric.name() + " when using protocol version: " + version);
106         }
107     }
108
109     private Mono<A1Client> createA1ClientMono(Ric ric, A1ProtocolType version) {
110         try {
111             return Mono.just(createClient(ric, version));
112         } catch (ServiceException e) {
113             return Mono.error(e);
114         }
115     }
116
117     private Mono<A1Client.A1ProtocolType> getProtocolVersion(Ric ric) {
118         if (ric.getProtocolVersion() == A1ProtocolType.UNKNOWN) {
119             return fetchVersion(ric, A1ProtocolType.STD_V1_1) //
120                 .onErrorResume(notUsed -> fetchVersion(ric, A1ProtocolType.OSC_V1)) //
121                 .onErrorResume(notUsed -> fetchVersion(ric, A1ProtocolType.SDNC_OSC_STD_V1_1)) //
122                 .onErrorResume(notUsed -> fetchVersion(ric, A1ProtocolType.SDNC_ONAP)) //
123                 .doOnNext(ric::setProtocolVersion)
124                 .doOnNext(version -> logger.debug("Established protocol version:{} for Ric: {}", version, ric.name())) //
125                 .doOnError(notUsed -> logger.warn("Could not get protocol version from RIC: {}", ric.name())) //
126                 .onErrorResume(
127                     notUsed -> Mono.error(new ServiceException("Protocol negotiation failed for " + ric.name())));
128         } else {
129             return Mono.just(ric.getProtocolVersion());
130         }
131     }
132
133     private Mono<A1ProtocolType> fetchVersion(Ric ric, A1ProtocolType protocolType) {
134         return createA1ClientMono(ric, protocolType) //
135             .flatMap(A1Client::getProtocolVersion);
136     }
137 }