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.ics.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.oransc.ics.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 public class AsyncRestClient {
52 private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
53 private WebClient webClient = null;
54 private final String baseUrl;
55 private static final AtomicInteger sequenceNumber = new AtomicInteger();
56 private final SslContext sslContext;
57 private final HttpProxyConfig httpProxyConfig;
59 public AsyncRestClient(String baseUrl, @Nullable SslContext sslContext, @Nullable HttpProxyConfig httpProxyConfig) {
60 this.baseUrl = baseUrl;
61 this.sslContext = sslContext;
62 this.httpProxyConfig = httpProxyConfig;
65 public Mono<ResponseEntity<String>> postForEntity(String uri, @Nullable String body) {
66 Object traceTag = createTraceTag();
67 logger.debug("{} POST uri = '{}{}''", traceTag, baseUrl, uri);
68 logger.trace("{} POST body: {}", traceTag, body);
69 Mono<String> bodyProducer = body != null ? Mono.just(body) : Mono.empty();
71 RequestHeadersSpec<?> request = getWebClient() //
74 .contentType(MediaType.APPLICATION_JSON) //
75 .body(bodyProducer, String.class);
76 return retrieve(traceTag, request);
79 public Mono<String> post(String uri, @Nullable String body) {
80 return postForEntity(uri, body) //
84 public Mono<String> postWithAuthHeader(String uri, String body, String username, String password) {
85 Object traceTag = createTraceTag();
86 logger.debug("{} POST (auth) uri = '{}{}''", traceTag, baseUrl, uri);
87 logger.trace("{} POST body: {}", traceTag, body);
89 RequestHeadersSpec<?> request = getWebClient() //
92 .headers(headers -> headers.setBasicAuth(username, password)) //
93 .contentType(MediaType.APPLICATION_JSON) //
95 return retrieve(traceTag, request) //
99 public Mono<ResponseEntity<String>> putForEntity(String uri, String body) {
100 Object traceTag = createTraceTag();
101 logger.debug("{} PUT uri = '{}{}''", traceTag, baseUrl, uri);
102 logger.trace("{} PUT body: {}", traceTag, body);
104 RequestHeadersSpec<?> request = getWebClient() //
107 .contentType(MediaType.APPLICATION_JSON) //
109 return retrieve(traceTag, request);
112 public Mono<ResponseEntity<String>> putForEntity(String uri) {
113 Object traceTag = createTraceTag();
114 logger.debug("{} PUT uri = '{}{}''", traceTag, baseUrl, uri);
115 logger.trace("{} PUT body: <empty>", traceTag);
116 RequestHeadersSpec<?> request = getWebClient() //
119 return retrieve(traceTag, request);
122 public Mono<String> put(String uri, String body) {
123 return putForEntity(uri, body) //
127 public Mono<ResponseEntity<String>> getForEntity(String uri) {
128 Object traceTag = createTraceTag();
129 logger.debug("{} GET uri = '{}{}''", traceTag, baseUrl, uri);
130 RequestHeadersSpec<?> request = getWebClient().get().uri(uri);
131 return retrieve(traceTag, request);
134 public Mono<String> get(String uri) {
135 return getForEntity(uri) //
139 public Mono<ResponseEntity<String>> deleteForEntity(String uri) {
140 Object traceTag = createTraceTag();
141 logger.debug("{} DELETE uri = '{}{}''", traceTag, baseUrl, uri);
142 RequestHeadersSpec<?> request = getWebClient().delete().uri(uri);
143 return retrieve(traceTag, request);
146 public Mono<String> delete(String uri) {
147 return deleteForEntity(uri) //
151 private Mono<ResponseEntity<String>> retrieve(Object traceTag, RequestHeadersSpec<?> request) {
152 final Class<String> clazz = String.class;
153 return request.retrieve() //
155 .doOnNext(entity -> logReceivedData(traceTag, entity)) //
156 .doOnError(throwable -> onHttpError(traceTag, throwable));
159 private void logReceivedData(Object traceTag, ResponseEntity<String> entity) {
160 logger.trace("{} Received: {} {}", traceTag, entity.getBody(), entity.getHeaders().getContentType());
163 private static Object createTraceTag() {
164 return sequenceNumber.incrementAndGet();
167 private void onHttpError(Object traceTag, Throwable t) {
168 if (t instanceof WebClientResponseException) {
169 WebClientResponseException exception = (WebClientResponseException) t;
170 logger.debug("{} HTTP error status = '{}', body '{}'", traceTag, exception.getStatusCode(),
171 exception.getResponseBodyAsString());
173 logger.debug("{} HTTP error {}", traceTag, t.getMessage());
177 private String toBody(ResponseEntity<String> entity) {
178 if (entity.getBody() == null) {
181 return entity.getBody();
185 private boolean isHttpProxyConfigured() {
186 return httpProxyConfig != null && httpProxyConfig.httpProxyPort() > 0
187 && !httpProxyConfig.httpProxyHost().isEmpty();
190 private HttpClient buildHttpClient() {
191 HttpClient httpClient = HttpClient.create() //
192 .option(ChannelOption.CONNECT_TIMEOUT_MILLIS, 10_000) //
193 .doOnConnected(connection -> {
194 connection.addHandlerLast(new ReadTimeoutHandler(30));
195 connection.addHandlerLast(new WriteTimeoutHandler(30));
198 if (this.sslContext != null) {
199 httpClient = httpClient.secure(ssl -> ssl.sslContext(sslContext));
202 if (isHttpProxyConfigured()) {
203 httpClient = httpClient.proxy(proxy -> proxy.type(ProxyProvider.Proxy.HTTP)
204 .host(httpProxyConfig.httpProxyHost()).port(httpProxyConfig.httpProxyPort()));
209 private WebClient buildWebClient(String baseUrl) {
210 final HttpClient httpClient = buildHttpClient();
211 ExchangeStrategies exchangeStrategies = ExchangeStrategies.builder() //
212 .codecs(configurer -> configurer.defaultCodecs().maxInMemorySize(-1)) //
214 return WebClient.builder() //
215 .clientConnector(new ReactorClientHttpConnector(httpClient)) //
217 .exchangeStrategies(exchangeStrategies) //
221 private WebClient getWebClient() {
222 if (this.webClient == null) {
223 this.webClient = buildWebClient(baseUrl);
225 return this.webClient;