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 com.fasterxml.jackson.core.JsonProcessingException;
  24 import com.fasterxml.jackson.core.type.TypeReference;
  25 import com.fasterxml.jackson.databind.ObjectMapper;
  26 import com.google.common.base.Strings;
  27 import java.util.ArrayList;
  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.RequestPathParameters;
  36 import org.onap.cps.ncmp.impl.provmns.model.PatchItem;
  37 import org.onap.cps.utils.JsonObjectMapper;
  38 import org.springframework.stereotype.Service;
  39
  40 @Slf4j
  41 @Service
  42 @RequiredArgsConstructor
  43 public class OperationDetailsFactory {
  44
  45     private static final String ATTRIBUTE_NAME_SEPARATOR = "/";
  46     private static final String REGEX_FOR_LEADING_AND_TRAILING_SEPARATORS = "(^/)|(/$)";
  47
  48     private final JsonObjectMapper jsonObjectMapper;
  49     private final ObjectMapper objectMapper;
  50
  51     /**
  52      * Build a PatchOperationDetails object from ProvMnS request details.
  53      *
  54      * @param requestPathParameters    request parameters including uri-ldn-first-part, className and id
  55      * @param patchItems               provided request list of patch Items
  56      * @return CreateOperationDetails object
  57      */
  58     public PatchOperationsDetails buildPatchOperationDetails(final RequestPathParameters requestPathParameters,
  59                                                              final List<PatchItem> patchItems) {
  60         final List<Object> operations = new ArrayList<>(patchItems.size());
  61         for (final PatchItem patchItem : patchItems) {
  62             switch (patchItem.getOp()) {
  63                 case ADD -> operations.add(buildCreateOperationDetails(OperationType.CREATE, requestPathParameters,
  64                                         patchItem.getValue()));
  65                 case REPLACE -> operations.add(buildCreateOperationDetailsForUpdate(OperationType.UPDATE,
  66                                         requestPathParameters,
  67                                         patchItem));
  68                 case REMOVE -> operations.add(buildDeleteOperationDetails(requestPathParameters.toAlternateId()));
  69                 default -> throw new ProvMnSException("UNSUPPORTED_OP",
  70                     "Unsupported Patch Operation Type: " + patchItem.getOp().getValue());
  71             }
  72         }
  73         return new PatchOperationsDetails("Some Permission Id", "cm-legacy", operations);
  74     }
  75
  76     /**
  77      * Build a CreateOperationDetails object from ProvMnS request details.
  78      *
  79      * @param operationType            Type of operation create, update.
  80      * @param requestPathParameters    request parameters including uri-ldn-first-part, className and id
  81      * @param resourceAsObject         provided request payload
  82      * @return CreateOperationDetails object
  83      */
  84     public CreateOperationDetails buildCreateOperationDetails(final OperationType operationType,
  85                                                               final RequestPathParameters requestPathParameters,
  86                                                               final Object resourceAsObject) {
  87
  88         final ResourceObjectDetails resourceObjectDetails = createResourceObjectDetails(resourceAsObject,
  89                                                                                         requestPathParameters);
  90
  91         final OperationEntry operationEntry = new OperationEntry(resourceObjectDetails.id(),
  92                 resourceObjectDetails.attributes());
  93
  94         final Map<String, List<OperationEntry>> operationEntriesPerObjectClass =
  95                 Map.of(resourceObjectDetails.objectClass(), List.of(operationEntry));
  96
  97         return new CreateOperationDetails(
  98                 operationType.name(),
  99                 requestPathParameters.getUriLdnFirstPart(),
 100                 operationEntriesPerObjectClass
 101         );
 102     }
 103
 104     /**
 105      * Build a CreateOperationDetails object from ProvMnS request details.
 106      *
 107      * @param operationType            Type of operation create, update.
 108      * @param requestPathParameters    request parameters including uri-ldn-first-part, className and id
 109      * @param patchItem                 provided request
 110      * @return CreateOperationDetails object
 111      */
 112     public CreateOperationDetails buildCreateOperationDetailsForUpdate(final OperationType operationType,
 113                                                                      final RequestPathParameters requestPathParameters,
 114                                                                      final PatchItem patchItem) {
 115         if (patchItem.getPath().contains("#/attributes")) {
 116             return buildCreateOperationDetailsForUpdateWithHash(operationType, requestPathParameters, patchItem);
 117         } else {
 118             return buildCreateOperationDetails(operationType, requestPathParameters, patchItem.getValue());
 119         }
 120     }
 121
 122     /**
 123      * Builds a DeleteOperationDetails object from provided alternate id.
 124      *
 125      * @param alternateId        alternate id for request
 126      * @return DeleteOperationDetails object
 127      */
 128     public DeleteOperationDetails buildDeleteOperationDetails(final String alternateId) {
 129         return new DeleteOperationDetails(OperationType.DELETE.name(), alternateId);
 130     }
 131
 132     private ResourceObjectDetails createResourceObjectDetails(final Object resourceAsObject,
 133                                                               final RequestPathParameters requestPathParameters) {
 134         try {
 135             final String resourceAsJson = jsonObjectMapper.asJsonString(resourceAsObject);
 136             final TypeReference<Map<String, Object>> typeReference = new TypeReference<>() {};
 137             final Map<String, Object> resourceAsMap = objectMapper.readValue(resourceAsJson, typeReference);
 138
 139             return new ResourceObjectDetails(requestPathParameters.getId(),
 140                                              extractObjectClass(resourceAsMap, requestPathParameters),
 141                                              resourceAsMap.get("attributes"));
 142         } catch (final JsonProcessingException e) {
 143             log.debug("JSON processing error: {}", e.getMessage());
 144             throw new ProvMnSException("Cannot convert Resource Object", e.getMessage());
 145         }
 146     }
 147
 148     private static String extractObjectClass(final Map<String, Object> resourceAsMap,
 149                                              final RequestPathParameters requestPathParameters) {
 150         final String objectClass = (String) resourceAsMap.get("objectClass");
 151         if (Strings.isNullOrEmpty(objectClass)) {
 152             return requestPathParameters.getClassName();
 153         }
 154         return objectClass;
 155     }
 156
 157
 158     private CreateOperationDetails buildCreateOperationDetailsForUpdateWithHash(final OperationType operationType,
 159                                                                      final RequestPathParameters requestPathParameters,
 160                                                                      final PatchItem patchItem) {
 161         final Map<String, List<OperationEntry>> operationEntriesPerObjectClass = new HashMap<>();
 162         final String className = requestPathParameters.getClassName();
 163
 164         final Map<String, Object> attributeHierarchyAsMap = createNestedMap(patchItem);
 165
 166         final OperationEntry operationEntry = new OperationEntry(requestPathParameters.getId(),
 167                                                                  attributeHierarchyAsMap);
 168         operationEntriesPerObjectClass.put(className, List.of(operationEntry));
 169
 170         return new CreateOperationDetails(operationType.getOperationName(),
 171                 requestPathParameters.getUriLdnFirstPart(),
 172                 operationEntriesPerObjectClass);
 173     }
 174
 175     private Map<String, Object> createNestedMap(final PatchItem patchItem) {
 176         final Map<String, Object> attributeHierarchyMap = new HashMap<>();
 177         Map<String, Object> currentLevel = attributeHierarchyMap;
 178
 179         final String[] attributeHierarchyNames = patchItem.getPath().split("#/attributes")[1]
 180                 .replaceAll(REGEX_FOR_LEADING_AND_TRAILING_SEPARATORS, "")
 181                 .split(ATTRIBUTE_NAME_SEPARATOR);
 182
 183         for (int level = 0; level < attributeHierarchyNames.length; level++) {
 184             final String attributeName = attributeHierarchyNames[level];
 185
 186             if (isLastLevel(attributeHierarchyNames, level)) {
 187                 currentLevel.put(attributeName, patchItem.getValue());
 188             } else {
 189                 final Map<String, Object> nextLevel = new HashMap<>();
 190                 currentLevel.put(attributeName, nextLevel);
 191                 currentLevel = nextLevel;
 192             }
 193         }
 194         return attributeHierarchyMap;
 195     }
 196
 197     private boolean isLastLevel(final String[] attributeNamesArray, final int level) {
 198         return level == attributeNamesArray.length - 1;
 199     }
 200 }
 201