1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
|
/*
* ============LICENSE_START=======================================================
* Copyright (C) 2021-2024 Nordix Foundation
* Modifications Copyright (C) 2022 Bell Canada
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* SPDX-License-Identifier: Apache-2.0
* ============LICENSE_END=========================================================
*/
package org.onap.cps.ncmp.api.impl.client;
import static org.onap.cps.ncmp.api.NcmpResponseStatus.DMI_SERVICE_NOT_RESPONDING;
import static org.onap.cps.ncmp.api.NcmpResponseStatus.UNABLE_TO_READ_RESOURCE_DATA;
import static org.onap.cps.ncmp.api.NcmpResponseStatus.UNKNOWN_ERROR;
import static org.springframework.http.HttpStatus.BAD_REQUEST;
import static org.springframework.http.HttpStatus.INTERNAL_SERVER_ERROR;
import static org.springframework.http.HttpStatus.REQUEST_TIMEOUT;
import com.fasterxml.jackson.databind.JsonNode;
import java.net.URI;
import java.net.URISyntaxException;
import java.util.Locale;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.onap.cps.ncmp.api.impl.config.DmiProperties;
import org.onap.cps.ncmp.api.impl.exception.DmiClientRequestException;
import org.onap.cps.ncmp.api.impl.exception.InvalidDmiResourceUrlException;
import org.onap.cps.ncmp.api.impl.operations.OperationType;
import org.onap.cps.ncmp.api.impl.operations.RequiredDmiService;
import org.onap.cps.utils.JsonObjectMapper;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Component;
import org.springframework.web.client.HttpServerErrorException;
import org.springframework.web.reactive.function.BodyInserters;
import org.springframework.web.reactive.function.client.WebClient;
import org.springframework.web.reactive.function.client.WebClientRequestException;
import org.springframework.web.reactive.function.client.WebClientResponseException;
@Component
@RequiredArgsConstructor
@Slf4j
public class DmiRestClient {
private static final String HEALTH_CHECK_URL_EXTENSION = "/actuator/health";
private static final String NOT_SPECIFIED = "";
private static final String NO_AUTHORIZATION = null;
private final DmiProperties dmiProperties;
private final JsonObjectMapper jsonObjectMapper;
@Qualifier("dataServicesWebClient")
private final WebClient dataServicesWebClient;
@Qualifier("modelServicesWebClient")
private final WebClient modelServicesWebClient;
@Qualifier("healthChecksWebClient")
private final WebClient healthChecksWebClient;
/**
* Sends a POST operation to the DMI with a JSON body containing module references.
*
* @param requiredDmiService Determines if the required service is for a data or model operation.
* @param dmiUrl The DMI resource URL.
* @param requestBodyAsJsonString JSON data body.
* @param operationType The type of operation being executed (for error reporting only).
* @param authorization Contents of the Authorization header, or null if not present.
* @return ResponseEntity containing the response from the DMI.
* @throws DmiClientRequestException If there is an error during the DMI request.
*/
public ResponseEntity<Object> postOperationWithJsonData(final RequiredDmiService requiredDmiService,
final String dmiUrl,
final String requestBodyAsJsonString,
final OperationType operationType,
final String authorization) {
final WebClient webClient = requiredDmiService.equals(RequiredDmiService.DATA)
? dataServicesWebClient : modelServicesWebClient;
try {
return webClient.post()
.uri(toUri(dmiUrl))
.headers(httpHeaders -> configureHttpHeaders(httpHeaders, authorization))
.body(BodyInserters.fromValue(requestBodyAsJsonString))
.retrieve()
.toEntity(Object.class)
.onErrorMap(httpError -> handleDmiClientException(httpError, operationType.getOperationName()))
.block();
} catch (final HttpServerErrorException e) {
throw handleDmiClientException(e, operationType.getOperationName());
}
}
/**
* Get DMI plugin health status.
*
* @param dmiUrl the base URL of the dmi-plugin
* @return plugin health status ("UP" is all OK, "" (not-specified) in case of any exception)
*/
public String getDmiHealthStatus(final String dmiUrl) {
try {
final URI dmiHealthCheckUri = toUri(dmiUrl + HEALTH_CHECK_URL_EXTENSION);
final JsonNode responseHealthStatus = healthChecksWebClient.get()
.uri(dmiHealthCheckUri)
.headers(httpHeaders -> configureHttpHeaders(httpHeaders, NO_AUTHORIZATION))
.retrieve()
.bodyToMono(JsonNode.class).block();
return responseHealthStatus == null ? NOT_SPECIFIED :
responseHealthStatus.path("status").asText();
} catch (final Exception e) {
log.warn("Failed to retrieve health status from {}. Error Message: {}", dmiUrl, e.getMessage());
return NOT_SPECIFIED;
}
}
private void configureHttpHeaders(final HttpHeaders httpHeaders, final String authorization) {
if (dmiProperties.isDmiBasicAuthEnabled()) {
httpHeaders.setBasicAuth(dmiProperties.getAuthUsername(), dmiProperties.getAuthPassword());
} else if (authorization != null && authorization.toLowerCase(Locale.getDefault()).startsWith("bearer ")) {
httpHeaders.add(HttpHeaders.AUTHORIZATION, authorization);
}
}
private static URI toUri(final String dmiResourceUrl) {
try {
return new URI(dmiResourceUrl);
} catch (final URISyntaxException e) {
throw new InvalidDmiResourceUrlException(dmiResourceUrl, BAD_REQUEST.value());
}
}
private DmiClientRequestException handleDmiClientException(final Throwable throwable, final String operationType) {
if (throwable instanceof WebClientResponseException webClientResponseException) {
if (webClientResponseException.getStatusCode().isSameCodeAs(REQUEST_TIMEOUT)) {
throw new DmiClientRequestException(webClientResponseException.getStatusCode().value(),
webClientResponseException.getMessage(),
jsonObjectMapper.asJsonString(webClientResponseException.getResponseBodyAsString()),
DMI_SERVICE_NOT_RESPONDING);
}
throw new DmiClientRequestException(webClientResponseException.getStatusCode().value(),
webClientResponseException.getMessage(),
jsonObjectMapper.asJsonString(webClientResponseException.getResponseBodyAsString()),
UNABLE_TO_READ_RESOURCE_DATA);
}
final String exceptionMessage = "Unable to " + operationType + " resource data.";
if (throwable instanceof WebClientRequestException webClientRequestException) {
throw new DmiClientRequestException(HttpStatus.SERVICE_UNAVAILABLE.value(),
webClientRequestException.getMessage(),
exceptionMessage, DMI_SERVICE_NOT_RESPONDING);
}
if (throwable instanceof HttpServerErrorException httpServerErrorException) {
throw new DmiClientRequestException(httpServerErrorException.getStatusCode().value(), exceptionMessage,
httpServerErrorException.getResponseBodyAsString(), DMI_SERVICE_NOT_RESPONDING);
}
throw new DmiClientRequestException(INTERNAL_SERVER_ERROR.value(), exceptionMessage, throwable.getMessage(),
UNKNOWN_ERROR);
}
}
|
