Support Delete operation for ds Passtrough-Running in NCMP 1/3
[cps.git] / cps-ncmp-rest / src / main / java / org / onap / cps / ncmp / rest / controller / NetworkCmProxyController.java
index d4e842a..3b44b80 100755 (executable)
@@ -3,6 +3,7 @@
  *  Copyright (C) 2021 Pantheon.tech
  *  Modifications (C) 2021 Nordix Foundation
  *  Modification Copyright (C) 2021 highstreet technologies GmbH
+ *  Modifications (C) 2021 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.rest.controller;
 
+import static org.onap.cps.ncmp.api.impl.operations.DmiRequestBody.OperationEnum.CREATE;
+import static org.onap.cps.ncmp.api.impl.operations.DmiRequestBody.OperationEnum.DELETE;
+import static org.onap.cps.ncmp.api.impl.operations.DmiRequestBody.OperationEnum.PATCH;
+import static org.onap.cps.ncmp.api.impl.operations.DmiRequestBody.OperationEnum.UPDATE;
 
-import com.fasterxml.jackson.databind.ObjectMapper;
 import com.google.gson.Gson;
 import com.google.gson.GsonBuilder;
+import java.util.ArrayList;
 import java.util.Collection;
+import java.util.Collections;
+import java.util.List;
+import java.util.stream.Collectors;
 import javax.validation.Valid;
-import javax.validation.constraints.Min;
 import javax.validation.constraints.NotNull;
+import lombok.extern.slf4j.Slf4j;
 import org.onap.cps.ncmp.api.NetworkCmProxyDataService;
-import org.onap.cps.ncmp.api.models.DmiPluginRegistration;
 import org.onap.cps.ncmp.rest.api.NetworkCmProxyApi;
-import org.onap.cps.ncmp.rest.model.RestDmiPluginRegistration;
+import org.onap.cps.ncmp.rest.model.CmHandleProperties;
+import org.onap.cps.ncmp.rest.model.CmHandleProperty;
+import org.onap.cps.ncmp.rest.model.CmHandles;
+import org.onap.cps.ncmp.rest.model.ConditionProperties;
+import org.onap.cps.ncmp.rest.model.Conditions;
+import org.onap.cps.ncmp.rest.model.ModuleNameAsJsonObject;
+import org.onap.cps.ncmp.rest.model.ModuleNamesAsJsonArray;
 import org.onap.cps.spi.FetchDescendantsOption;
 import org.onap.cps.spi.model.DataNode;
+import org.onap.cps.spi.model.ModuleReference;
 import org.onap.cps.utils.DataMapUtils;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
 
