Get data job status from DMI Plugin

    - added java interface
    - extended DmiRestClient to get data job status
    - added testware

Issue-ID: CPS-2296
Change-Id: If9006bba06397724c15bdc3bdf1bd52a0188f002
Signed-off-by: leventecsanyi <levente.csanyi@est.tech>

3 files changed, 132 insertions, 0 deletions

diff --git a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/datajobs/DataJobStatusService.java b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/datajobs/DataJobStatusService.java
new file mode 100644
index 0000000000..50d96f858c
--- /dev/null
+++ b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/datajobs/DataJobStatusService.java
@@ -0,0 +1,45 @@
+/*
+ *  ============LICENSE_START=======================================================
+ *  Copyright (C) 2024 Nordix Foundation
+ *  ================================================================================
+ *  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.datajobs;
+
+/**
+ * Service interface to check the status of a data job.
+ * The operations interact with a DMI Plugin to retrieve data job statuses.
+ */
+public interface DataJobStatusService {
+
+    /**
+     * Retrieves the current status of a specific data job.
+     *
+     * @param authorization     The authorization header from the REST request.
+     * @param dmiServiceName    The name of the DMI Service relevant to the data job.
+     * @param requestId         The unique identifier for the overall data job request.
+     * @param dataProducerJobId The identifier of the data producer job within the DMI system.
+     * @param dataProducerId    The ID of the producer registered by DMI, used for operations related to this request.
+     *                          This could include alternate IDs or specific identifiers.
+     * @return The current status of the data job as a String.
+     */
+    String getDataJobStatus(final String authorization,
+                            final String dmiServiceName,
+                            final String requestId,
+                            final String dataProducerJobId,
+                            final String dataProducerId);
+}
diff --git a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/impl/datajobs/DataJobStatusServiceImpl.java b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/impl/datajobs/DataJobStatusServiceImpl.java
new file mode 100644
index 0000000000..a6ecaa1097
--- /dev/null
+++ b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/impl/datajobs/DataJobStatusServiceImpl.java
@@ -0,0 +1,67 @@
+/*
+ *  ============LICENSE_START=======================================================
+ *  Copyright (C) 2024 Nordix Foundation
+ *  ================================================================================
+ *  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.impl.datajobs;
+
+import lombok.RequiredArgsConstructor;
+import org.onap.cps.ncmp.api.datajobs.DataJobStatusService;
+import org.onap.cps.ncmp.impl.dmi.DmiProperties;
+import org.onap.cps.ncmp.impl.dmi.DmiRestClient;
+import org.onap.cps.ncmp.impl.dmi.DmiServiceUrlTemplateBuilder;
+import org.onap.cps.ncmp.impl.dmi.UrlTemplateParameters;
+import org.springframework.stereotype.Service;
+
+/**
+ * Implementation of {@link DataJobStatusService} interface.
+ * The operations interact with a DMI Plugin to retrieve data job statuses.
+ */
+@Service
+@RequiredArgsConstructor
+public class DataJobStatusServiceImpl implements DataJobStatusService {
+
+    private final DmiRestClient dmiRestClient;
+    private final DmiProperties dmiProperties;
+
+    @Override
+    public String getDataJobStatus(final String authorization,
+                                   final String dmiServiceName,
+                                   final String requestId,
+                                   final String dataProducerJobId,
+                                   final String dataProducerId) {
+
+        final UrlTemplateParameters urlTemplateParameters = buildUrlParameters(dmiServiceName, requestId,
+                dataProducerJobId, dataProducerId);
+        return dmiRestClient.getDataJobStatus(urlTemplateParameters, authorization).block();
+    }
+
+    private UrlTemplateParameters buildUrlParameters(final String dmiServiceName,
+                                                     final String requestId,
+                                                     final String dataProducerJobId,
+                                                     final String dataProducerId) {
+        return DmiServiceUrlTemplateBuilder.newInstance()
+                .fixedPathSegment("dataJob")
+                .variablePathSegment("requestId", requestId)
+                .fixedPathSegment("dataProducerJob")
+                .variablePathSegment("dataProducerJobId", dataProducerJobId)
+                .fixedPathSegment("status")
+                .queryParameter("dataProducerId", dataProducerId)
+                .createUrlTemplateParameters(dmiServiceName, dmiProperties.getDmiBasePath());
+    }
+}
diff --git a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/impl/dmi/DmiRestClient.java b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/impl/dmi/DmiRestClient.java
index 7ac85cbf84..ba6bba9c53 100644
--- a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/impl/dmi/DmiRestClient.java
+++ b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/impl/dmi/DmiRestClient.java
@@ -144,6 +144,26 @@ public class DmiRestClient {
                 .defaultIfEmpty(NOT_SPECIFIED);
     }
 
+    /**
+     * Retrieves the status of a data job from the DMI service.
+     *
+     * @param urlTemplateParameters   The URL template parameters for the DMI data job status endpoint.
+     * @param authorization           The authorization token to be added to the request headers.
+     * @return A Mono emitting the status of the data job as a String.
+     * @throws DmiClientRequestException If there is an error during the DMI request.
+     */
+    public Mono<String> getDataJobStatus(final UrlTemplateParameters urlTemplateParameters,
+                                         final String authorization) {
+
+        return dataServicesWebClient.get()
+                .uri(urlTemplateParameters.urlTemplate(), urlTemplateParameters.urlVariables())
+                .headers(httpHeaders -> configureHttpHeaders(httpHeaders, authorization))
+                .retrieve()
+                .bodyToMono(JsonNode.class)
+                .map(responseHealthStatus -> responseHealthStatus.path("status").asText())
+                .onErrorMap(throwable -> handleDmiClientException(throwable, OperationType.READ.getOperationName()));
+    }
+
     private WebClient getWebClient(final RequiredDmiService requiredDmiService) {
         return requiredDmiService.equals(RequiredDmiService.DATA) ? dataServicesWebClient : modelServicesWebClient;
     }