2 * ========================LICENSE_START=================================
5 * Copyright (C) 2021 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.oran.dmaapadapter.clients;
23 import io.netty.channel.ChannelOption;
24 import io.netty.handler.ssl.SslContext;
25 import io.netty.handler.timeout.ReadTimeoutHandler;
26 import io.netty.handler.timeout.WriteTimeoutHandler;
28 import java.lang.invoke.MethodHandles;
29 import java.util.concurrent.atomic.AtomicInteger;
31 import org.oran.dmaapadapter.configuration.WebClientConfig.HttpProxyConfig;
32 import org.slf4j.Logger;
33 import org.slf4j.LoggerFactory;
34 import org.springframework.http.MediaType;
35 import org.springframework.http.ResponseEntity;
36 import org.springframework.http.client.reactive.ReactorClientHttpConnector;
37 import org.springframework.lang.Nullable;
38 import org.springframework.web.reactive.function.client.ExchangeStrategies;
39 import org.springframework.web.reactive.function.client.WebClient;
40 import org.springframework.web.reactive.function.client.WebClient.RequestHeadersSpec;
41 import org.springframework.web.reactive.function.client.WebClientResponseException;
43 import reactor.core.publisher.Mono;
44 import reactor.netty.http.client.HttpClient;
45 import reactor.netty.transport.ProxyProvider;
48 * Generic reactive REST client.
50 @SuppressWarnings("java:S4449") // @Add Nullable to third party api
51 public class AsyncRestClient {
53 private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
54 private WebClient webClient = null;
55 private final String baseUrl;
56 private static final AtomicInteger sequenceNumber = new AtomicInteger();
57 private final SslContext sslContext;
58 private final HttpProxyConfig httpProxyConfig;
60 public AsyncRestClient(String baseUrl, @Nullable SslContext sslContext, @Nullable HttpProxyConfig httpProxyConfig) {
61 this.baseUrl = baseUrl;
62 this.sslContext = sslContext;
63 this.httpProxyConfig = httpProxyConfig;
66 public Mono<ResponseEntity<String>> postForEntity(String uri, @Nullable String body,
67 @Nullable MediaType contentType) {
68 Object traceTag = createTraceTag();
69 logger.debug("{} POST uri = '{}{}''", traceTag, baseUrl, uri);
70 logger.trace("{} POST body: {}", traceTag, body);
71 Mono<String> bodyProducer = body != null ? Mono.just(body) : Mono.empty();
73 RequestHeadersSpec<?> request = getWebClient() //
76 .contentType(contentType) //
77 .body(bodyProducer, String.class);
78 return retrieve(traceTag, request);
81 public Mono<String> post(String uri, @Nullable String body, @Nullable MediaType contentType) {
82 return postForEntity(uri, body, contentType) //
86 public Mono<String> postWithAuthHeader(String uri, String body, String username, String password,
87 @Nullable MediaType mediaType) {
88 Object traceTag = createTraceTag();
89 logger.debug("{} POST (auth) uri = '{}{}''", traceTag, baseUrl, uri);
90 logger.trace("{} POST body: {}", traceTag, body);
92 RequestHeadersSpec<?> request = getWebClient() //
95 .headers(headers -> headers.setBasicAuth(username, password)) //
96 .contentType(mediaType) //
98 return retrieve(traceTag, request) //
102 public Mono<ResponseEntity<String>> putForEntity(String uri, String body) {
103 Object traceTag = createTraceTag();
104 logger.debug("{} PUT uri = '{}{}''", traceTag, baseUrl, uri);
105 logger.trace("{} PUT body: {}", traceTag, body);
107 RequestHeadersSpec<?> request = getWebClient() //
110 .contentType(MediaType.APPLICATION_JSON) //
112 return retrieve(traceTag, request);
115 public Mono<ResponseEntity<String>> putForEntity(String uri) {
116 Object traceTag = createTraceTag();
117 logger.debug("{} PUT uri = '{}{}''", traceTag, baseUrl, uri);
118 logger.trace("{} PUT body: <empty>", traceTag);
119 RequestHeadersSpec<?> request = getWebClient() //
122 return retrieve(traceTag, request);
125 public Mono<String> put(String uri, String body) {
126 return putForEntity(uri, body) //
130 public Mono<ResponseEntity<String>> getForEntity(String uri) {
131 Object traceTag = createTraceTag();
132 logger.debug("{} GET uri = '{}{}''", traceTag, baseUrl, uri);
133 RequestHeadersSpec<?> request = getWebClient().get().uri(uri);
134 return retrieve(traceTag, request);
137 public Mono<String> get(String uri) {
138 return getForEntity(uri) //
142 public Mono<ResponseEntity<String>> deleteForEntity(String uri) {
143 Object traceTag = createTraceTag();
144 logger.debug("{} DELETE uri = '{}{}''", traceTag, baseUrl, uri);
145 RequestHeadersSpec<?> request = getWebClient().delete().uri(uri);
146 return retrieve(traceTag, request);
149 public Mono<String> delete(String uri) {
150 return deleteForEntity(uri) //
154 private Mono<ResponseEntity<String>> retrieve(Object traceTag, RequestHeadersSpec<?> request) {
155 final Class<String> clazz = String.class;
156 return request.retrieve() //
158 .doOnNext(entity -> logReceivedData(traceTag, entity)) //
159 .doOnError(throwable -> onHttpError(traceTag, throwable));
162 private void logReceivedData(Object traceTag, ResponseEntity<String> entity) {
163 logger.trace("{} Received: {} {}", traceTag, entity.getBody(), entity.getHeaders().getContentType());
166 private static Object createTraceTag() {
167 return sequenceNumber.incrementAndGet();
170 private void onHttpError(Object traceTag, Throwable t) {
171 if (t instanceof WebClientResponseException) {
172 WebClientResponseException exception = (WebClientResponseException) t;
173 logger.debug("{} HTTP error status = '{}', body '{}'", traceTag, exception.getStatusCode(),
174 exception.getResponseBodyAsString());
176 logger.debug("{} HTTP error {}", traceTag, t.getMessage());
180 private String toBody(ResponseEntity<String> entity) {
181 if (entity.getBody() == null) {
184 return entity.getBody();
188 private boolean isHttpProxyConfigured() {
189 return httpProxyConfig != null && httpProxyConfig.httpProxyPort() > 0
190 && !httpProxyConfig.httpProxyHost().isEmpty();
193 private HttpClient buildHttpClient() {
194 HttpClient httpClient = HttpClient.create() //
195 .option(ChannelOption.CONNECT_TIMEOUT_MILLIS, 10_000) //
196 .doOnConnected(connection -> {
197 connection.addHandlerLast(new ReadTimeoutHandler(30));
198 connection.addHandlerLast(new WriteTimeoutHandler(30));
201 if (this.sslContext != null) {
202 httpClient = httpClient.secure(ssl -> ssl.sslContext(sslContext));
205 if (isHttpProxyConfigured()) {
206 httpClient = httpClient.proxy(proxy -> proxy.type(ProxyProvider.Proxy.HTTP)
207 .host(httpProxyConfig.httpProxyHost()).port(httpProxyConfig.httpProxyPort()));
212 private WebClient buildWebClient(String baseUrl) {
213 final HttpClient httpClient = buildHttpClient();
214 ExchangeStrategies exchangeStrategies = ExchangeStrategies.builder() //
215 .codecs(configurer -> configurer.defaultCodecs().maxInMemorySize(-1)) //
217 return WebClient.builder() //
218 .clientConnector(new ReactorClientHttpConnector(httpClient)) //
220 .exchangeStrategies(exchangeStrategies) //
224 private WebClient getWebClient() {
225 if (this.webClient == null) {
226 this.webClient = buildWebClient(baseUrl);
228 return this.webClient;