+@Slf4j
 @RestController
 @RequestMapping("${rest.api.ncmp-base-path}")
 public class NetworkCmProxyController implements NetworkCmProxyApi {
@@ -49,17 +64,12 @@ public class NetworkCmProxyController implements NetworkCmProxyApi {
 
     private final NetworkCmProxyDataService networkCmProxyDataService;
 
-    private final ObjectMapper objectMapper;
-
     /**
      * Constructor Injection for Dependencies.
      * @param networkCmProxyDataService Data Service Interface
-     * @param objectMapper Object Mapper
      */
-    public NetworkCmProxyController(final NetworkCmProxyDataService networkCmProxyDataService,
-        final ObjectMapper objectMapper) {
+    public NetworkCmProxyController(final NetworkCmProxyDataService networkCmProxyDataService) {
         this.networkCmProxyDataService = networkCmProxyDataService;
-        this.objectMapper = objectMapper;
     }
 
     /**
@@ -100,19 +110,6 @@ public class NetworkCmProxyController implements NetworkCmProxyApi {
         return new ResponseEntity<>(DataMapUtils.toDataMap(dataNode), HttpStatus.OK);
     }
 
-    /**
-     * Update DMI Plugin Registration (used for first registration also).
-     * @param restDmiPluginRegistration the registration data
-     */
-    @Override
-    public ResponseEntity<Void> updateDmiPluginRegistration(
-        final @Valid RestDmiPluginRegistration restDmiPluginRegistration) {
-        final DmiPluginRegistration dmiPluginRegistration =
-            convertRestObjectToJavaApiObject(restDmiPluginRegistration);
-        networkCmProxyDataService.updateDmiPluginRegistration(dmiPluginRegistration);
-        return new ResponseEntity<>(HttpStatus.CREATED);
-    }
-
     /**
      * Query Data Nodes.
      * @deprecated This Method is no longer used as part of NCMP.
@@ -157,22 +154,19 @@ public class NetworkCmProxyController implements NetworkCmProxyApi {
      *
      * @param cmHandle cm handle identifier
      * @param resourceIdentifier resource identifier
-     * @param accept accept header parameter
-     * @param fields fields query parameter
-     * @param depth depth query parameter
+     * @param acceptParamInHeader accept header parameter
+     * @param optionsParamInQuery options query parameter
      * @return {@code ResponseEntity} response from dmi plugin
      */
     @Override
     public ResponseEntity<Object> getResourceDataOperationalForCmHandle(final String cmHandle,
-                                                                        final String resourceIdentifier,
-                                                                        final String accept,
-                                                                        final @Valid String fields,
-                                                                        final @Min(1) @Valid Integer depth) {
+                                                                        final @NotNull @Valid String resourceIdentifier,
+                                                                        final String acceptParamInHeader,
+                                                                        final @Valid String optionsParamInQuery) {
         final Object responseObject = networkCmProxyDataService.getResourceDataOperationalForCmHandle(cmHandle,
                 resourceIdentifier,
-                accept,
-                fields,
-                depth);
+                acceptParamInHeader,
+                optionsParamInQuery);
         return ResponseEntity.ok(responseObject);
     }
 
@@ -181,48 +175,150 @@ public class NetworkCmProxyController implements NetworkCmProxyApi {
      *
      * @param cmHandle cm handle identifier
      * @param resourceIdentifier resource identifier
-     * @param accept accept header parameter
-     * @param fields fields query parameter
-     * @param depth depth query parameter
+     * @param acceptParamInHeader accept header parameter
+     * @param optionsParamInQuery options query parameter
      * @return {@code ResponseEntity} response from dmi plugin
      */
     @Override
     public ResponseEntity<Object> getResourceDataRunningForCmHandle(final String cmHandle,
-                                                                    final String resourceIdentifier,
-                                                                    final String accept,
-                                                                    final @Valid String fields,
-                                                                    final @Min(1) @Valid Integer depth) {
+                                                                    final @NotNull @Valid String resourceIdentifier,
+                                                                    final String acceptParamInHeader,
+                                                                    final @Valid String optionsParamInQuery) {
         final Object responseObject = networkCmProxyDataService.getResourceDataPassThroughRunningForCmHandle(cmHandle,
                 resourceIdentifier,
-                accept,
-                fields,
-                depth);
+                acceptParamInHeader,
+                optionsParamInQuery);
         return ResponseEntity.ok(responseObject);
     }
 
+    @Override
+    public ResponseEntity<Object> patchResourceDataRunningForCmHandle(final String resourceIdentifier,
+        final String cmHandle,
+        final Object requestBody, final String contentType) {
+        networkCmProxyDataService.writeResourceDataPassThroughRunningForCmHandle(cmHandle,
+            resourceIdentifier, PATCH, requestBody.toString(), contentType);
+        return new ResponseEntity<>(HttpStatus.OK);
+    }
+
     /**
-     * Create resource data in datastore pass through running
-     * for given cm-handle.
+     * Create resource data in datastore pass-through running for given cm-handle.
      *
-     * @param cmHandle cm handle identifier
      * @param resourceIdentifier resource identifier
-     * @param requestBody requestBody
+     * @param cmHandle cm handle identifier
+     * @param requestBody the request body
      * @param contentType content type of body
-     * @return {@code ResponseEntity} response from dmi plugi
+     * @return {@code ResponseEntity} response from dmi plugin
      */
     @Override
-    public ResponseEntity<Void> createResourceDataRunningForCmHandle(final String cmHandle,
-                                                                     final String resourceIdentifier,
-                                                                     final Object requestBody,
+    public ResponseEntity<Void> createResourceDataRunningForCmHandle(final String resourceIdentifier,
+                                                                     final String cmHandle,
+                                                                     final String requestBody,
                                                                      final String contentType) {
-        networkCmProxyDataService.createResourceDataPassThroughRunningForCmHandle(cmHandle,
-                resourceIdentifier, requestBody, contentType);
+        networkCmProxyDataService.writeResourceDataPassThroughRunningForCmHandle(cmHandle,
+                resourceIdentifier, CREATE, requestBody, contentType);
         return new ResponseEntity<>(HttpStatus.CREATED);
     }
 
-    private DmiPluginRegistration convertRestObjectToJavaApiObject(
-        final RestDmiPluginRegistration restDmiPluginRegistration) {
-        return objectMapper.convertValue(restDmiPluginRegistration, DmiPluginRegistration.class);
+    /**
+     * Update resource data in datastore pass-through running for given cm-handle.
+     *
+     * @param resourceIdentifier resource identifier
+     * @param cmHandle cm handle identifier
+     * @param requestBody the request body
+     * @param contentType content type of the body
+     * @return response entity
+     */
+    @Override
+    public ResponseEntity<Object> updateResourceDataRunningForCmHandle(final String resourceIdentifier,
+                                                                       final String cmHandle,
+                                                                       final String requestBody,
+                                                                       final String contentType) {
+        networkCmProxyDataService.writeResourceDataPassThroughRunningForCmHandle(cmHandle,
+            resourceIdentifier, UPDATE, requestBody, contentType);
+        return new ResponseEntity<>(HttpStatus.OK);
     }
 
+
+    /**
+     *  Delete resource data in datastore pass-through running for a given cm-handle.
+     *
+     * @param resourceIdentifier resource identifier
+     * @param cmHandle cm handle identifier
+     * @param requestBody the request body
+     * @param contentType content type of the body
+     * @return response entity no content if request is successful
+     */
+    @Override
+    public ResponseEntity<Void> deleteResourceDataRunningForCmHandle(final String resourceIdentifier,
+                                                                     final String cmHandle,
+                                                                     final String requestBody,
+                                                                     final String contentType) {
+
+        networkCmProxyDataService.writeResourceDataPassThroughRunningForCmHandle(cmHandle,
+            resourceIdentifier, DELETE, requestBody, contentType);
+        return new ResponseEntity<>(HttpStatus.NO_CONTENT);
+    }
+
+    /**
+     * Execute cm handle search.
+     *
+     * @param conditions the conditions
+     * @return cm handles returned from search.
+     */
+    @Override
+    public ResponseEntity<CmHandles> executeCmHandleSearch(final Conditions conditions) {
+        final List<ConditionProperties> conditionProperties =
+            conditions.getConditions().stream().collect(Collectors.toList());
+        final CmHandles cmHandles = new CmHandles();
+        cmHandles.setCmHandles(toCmHandleProperties(processConditions(conditionProperties)));
+        return ResponseEntity.ok(cmHandles);
+    }
+
+    /**
+     * Return module references for a cm handle.
+     *
+     * @param cmHandle the cm handle
+     * @return module references for cm handle
+     */
+    @Override
+    public ResponseEntity<Object> getModuleReferencesByCmHandle(final String cmHandle) {
+        final Collection<ModuleReference>
+            moduleReferences = networkCmProxyDataService.getYangResourcesModuleReferences(cmHandle);
+        return new ResponseEntity<>(new Gson().toJson(moduleReferences), HttpStatus.OK);
+    }
+
+    private Collection<String> processConditions(final List<ConditionProperties> conditionProperties) {
+        for (final ConditionProperties conditionProperty : conditionProperties) {
+            if (conditionProperty.getName().equals("hasAllModules")) {
+                return executeCmHandleSearchesForModuleNames(conditionProperty);
+            } else {
+                log.warn("Unrecognized condition name {}.", conditionProperty.getName());
+            }
+        }
+        log.warn("No valid conditions found {}.", conditionProperties);
+        return Collections.emptyList();
+    }
+
+    private Collection<String> executeCmHandleSearchesForModuleNames(final ConditionProperties conditionProperties) {
+        return networkCmProxyDataService
+            .executeCmHandleHasAllModulesSearch(getModuleNames(conditionProperties.getConditionParameters()));
+    }
+
+    private Collection<String> getModuleNames(final ModuleNamesAsJsonArray moduleNamesAsJsonArray) {
+        final Collection<String> moduleNames = new ArrayList<>(moduleNamesAsJsonArray.size());
+        for (final ModuleNameAsJsonObject moduleNameAsJsonObject : moduleNamesAsJsonArray) {
+            moduleNames.add(moduleNameAsJsonObject.getModuleName());
+        }
+        return moduleNames;
+    }
+
+    private CmHandleProperties toCmHandleProperties(final Collection<String> cmHandleIdentifiers) {
+        final CmHandleProperties cmHandleProperties = new CmHandleProperties();
+        for (final String cmHandleIdentifier : cmHandleIdentifiers) {
+            final CmHandleProperty cmHandleProperty = new CmHandleProperty();
+            cmHandleProperty.setCmHandleId(cmHandleIdentifier);
+            cmHandleProperties.add(cmHandleProperty);
+        }
+        return cmHandleProperties;
+    }
 }