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

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 2022 Bell Canada
   4  *  Modifications Copyright (c) 2022-2023 Nordix Foundation
   5  *  ================================================================================
   6  *  Licensed under the Apache License, Version 2.0 (the "License");
   7  *  you may not use this file except in compliance with the License.
   8  *  You may obtain a copy of the License at
   9  *
  10  *        http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  *  Unless required by applicable law or agreed to in writing, software
  13  *  distributed under the License is distributed on an "AS IS" BASIS,
  14  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  *  See the License for the specific language governing permissions and
  16  *  limitations under the License.
  17  *
  18  *  SPDX-License-Identifier: Apache-2.0
  19  *  ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.cps.ncmp.rest.stub.controller;
  23
  24 import com.fasterxml.jackson.databind.ObjectMapper;
  25 import java.io.IOException;
  26 import java.io.InputStream;
  27 import java.nio.charset.StandardCharsets;
  28 import java.util.Arrays;
  29 import java.util.HashMap;
  30 import java.util.List;
  31 import java.util.Map;
  32 import java.util.UUID;
  33 import javax.validation.Valid;
  34 import javax.validation.constraints.NotNull;
  35 import lombok.extern.slf4j.Slf4j;
  36 import org.onap.cps.ncmp.api.impl.operations.DatastoreType;
  37 import org.onap.cps.ncmp.rest.api.NetworkCmProxyApi;
  38 import org.onap.cps.ncmp.rest.model.CmHandleQueryParameters;
  39 import org.onap.cps.ncmp.rest.model.ResourceDataBatchRequest;
  40 import org.onap.cps.ncmp.rest.model.RestModuleDefinition;
  41 import org.onap.cps.ncmp.rest.model.RestModuleReference;
  42 import org.onap.cps.ncmp.rest.model.RestOutputCmHandle;
  43 import org.onap.cps.ncmp.rest.model.RestOutputCmHandleCompositeState;
  44 import org.onap.cps.ncmp.rest.model.RestOutputCmHandlePublicProperties;
  45 import org.springframework.beans.factory.annotation.Value;
  46 import org.springframework.core.io.ClassPathResource;
  47 import org.springframework.http.HttpStatus;
  48 import org.springframework.http.ResponseEntity;
  49 import org.springframework.web.bind.annotation.RequestMapping;
  50 import org.springframework.web.bind.annotation.RestController;
  51
  52
  53 @Slf4j
  54 @RestController
  55 @RequestMapping("${rest.api.ncmp-stub-base-path}")
  56 public class NetworkCmProxyStubController implements NetworkCmProxyApi {
  57
  58     @Value("${stub.path}")
  59     private String pathToResponseFiles;
  60     private static final String ASYNC_REQUEST_ID = "requestId";
  61
  62     @Override
  63     public ResponseEntity<Object> getResourceDataForCmHandle(final String datastoreName, final String cmHandle,
  64                                                              final String resourceIdentifier,
  65                                                              final String optionsParamInQuery,
  66                                                              final String topicParamInQuery,
  67                                                              final Boolean includeDescendants) {
  68         if (DatastoreType.PASSTHROUGH_OPERATIONAL == DatastoreType.fromDatastoreName(datastoreName)) {
  69             final ResponseEntity<Map<String, Object>> asyncResponse = populateAsyncResponse(topicParamInQuery);
  70             final Map<String, Object> asyncResponseData = asyncResponse.getBody();
  71             Object responseObject = null;
  72             // read JSON file and map/convert to java POJO
  73             final ClassPathResource resource = new ClassPathResource(
  74                     pathToResponseFiles + "passthrough-operational-example.json");
  75             try (InputStream inputStream = resource.getInputStream()) {
  76                 final String string = new String(inputStream.readAllBytes(), StandardCharsets.UTF_8);
  77                 final ObjectMapper mapper = new ObjectMapper();
  78                 responseObject = mapper.readValue(string, Object.class);
  79             } catch (final IOException exception) {
  80                 log.error("Error reading the file.", exception);
  81                 return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).build();
  82             }
  83             if (asyncResponseData == null) {
  84                 return ResponseEntity.ok(responseObject);
  85             }
  86             return ResponseEntity.ok(asyncResponse);
  87         }
  88         return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
  89     }
  90
  91     @Override
  92     public ResponseEntity<List<RestOutputCmHandle>> searchCmHandles(
  93             final CmHandleQueryParameters cmHandleQueryParameters) {
  94         List<RestOutputCmHandle> restOutputCmHandles = null;
  95         // read JSON file and map/convert to java POJO
  96         final ClassPathResource resource = new ClassPathResource(pathToResponseFiles + "cmHandlesSearch.json");
  97         try (InputStream inputStream = resource.getInputStream()) {
  98             final String string = new String(inputStream.readAllBytes(), StandardCharsets.UTF_8);
  99             final ObjectMapper mapper = new ObjectMapper();
 100             restOutputCmHandles = Arrays.asList(mapper.readValue(string, RestOutputCmHandle[].class));
 101         } catch (final IOException exception) {
 102             log.error("Error reading the file.", exception);
 103             return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).build();
 104         }
 105         return ResponseEntity.ok(restOutputCmHandles);
 106     }
 107
 108     private ResponseEntity<Map<String, Object>> populateAsyncResponse(final String topicParamInQuery) {
 109         final Map<String, Object> responseData;
 110         if (topicParamInQuery == null) {
 111             responseData = null;
 112         } else {
 113             responseData = getAsyncResponseData();
 114         }
 115         return ResponseEntity.ok().body(responseData);
 116     }
 117
 118     private Map<String, Object> getAsyncResponseData() {
 119         final Map<String, Object> asyncResponseData = new HashMap<>(1);
 120         final String resourceDataRequestId = UUID.randomUUID().toString();
 121         asyncResponseData.put(ASYNC_REQUEST_ID, resourceDataRequestId);
 122         return asyncResponseData;
 123     }
 124
 125     @Override
 126     public ResponseEntity<Void> createResourceDataRunningForCmHandle(@NotNull @Valid final String resourceIdentifier,
 127                                                                      final String datastoreName, final String cmHandle,
 128                                                                      @Valid final Object body,
 129                                                                      final String contentType) {
 130         return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
 131     }
 132
 133     @Override
 134     public ResponseEntity<Void> deleteResourceDataRunningForCmHandle(final String datastoreName, final String cmHandle,
 135                                                                      @NotNull @Valid final String resourceIdentifier,
 136                                                                      final String contentType) {
 137         return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
 138     }
 139
 140     @Override
 141     public ResponseEntity<RestOutputCmHandlePublicProperties> getCmHandlePublicPropertiesByCmHandleId(
 142             final String cmHandle) {
 143         return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
 144     }
 145
 146     @Override
 147     public ResponseEntity<RestOutputCmHandleCompositeState> getCmHandleStateByCmHandleId(final String cmHandle) {
 148         return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
 149     }
 150
 151     @Override
 152     public ResponseEntity<List<RestModuleDefinition>> getModuleDefinitionsByCmHandleId(final String cmHandle) {
 153         return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
 154     }
 155
 156     @Override
 157     public ResponseEntity<List<RestModuleReference>> getModuleReferencesByCmHandle(final String cmHandle) {
 158         return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
 159     }
 160
 161     @Override
 162     public ResponseEntity<Object> getResourceDataForCmHandleBatch(@NotNull @Valid final String topic,
 163                                                                   @Valid final ResourceDataBatchRequest body) {
 164         return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
 165     }
 166
 167     @Override
 168     public ResponseEntity<Object> patchResourceDataRunningForCmHandle(@NotNull @Valid final String resourceIdentifier,
 169                                                                       final String datastoreName, final String cmHandle,
 170                                                                       @Valid final Object body,
 171                                                                       final String contentType) {
 172         return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
 173     }
 174
 175     @Override
 176     public ResponseEntity<Object> queryResourceDataForCmHandle(final String datastoreName, final String cmHandle,
 177                                                                @Valid final String cpsPath, @Valid final String options,
 178                                                                @Valid final String topic,
 179                                                                @Valid final Boolean includeDescendants) {
 180         return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
 181     }
 182
 183     @Override
 184     public ResponseEntity<RestOutputCmHandle> retrieveCmHandleDetailsById(final String cmHandle) {
 185         return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
 186
 187     }
 188
 189     @Override
 190     public ResponseEntity<List<String>> searchCmHandleIds(@Valid final CmHandleQueryParameters body) {
 191         return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
 192
 193     }
 194
 195     @Override
 196     public ResponseEntity<Object> setDataSyncEnabledFlagForCmHandle(final String cmHandle,
 197                                                                     @NotNull @Valid final Boolean dataSyncEnabled) {
 198         return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
 199
 200     }
 201
 202     @Override
 203     public ResponseEntity<Object> updateResourceDataRunningForCmHandle(@NotNull @Valid final String resourceIdentifier,
 204                                                                        final String datastoreName,
 205                                                                        final String cmHandle, @Valid final Object body,
 206                                                                        final String contentType) {
 207         return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
 208
 209     }
 210 }