Merge "Trust level updates with dmi status change"

[cps.git] / cps-ncmp-service / src / main / java / org / onap / cps / ncmp / api / impl / client / DmiRestClient.java

diff --git a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/client/DmiRestClient.java b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/client/DmiRestClient.java
index 94faa55..b6eb092 100644 (file)
--- a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/client/DmiRestClient.java
+++ b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/client/DmiRestClient.java
@@ -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.
@@ -20,60 +21,76 @@
 
 package org.onap.cps.ncmp.api.impl.client;
 
+import com.fasterxml.jackson.databind.JsonNode;
+import lombok.RequiredArgsConstructor;
+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.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
+@RequiredArgsConstructor
+@Slf4j
 public class DmiRestClient {
 
-    private RestTemplate restTemplate;
-    private DmiProperties dmiProperties;
+    private static final String HEALTH_CHECK_URL_EXTENSION = "/actuator/health";
+    private static final String EMPTY_STRING = "";
+    private final RestTemplate restTemplate;
+    private final DmiProperties dmiProperties;
 
     /**
-     * Constructor injection for DmiRestClient objects.
+     * Sends POST operation to DMI with json body containing module references.
      *
-     * @param restTemplate the rest template
-     * @param dmiProperties the DMI properties
+     * @param dmiResourceUrl          dmi resource url
+     * @param requestBodyAsJsonString json data body
+     * @param operationType           the type of operation being executed (for error reporting only)
+     * @return response entity of type String
      */
-    public DmiRestClient(final RestTemplate restTemplate, final DmiProperties dmiProperties) {
-        this.restTemplate = restTemplate;
-        this.dmiProperties = dmiProperties;
+    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 POST operation to DMI with json body containing module references.
-     * @param dmiResourceUrl dmi resource url
-     * @param jsonData json data body
-     * @param httpHeaders http headers
-     * @return response entity of type String
+     * Get DMI plugin health status.
+     *
+     * @param       dmiPluginBaseUrl the base URL of the dmi-plugin
+     * @return      plugin health status ("UP" is all OK, EMPTY_STRING in case of any exception)
      */
-    public ResponseEntity<Object> postOperationWithJsonData(final String dmiResourceUrl,
-                                                            final String jsonData,
-                                                            final HttpHeaders httpHeaders) {
-        final var httpEntity = new HttpEntity<>(jsonData, configureHttpHeaders(httpHeaders));
-        return restTemplate.postForEntity(dmiResourceUrl, httpEntity, Object.class);
+    public String getDmiHealthStatus(final String dmiPluginBaseUrl) {
+        final HttpEntity<Object> httpHeaders = new HttpEntity<>(configureHttpHeaders(new HttpHeaders()));
+        try {
+            final JsonNode responseHealthStatus =
+                restTemplate.getForObject(dmiPluginBaseUrl + HEALTH_CHECK_URL_EXTENSION,
+                JsonNode.class, httpHeaders);
+            return responseHealthStatus == null ? EMPTY_STRING :
+                responseHealthStatus.get("status").asText();
+        } catch (final Exception e) {
+            log.warn("Failed to retrieve health status from {}. Error Message: {}", dmiPluginBaseUrl, e.getMessage());
+            return EMPTY_STRING;
+        }
     }
 
     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<Object> postOperation(final String dmiResourceUrl, final HttpHeaders httpHeaders) {
-        final var httpEntity = new HttpEntity<>(configureHttpHeaders(httpHeaders));
-        return restTemplate.exchange(dmiResourceUrl, HttpMethod.POST, httpEntity, Object.class);
-    }
 }