gerrit.onap Code Review - cps.git/blob

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 2025-2026 OpenInfra Foundation Europe
   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.impl.data.policyexecutor;
  22
  23 import static java.util.Collections.emptyList;
  24 import static org.onap.cps.ncmp.api.data.models.OperationType.CREATE;
  25 import static org.onap.cps.ncmp.api.data.models.OperationType.UPDATE;
  26
  27 import java.util.HashMap;
  28 import java.util.List;
  29 import java.util.Map;
  30 import lombok.RequiredArgsConstructor;
  31 import lombok.extern.slf4j.Slf4j;
  32 import org.onap.cps.ncmp.api.data.models.OperationType;
  33 import org.onap.cps.ncmp.api.exceptions.ProvMnSException;
  34 import org.onap.cps.ncmp.impl.provmns.ParameterHelper;
  35 import org.onap.cps.ncmp.impl.provmns.RequestParameters;
  36 import org.onap.cps.ncmp.impl.provmns.model.PatchItem;
  37 import org.onap.cps.utils.JsonObjectMapper;
  38 import org.springframework.http.HttpStatus;
  39 import org.springframework.stereotype.Service;
  40
  41 @Slf4j
  42 @Service
  43 @RequiredArgsConstructor
  44 public class OperationDetailsFactory {
  45
  46     private static final String ATTRIBUTE_NAME_SEPARATOR = "/";
  47     private static final String REGEX_FOR_LEADING_AND_TRAILING_SEPARATORS = "(^/)|(/$)";
  48
  49     private final JsonObjectMapper jsonObjectMapper;
  50
  51     /**
  52      * Create OperationDetails object from ProvMnS request details.
  53      *
  54      * @param requestParameters request parameters including uri-ldn-first-part, className and id
  55      * @param patchItem provided request payload
  56      * @return OperationDetails object
  57      */
  58     public OperationDetails buildOperationDetails(final RequestParameters requestParameters,
  59                                                   final PatchItem patchItem) {
  60         final OperationDetails operationDetails;
  61         switch (patchItem.getOp()) {
  62             case ADD:
  63                 operationDetails = buildOperationDetails(CREATE, requestParameters, patchItem.getValue());
  64                 break;
  65             case REPLACE:
  66                 if (patchItem.getPath().contains("#/attributes")) {
  67                     operationDetails = buildOperationDetailsForPatchItemWithHash(requestParameters, patchItem);
  68                 } else {
  69                     operationDetails = buildOperationDetails(UPDATE, requestParameters, patchItem.getValue());
  70                 }
  71                 break;
  72             case REMOVE:
  73                 operationDetails = buildOperationDetailsForDelete(requestParameters.fdn());
  74                 break;
  75             default:
  76                 throw new ProvMnSException("PATCH", HttpStatus.UNPROCESSABLE_ENTITY,
  77                     "Unsupported Patch Operation Type: " + patchItem.getOp().getValue(), patchItem.getOp().getValue());
  78         }
  79         return operationDetails;
  80     }
  81
  82     /**
  83      * Build a OperationDetails object from ProvMnS request details.
  84      *
  85      * @param operationType     Type of operation create, update.
  86      * @param requestParameters request parameters including uri-ldn-first-part, className and id
  87      * @param resourceAsObject  provided request payload
  88      * @return OperationDetails object
  89      */
  90     public OperationDetails buildOperationDetails(final OperationType operationType,
  91                                                   final RequestParameters requestParameters,
  92                                                   final Object resourceAsObject) {
  93         final ResourceObjectDetails resourceObjectDetails = createResourceObjectDetails(resourceAsObject,
  94             requestParameters);
  95         final String parentFdn = ParameterHelper.extractParentFdn(requestParameters.fdn());
  96         final List<ClassInstance> classInstances
  97             = List.of(new ClassInstance(resourceObjectDetails.id(), resourceObjectDetails.attributes()));
  98         return new OperationDetails(operationType, parentFdn, resourceObjectDetails.objectClass(), classInstances);
  99     }
 100
 101     /**
 102      * Build a OperationDetails object from ProvMnS request details for delete.
 103      *
 104      * @param fdn    fdn to be deleted
 105      * @return OperationDetails object
 106      */
 107     public OperationDetails buildOperationDetailsForDelete(final String fdn) {
 108         final String parentFdn = ParameterHelper.extractParentFdn(fdn);
 109         return new OperationDetails(OperationType.DELETE, parentFdn, "", emptyList());
 110     }
 111
 112     private OperationDetails buildOperationDetailsForPatchItemWithHash(final RequestParameters requestParameters,
 113                                                                        final PatchItem patchItem) {
 114         final Map<String, Object> attributeHierarchyAsMap = createNestedMap(patchItem);
 115         final String parentFdn = ParameterHelper.extractParentFdn(requestParameters.fdn());
 116         final List<ClassInstance> classInstances
 117             = List.of(new ClassInstance(requestParameters.id(), attributeHierarchyAsMap));
 118         return new OperationDetails(UPDATE, parentFdn, requestParameters.className(), classInstances);
 119     }
 120
 121     @SuppressWarnings("unchecked")
 122     private ResourceObjectDetails createResourceObjectDetails(final Object resourceAsObject,
 123                                                               final RequestParameters requestParameters) {
 124         final String resourceAsJson = jsonObjectMapper.asJsonString(resourceAsObject);
 125         final Map<String, Object> resourceAsMap = jsonObjectMapper.convertJsonString(resourceAsJson, Map.class);
 126         return new ResourceObjectDetails(requestParameters.id(),
 127                                          requestParameters.className(),
 128                                          resourceAsMap.get("attributes"));
 129     }
 130
 131     private Map<String, Object> createNestedMap(final PatchItem patchItem) {
 132         final Map<String, Object> attributeHierarchyMap = new HashMap<>();
 133         Map<String, Object> currentLevel = attributeHierarchyMap;
 134         final String[] attributeHierarchyNames = patchItem.getPath().split("#/attributes")[1]
 135                 .replaceAll(REGEX_FOR_LEADING_AND_TRAILING_SEPARATORS, "")
 136                 .split(ATTRIBUTE_NAME_SEPARATOR);
 137         for (int level = 0; level < attributeHierarchyNames.length; level++) {
 138             final String attributeName = attributeHierarchyNames[level];
 139             if (isLastLevel(attributeHierarchyNames, level)) {
 140                 currentLevel.put(attributeName, patchItem.getValue());
 141             } else {
 142                 final Map<String, Object> nextLevel = new HashMap<>();
 143                 currentLevel.put(attributeName, nextLevel);
 144                 currentLevel = nextLevel;
 145             }
 146         }
 147         return attributeHierarchyMap;
 148     }
 149
 150     private boolean isLastLevel(final String[] attributeNamesArray, final int level) {
 151         return level == attributeNamesArray.length - 1;
 152     }
 153 }
 154