cps-ri/src/main/java/org/onap/cps/spi/impl/CpsDataPersistenceServiceImpl.java

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 2021-2023 Nordix Foundation
   4  *  Modifications Copyright (C) 2021 Pantheon.tech
   5  *  Modifications Copyright (C) 2020-2022 Bell Canada.
   6  *  Modifications Copyright (C) 2022-2023 TechMahindra Ltd.
   7  *  ================================================================================
   8  *  Licensed under the Apache License, Version 2.0 (the "License");
   9  *  you may not use this file except in compliance with the License.
  10  *  You may obtain a copy of the License at
  11  *
  12  *        http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  *  Unless required by applicable law or agreed to in writing, software
  15  *  distributed under the License is distributed on an "AS IS" BASIS,
  16  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  *  See the License for the specific language governing permissions and
  18  *  limitations under the License.
  19  *
  20  *  SPDX-License-Identifier: Apache-2.0
  21  *  ============LICENSE_END=========================================================
  22  */
  23
  24 package org.onap.cps.spi.impl;
  25
  26 import com.google.common.base.Strings;
  27 import com.google.common.collect.ImmutableSet;
  28 import com.google.common.collect.ImmutableSet.Builder;
  29 import io.micrometer.core.annotation.Timed;
  30 import java.io.Serializable;
  31 import java.util.ArrayList;
  32 import java.util.Collection;
  33 import java.util.Collections;
  34 import java.util.HashMap;
  35 import java.util.HashSet;
  36 import java.util.List;
  37 import java.util.Map;
  38 import java.util.Set;
  39 import java.util.regex.Matcher;
  40 import java.util.regex.Pattern;
  41 import java.util.stream.Collectors;
  42 import javax.transaction.Transactional;
  43 import lombok.RequiredArgsConstructor;
  44 import lombok.extern.slf4j.Slf4j;
  45 import org.hibernate.StaleStateException;
  46 import org.onap.cps.cpspath.parser.CpsPathQuery;
  47 import org.onap.cps.cpspath.parser.CpsPathUtil;
  48 import org.onap.cps.cpspath.parser.PathParsingException;
  49 import org.onap.cps.spi.CpsDataPersistenceService;
  50 import org.onap.cps.spi.FetchDescendantsOption;
  51 import org.onap.cps.spi.entities.AnchorEntity;
  52 import org.onap.cps.spi.entities.DataspaceEntity;
  53 import org.onap.cps.spi.entities.FragmentEntity;
  54 import org.onap.cps.spi.entities.FragmentEntityArranger;
  55 import org.onap.cps.spi.entities.FragmentExtract;
  56 import org.onap.cps.spi.exceptions.AlreadyDefinedException;
  57 import org.onap.cps.spi.exceptions.AlreadyDefinedExceptionBatch;
  58 import org.onap.cps.spi.exceptions.ConcurrencyException;
  59 import org.onap.cps.spi.exceptions.CpsAdminException;
  60 import org.onap.cps.spi.exceptions.CpsPathException;
  61 import org.onap.cps.spi.exceptions.DataNodeNotFoundException;
  62 import org.onap.cps.spi.exceptions.DataNodeNotFoundExceptionBatch;
  63 import org.onap.cps.spi.model.DataNode;
  64 import org.onap.cps.spi.model.DataNodeBuilder;
  65 import org.onap.cps.spi.repository.AnchorRepository;
  66 import org.onap.cps.spi.repository.DataspaceRepository;
  67 import org.onap.cps.spi.repository.FragmentQueryBuilder;
  68 import org.onap.cps.spi.repository.FragmentRepository;
  69 import org.onap.cps.spi.utils.SessionManager;
  70 import org.onap.cps.utils.JsonObjectMapper;
  71 import org.springframework.dao.DataIntegrityViolationException;
  72 import org.springframework.stereotype.Service;
  73
  74 @Service
  75 @Slf4j
  76 @RequiredArgsConstructor
  77 public class CpsDataPersistenceServiceImpl implements CpsDataPersistenceService {
  78
  79     private final DataspaceRepository dataspaceRepository;
  80     private final AnchorRepository anchorRepository;
  81     private final FragmentRepository fragmentRepository;
  82     private final JsonObjectMapper jsonObjectMapper;
  83     private final SessionManager sessionManager;
  84
  85     private static final String REG_EX_FOR_OPTIONAL_LIST_INDEX = "(\\[@[\\s\\S]+?])?)";
  86     private static final String QUERY_ACROSS_ANCHORS = null;
  87     private static final AnchorEntity ALL_ANCHORS = null;
  88
  89     @Override
  90     public void addChildDataNode(final String dataspaceName, final String anchorName, final String parentNodeXpath,
  91                                  final DataNode newChildDataNode) {
  92         final AnchorEntity anchorEntity = getAnchorEntity(dataspaceName, anchorName);
  93         addNewChildDataNode(anchorEntity, parentNodeXpath, newChildDataNode);
  94     }
  95
  96     @Override
  97     public void addChildDataNodes(final String dataspaceName, final String anchorName,
  98                                   final String parentNodeXpath, final Collection<DataNode> dataNodes) {
  99         final AnchorEntity anchorEntity = getAnchorEntity(dataspaceName, anchorName);
 100         addChildrenDataNodes(anchorEntity, parentNodeXpath, dataNodes);
 101     }
 102
 103     @Override
 104     public void addListElements(final String dataspaceName, final String anchorName, final String parentNodeXpath,
 105                                 final Collection<DataNode> newListElements) {
 106         final AnchorEntity anchorEntity = getAnchorEntity(dataspaceName, anchorName);
 107         addChildrenDataNodes(anchorEntity, parentNodeXpath, newListElements);
 108     }
 109
 110     @Override
 111     public void addMultipleLists(final String dataspaceName, final String anchorName, final String parentNodeXpath,
 112                                  final Collection<Collection<DataNode>> newLists) {
 113         final AnchorEntity anchorEntity = getAnchorEntity(dataspaceName, anchorName);
 114         final Collection<String> failedXpaths = new HashSet<>();
 115         for (final Collection<DataNode> newList : newLists) {
 116             try {
 117                 addChildrenDataNodes(anchorEntity, parentNodeXpath, newList);
 118             } catch (final AlreadyDefinedExceptionBatch e) {
 119                 failedXpaths.addAll(e.getAlreadyDefinedXpaths());
 120             }
 121         }
 122         if (!failedXpaths.isEmpty()) {
 123             throw new AlreadyDefinedExceptionBatch(failedXpaths);
 124         }
 125     }
 126
 127     private void addNewChildDataNode(final AnchorEntity anchorEntity, final String parentNodeXpath,
 128                                      final DataNode newChild) {
 129         final FragmentEntity parentFragmentEntity = getFragmentEntity(anchorEntity, parentNodeXpath);
 130         final FragmentEntity newChildAsFragmentEntity = convertToFragmentWithAllDescendants(anchorEntity, newChild);
 131         newChildAsFragmentEntity.setParentId(parentFragmentEntity.getId());
 132         try {
 133             fragmentRepository.save(newChildAsFragmentEntity);
 134         } catch (final DataIntegrityViolationException e) {
 135             throw AlreadyDefinedException.forDataNode(newChild.getXpath(), anchorEntity.getName(), e);
 136         }
 137     }
 138
 139     private void addChildrenDataNodes(final AnchorEntity anchorEntity, final String parentNodeXpath,
 140                                       final Collection<DataNode> newChildren) {
 141         final FragmentEntity parentFragmentEntity = getFragmentEntity(anchorEntity, parentNodeXpath);
 142         final List<FragmentEntity> fragmentEntities = new ArrayList<>(newChildren.size());
 143         try {
 144             for (final DataNode newChildAsDataNode : newChildren) {
 145                 final FragmentEntity newChildAsFragmentEntity =
 146                     convertToFragmentWithAllDescendants(anchorEntity, newChildAsDataNode);
 147                 newChildAsFragmentEntity.setParentId(parentFragmentEntity.getId());
 148                 fragmentEntities.add(newChildAsFragmentEntity);
 149             }
 150             fragmentRepository.saveAll(fragmentEntities);
 151         } catch (final DataIntegrityViolationException e) {
 152             log.warn("Exception occurred : {} , While saving : {} children, retrying using individual save operations",
 153                     e, fragmentEntities.size());
 154             retrySavingEachChildIndividually(anchorEntity, parentNodeXpath, newChildren);
 155         }
 156     }
 157
 158     private void retrySavingEachChildIndividually(final AnchorEntity anchorEntity, final String parentNodeXpath,
 159                                                   final Collection<DataNode> newChildren) {
 160         final Collection<String> failedXpaths = new HashSet<>();
 161         for (final DataNode newChild : newChildren) {
 162             try {
 163                 addNewChildDataNode(anchorEntity, parentNodeXpath, newChild);
 164             } catch (final AlreadyDefinedException e) {
 165                 failedXpaths.add(newChild.getXpath());
 166             }
 167         }
 168         if (!failedXpaths.isEmpty()) {
 169             throw new AlreadyDefinedExceptionBatch(failedXpaths);
 170         }
 171     }
 172
 173     @Override
 174     public void storeDataNode(final String dataspaceName, final String anchorName, final DataNode dataNode) {
 175         storeDataNodes(dataspaceName, anchorName, Collections.singletonList(dataNode));
 176     }
 177
 178     @Override
 179     public void storeDataNodes(final String dataspaceName, final String anchorName,
 180                                final Collection<DataNode> dataNodes) {
 181         final AnchorEntity anchorEntity = getAnchorEntity(dataspaceName, anchorName);
 182         final List<FragmentEntity> fragmentEntities = new ArrayList<>(dataNodes.size());
 183         try {
 184             for (final DataNode dataNode: dataNodes) {
 185                 final FragmentEntity fragmentEntity = convertToFragmentWithAllDescendants(anchorEntity, dataNode);
 186                 fragmentEntities.add(fragmentEntity);
 187             }
 188             fragmentRepository.saveAll(fragmentEntities);
 189         } catch (final DataIntegrityViolationException exception) {
 190             log.warn("Exception occurred : {} , While saving : {} data nodes, Retrying saving data nodes individually",
 191                     exception, dataNodes.size());
 192             storeDataNodesIndividually(anchorEntity, dataNodes);
 193         }
 194     }
 195
 196     private void storeDataNodesIndividually(final AnchorEntity anchorEntity, final Collection<DataNode> dataNodes) {
 197         final Collection<String> failedXpaths = new HashSet<>();
 198         for (final DataNode dataNode: dataNodes) {
 199             try {
 200                 final FragmentEntity fragmentEntity = convertToFragmentWithAllDescendants(anchorEntity, dataNode);
 201                 fragmentRepository.save(fragmentEntity);
 202             } catch (final DataIntegrityViolationException e) {
 203                 failedXpaths.add(dataNode.getXpath());
 204             }
 205         }
 206         if (!failedXpaths.isEmpty()) {
 207             throw new AlreadyDefinedExceptionBatch(failedXpaths);
 208         }
 209     }
 210
 211     /**
 212      * Convert DataNode object into Fragment and places the result in the fragments placeholder. Performs same action
 213      * for all DataNode children recursively.
 214      *
 215      * @param anchorEntity          anchorEntity
 216      * @param dataNodeToBeConverted dataNode
 217      * @return a Fragment built from current DataNode
 218      */
 219     private FragmentEntity convertToFragmentWithAllDescendants(final AnchorEntity anchorEntity,
 220                                                                final DataNode dataNodeToBeConverted) {
 221         final FragmentEntity parentFragment = toFragmentEntity(anchorEntity, dataNodeToBeConverted);
 222         final Builder<FragmentEntity> childFragmentsImmutableSetBuilder = ImmutableSet.builder();
 223         for (final DataNode childDataNode : dataNodeToBeConverted.getChildDataNodes()) {
 224             final FragmentEntity childFragment = convertToFragmentWithAllDescendants(anchorEntity, childDataNode);
 225             childFragmentsImmutableSetBuilder.add(childFragment);
 226         }
 227         parentFragment.setChildFragments(childFragmentsImmutableSetBuilder.build());
 228         return parentFragment;
 229     }
 230
 231     private FragmentEntity toFragmentEntity(final AnchorEntity anchorEntity, final DataNode dataNode) {
 232         return FragmentEntity.builder()
 233                 .dataspace(anchorEntity.getDataspace())
 234                 .anchor(anchorEntity)
 235                 .xpath(dataNode.getXpath())
 236                 .attributes(jsonObjectMapper.asJsonString(dataNode.getLeaves()))
 237                 .build();
 238     }
 239
 240     @Override
 241     @Timed(value = "cps.data.persistence.service.datanode.get",
 242             description = "Time taken to get a data node")
 243     public Collection<DataNode> getDataNodes(final String dataspaceName, final String anchorName,
 244                                              final String xpath,
 245                                              final FetchDescendantsOption fetchDescendantsOption) {
 246         final String targetXpath = getNormalizedXpath(xpath);
 247         final Collection<DataNode> dataNodes = getDataNodesForMultipleXpaths(dataspaceName, anchorName,
 248                 Collections.singletonList(targetXpath), fetchDescendantsOption);
 249         if (dataNodes.isEmpty()) {
 250             throw new DataNodeNotFoundException(dataspaceName, anchorName, xpath);
 251         }
 252         return dataNodes;
 253     }
 254
 255     @Override
 256     @Timed(value = "cps.data.persistence.service.datanode.batch.get",
 257             description = "Time taken to get data nodes")
 258     public Collection<DataNode> getDataNodesForMultipleXpaths(final String dataspaceName, final String anchorName,
 259                                                               final Collection<String> xpaths,
 260                                                               final FetchDescendantsOption fetchDescendantsOption) {
 261         final AnchorEntity anchorEntity = getAnchorEntity(dataspaceName, anchorName);
 262         final Collection<FragmentEntity> fragmentEntities =
 263             getFragmentEntities(anchorEntity, xpaths, fetchDescendantsOption);
 264         return toDataNodes(fragmentEntities, fetchDescendantsOption);
 265     }
 266
 267     private Collection<FragmentEntity> getFragmentEntities(final AnchorEntity anchorEntity,
 268                                                            final Collection<String> xpaths,
 269                                                            final FetchDescendantsOption fetchDescendantsOption) {
 270         final Collection<String> nonRootXpaths = new HashSet<>(xpaths);
 271         final boolean haveRootXpath = nonRootXpaths.removeIf(CpsDataPersistenceServiceImpl::isRootXpath);
 272
 273         final Collection<String> normalizedXpaths = new HashSet<>(nonRootXpaths.size());
 274         for (final String xpath : nonRootXpaths) {
 275             try {
 276                 normalizedXpaths.add(CpsPathUtil.getNormalizedXpath(xpath));
 277             } catch (final PathParsingException e) {
 278                 log.warn("Error parsing xpath \"{}\": {}", xpath, e.getMessage());
 279             }
 280         }
 281         if (haveRootXpath) {
 282             normalizedXpaths.addAll(fragmentRepository.findAllXpathByAnchorAndParentIdIsNull(anchorEntity));
 283         }
 284
 285         final List<FragmentExtract> fragmentExtracts =
 286             fragmentRepository.findExtractsWithDescendants(anchorEntity.getId(), normalizedXpaths,
 287                 fetchDescendantsOption.getDepth());
 288
 289         return FragmentEntityArranger.toFragmentEntityTrees(anchorEntity, fragmentExtracts);
 290     }
 291
 292     private FragmentEntity getFragmentEntity(final AnchorEntity anchorEntity, final String xpath) {
 293         final FragmentEntity fragmentEntity;
 294         if (isRootXpath(xpath)) {
 295             final List<FragmentExtract> fragmentExtracts = fragmentRepository.findAllExtractsByAnchor(anchorEntity);
 296             fragmentEntity = FragmentEntityArranger.toFragmentEntityTrees(anchorEntity, fragmentExtracts)
 297                 .stream().findFirst().orElse(null);
 298         } else {
 299             fragmentEntity = fragmentRepository.getByAnchorAndXpath(anchorEntity, getNormalizedXpath(xpath));
 300         }
 301         if (fragmentEntity == null) {
 302             throw new DataNodeNotFoundException(anchorEntity.getDataspace().getName(), anchorEntity.getName(), xpath);
 303         }
 304         return fragmentEntity;
 305     }
 306
 307     private Collection<FragmentEntity> buildFragmentEntitiesFromFragmentExtracts(final AnchorEntity anchorEntity,
 308                                                                                  final String normalizedXpath) {
 309         final List<FragmentExtract> fragmentExtracts =
 310             fragmentRepository.findByAnchorAndParentXpath(anchorEntity, normalizedXpath);
 311         return FragmentEntityArranger.toFragmentEntityTrees(anchorEntity, fragmentExtracts);
 312     }
 313
 314     @Override
 315     @Timed(value = "cps.data.persistence.service.datanode.query",
 316             description = "Time taken to query data nodes")
 317     public List<DataNode> queryDataNodes(final String dataspaceName, final String anchorName, final String cpsPath,
 318                                          final FetchDescendantsOption fetchDescendantsOption) {
 319         final AnchorEntity anchorEntity = (Strings.isNullOrEmpty(anchorName)) ? ALL_ANCHORS
 320                 : getAnchorEntity(dataspaceName, anchorName);
 321         final CpsPathQuery cpsPathQuery;
 322         try {
 323             cpsPathQuery = CpsPathUtil.getCpsPathQuery(cpsPath);
 324         } catch (final PathParsingException e) {
 325             throw new CpsPathException(e.getMessage());
 326         }
 327
 328         Collection<FragmentEntity> fragmentEntities;
 329         if (canUseRegexQuickFind(fetchDescendantsOption, cpsPathQuery)) {
 330             return getDataNodesUsingRegexQuickFind(fetchDescendantsOption, anchorEntity, cpsPathQuery);
 331         }
 332         fragmentEntities = (anchorEntity == ALL_ANCHORS) ? fragmentRepository.findByCpsPath(cpsPathQuery)
 333                 : fragmentRepository.findByAnchorAndCpsPath(anchorEntity.getId(), cpsPathQuery);
 334         if (cpsPathQuery.hasAncestorAxis()) {
 335             final Collection<String> ancestorXpaths = processAncestorXpath(fragmentEntities, cpsPathQuery);
 336             fragmentEntities = (anchorEntity == ALL_ANCHORS) ? getAncestorFragmentEntitiesAcrossAnchors(cpsPathQuery,
 337             fragmentEntities) : getFragmentEntities(anchorEntity, ancestorXpaths, fetchDescendantsOption);
 338         }
 339         return createDataNodesFromProxiedFragmentEntities(fetchDescendantsOption, anchorEntity, fragmentEntities);
 340     }
 341
 342     @Override
 343     public List<DataNode> queryDataNodesAcrossAnchors(final String dataspaceName, final String cpsPath,
 344                                          final FetchDescendantsOption fetchDescendantsOption) {
 345         return queryDataNodes(dataspaceName, QUERY_ACROSS_ANCHORS, cpsPath, fetchDescendantsOption);
 346     }
 347
 348     private static boolean canUseRegexQuickFind(final FetchDescendantsOption fetchDescendantsOption,
 349                                                 final CpsPathQuery cpsPathQuery) {
 350         return fetchDescendantsOption.equals(FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS)
 351             && !cpsPathQuery.hasLeafConditions()
 352             && !cpsPathQuery.hasTextFunctionCondition();
 353     }
 354
 355     private List<DataNode> getDataNodesUsingRegexQuickFind(final FetchDescendantsOption fetchDescendantsOption,
 356                                                            final AnchorEntity anchorEntity,
 357                                                            final CpsPathQuery cpsPathQuery) {
 358         Collection<FragmentEntity> fragmentEntities;
 359         final String xpathRegex = FragmentQueryBuilder.getXpathSqlRegex(cpsPathQuery, true);
 360         final List<FragmentExtract> fragmentExtracts = (anchorEntity == ALL_ANCHORS)
 361                 ? fragmentRepository.quickFindWithDescendantsAcrossAnchor(xpathRegex) :
 362             fragmentRepository.quickFindWithDescendants(anchorEntity.getId(), xpathRegex);
 363         fragmentEntities = FragmentEntityArranger.toFragmentEntityTrees(anchorEntity, fragmentExtracts);
 364         if (cpsPathQuery.hasAncestorAxis()) {
 365             final Collection<String> ancestorXpaths = processAncestorXpath(fragmentEntities, cpsPathQuery);
 366             fragmentEntities = (anchorEntity == ALL_ANCHORS) ? getAncestorFragmentEntitiesAcrossAnchors(cpsPathQuery,
 367             fragmentEntities) : getFragmentEntities(anchorEntity, ancestorXpaths, fetchDescendantsOption);
 368         }
 369         return createDataNodesFromFragmentEntities(fetchDescendantsOption, fragmentEntities);
 370     }
 371
 372     private Collection<FragmentEntity> getAncestorFragmentEntitiesAcrossAnchors(final CpsPathQuery cpsPathQuery,
 373         final Collection<FragmentEntity> fragmentEntities) {
 374         final Collection<String> ancestorXpaths = processAncestorXpath(fragmentEntities, cpsPathQuery);
 375         return ancestorXpaths.isEmpty() ? Collections.emptyList() : fragmentRepository.findAllByXpathIn(ancestorXpaths);
 376     }
 377
 378     private List<DataNode> createDataNodesFromProxiedFragmentEntities(
 379                                             final FetchDescendantsOption fetchDescendantsOption,
 380                                             final AnchorEntity anchorEntity,
 381                                             final Collection<FragmentEntity> proxiedFragmentEntities) {
 382         final List<DataNode> dataNodes = new ArrayList<>(proxiedFragmentEntities.size());
 383         for (final FragmentEntity proxiedFragmentEntity : proxiedFragmentEntities) {
 384             if (FetchDescendantsOption.OMIT_DESCENDANTS.equals(fetchDescendantsOption)) {
 385                 dataNodes.add(toDataNode(proxiedFragmentEntity, fetchDescendantsOption));
 386             } else {
 387                 final String normalizedXpath = getNormalizedXpath(proxiedFragmentEntity.getXpath());
 388                 final AnchorEntity anchorEntityForFragmentExtract = (anchorEntity == ALL_ANCHORS)
 389                         ? proxiedFragmentEntity.getAnchor() : anchorEntity;
 390                 final Collection<FragmentEntity> unproxiedFragmentEntities =
 391                     buildFragmentEntitiesFromFragmentExtracts(anchorEntityForFragmentExtract, normalizedXpath);
 392                 for (final FragmentEntity unproxiedFragmentEntity : unproxiedFragmentEntities) {
 393                     dataNodes.add(toDataNode(unproxiedFragmentEntity, fetchDescendantsOption));
 394                 }
 395             }
 396         }
 397         return Collections.unmodifiableList(dataNodes);
 398     }
 399
 400     private List<DataNode> createDataNodesFromFragmentEntities(final FetchDescendantsOption fetchDescendantsOption,
 401                                                                final Collection<FragmentEntity> fragmentEntities) {
 402         final List<DataNode> dataNodes = new ArrayList<>(fragmentEntities.size());
 403         for (final FragmentEntity fragmentEntity : fragmentEntities) {
 404             dataNodes.add(toDataNode(fragmentEntity, fetchDescendantsOption));
 405         }
 406         return Collections.unmodifiableList(dataNodes);
 407     }
 408
 409     private static String getNormalizedXpath(final String xpathSource) {
 410         if (isRootXpath(xpathSource)) {
 411             return xpathSource;
 412         }
 413         try {
 414             return CpsPathUtil.getNormalizedXpath(xpathSource);
 415         } catch (final PathParsingException e) {
 416             throw new CpsPathException(e.getMessage());
 417         }
 418     }
 419
 420     @Override
 421     public String startSession() {
 422         return sessionManager.startSession();
 423     }
 424
 425     @Override
 426     public void closeSession(final String sessionId) {
 427         sessionManager.closeSession(sessionId, SessionManager.WITH_COMMIT);
 428     }
 429
 430     @Override
 431     public void lockAnchor(final String sessionId, final String dataspaceName,
 432                            final String anchorName, final Long timeoutInMilliseconds) {
 433         sessionManager.lockAnchor(sessionId, dataspaceName, anchorName, timeoutInMilliseconds);
 434     }
 435
 436     private static Set<String> processAncestorXpath(final Collection<FragmentEntity> fragmentEntities,
 437                                                     final CpsPathQuery cpsPathQuery) {
 438         final Set<String> ancestorXpath = new HashSet<>();
 439         final Pattern pattern =
 440                 Pattern.compile("([\\s\\S]*/" + Pattern.quote(cpsPathQuery.getAncestorSchemaNodeIdentifier())
 441                         + REG_EX_FOR_OPTIONAL_LIST_INDEX + "/[\\s\\S]*");
 442         for (final FragmentEntity fragmentEntity : fragmentEntities) {
 443             final Matcher matcher = pattern.matcher(fragmentEntity.getXpath());
 444             if (matcher.matches()) {
 445                 ancestorXpath.add(matcher.group(1));
 446             }
 447         }
 448         return ancestorXpath;
 449     }
 450
 451     private DataNode toDataNode(final FragmentEntity fragmentEntity,
 452                                 final FetchDescendantsOption fetchDescendantsOption) {
 453         final List<DataNode> childDataNodes = getChildDataNodes(fragmentEntity, fetchDescendantsOption);
 454         Map<String, Serializable> leaves = new HashMap<>();
 455         if (fragmentEntity.getAttributes() != null) {
 456             leaves = jsonObjectMapper.convertJsonString(fragmentEntity.getAttributes(), Map.class);
 457         }
 458         return new DataNodeBuilder()
 459                 .withXpath(fragmentEntity.getXpath())
 460                 .withLeaves(leaves)
 461                 .withDataspace(fragmentEntity.getAnchor().getDataspace().getName())
 462                 .withAnchor(fragmentEntity.getAnchor().getName())
 463                 .withChildDataNodes(childDataNodes).build();
 464     }
 465
 466     private Collection<DataNode> toDataNodes(final Collection<FragmentEntity> fragmentEntities,
 467                                              final FetchDescendantsOption fetchDescendantsOption) {
 468         final Collection<DataNode> dataNodes = new ArrayList<>(fragmentEntities.size());
 469         for (final FragmentEntity fragmentEntity : fragmentEntities) {
 470             dataNodes.add(toDataNode(fragmentEntity, fetchDescendantsOption));
 471         }
 472         return dataNodes;
 473     }
 474
 475     private List<DataNode> getChildDataNodes(final FragmentEntity fragmentEntity,
 476                                              final FetchDescendantsOption fetchDescendantsOption) {
 477         if (fetchDescendantsOption.hasNext()) {
 478             return fragmentEntity.getChildFragments().stream()
 479                     .map(childFragmentEntity -> toDataNode(childFragmentEntity, fetchDescendantsOption.next()))
 480                     .collect(Collectors.toList());
 481         }
 482         return Collections.emptyList();
 483     }
 484
 485     @Override
 486     public void updateDataLeaves(final String dataspaceName, final String anchorName, final String xpath,
 487                                  final Map<String, Serializable> updateLeaves) {
 488         final AnchorEntity anchorEntity = getAnchorEntity(dataspaceName, anchorName);
 489         final FragmentEntity fragmentEntity = getFragmentEntity(anchorEntity, xpath);
 490         final String currentLeavesAsString = fragmentEntity.getAttributes();
 491         final String mergedLeaves = mergeLeaves(updateLeaves, currentLeavesAsString);
 492         fragmentEntity.setAttributes(mergedLeaves);
 493         fragmentRepository.save(fragmentEntity);
 494     }
 495
 496     @Override
 497     public void updateDataNodeAndDescendants(final String dataspaceName, final String anchorName,
 498                                              final DataNode dataNode) {
 499         final AnchorEntity anchorEntity = getAnchorEntity(dataspaceName, anchorName);
 500         final FragmentEntity fragmentEntity = getFragmentEntity(anchorEntity, dataNode.getXpath());
 501         updateFragmentEntityAndDescendantsWithDataNode(fragmentEntity, dataNode);
 502         try {
 503             fragmentRepository.save(fragmentEntity);
 504         } catch (final StaleStateException staleStateException) {
 505             throw new ConcurrencyException("Concurrent Transactions",
 506                     String.format("dataspace :'%s', Anchor : '%s' and xpath: '%s' is updated by another transaction.",
 507                             dataspaceName, anchorName, dataNode.getXpath()));
 508         }
 509     }
 510
 511     @Override
 512     public void updateDataNodesAndDescendants(final String dataspaceName, final String anchorName,
 513                                               final Collection<DataNode> updatedDataNodes) {
 514         final AnchorEntity anchorEntity = getAnchorEntity(dataspaceName, anchorName);
 515
 516         final Map<String, DataNode> xpathToUpdatedDataNode = updatedDataNodes.stream()
 517             .collect(Collectors.toMap(DataNode::getXpath, dataNode -> dataNode));
 518
 519         final Collection<String> xpaths = xpathToUpdatedDataNode.keySet();
 520         final Collection<FragmentEntity> existingFragmentEntities =
 521             getFragmentEntities(anchorEntity, xpaths, FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS);
 522
 523         for (final FragmentEntity existingFragmentEntity : existingFragmentEntities) {
 524             final DataNode updatedDataNode = xpathToUpdatedDataNode.get(existingFragmentEntity.getXpath());
 525             updateFragmentEntityAndDescendantsWithDataNode(existingFragmentEntity, updatedDataNode);
 526         }
 527
 528         try {
 529             fragmentRepository.saveAll(existingFragmentEntities);
 530         } catch (final StaleStateException staleStateException) {
 531             retryUpdateDataNodesIndividually(anchorEntity, existingFragmentEntities);
 532         }
 533     }
 534
 535     private void retryUpdateDataNodesIndividually(final AnchorEntity anchorEntity,
 536                                                   final Collection<FragmentEntity> fragmentEntities) {
 537         final Collection<String> failedXpaths = new HashSet<>();
 538         for (final FragmentEntity dataNodeFragment : fragmentEntities) {
 539             try {
 540                 fragmentRepository.save(dataNodeFragment);
 541             } catch (final StaleStateException e) {
 542                 failedXpaths.add(dataNodeFragment.getXpath());
 543             }
 544         }
 545         if (!failedXpaths.isEmpty()) {
 546             final String failedXpathsConcatenated = String.join(",", failedXpaths);
 547             throw new ConcurrencyException("Concurrent Transactions", String.format(
 548                     "DataNodes : %s in Dataspace :'%s' with Anchor : '%s'  are updated by another transaction.",
 549                     failedXpathsConcatenated, anchorEntity.getDataspace().getName(), anchorEntity.getName()));
 550         }
 551     }
 552
 553     private void updateFragmentEntityAndDescendantsWithDataNode(final FragmentEntity existingFragmentEntity,
 554                                                                 final DataNode newDataNode) {
 555         existingFragmentEntity.setAttributes(jsonObjectMapper.asJsonString(newDataNode.getLeaves()));
 556
 557         final Map<String, FragmentEntity> existingChildrenByXpath = existingFragmentEntity.getChildFragments().stream()
 558                 .collect(Collectors.toMap(FragmentEntity::getXpath, childFragmentEntity -> childFragmentEntity));
 559
 560         final Collection<FragmentEntity> updatedChildFragments = new HashSet<>();
 561         for (final DataNode newDataNodeChild : newDataNode.getChildDataNodes()) {
 562             final FragmentEntity childFragment;
 563             if (isNewDataNode(newDataNodeChild, existingChildrenByXpath)) {
 564                 childFragment = convertToFragmentWithAllDescendants(existingFragmentEntity.getAnchor(),
 565                     newDataNodeChild);
 566             } else {
 567                 childFragment = existingChildrenByXpath.get(newDataNodeChild.getXpath());
 568                 updateFragmentEntityAndDescendantsWithDataNode(childFragment, newDataNodeChild);
 569             }
 570             updatedChildFragments.add(childFragment);
 571         }
 572
 573         existingFragmentEntity.getChildFragments().clear();
 574         existingFragmentEntity.getChildFragments().addAll(updatedChildFragments);
 575     }
 576
 577     @Override
 578     @Transactional
 579     public void replaceListContent(final String dataspaceName, final String anchorName, final String parentNodeXpath,
 580                                    final Collection<DataNode> newListElements) {
 581         final AnchorEntity anchorEntity = getAnchorEntity(dataspaceName, anchorName);
 582         final FragmentEntity parentEntity = getFragmentEntity(anchorEntity, parentNodeXpath);
 583         final String listElementXpathPrefix = getListElementXpathPrefix(newListElements);
 584         final Map<String, FragmentEntity> existingListElementFragmentEntitiesByXPath =
 585                 extractListElementFragmentEntitiesByXPath(parentEntity.getChildFragments(), listElementXpathPrefix);
 586         parentEntity.getChildFragments().removeAll(existingListElementFragmentEntitiesByXPath.values());
 587         final Set<FragmentEntity> updatedChildFragmentEntities = new HashSet<>();
 588         for (final DataNode newListElement : newListElements) {
 589             final FragmentEntity existingListElementEntity =
 590                     existingListElementFragmentEntitiesByXPath.get(newListElement.getXpath());
 591             final FragmentEntity entityToBeAdded = getFragmentForReplacement(parentEntity, newListElement,
 592                     existingListElementEntity);
 593             updatedChildFragmentEntities.add(entityToBeAdded);
 594         }
 595         parentEntity.getChildFragments().addAll(updatedChildFragmentEntities);
 596         fragmentRepository.save(parentEntity);
 597     }
 598
 599     @Override
 600     @Transactional
 601     public void deleteDataNodes(final String dataspaceName, final String anchorName) {
 602         final DataspaceEntity dataspaceEntity = dataspaceRepository.getByName(dataspaceName);
 603         anchorRepository.findByDataspaceAndName(dataspaceEntity, anchorName)
 604             .ifPresent(anchorEntity -> fragmentRepository.deleteByAnchorIn(Collections.singletonList(anchorEntity)));
 605     }
 606
 607     @Override
 608     @Transactional
 609     public void deleteDataNodes(final String dataspaceName, final Collection<String> anchorNames) {
 610         final DataspaceEntity dataspaceEntity = dataspaceRepository.getByName(dataspaceName);
 611         final Collection<AnchorEntity> anchorEntities =
 612             anchorRepository.findAllByDataspaceAndNameIn(dataspaceEntity, anchorNames);
 613         fragmentRepository.deleteByAnchorIn(anchorEntities);
 614     }
 615
 616     @Override
 617     @Transactional
 618     public void deleteDataNodes(final String dataspaceName, final String anchorName,
 619                                 final Collection<String> xpathsToDelete) {
 620         deleteDataNodes(dataspaceName, anchorName, xpathsToDelete, false);
 621     }
 622
 623     private void deleteDataNodes(final String dataspaceName, final String anchorName,
 624                                  final Collection<String> xpathsToDelete, final boolean onlySupportListDeletion) {
 625         final boolean haveRootXpath = xpathsToDelete.stream().anyMatch(CpsDataPersistenceServiceImpl::isRootXpath);
 626         if (haveRootXpath) {
 627             deleteDataNodes(dataspaceName, anchorName);
 628             return;
 629         }
 630
 631         final AnchorEntity anchorEntity = getAnchorEntity(dataspaceName, anchorName);
 632
 633         final Collection<String> deleteChecklist = new HashSet<>(xpathsToDelete.size());
 634         for (final String xpath : xpathsToDelete) {
 635             try {
 636                 deleteChecklist.add(CpsPathUtil.getNormalizedXpath(xpath));
 637             } catch (final PathParsingException e) {
 638                 log.warn("Error parsing xpath \"{}\": {}", xpath, e.getMessage());
 639             }
 640         }
 641
 642         final Collection<String> xpathsToExistingContainers =
 643             fragmentRepository.findAllXpathByAnchorAndXpathIn(anchorEntity, deleteChecklist);
 644         if (onlySupportListDeletion) {
 645             final Collection<String> xpathsToExistingListElements = xpathsToExistingContainers.stream()
 646                 .filter(CpsPathUtil::isPathToListElement).collect(Collectors.toList());
 647             deleteChecklist.removeAll(xpathsToExistingListElements);
 648         } else {
 649             deleteChecklist.removeAll(xpathsToExistingContainers);
 650         }
 651
 652         final Collection<String> xpathsToExistingLists = deleteChecklist.stream()
 653             .filter(xpath -> fragmentRepository.existsByAnchorAndXpathStartsWith(anchorEntity, xpath + "["))
 654             .collect(Collectors.toList());
 655         deleteChecklist.removeAll(xpathsToExistingLists);
 656
 657         if (!deleteChecklist.isEmpty()) {
 658             throw new DataNodeNotFoundExceptionBatch(dataspaceName, anchorName, deleteChecklist);
 659         }
 660
 661         fragmentRepository.deleteByAnchorIdAndXpaths(anchorEntity.getId(), xpathsToExistingContainers);
 662         fragmentRepository.deleteListsByAnchorIdAndXpaths(anchorEntity.getId(), xpathsToExistingLists);
 663     }
 664
 665     @Override
 666     @Transactional
 667     public void deleteListDataNode(final String dataspaceName, final String anchorName,
 668                                    final String targetXpath) {
 669         deleteDataNode(dataspaceName, anchorName, targetXpath, true);
 670     }
 671
 672     @Override
 673     @Transactional
 674     public void deleteDataNode(final String dataspaceName, final String anchorName, final String targetXpath) {
 675         deleteDataNode(dataspaceName, anchorName, targetXpath, false);
 676     }
 677
 678     private void deleteDataNode(final String dataspaceName, final String anchorName, final String targetXpath,
 679                                 final boolean onlySupportListNodeDeletion) {
 680         final String normalizedXpath = getNormalizedXpath(targetXpath);
 681         try {
 682             deleteDataNodes(dataspaceName, anchorName, Collections.singletonList(normalizedXpath),
 683                 onlySupportListNodeDeletion);
 684         } catch (final DataNodeNotFoundExceptionBatch dataNodeNotFoundExceptionBatch) {
 685             throw new DataNodeNotFoundException(dataspaceName, anchorName, targetXpath);
 686         }
 687     }
 688
 689     private static String getListElementXpathPrefix(final Collection<DataNode> newListElements) {
 690         if (newListElements.isEmpty()) {
 691             throw new CpsAdminException("Invalid list replacement",
 692                     "Cannot replace list elements with empty collection");
 693         }
 694         final String firstChildNodeXpath = newListElements.iterator().next().getXpath();
 695         return firstChildNodeXpath.substring(0, firstChildNodeXpath.lastIndexOf('[') + 1);
 696     }
 697
 698     private FragmentEntity getFragmentForReplacement(final FragmentEntity parentEntity,
 699                                                      final DataNode newListElement,
 700                                                      final FragmentEntity existingListElementEntity) {
 701         if (existingListElementEntity == null) {
 702             return convertToFragmentWithAllDescendants(parentEntity.getAnchor(), newListElement);
 703         }
 704         if (newListElement.getChildDataNodes().isEmpty()) {
 705             copyAttributesFromNewListElement(existingListElementEntity, newListElement);
 706             existingListElementEntity.getChildFragments().clear();
 707         } else {
 708             updateFragmentEntityAndDescendantsWithDataNode(existingListElementEntity, newListElement);
 709         }
 710         return existingListElementEntity;
 711     }
 712
 713     private static boolean isNewDataNode(final DataNode replacementDataNode,
 714                                          final Map<String, FragmentEntity> existingListElementsByXpath) {
 715         return !existingListElementsByXpath.containsKey(replacementDataNode.getXpath());
 716     }
 717
 718     private void copyAttributesFromNewListElement(final FragmentEntity existingListElementEntity,
 719                                                   final DataNode newListElement) {
 720         final FragmentEntity replacementFragmentEntity =
 721                 FragmentEntity.builder().attributes(jsonObjectMapper.asJsonString(
 722                         newListElement.getLeaves())).build();
 723         existingListElementEntity.setAttributes(replacementFragmentEntity.getAttributes());
 724     }
 725
 726     private static Map<String, FragmentEntity> extractListElementFragmentEntitiesByXPath(
 727             final Set<FragmentEntity> childEntities, final String listElementXpathPrefix) {
 728         return childEntities.stream()
 729                 .filter(fragmentEntity -> fragmentEntity.getXpath().startsWith(listElementXpathPrefix))
 730                 .collect(Collectors.toMap(FragmentEntity::getXpath, fragmentEntity -> fragmentEntity));
 731     }
 732
 733     private static boolean isRootXpath(final String xpath) {
 734         return "/".equals(xpath) || "".equals(xpath);
 735     }
 736
 737     private String mergeLeaves(final Map<String, Serializable> updateLeaves, final String currentLeavesAsString) {
 738         final Map<String, Serializable> currentLeavesAsMap = currentLeavesAsString.isEmpty()
 739             ? new HashMap<>() : jsonObjectMapper.convertJsonString(currentLeavesAsString, Map.class);
 740         currentLeavesAsMap.putAll(updateLeaves);
 741         if (currentLeavesAsMap.isEmpty()) {
 742             return "";
 743         }
 744         return jsonObjectMapper.asJsonString(currentLeavesAsMap);
 745     }
 746
 747     private AnchorEntity getAnchorEntity(final String dataspaceName, final String anchorName) {
 748         final DataspaceEntity dataspaceEntity = dataspaceRepository.getByName(dataspaceName);
 749         return anchorRepository.getByDataspaceAndName(dataspaceEntity, anchorName);
 750     }
 751 }