Merge "Migrate CPS to Spring-boot 3.0"
[cps.git] / cps-ncmp-service / src / main / java / org / onap / cps / ncmp / api / impl / client / DmiRestClient.java
index fc70708..6a8310c 100644 (file)
@@ -1,6 +1,7 @@
 /*
  *  ============LICENSE_START=======================================================
- *  Copyright (C) 2021 Nordix Foundation
+ *  Copyright (C) 2021-2023 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.
 
 package org.onap.cps.ncmp.api.impl.client;
 
+import com.fasterxml.jackson.databind.JsonNode;
+import lombok.AllArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
 import org.onap.cps.ncmp.api.impl.config.NcmpConfiguration.DmiProperties;
+import org.onap.cps.ncmp.api.impl.exception.HttpClientRequestException;
+import org.onap.cps.ncmp.api.impl.operations.OperationType;
+import org.onap.cps.ncmp.api.impl.trustlevel.dmiavailability.DmiPluginStatus;
 import org.springframework.http.HttpEntity;
 import org.springframework.http.HttpHeaders;
-import org.springframework.http.HttpMethod;
 import org.springframework.http.MediaType;
 import org.springframework.http.ResponseEntity;
 import org.springframework.stereotype.Component;
+import org.springframework.web.client.HttpStatusCodeException;
 import org.springframework.web.client.RestTemplate;
 
 @Component
+@AllArgsConstructor
+@Slf4j
 public class DmiRestClient {
 
     private RestTemplate restTemplate;
     private DmiProperties dmiProperties;
 
-    public DmiRestClient(final RestTemplate restTemplate, final DmiProperties dmiProperties) {
-        this.restTemplate = restTemplate;
-        this.dmiProperties = dmiProperties;
-    }
-
-    public ResponseEntity<Object> putOperationWithJsonData(final String dmiResourceUrl,
-                                                            final String jsonData, final HttpHeaders headers) {
-        final var httpEntity = new HttpEntity<>(jsonData, configureHttpHeaders(headers));
-        return restTemplate.exchange(dmiResourceUrl, HttpMethod.PUT, httpEntity, Object.class);
-    }
-
     /**
      * Sends POST operation to DMI with json body containing module references.
      * @param dmiResourceUrl dmi resource url
-     * @param jsonData json data body
-     * @param httpHeaders http headers
+     * @param requestBodyAsJsonString json data body
+     * @param operationType the type of operation being executed (for error reporting only)
      * @return response entity of type String
      */
-    public ResponseEntity<String> postOperationWithJsonData(final String dmiResourceUrl,
-                                                            final String jsonData,
-                                                            final HttpHeaders httpHeaders) {
-        final var httpEntity = new HttpEntity<>(jsonData, configureHttpHeaders(httpHeaders));
-        return restTemplate.postForEntity(dmiResourceUrl, httpEntity, String.class);
+    public ResponseEntity<Object> postOperationWithJsonData(final String dmiResourceUrl,
+                                                            final String requestBodyAsJsonString,
+                                                            final OperationType operationType) {
+        final var httpEntity = new HttpEntity<>(requestBodyAsJsonString, configureHttpHeaders(new HttpHeaders()));
+        try {
+            return restTemplate.postForEntity(dmiResourceUrl, httpEntity, Object.class);
+        } catch (final HttpStatusCodeException httpStatusCodeException) {
+            final String exceptionMessage = "Unable to " + operationType.toString() + " resource data.";
+            throw new HttpClientRequestException(exceptionMessage, httpStatusCodeException.getResponseBodyAsString(),
+                    httpStatusCodeException.getStatusCode().value());
+        }
+    }
+
+    /**
+     * Sends GET operation to DMI plugin's health check URL.
+     *
+     * @param       dmiPluginBaseUrl the base URL of the dmi-plugin
+     * @return      DmiPluginStatus as UP or DOWN
+     */
+    public DmiPluginStatus getDmiPluginStatus(final String dmiPluginBaseUrl) {
+        try {
+            final HttpEntity<Object> httpHeaders = new HttpEntity<>(configureHttpHeaders(new HttpHeaders()));
+            final JsonNode dmiPluginHealthStatus = restTemplate.getForObject(dmiPluginBaseUrl + "/manage/health",
+                    JsonNode.class, httpHeaders);
+            if (dmiPluginHealthStatus != null) {
+                if (dmiPluginHealthStatus.get("status").asText().equals("UP")) {
+                    return DmiPluginStatus.UP;
+                }
+            }
+        } catch (final Exception exception) {
+            log.warn("Could not send request for health check since {}", exception.getMessage());
+        }
+        return DmiPluginStatus.DOWN;
     }
 
     private HttpHeaders configureHttpHeaders(final HttpHeaders httpHeaders) {
-        httpHeaders.setBasicAuth(dmiProperties.getAuthUsername(), dmiProperties.getAuthPassword());
+        if (dmiProperties.isDmiBasicAuthEnabled()) {
+            httpHeaders.setBasicAuth(dmiProperties.getAuthUsername(), dmiProperties.getAuthPassword());
+        }
         httpHeaders.setContentType(MediaType.APPLICATION_JSON);
         return httpHeaders;
     }
-
-    /**
-     * Sends POST operation to DMI.
-     * @param dmiResourceUrl dmi resource url
-     * @param httpHeaders http headers
-     * @return response entity of type String
-     */
-    public ResponseEntity<String> postOperation(final String dmiResourceUrl, final HttpHeaders httpHeaders) {
-        final var httpEntity = new HttpEntity<>(configureHttpHeaders(httpHeaders));
-        return restTemplate.exchange(dmiResourceUrl, HttpMethod.POST, httpEntity, String.class);
-    }
-}
\ No newline at end of file
+}