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.Collections;
  30 import java.util.HashMap;
  31 import java.util.List;
  32 import java.util.Map;
  33 import java.util.Optional;
  34 import java.util.UUID;
  35 import javax.validation.Valid;
  36 import javax.validation.constraints.NotNull;
  37 import lombok.extern.slf4j.Slf4j;
  38 import org.onap.cps.ncmp.api.impl.operations.DatastoreType;
  39 import org.onap.cps.ncmp.rest.api.NetworkCmProxyApi;
  40 import org.onap.cps.ncmp.rest.model.CmHandleQueryParameters;
  41 import org.onap.cps.ncmp.rest.model.DataOperationRequest;
  42 import org.onap.cps.ncmp.rest.model.RestModuleDefinition;
  43 import org.onap.cps.ncmp.rest.model.RestModuleReference;
  44 import org.onap.cps.ncmp.rest.model.RestOutputCmHandle;
  45 import org.onap.cps.ncmp.rest.model.RestOutputCmHandleCompositeState;
  46 import org.onap.cps.ncmp.rest.model.RestOutputCmHandlePublicProperties;
  47 import org.onap.cps.ncmp.rest.stub.providers.ResourceProvider;
  48 import org.springframework.beans.factory.annotation.Autowired;
  49 import org.springframework.http.HttpStatus;
  50 import org.springframework.http.ResponseEntity;
  51 import org.springframework.web.bind.annotation.RequestMapping;
  52 import org.springframework.web.bind.annotation.RestController;
  53
  54 @Slf4j
  55 @RestController
  56 @RequestMapping("${rest.api.ncmp-stub-base-path}")
  57 public class NetworkCmProxyStubController implements NetworkCmProxyApi {
  58
  59     @Autowired
  60     private ResourceProvider resourceProvider;
  61
  62     @Autowired
  63     private ObjectMapper objectMapper;
  64
  65     private static final String ASYNC_REQUEST_ID = "requestId";
  66
  67     @Override
  68     public ResponseEntity<Object> getResourceDataForCmHandle(final String datastoreName, final String cmHandle,
  69                                                              final String resourceIdentifier,
  70                                                              final String optionsParamInQuery,
  71                                                              final String topicParamInQuery,
  72                                                              final Boolean includeDescendants) {
  73         if (DatastoreType.PASSTHROUGH_OPERATIONAL == DatastoreType.fromDatastoreName(datastoreName)) {
  74             final ResponseEntity<Map<String, Object>> asyncResponse = populateAsyncResponse(topicParamInQuery);
  75             final Map<String, Object> asyncResponseData = asyncResponse.getBody();
  76             Object responseObject = null;
  77             // read JSON file and map/convert to java POJO
  78             try {
  79                 final Optional<Object> optionalResponseObject = getResponseObject(
  80                         "passthrough-operational-example.json", Object.class);
  81                 if (optionalResponseObject.isPresent()) {
  82                     responseObject = optionalResponseObject.get();
  83                 }
  84
  85             } catch (final IOException ioException) {
  86                 log.error("Error reading the file.", ioException);
  87                 return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).build();
  88             }
  89
  90             if (asyncResponseData == null) {
  91                 return ResponseEntity.ok(responseObject);
  92             }
  93             return ResponseEntity.ok(asyncResponse);
  94         }
  95         return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
  96     }
  97
  98     @Override
  99     public ResponseEntity<List<RestOutputCmHandle>> searchCmHandles(
 100             final CmHandleQueryParameters cmHandleQueryParameters) {
 101         // read JSON file and map/convert to java POJO
 102         try {
 103             final Optional<RestOutputCmHandle[]> optionalResponseObject = getResponseObject("cmHandlesSearch.json",
 104                     RestOutputCmHandle[].class);
 105             if (optionalResponseObject.isPresent()) {
 106                 final List<RestOutputCmHandle> restOutputCmHandles = Arrays.asList(optionalResponseObject.get());
 107                 return ResponseEntity.ok(restOutputCmHandles);
 108             }
 109         } catch (final IOException ioException) {
 110             log.error("Error reading the file.", ioException);
 111             return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).build();
 112         }
 113
 114         return ResponseEntity.ok(Collections.<RestOutputCmHandle>emptyList());
 115     }
 116
 117     private ResponseEntity<Map<String, Object>> populateAsyncResponse(final String topicParamInQuery) {
 118         final Map<String, Object> responseData;
 119         if (topicParamInQuery == null) {
 120             responseData = null;
 121         } else {
 122             responseData = getAsyncResponseData();
 123         }
 124         return ResponseEntity.ok().body(responseData);
 125     }
 126
 127     private Map<String, Object> getAsyncResponseData() {
 128         final Map<String, Object> asyncResponseData = new HashMap<>(1);
 129         final String resourceDataRequestId = UUID.randomUUID().toString();
 130         asyncResponseData.put(ASYNC_REQUEST_ID, resourceDataRequestId);
 131         return asyncResponseData;
 132     }
 133
 134     private <T> Optional<T> getResponseObject(final String filename, final Class<T> type) throws IOException {
 135         final Optional<InputStream> optionalInputStream = resourceProvider.getResourceInputStream(filename);
 136         if (optionalInputStream.isPresent()) {
 137             final String content = new String(optionalInputStream.get().readAllBytes(), StandardCharsets.UTF_8);
 138             return Optional.of(objectMapper.readValue(content, type));
 139         }
 140         return Optional.empty();
 141     }
 142
 143     @Override
 144     public ResponseEntity<Void> createResourceDataRunningForCmHandle(@NotNull @Valid final String resourceIdentifier,
 145                                                                      final String datastoreName, final String cmHandle,
 146                                                                      @Valid final Object body,
 147                                                                      final String contentType) {
 148         return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
 149     }
 150
 151     @Override
 152     public ResponseEntity<Void> deleteResourceDataRunningForCmHandle(final String datastoreName, final String cmHandle,
 153                                                                      @NotNull @Valid final String resourceIdentifier,
 154                                                                      final String contentType) {
 155         return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
 156     }
 157
 158     @Override
 159     public ResponseEntity<RestOutputCmHandlePublicProperties> getCmHandlePublicPropertiesByCmHandleId(
 160             final String cmHandle) {
 161         return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
 162     }
 163
 164     @Override
 165     public ResponseEntity<RestOutputCmHandleCompositeState> getCmHandleStateByCmHandleId(final String cmHandle) {
 166         return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
 167     }
 168
 169     @Override
 170     public ResponseEntity<List<RestModuleDefinition>> getModuleDefinitionsByCmHandleId(final String cmHandle) {
 171         return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
 172     }
 173
 174     @Override
 175     public ResponseEntity<List<RestModuleReference>> getModuleReferencesByCmHandle(final String cmHandle) {
 176         return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
 177     }
 178
 179     @Override
 180     public ResponseEntity<Object> executeDataOperationForCmHandles(final String topicParamInQuery,
 181                                                                    final DataOperationRequest dataOperationRequest) {
 182         return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
 183     }
 184
 185     @Override
 186     public ResponseEntity<Object> patchResourceDataRunningForCmHandle(@NotNull @Valid final String resourceIdentifier,
 187                                                                       final String datastoreName, final String cmHandle,
 188                                                                       @Valid final Object body,
 189                                                                       final String contentType) {
 190         return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
 191     }
 192
 193     @Override
 194     public ResponseEntity<Object> queryResourceDataForCmHandle(final String datastoreName, final String cmHandle,
 195                                                                @Valid final String cpsPath, @Valid final String options,
 196                                                                @Valid final String topic,
 197                                                                @Valid final Boolean includeDescendants) {
 198         return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
 199     }
 200
 201     @Override
 202     public ResponseEntity<RestOutputCmHandle> retrieveCmHandleDetailsById(final String cmHandle) {
 203         return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
 204
 205     }
 206
 207     @Override
 208     public ResponseEntity<List<String>> searchCmHandleIds(@Valid final CmHandleQueryParameters body) {
 209         return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
 210
 211     }
 212
 213     @Override
 214     public ResponseEntity<Object> setDataSyncEnabledFlagForCmHandle(final String cmHandle,
 215                                                                     @NotNull @Valid final Boolean dataSyncEnabled) {
 216         return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
 217
 218     }
 219
 220     @Override
 221     public ResponseEntity<Object> updateResourceDataRunningForCmHandle(@NotNull @Valid final String resourceIdentifier,
 222                                                                        final String datastoreName,
 223                                                                        final String cmHandle, @Valid final Object body,
 224                                                                        final String contentType) {
 225         return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
 226
 227     }
 228 }