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             && !cpsPathQuery.hasContainsFunctionCondition();
 354     }
 355
 356     private List<DataNode> getDataNodesUsingRegexQuickFind(final FetchDescendantsOption fetchDescendantsOption,
 357                                                            final AnchorEntity anchorEntity,
 358                                                            final CpsPathQuery cpsPathQuery) {
 359         Collection<FragmentEntity> fragmentEntities;
 360         final String xpathRegex = FragmentQueryBuilder.getXpathSqlRegex(cpsPathQuery, true);
 361         final List<FragmentExtract> fragmentExtracts = (anchorEntity == ALL_ANCHORS)
 362                 ? fragmentRepository.quickFindWithDescendantsAcrossAnchor(xpathRegex) :
 363             fragmentRepository.quickFindWithDescendants(anchorEntity.getId(), xpathRegex);
 364         fragmentEntities = FragmentEntityArranger.toFragmentEntityTrees(anchorEntity, fragmentExtracts);
 365         if (cpsPathQuery.hasAncestorAxis()) {
 366             final Collection<String> ancestorXpaths = processAncestorXpath(fragmentEntities, cpsPathQuery);
 367             fragmentEntities = (anchorEntity == ALL_ANCHORS) ? getAncestorFragmentEntitiesAcrossAnchors(cpsPathQuery,
 368             fragmentEntities) : getFragmentEntities(anchorEntity, ancestorXpaths, fetchDescendantsOption);
 369         }
 370         return createDataNodesFromFragmentEntities(fetchDescendantsOption, fragmentEntities);
 371     }
 372
 373     private Collection<FragmentEntity> getAncestorFragmentEntitiesAcrossAnchors(final CpsPathQuery cpsPathQuery,
 374         final Collection<FragmentEntity> fragmentEntities) {
 375         final Collection<String> ancestorXpaths = processAncestorXpath(fragmentEntities, cpsPathQuery);
 376         return ancestorXpaths.isEmpty() ? Collections.emptyList() : fragmentRepository.findAllByXpathIn(ancestorXpaths);
 377     }
 378
 379     private List<DataNode> createDataNodesFromProxiedFragmentEntities(
 380                                             final FetchDescendantsOption fetchDescendantsOption,
 381                                             final AnchorEntity anchorEntity,
 382                                             final Collection<FragmentEntity> proxiedFragmentEntities) {
 383         final List<DataNode> dataNodes = new ArrayList<>(proxiedFragmentEntities.size());
 384         for (final FragmentEntity proxiedFragmentEntity : proxiedFragmentEntities) {
 385             if (FetchDescendantsOption.OMIT_DESCENDANTS.equals(fetchDescendantsOption)) {
 386                 dataNodes.add(toDataNode(proxiedFragmentEntity, fetchDescendantsOption));
 387             } else {
 388                 final String normalizedXpath = getNormalizedXpath(proxiedFragmentEntity.getXpath());
 389                 final AnchorEntity anchorEntityForFragmentExtract = (anchorEntity == ALL_ANCHORS)
 390                         ? proxiedFragmentEntity.getAnchor() : anchorEntity;
 391                 final Collection<FragmentEntity> unproxiedFragmentEntities =
 392                     buildFragmentEntitiesFromFragmentExtracts(anchorEntityForFragmentExtract, normalizedXpath);
 393                 for (final FragmentEntity unproxiedFragmentEntity : unproxiedFragmentEntities) {
 394                     dataNodes.add(toDataNode(unproxiedFragmentEntity, fetchDescendantsOption));
 395                 }
 396             }
 397         }
 398         return Collections.unmodifiableList(dataNodes);
 399     }
 400
 401     private List<DataNode> createDataNodesFromFragmentEntities(final FetchDescendantsOption fetchDescendantsOption,
 402                                                                final Collection<FragmentEntity> fragmentEntities) {
 403         final List<DataNode> dataNodes = new ArrayList<>(fragmentEntities.size());
 404         for (final FragmentEntity fragmentEntity : fragmentEntities) {
 405             dataNodes.add(toDataNode(fragmentEntity, fetchDescendantsOption));
 406         }
 407         return Collections.unmodifiableList(dataNodes);
 408     }
 409
 410     private static String getNormalizedXpath(final String xpathSource) {
 411         if (isRootXpath(xpathSource)) {
 412             return xpathSource;
 413         }
 414         try {
 415             return CpsPathUtil.getNormalizedXpath(xpathSource);
 416         } catch (final PathParsingException e) {
 417             throw new CpsPathException(e.getMessage());
 418         }
 419     }
 420
 421     @Override
 422     public String startSession() {
 423         return sessionManager.startSession();
 424     }
 425
 426     @Override
 427     public void closeSession(final String sessionId) {
 428         sessionManager.closeSession(sessionId, SessionManager.WITH_COMMIT);
 429     }
 430
 431     @Override
 432     public void lockAnchor(final String sessionId, final String dataspaceName,
 433                            final String anchorName, final Long timeoutInMilliseconds) {
 434         sessionManager.lockAnchor(sessionId, dataspaceName, anchorName, timeoutInMilliseconds);
 435     }
 436
 437     private static Set<String> processAncestorXpath(final Collection<FragmentEntity> fragmentEntities,
 438                                                     final CpsPathQuery cpsPathQuery) {
 439         final Set<String> ancestorXpath = new HashSet<>();
 440         final Pattern pattern =
 441                 Pattern.compile("([\\s\\S]*/" + Pattern.quote(cpsPathQuery.getAncestorSchemaNodeIdentifier())
 442                         + REG_EX_FOR_OPTIONAL_LIST_INDEX + "/[\\s\\S]*");
 443         for (final FragmentEntity fragmentEntity : fragmentEntities) {
 444             final Matcher matcher = pattern.matcher(fragmentEntity.getXpath());
 445             if (matcher.matches()) {
 446                 ancestorXpath.add(matcher.group(1));
 447             }
 448         }
 449         return ancestorXpath;
 450     }
 451
 452     private DataNode toDataNode(final FragmentEntity fragmentEntity,
 453                                 final FetchDescendantsOption fetchDescendantsOption) {
 454         final List<DataNode> childDataNodes = getChildDataNodes(fragmentEntity, fetchDescendantsOption);
 455         Map<String, Serializable> leaves = new HashMap<>();
 456         if (fragmentEntity.getAttributes() != null) {
 457             leaves = jsonObjectMapper.convertJsonString(fragmentEntity.getAttributes(), Map.class);
 458         }
 459         return new DataNodeBuilder()
 460                 .withXpath(fragmentEntity.getXpath())
 461                 .withLeaves(leaves)
 462                 .withDataspace(fragmentEntity.getAnchor().getDataspace().getName())
 463                 .withAnchor(fragmentEntity.getAnchor().getName())
 464                 .withChildDataNodes(childDataNodes).build();
 465     }
 466
 467     private Collection<DataNode> toDataNodes(final Collection<FragmentEntity> fragmentEntities,
 468                                              final FetchDescendantsOption fetchDescendantsOption) {
 469         final Collection<DataNode> dataNodes = new ArrayList<>(fragmentEntities.size());
 470         for (final FragmentEntity fragmentEntity : fragmentEntities) {
 471             dataNodes.add(toDataNode(fragmentEntity, fetchDescendantsOption));
 472         }
 473         return dataNodes;
 474     }
 475
 476     private List<DataNode> getChildDataNodes(final FragmentEntity fragmentEntity,
 477                                              final FetchDescendantsOption fetchDescendantsOption) {
 478         if (fetchDescendantsOption.hasNext()) {
 479             return fragmentEntity.getChildFragments().stream()
 480                     .map(childFragmentEntity -> toDataNode(childFragmentEntity, fetchDescendantsOption.next()))
 481                     .collect(Collectors.toList());
 482         }
 483         return Collections.emptyList();
 484     }
 485
 486     @Override
 487     public void updateDataLeaves(final String dataspaceName, final String anchorName, final String xpath,
 488                                  final Map<String, Serializable> updateLeaves) {
 489         final AnchorEntity anchorEntity = getAnchorEntity(dataspaceName, anchorName);
 490         final FragmentEntity fragmentEntity = getFragmentEntity(anchorEntity, xpath);
 491         final String currentLeavesAsString = fragmentEntity.getAttributes();
 492         final String mergedLeaves = mergeLeaves(updateLeaves, currentLeavesAsString);
 493         fragmentEntity.setAttributes(mergedLeaves);
 494         fragmentRepository.save(fragmentEntity);
 495     }
 496
 497     @Override
 498     public void updateDataNodesAndDescendants(final String dataspaceName, final String anchorName,
 499                                               final Collection<DataNode> updatedDataNodes) {
 500         final AnchorEntity anchorEntity = getAnchorEntity(dataspaceName, anchorName);
 501
 502         final Map<String, DataNode> xpathToUpdatedDataNode = updatedDataNodes.stream()
 503             .collect(Collectors.toMap(DataNode::getXpath, dataNode -> dataNode));
 504
 505         final Collection<String> xpaths = xpathToUpdatedDataNode.keySet();
 506         final Collection<FragmentEntity> existingFragmentEntities =
 507             getFragmentEntities(anchorEntity, xpaths, FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS);
 508
 509         for (final FragmentEntity existingFragmentEntity : existingFragmentEntities) {
 510             final DataNode updatedDataNode = xpathToUpdatedDataNode.get(existingFragmentEntity.getXpath());
 511             updateFragmentEntityAndDescendantsWithDataNode(existingFragmentEntity, updatedDataNode);
 512         }
 513
 514         try {
 515             fragmentRepository.saveAll(existingFragmentEntities);
 516         } catch (final StaleStateException staleStateException) {
 517             retryUpdateDataNodesIndividually(anchorEntity, existingFragmentEntities);
 518         }
 519     }
 520
 521     private void retryUpdateDataNodesIndividually(final AnchorEntity anchorEntity,
 522                                                   final Collection<FragmentEntity> fragmentEntities) {
 523         final Collection<String> failedXpaths = new HashSet<>();
 524         for (final FragmentEntity dataNodeFragment : fragmentEntities) {
 525             try {
 526                 fragmentRepository.save(dataNodeFragment);
 527             } catch (final StaleStateException e) {
 528                 failedXpaths.add(dataNodeFragment.getXpath());
 529             }
 530         }
 531         if (!failedXpaths.isEmpty()) {
 532             final String failedXpathsConcatenated = String.join(",", failedXpaths);
 533             throw new ConcurrencyException("Concurrent Transactions", String.format(
 534                     "DataNodes : %s in Dataspace :'%s' with Anchor : '%s'  are updated by another transaction.",
 535                     failedXpathsConcatenated, anchorEntity.getDataspace().getName(), anchorEntity.getName()));
 536         }
 537     }
 538
 539     private void updateFragmentEntityAndDescendantsWithDataNode(final FragmentEntity existingFragmentEntity,
 540                                                                 final DataNode newDataNode) {
 541         existingFragmentEntity.setAttributes(jsonObjectMapper.asJsonString(newDataNode.getLeaves()));
 542
 543         final Map<String, FragmentEntity> existingChildrenByXpath = existingFragmentEntity.getChildFragments().stream()
 544                 .collect(Collectors.toMap(FragmentEntity::getXpath, childFragmentEntity -> childFragmentEntity));
 545
 546         final Collection<FragmentEntity> updatedChildFragments = new HashSet<>();
 547         for (final DataNode newDataNodeChild : newDataNode.getChildDataNodes()) {
 548             final FragmentEntity childFragment;
 549             if (isNewDataNode(newDataNodeChild, existingChildrenByXpath)) {
 550                 childFragment = convertToFragmentWithAllDescendants(existingFragmentEntity.getAnchor(),
 551                     newDataNodeChild);
 552             } else {
 553                 childFragment = existingChildrenByXpath.get(newDataNodeChild.getXpath());
 554                 updateFragmentEntityAndDescendantsWithDataNode(childFragment, newDataNodeChild);
 555             }
 556             updatedChildFragments.add(childFragment);
 557         }
 558
 559         existingFragmentEntity.getChildFragments().clear();
 560         existingFragmentEntity.getChildFragments().addAll(updatedChildFragments);
 561     }
 562
 563     @Override
 564     @Transactional
 565     public void replaceListContent(final String dataspaceName, final String anchorName, final String parentNodeXpath,
 566                                    final Collection<DataNode> newListElements) {
 567         final AnchorEntity anchorEntity = getAnchorEntity(dataspaceName, anchorName);
 568         final FragmentEntity parentEntity = getFragmentEntity(anchorEntity, parentNodeXpath);
 569         final String listElementXpathPrefix = getListElementXpathPrefix(newListElements);
 570         final Map<String, FragmentEntity> existingListElementFragmentEntitiesByXPath =
 571                 extractListElementFragmentEntitiesByXPath(parentEntity.getChildFragments(), listElementXpathPrefix);
 572         parentEntity.getChildFragments().removeAll(existingListElementFragmentEntitiesByXPath.values());
 573         final Set<FragmentEntity> updatedChildFragmentEntities = new HashSet<>();
 574         for (final DataNode newListElement : newListElements) {
 575             final FragmentEntity existingListElementEntity =
 576                     existingListElementFragmentEntitiesByXPath.get(newListElement.getXpath());
 577             final FragmentEntity entityToBeAdded = getFragmentForReplacement(parentEntity, newListElement,
 578                     existingListElementEntity);
 579             updatedChildFragmentEntities.add(entityToBeAdded);
 580         }
 581         parentEntity.getChildFragments().addAll(updatedChildFragmentEntities);
 582         fragmentRepository.save(parentEntity);
 583     }
 584
 585     @Override
 586     @Transactional
 587     public void deleteDataNodes(final String dataspaceName, final String anchorName) {
 588         final DataspaceEntity dataspaceEntity = dataspaceRepository.getByName(dataspaceName);
 589         anchorRepository.findByDataspaceAndName(dataspaceEntity, anchorName)
 590             .ifPresent(anchorEntity -> fragmentRepository.deleteByAnchorIn(Collections.singletonList(anchorEntity)));
 591     }
 592
 593     @Override
 594     @Transactional
 595     public void deleteDataNodes(final String dataspaceName, final Collection<String> anchorNames) {
 596         final DataspaceEntity dataspaceEntity = dataspaceRepository.getByName(dataspaceName);
 597         final Collection<AnchorEntity> anchorEntities =
 598             anchorRepository.findAllByDataspaceAndNameIn(dataspaceEntity, anchorNames);
 599         fragmentRepository.deleteByAnchorIn(anchorEntities);
 600     }
 601
 602     @Override
 603     @Transactional
 604     public void deleteDataNodes(final String dataspaceName, final String anchorName,
 605                                 final Collection<String> xpathsToDelete) {
 606         deleteDataNodes(dataspaceName, anchorName, xpathsToDelete, false);
 607     }
 608
 609     private void deleteDataNodes(final String dataspaceName, final String anchorName,
 610                                  final Collection<String> xpathsToDelete, final boolean onlySupportListDeletion) {
 611         final boolean haveRootXpath = xpathsToDelete.stream().anyMatch(CpsDataPersistenceServiceImpl::isRootXpath);
 612         if (haveRootXpath) {
 613             deleteDataNodes(dataspaceName, anchorName);
 614             return;
 615         }
 616
 617         final AnchorEntity anchorEntity = getAnchorEntity(dataspaceName, anchorName);
 618
 619         final Collection<String> deleteChecklist = new HashSet<>(xpathsToDelete.size());
 620         for (final String xpath : xpathsToDelete) {
 621             try {
 622                 deleteChecklist.add(CpsPathUtil.getNormalizedXpath(xpath));
 623             } catch (final PathParsingException e) {
 624                 log.warn("Error parsing xpath \"{}\": {}", xpath, e.getMessage());
 625             }
 626         }
 627
 628         final Collection<String> xpathsToExistingContainers =
 629             fragmentRepository.findAllXpathByAnchorAndXpathIn(anchorEntity, deleteChecklist);
 630         if (onlySupportListDeletion) {
 631             final Collection<String> xpathsToExistingListElements = xpathsToExistingContainers.stream()
 632                 .filter(CpsPathUtil::isPathToListElement).collect(Collectors.toList());
 633             deleteChecklist.removeAll(xpathsToExistingListElements);
 634         } else {
 635             deleteChecklist.removeAll(xpathsToExistingContainers);
 636         }
 637
 638         final Collection<String> xpathsToExistingLists = deleteChecklist.stream()
 639             .filter(xpath -> fragmentRepository.existsByAnchorAndXpathStartsWith(anchorEntity, xpath + "["))
 640             .collect(Collectors.toList());
 641         deleteChecklist.removeAll(xpathsToExistingLists);
 642
 643         if (!deleteChecklist.isEmpty()) {
 644             throw new DataNodeNotFoundExceptionBatch(dataspaceName, anchorName, deleteChecklist);
 645         }
 646
 647         fragmentRepository.deleteByAnchorIdAndXpaths(anchorEntity.getId(), xpathsToExistingContainers);
 648         fragmentRepository.deleteListsByAnchorIdAndXpaths(anchorEntity.getId(), xpathsToExistingLists);
 649     }
 650
 651     @Override
 652     @Transactional
 653     public void deleteListDataNode(final String dataspaceName, final String anchorName,
 654                                    final String targetXpath) {
 655         deleteDataNode(dataspaceName, anchorName, targetXpath, true);
 656     }
 657
 658     @Override
 659     @Transactional
 660     public void deleteDataNode(final String dataspaceName, final String anchorName, final String targetXpath) {
 661         deleteDataNode(dataspaceName, anchorName, targetXpath, false);
 662     }
 663
 664     private void deleteDataNode(final String dataspaceName, final String anchorName, final String targetXpath,
 665                                 final boolean onlySupportListNodeDeletion) {
 666         final String normalizedXpath = getNormalizedXpath(targetXpath);
 667         try {
 668             deleteDataNodes(dataspaceName, anchorName, Collections.singletonList(normalizedXpath),
 669                 onlySupportListNodeDeletion);
 670         } catch (final DataNodeNotFoundExceptionBatch dataNodeNotFoundExceptionBatch) {
 671             throw new DataNodeNotFoundException(dataspaceName, anchorName, targetXpath);
 672         }
 673     }
 674
 675     private static String getListElementXpathPrefix(final Collection<DataNode> newListElements) {
 676         if (newListElements.isEmpty()) {
 677             throw new CpsAdminException("Invalid list replacement",
 678                     "Cannot replace list elements with empty collection");
 679         }
 680         final String firstChildNodeXpath = newListElements.iterator().next().getXpath();
 681         return firstChildNodeXpath.substring(0, firstChildNodeXpath.lastIndexOf('[') + 1);
 682     }
 683
 684     private FragmentEntity getFragmentForReplacement(final FragmentEntity parentEntity,
 685                                                      final DataNode newListElement,
 686                                                      final FragmentEntity existingListElementEntity) {
 687         if (existingListElementEntity == null) {
 688             return convertToFragmentWithAllDescendants(parentEntity.getAnchor(), newListElement);
 689         }
 690         if (newListElement.getChildDataNodes().isEmpty()) {
 691             copyAttributesFromNewListElement(existingListElementEntity, newListElement);
 692             existingListElementEntity.getChildFragments().clear();
 693         } else {
 694             updateFragmentEntityAndDescendantsWithDataNode(existingListElementEntity, newListElement);
 695         }
 696         return existingListElementEntity;
 697     }
 698
 699     private static boolean isNewDataNode(final DataNode replacementDataNode,
 700                                          final Map<String, FragmentEntity> existingListElementsByXpath) {
 701         return !existingListElementsByXpath.containsKey(replacementDataNode.getXpath());
 702     }
 703
 704     private void copyAttributesFromNewListElement(final FragmentEntity existingListElementEntity,
 705                                                   final DataNode newListElement) {
 706         final FragmentEntity replacementFragmentEntity =
 707                 FragmentEntity.builder().attributes(jsonObjectMapper.asJsonString(
 708                         newListElement.getLeaves())).build();
 709         existingListElementEntity.setAttributes(replacementFragmentEntity.getAttributes());
 710     }
 711
 712     private static Map<String, FragmentEntity> extractListElementFragmentEntitiesByXPath(
 713             final Set<FragmentEntity> childEntities, final String listElementXpathPrefix) {
 714         return childEntities.stream()
 715                 .filter(fragmentEntity -> fragmentEntity.getXpath().startsWith(listElementXpathPrefix))
 716                 .collect(Collectors.toMap(FragmentEntity::getXpath, fragmentEntity -> fragmentEntity));
 717     }
 718
 719     private static boolean isRootXpath(final String xpath) {
 720         return "/".equals(xpath) || "".equals(xpath);
 721     }
 722
 723     private String mergeLeaves(final Map<String, Serializable> updateLeaves, final String currentLeavesAsString) {
 724         final Map<String, Serializable> currentLeavesAsMap = currentLeavesAsString.isEmpty()
 725             ? new HashMap<>() : jsonObjectMapper.convertJsonString(currentLeavesAsString, Map.class);
 726         currentLeavesAsMap.putAll(updateLeaves);
 727         if (currentLeavesAsMap.isEmpty()) {
 728             return "";
 729         }
 730         return jsonObjectMapper.asJsonString(currentLeavesAsMap);
 731     }
 732
 733     private AnchorEntity getAnchorEntity(final String dataspaceName, final String anchorName) {
 734         final DataspaceEntity dataspaceEntity = dataspaceRepository.getByName(dataspaceName);
 735         return anchorRepository.getByDataspaceAndName(dataspaceEntity, anchorName);
 736     }
 737 }