cps-ncmp-rest-stub/src/main/java/org/onap/cps/ncmp/rest/stub/controller/NetworkCmProxyStubController.java

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 2022 Bell Canada
   4  *  ================================================================================
   5  *  Licensed under the Apache License, Version 2.0 (the "License");
   6  *  you may not use this file except in compliance with the License.
   7  *  You may obtain a copy of the License at
   8  *
   9  *        http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  *  Unless required by applicable law or agreed to in writing, software
  12  *  distributed under the License is distributed on an "AS IS" BASIS,
  13  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  *  See the License for the specific language governing permissions and
  15  *  limitations under the License.
  16  *
  17  *  SPDX-License-Identifier: Apache-2.0
  18  *  ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.cps.ncmp.rest.stub.controller;
  22
  23 import com.fasterxml.jackson.databind.ObjectMapper;
  24 import java.io.IOException;
  25 import java.io.InputStream;
  26 import java.nio.charset.StandardCharsets;
  27 import java.util.HashMap;
  28 import java.util.List;
  29 import java.util.Map;
  30 import java.util.UUID;
  31 import javax.validation.Valid;
  32 import javax.validation.constraints.NotNull;
  33 import lombok.extern.slf4j.Slf4j;
  34 import org.onap.cps.ncmp.rest.api.NetworkCmProxyApi;
  35 import org.onap.cps.ncmp.rest.model.CmHandleQueryRestParameters;
  36 import org.onap.cps.ncmp.rest.model.CmHandles;
  37 import org.onap.cps.ncmp.rest.model.Conditions;
  38 import org.onap.cps.ncmp.rest.model.RestModuleReference;
  39 import org.onap.cps.ncmp.rest.model.RestOutputCmHandle;
  40 import org.onap.cps.ncmp.rest.model.RestOutputCmHandlePublicProperties;
  41 import org.springframework.beans.factory.annotation.Value;
  42 import org.springframework.core.io.ClassPathResource;
  43 import org.springframework.http.HttpStatus;
  44 import org.springframework.http.ResponseEntity;
  45 import org.springframework.web.bind.annotation.RequestMapping;
  46 import org.springframework.web.bind.annotation.RestController;
  47
  48 @Slf4j
  49 @RestController
  50 @RequestMapping("${rest.api.ncmp-stub-base-path}")
  51 public class NetworkCmProxyStubController implements NetworkCmProxyApi {
  52
  53     public static final String ASYNC_REQUEST_ID = "requestId";
  54
  55     @Value("${stub.path}")
  56     private String pathToResponseFiles;
  57
  58     @Override
  59     public ResponseEntity<Void> createResourceDataRunningForCmHandle(@NotNull @Valid final String resourceIdentifier,
  60         final String cmHandleId, @Valid final Object body, final String contentType) {
  61         return new ResponseEntity<>(HttpStatus.CREATED);
  62     }
  63
  64     @Override
  65     public ResponseEntity<Void> deleteResourceDataRunningForCmHandle(final String cmHandleId,
  66         @NotNull @Valid final String resourceIdentifier, final String contentType) {
  67         return new ResponseEntity<>(HttpStatus.NO_CONTENT);
  68     }
  69
  70     @Override
  71     public ResponseEntity<CmHandles> executeCmHandleSearch(@Valid final Conditions body) {
  72         final ObjectMapper mapper = new ObjectMapper();
  73         CmHandles cmHandles = new CmHandles();
  74         // read JSON file and map/convert to java POJO
  75         final ClassPathResource resource = new ClassPathResource(pathToResponseFiles + "cmHandlesSearch.json");
  76         try (InputStream inputStream = resource.getInputStream()) {
  77             final String string = new String(inputStream.readAllBytes(), StandardCharsets.UTF_8);
  78             cmHandles = mapper.readValue(string, CmHandles.class);
  79         } catch (final IOException exception) {
  80             log.error("Error reading the file.", exception);
  81         }
  82         return ResponseEntity.ok(cmHandles);
  83     }
  84
  85     @Override
  86     public ResponseEntity<RestOutputCmHandlePublicProperties> getCmHandlePublicPropertiesByCmHandleId(
  87         final String cmHandleId) {
  88         return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
  89     }
  90
  91     @Override
  92     public ResponseEntity<List<RestModuleReference>> getModuleReferencesByCmHandle(final String cmHandleId) {
  93         return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
  94     }
  95
  96     /**
  97      * Get resource data from operational datastore.
  98      *
  99      * @param cmHandleId cm handle identifier
 100      * @param resourceIdentifier resource identifier
 101      * @param optionsParamInQuery options query parameter
 102      * @param topicParamInQuery topic query parameter
 103      * @return {@code ResponseEntity} response from dmi plugin
 104      */
 105     @Override
 106     public ResponseEntity<Object> getResourceDataOperationalForCmHandle(final String cmHandleId,
 107         final String resourceIdentifier, final String optionsParamInQuery, final String topicParamInQuery) {
 108         final ResponseEntity<Map<String, Object>> asyncResponse = populateAsyncResponse(topicParamInQuery);
 109         final Map<String, Object> asyncResponseData = asyncResponse.getBody();
 110         final ObjectMapper mapper = new ObjectMapper();
 111         Object responseObject = null;
 112         // read JSON file and map/convert to java POJO
 113         final ClassPathResource resource = new ClassPathResource(pathToResponseFiles
 114             + "passthrough-operational-example.json");
 115         try (InputStream inputStream = resource.getInputStream()) {
 116             final String string = new String(inputStream.readAllBytes(), StandardCharsets.UTF_8);
 117             responseObject = mapper.readValue(string, Object.class);
 118         } catch (final IOException exception) {
 119             log.error("Error reading the file.", exception);
 120         }
 121         if (asyncResponseData == null) {
 122             return ResponseEntity.ok(responseObject);
 123         }
 124         return ResponseEntity.ok(asyncResponse);
 125
 126     }
 127
 128     @Override
 129     public ResponseEntity<Object> getResourceDataRunningForCmHandle(final String cmHandleId,
 130         final String resourceIdentifier, final String options, final String topic) {
 131         return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
 132     }
 133
 134     @Override
 135     public ResponseEntity<Object> patchResourceDataRunningForCmHandle(final String resourceIdentifier,
 136         final String cmHandleId, final Object body, final String contentType) {
 137         return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
 138     }
 139
 140     @Override
 141     public ResponseEntity<List<String>> queryCmHandles(final CmHandleQueryRestParameters body) {
 142         return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
 143     }
 144
 145     @Override
 146     public ResponseEntity<RestOutputCmHandle> retrieveCmHandleDetailsById(final String cmHandleId) {
 147         return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
 148     }
 149
 150     @Override
 151     public ResponseEntity<Object> updateResourceDataRunningForCmHandle(@NotNull @Valid final String resourceIdentifier,
 152         final String cmHandleId, @Valid final Object body, final String contentType) {
 153         return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
 154     }
 155
 156     private ResponseEntity<Map<String, Object>> populateAsyncResponse(final String topicParamInQuery) {
 157         final Map<String, Object> responseData;
 158         if (topicParamInQuery != null) {
 159             responseData = getAsyncResponseData();
 160         } else {
 161             responseData = null;
 162         }
 163         return ResponseEntity.ok().body(responseData);
 164     }
 165
 166     private Map<String, Object> getAsyncResponseData() {
 167         final Map<String, Object> asyncResponseData = new HashMap<>(1);
 168         final String resourceDataRequestId = UUID.randomUUID().toString();
 169         asyncResponseData.put(ASYNC_REQUEST_ID, resourceDataRequestId);
 170         return asyncResponseData;
 171     }
 172 }