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.Arrays;
  28 import java.util.HashMap;
  29 import java.util.List;
  30 import java.util.Map;
  31 import java.util.UUID;
  32 import javax.validation.Valid;
  33 import javax.validation.constraints.NotNull;
  34 import lombok.extern.slf4j.Slf4j;
  35 import org.onap.cps.ncmp.rest.api.NetworkCmProxyApi;
  36 import org.onap.cps.ncmp.rest.model.CmHandleQueryParameters;
  37 import org.onap.cps.ncmp.rest.model.RestModuleDefinition;
  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.RestOutputCmHandleCompositeState;
  41 import org.onap.cps.ncmp.rest.model.RestOutputCmHandlePublicProperties;
  42 import org.springframework.beans.factory.annotation.Value;
  43 import org.springframework.core.io.ClassPathResource;
  44 import org.springframework.http.HttpStatus;
  45 import org.springframework.http.ResponseEntity;
  46 import org.springframework.web.bind.annotation.RequestMapping;
  47 import org.springframework.web.bind.annotation.RestController;
  48
  49 @Slf4j
  50 @RestController
  51 @RequestMapping("${rest.api.ncmp-stub-base-path}")
  52 public class NetworkCmProxyStubController implements NetworkCmProxyApi {
  53
  54     public static final String ASYNC_REQUEST_ID = "requestId";
  55
  56     @Value("${stub.path}")
  57     private String pathToResponseFiles;
  58
  59     @Override
  60     public ResponseEntity<Void> createResourceDataRunningForCmHandle(@NotNull @Valid final String resourceIdentifier,
  61         final String cmHandleId, @Valid final Object body, final String contentType) {
  62         return new ResponseEntity<>(HttpStatus.CREATED);
  63     }
  64
  65     @Override
  66     public ResponseEntity<Void> deleteResourceDataRunningForCmHandle(final String cmHandleId,
  67         @NotNull @Valid final String resourceIdentifier, final String contentType) {
  68         return new ResponseEntity<>(HttpStatus.NO_CONTENT);
  69     }
  70
  71     @Override
  72     public ResponseEntity<List<RestOutputCmHandle>> searchCmHandles(
  73         final CmHandleQueryParameters cmHandleQueryParameters) {
  74         List<RestOutputCmHandle> restOutputCmHandles = null;
  75         // read JSON file and map/convert to java POJO
  76         final ClassPathResource resource = new ClassPathResource(pathToResponseFiles + "cmHandlesSearch.json");
  77         try (InputStream inputStream = resource.getInputStream()) {
  78             final String string = new String(inputStream.readAllBytes(), StandardCharsets.UTF_8);
  79             final ObjectMapper mapper = new ObjectMapper();
  80             restOutputCmHandles = Arrays.asList(mapper.readValue(string, RestOutputCmHandle[].class));
  81         } catch (final IOException exception) {
  82             log.error("Error reading the file.", exception);
  83             return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).build();
  84         }
  85         return ResponseEntity.ok(restOutputCmHandles);
  86     }
  87
  88     @Override
  89     public ResponseEntity<List<String>> searchCmHandleIds(
  90         final CmHandleQueryParameters cmHandleQueryParameters) {
  91         return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
  92     }
  93
  94     @Override
  95     public ResponseEntity<RestOutputCmHandlePublicProperties> getCmHandlePublicPropertiesByCmHandleId(
  96         final String cmHandleId) {
  97         return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
  98     }
  99
 100     @Override
 101     public ResponseEntity<RestOutputCmHandleCompositeState> getCmHandleStateByCmHandleId(final String cmHandle) {
 102         return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
 103     }
 104
 105     @Override
 106     public ResponseEntity<List<RestModuleDefinition>> getModuleDefinitionsByCmHandleId(final String cmHandle) {
 107         return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
 108     }
 109
 110     @Override
 111     public ResponseEntity<List<RestModuleReference>> getModuleReferencesByCmHandle(final String cmHandleId) {
 112         return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
 113     }
 114
 115     /**
 116      * Get resource data from operational datastore.
 117      *
 118      * @param cmHandleId cm handle identifier
 119      * @param resourceIdentifier resource identifier
 120      * @param optionsParamInQuery options query parameter
 121      * @param topicParamInQuery topic query parameter
 122      * @return {@code ResponseEntity} response from dmi plugin
 123      */
 124     @Override
 125     public ResponseEntity<Object> getResourceDataOperationalForCmHandle(final String cmHandleId,
 126         final String resourceIdentifier, final String optionsParamInQuery, final String topicParamInQuery) {
 127         final ResponseEntity<Map<String, Object>> asyncResponse = populateAsyncResponse(topicParamInQuery);
 128         final Map<String, Object> asyncResponseData = asyncResponse.getBody();
 129         Object responseObject = null;
 130         // read JSON file and map/convert to java POJO
 131         final ClassPathResource resource = new ClassPathResource(pathToResponseFiles
 132             + "passthrough-operational-example.json");
 133         try (InputStream inputStream = resource.getInputStream()) {
 134             final String string = new String(inputStream.readAllBytes(), StandardCharsets.UTF_8);
 135             final ObjectMapper mapper = new ObjectMapper();
 136             responseObject = mapper.readValue(string, Object.class);
 137         } catch (final IOException exception) {
 138             log.error("Error reading the file.", exception);
 139             return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).build();
 140         }
 141         if (asyncResponseData == null) {
 142             return ResponseEntity.ok(responseObject);
 143         }
 144         return ResponseEntity.ok(asyncResponse);
 145
 146     }
 147
 148     @Override
 149     public ResponseEntity<Object> getResourceDataRunningForCmHandle(final String cmHandleId,
 150         final String resourceIdentifier, final String options, final String topic) {
 151         return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
 152     }
 153
 154     @Override
 155     public ResponseEntity<Object> patchResourceDataRunningForCmHandle(final String resourceIdentifier,
 156         final String cmHandleId, final Object body, final String contentType) {
 157         return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
 158     }
 159
 160     @Override
 161     public ResponseEntity<RestOutputCmHandle> retrieveCmHandleDetailsById(final String cmHandleId) {
 162         return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
 163     }
 164
 165     @Override
 166     public ResponseEntity<Object> updateResourceDataRunningForCmHandle(@NotNull @Valid final String resourceIdentifier,
 167         final String cmHandleId, @Valid final Object body, final String contentType) {
 168         return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
 169     }
 170
 171     private ResponseEntity<Map<String, Object>> populateAsyncResponse(final String topicParamInQuery) {
 172         final Map<String, Object> responseData;
 173         if (topicParamInQuery != null) {
 174             responseData = getAsyncResponseData();
 175         } else {
 176             responseData = null;
 177         }
 178         return ResponseEntity.ok().body(responseData);
 179     }
 180
 181     private Map<String, Object> getAsyncResponseData() {
 182         final Map<String, Object> asyncResponseData = new HashMap<>(1);
 183         final String resourceDataRequestId = UUID.randomUUID().toString();
 184         asyncResponseData.put(ASYNC_REQUEST_ID, resourceDataRequestId);
 185         return asyncResponseData;
 186     }
 187 }