cps-ncmp-rest/src/main/java/org/onap/cps/ncmp/rest/controller/handlers/NcmpPassthroughResourceRequestHandler.java

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 2022-2023 Nordix Foundation
   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.controller.handlers;
  22
  23 import static org.onap.cps.ncmp.api.impl.operations.DatastoreType.OPERATIONAL;
  24 import static org.onap.cps.ncmp.api.impl.operations.OperationType.READ;
  25
  26 import java.util.Map;
  27 import java.util.UUID;
  28 import java.util.function.Supplier;
  29 import org.onap.cps.ncmp.api.NetworkCmProxyDataService;
  30 import org.onap.cps.ncmp.api.impl.exception.InvalidDatastoreException;
  31 import org.onap.cps.ncmp.api.impl.operations.DatastoreType;
  32 import org.onap.cps.ncmp.api.impl.operations.OperationType;
  33 import org.onap.cps.ncmp.api.models.DataOperationRequest;
  34 import org.onap.cps.ncmp.rest.exceptions.OperationNotSupportedException;
  35 import org.onap.cps.ncmp.rest.executor.CpsNcmpTaskExecutor;
  36 import org.onap.cps.ncmp.rest.util.TopicValidator;
  37 import org.springframework.http.ResponseEntity;
  38 import org.springframework.stereotype.Component;
  39
  40 @Component
  41 public class NcmpPassthroughResourceRequestHandler extends NcmpDatastoreRequestHandler {
  42
  43     private final NetworkCmProxyDataService networkCmProxyDataService;
  44
  45     private static final Object noReturn = null;
  46
  47     /**
  48      * Constructor.
  49      *
  50      * @param cpsNcmpTaskExecutor        @see org.onap.cps.ncmp.rest.executor.CpsNcmpTaskExecutor
  51      * @param networkCmProxyDataService  @see org.onap.cps.ncmp.api.NetworkCmProxyDataService
  52      */
  53     public NcmpPassthroughResourceRequestHandler(final CpsNcmpTaskExecutor cpsNcmpTaskExecutor,
  54                                                  final NetworkCmProxyDataService networkCmProxyDataService) {
  55         super(cpsNcmpTaskExecutor);
  56         this.networkCmProxyDataService = networkCmProxyDataService;
  57     }
  58
  59     /**
  60      * Executes asynchronous request for group of cm handles to resource data.
  61      *
  62      * @param topicParamInQuery        the topic param in query
  63      * @param dataOperationRequest     data operation request details for resource data
  64      * @return the response entity
  65      */
  66     public ResponseEntity<Object> executeRequest(final String topicParamInQuery,
  67                                                  final DataOperationRequest
  68                                                      dataOperationRequest) {
  69         validateDataOperationRequest(topicParamInQuery, dataOperationRequest);
  70         if (!notificationFeatureEnabled) {
  71             return ResponseEntity.ok(Map.of("status",
  72                 "Asynchronous request is unavailable as notification feature is currently disabled."));
  73         }
  74         return getRequestIdAndSendDataOperationRequestToDmiService(topicParamInQuery, dataOperationRequest);
  75     }
  76
  77     @Override
  78     protected Supplier<Object> getTaskSupplierForGetRequest(final String datastoreName,
  79                                                             final String cmHandleId,
  80                                                             final String resourceIdentifier,
  81                                                             final String optionsParamInQuery,
  82                                                             final String topicParamInQuery,
  83                                                             final String requestId,
  84                                                             final boolean includeDescendants) {
  85
  86         return () -> networkCmProxyDataService.getResourceDataForCmHandle(
  87             datastoreName, cmHandleId, resourceIdentifier, optionsParamInQuery, topicParamInQuery, requestId);
  88     }
  89
  90     private ResponseEntity<Object> getRequestIdAndSendDataOperationRequestToDmiService(final String topicParamInQuery,
  91                                                                                        final DataOperationRequest
  92                                                                                            dataOperationRequest) {
  93         final String requestId = UUID.randomUUID().toString();
  94         cpsNcmpTaskExecutor.executeTask(
  95             getTaskSupplierForDataOperationRequest(topicParamInQuery, dataOperationRequest, requestId),
  96             timeOutInMilliSeconds);
  97         return ResponseEntity.ok(Map.of("requestId", requestId));
  98     }
  99
 100     private void validateDataOperationRequest(final String topicParamInQuery,
 101                                               final DataOperationRequest
 102                                                   dataOperationRequest) {
 103         TopicValidator.validateTopicName(topicParamInQuery);
 104         dataOperationRequest.getDataOperationDefinitions().forEach(dataOperationDetail -> {
 105             if (OperationType.fromOperationName(dataOperationDetail.getOperation()) != READ) {
 106                 throw new OperationNotSupportedException(
 107                     dataOperationDetail.getOperation() + " operation not yet supported");
 108             } else if (DatastoreType.fromDatastoreName(dataOperationDetail.getDatastore()) == OPERATIONAL) {
 109                 throw new InvalidDatastoreException(dataOperationDetail.getDatastore()
 110                     + " datastore is not supported");
 111             }
 112         });
 113     }
 114
 115     private Supplier<Object> getTaskSupplierForDataOperationRequest(final String topicParamInQuery,
 116                                                                     final DataOperationRequest dataOperationRequest,
 117                                                                     final String requestId) {
 118         return () -> {
 119             networkCmProxyDataService.executeDataOperationForCmHandles(topicParamInQuery,
 120                 dataOperationRequest,
 121                 requestId);
 122             return noReturn;
 123         };
 124     }
 125
 126 }