gerrit.onap Code Review - cps.git/blob

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 2025 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 org.onap.cps.ncmp.api.data.models.OperationType.CREATE;
  24 import static org.onap.cps.ncmp.api.data.models.OperationType.DELETE;
  25 import static org.onap.cps.ncmp.api.data.models.OperationType.UPDATE;
  26
  27 import com.google.common.base.Strings;
  28 import java.util.HashMap;
  29 import java.util.List;
  30 import java.util.Map;
  31 import lombok.RequiredArgsConstructor;
  32 import lombok.extern.slf4j.Slf4j;
  33 import org.onap.cps.ncmp.api.data.models.OperationType;
  34 import org.onap.cps.ncmp.api.exceptions.ProvMnSException;
  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 = buildCreateOperationDetails(CREATE, requestParameters, patchItem.getValue());
  64                 break;
  65             case REPLACE:
  66                 if (patchItem.getPath().contains("#/attributes")) {
  67                     operationDetails = buildCreateOperationDetailsForUpdateWithHash(requestParameters, patchItem);
  68                 } else {
  69                     operationDetails = buildCreateOperationDetails(UPDATE, requestParameters, patchItem.getValue());
  70                 }
  71                 break;
  72             case REMOVE:
  73                 operationDetails = buildDeleteOperationDetails(requestParameters.toTargetFdn());
  74                 break;
  75             default:
  76                 throw new ProvMnSException("PATCH", HttpStatus.UNPROCESSABLE_ENTITY,
  77                     "Unsupported Patch Operation Type: " + patchItem.getOp().getValue());
  78         }
  79         return operationDetails;
  80     }
  81
  82     /**
  83      * Build a CreateOperationDetails 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 CreateOperationDetails object
  89      */
  90     public CreateOperationDetails buildCreateOperationDetails(final OperationType operationType,
  91                                                               final RequestParameters requestParameters,
  92                                                               final Object resourceAsObject) {
  93         final ResourceObjectDetails resourceObjectDetails = createResourceObjectDetails(resourceAsObject,
  94             requestParameters);
  95         final OperationEntry operationEntry = new OperationEntry(resourceObjectDetails.id(),
  96             resourceObjectDetails.attributes());
  97         return new CreateOperationDetails(operationType.name(),
  98             requestParameters.getUriLdnFirstPart(),
  99             Map.of(resourceObjectDetails.objectClass(), List.of(operationEntry)));
 100     }
 101
 102     /**
 103      * Builds a DeleteOperationDetails object from provided alternate id.
 104      *
 105      * @param alternateId        alternate id for request
 106      * @return DeleteOperationDetails object
 107      */
 108     public DeleteOperationDetails buildDeleteOperationDetails(final String alternateId) {
 109         return new DeleteOperationDetails(DELETE.name(), alternateId);
 110     }
 111
 112     @SuppressWarnings("unchecked")
 113     private ResourceObjectDetails createResourceObjectDetails(final Object resourceAsObject,
 114                                                               final RequestParameters requestParameters) {
 115         final String resourceAsJson = jsonObjectMapper.asJsonString(resourceAsObject);
 116         final Map<String, Object> resourceAsMap = jsonObjectMapper.convertJsonString(resourceAsJson, Map.class);
 117         return new ResourceObjectDetails(requestParameters.getId(),
 118                                          extractObjectClass(resourceAsMap, requestParameters),
 119                                          resourceAsMap.get("attributes"));
 120
 121     }
 122
 123     private static String extractObjectClass(final Map<String, Object> resourceAsMap,
 124                                              final RequestParameters requestParameters) {
 125         final String objectClass = (String) resourceAsMap.get("objectClass");
 126         if (Strings.isNullOrEmpty(objectClass)) {
 127             return requestParameters.getClassName();
 128         }
 129         return objectClass;
 130     }
 131
 132     private CreateOperationDetails buildCreateOperationDetailsForUpdateWithHash(
 133                                                                      final RequestParameters requestParameters,
 134                                                                      final PatchItem patchItem) {
 135         final Map<String, List<OperationEntry>> operationEntriesPerObjectClass = new HashMap<>();
 136         final String className = requestParameters.getClassName();
 137         final Map<String, Object> attributeHierarchyAsMap = createNestedMap(patchItem);
 138         final OperationEntry operationEntry = new OperationEntry(requestParameters.getId(), attributeHierarchyAsMap);
 139         operationEntriesPerObjectClass.put(className, List.of(operationEntry));
 140         return new CreateOperationDetails(UPDATE.getOperationName(), requestParameters.getUriLdnFirstPart(),
 141                                           operationEntriesPerObjectClass);
 142     }
 143
 144     private Map<String, Object> createNestedMap(final PatchItem patchItem) {
 145         final Map<String, Object> attributeHierarchyMap = new HashMap<>();
 146         Map<String, Object> currentLevel = attributeHierarchyMap;
 147         final String[] attributeHierarchyNames = patchItem.getPath().split("#/attributes")[1]
 148                 .replaceAll(REGEX_FOR_LEADING_AND_TRAILING_SEPARATORS, "")
 149                 .split(ATTRIBUTE_NAME_SEPARATOR);
 150         for (int level = 0; level < attributeHierarchyNames.length; level++) {
 151             final String attributeName = attributeHierarchyNames[level];
 152             if (isLastLevel(attributeHierarchyNames, level)) {
 153                 currentLevel.put(attributeName, patchItem.getValue());
 154             } else {
 155                 final Map<String, Object> nextLevel = new HashMap<>();
 156                 currentLevel.put(attributeName, nextLevel);
 157                 currentLevel = nextLevel;
 158             }
 159         }
 160         return attributeHierarchyMap;
 161     }
 162
 163     private boolean isLastLevel(final String[] attributeNamesArray, final int level) {
 164         return level == attributeNamesArray.length - 1;
 165     }
 166 }
 167