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
12 * http://www.apache.org/licenses/LICENSE-2.0
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.
20 * SPDX-License-Identifier: Apache-2.0
21 * ============LICENSE_END=========================================================
24 package org.onap.cps.spi.impl;
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;
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;
76 @RequiredArgsConstructor
77 public class CpsDataPersistenceServiceImpl implements CpsDataPersistenceService {
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;
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;
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);
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);
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);
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) {
117 addChildrenDataNodes(anchorEntity, parentNodeXpath, newList);
118 } catch (final AlreadyDefinedExceptionBatch e) {
119 failedXpaths.addAll(e.getAlreadyDefinedXpaths());
122 if (!failedXpaths.isEmpty()) {
123 throw new AlreadyDefinedExceptionBatch(failedXpaths);
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());
133 fragmentRepository.save(newChildAsFragmentEntity);
134 } catch (final DataIntegrityViolationException e) {
135 throw AlreadyDefinedException.forDataNode(newChild.getXpath(), anchorEntity.getName(), e);
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());
144 for (final DataNode newChildAsDataNode : newChildren) {
145 final FragmentEntity newChildAsFragmentEntity =
146 convertToFragmentWithAllDescendants(anchorEntity, newChildAsDataNode);
147 newChildAsFragmentEntity.setParentId(parentFragmentEntity.getId());
148 fragmentEntities.add(newChildAsFragmentEntity);
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);
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) {
163 addNewChildDataNode(anchorEntity, parentNodeXpath, newChild);
164 } catch (final AlreadyDefinedException e) {
165 failedXpaths.add(newChild.getXpath());
168 if (!failedXpaths.isEmpty()) {
169 throw new AlreadyDefinedExceptionBatch(failedXpaths);
174 public void storeDataNode(final String dataspaceName, final String anchorName, final DataNode dataNode) {
175 storeDataNodes(dataspaceName, anchorName, Collections.singletonList(dataNode));
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());
184 for (final DataNode dataNode: dataNodes) {
185 final FragmentEntity fragmentEntity = convertToFragmentWithAllDescendants(anchorEntity, dataNode);
186 fragmentEntities.add(fragmentEntity);
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);
196 private void storeDataNodesIndividually(final AnchorEntity anchorEntity, final Collection<DataNode> dataNodes) {
197 final Collection<String> failedXpaths = new HashSet<>();
198 for (final DataNode dataNode: dataNodes) {
200 final FragmentEntity fragmentEntity = convertToFragmentWithAllDescendants(anchorEntity, dataNode);
201 fragmentRepository.save(fragmentEntity);
202 } catch (final DataIntegrityViolationException e) {
203 failedXpaths.add(dataNode.getXpath());
206 if (!failedXpaths.isEmpty()) {
207 throw new AlreadyDefinedExceptionBatch(failedXpaths);
212 * Convert DataNode object into Fragment and places the result in the fragments placeholder. Performs same action
213 * for all DataNode children recursively.
215 * @param anchorEntity anchorEntity
216 * @param dataNodeToBeConverted dataNode
217 * @return a Fragment built from current DataNode
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);
227 parentFragment.setChildFragments(childFragmentsImmutableSetBuilder.build());
228 return parentFragment;
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()))
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,
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);
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);
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);
273 final Collection<String> normalizedXpaths = new HashSet<>(nonRootXpaths.size());
274 for (final String xpath : nonRootXpaths) {
276 normalizedXpaths.add(CpsPathUtil.getNormalizedXpath(xpath));
277 } catch (final PathParsingException e) {
278 log.warn("Error parsing xpath \"{}\": {}", xpath, e.getMessage());
282 normalizedXpaths.addAll(fragmentRepository.findAllXpathByAnchorAndParentIdIsNull(anchorEntity));
285 final List<FragmentExtract> fragmentExtracts =
286 fragmentRepository.findExtractsWithDescendants(anchorEntity.getId(), normalizedXpaths,
287 fetchDescendantsOption.getDepth());
289 return FragmentEntityArranger.toFragmentEntityTrees(anchorEntity, fragmentExtracts);
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);
299 fragmentEntity = fragmentRepository.getByAnchorAndXpath(anchorEntity, getNormalizedXpath(xpath));
301 if (fragmentEntity == null) {
302 throw new DataNodeNotFoundException(anchorEntity.getDataspace().getName(), anchorEntity.getName(), xpath);
304 return fragmentEntity;
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);
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;
323 cpsPathQuery = CpsPathUtil.getCpsPathQuery(cpsPath);
324 } catch (final PathParsingException e) {
325 throw new CpsPathException(e.getMessage());
328 Collection<FragmentEntity> fragmentEntities;
329 if (canUseRegexQuickFind(fetchDescendantsOption, cpsPathQuery)) {
330 return getDataNodesUsingRegexQuickFind(fetchDescendantsOption, anchorEntity, cpsPathQuery);
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);
339 return createDataNodesFromProxiedFragmentEntities(fetchDescendantsOption, anchorEntity, fragmentEntities);
343 public List<DataNode> queryDataNodesAcrossAnchors(final String dataspaceName, final String cpsPath,
344 final FetchDescendantsOption fetchDescendantsOption) {
345 return queryDataNodes(dataspaceName, QUERY_ACROSS_ANCHORS, cpsPath, fetchDescendantsOption);
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();
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);
370 return createDataNodesFromFragmentEntities(fetchDescendantsOption, fragmentEntities);
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);
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));
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));
398 return Collections.unmodifiableList(dataNodes);
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));
407 return Collections.unmodifiableList(dataNodes);
410 private static String getNormalizedXpath(final String xpathSource) {
411 if (isRootXpath(xpathSource)) {
415 return CpsPathUtil.getNormalizedXpath(xpathSource);
416 } catch (final PathParsingException e) {
417 throw new CpsPathException(e.getMessage());
422 public String startSession() {
423 return sessionManager.startSession();
427 public void closeSession(final String sessionId) {
428 sessionManager.closeSession(sessionId, SessionManager.WITH_COMMIT);
432 public void lockAnchor(final String sessionId, final String dataspaceName,
433 final String anchorName, final Long timeoutInMilliseconds) {
434 sessionManager.lockAnchor(sessionId, dataspaceName, anchorName, timeoutInMilliseconds);
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));
449 return ancestorXpath;
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);
459 return new DataNodeBuilder()
460 .withXpath(fragmentEntity.getXpath())
462 .withDataspace(fragmentEntity.getAnchor().getDataspace().getName())
463 .withAnchor(fragmentEntity.getAnchor().getName())
464 .withChildDataNodes(childDataNodes).build();
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));
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());
483 return Collections.emptyList();
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);
498 public void updateDataNodesAndDescendants(final String dataspaceName, final String anchorName,
499 final Collection<DataNode> updatedDataNodes) {
500 final AnchorEntity anchorEntity = getAnchorEntity(dataspaceName, anchorName);
502 final Map<String, DataNode> xpathToUpdatedDataNode = updatedDataNodes.stream()
503 .collect(Collectors.toMap(DataNode::getXpath, dataNode -> dataNode));
505 final Collection<String> xpaths = xpathToUpdatedDataNode.keySet();
506 final Collection<FragmentEntity> existingFragmentEntities =
507 getFragmentEntities(anchorEntity, xpaths, FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS);
509 for (final FragmentEntity existingFragmentEntity : existingFragmentEntities) {
510 final DataNode updatedDataNode = xpathToUpdatedDataNode.get(existingFragmentEntity.getXpath());
511 updateFragmentEntityAndDescendantsWithDataNode(existingFragmentEntity, updatedDataNode);
515 fragmentRepository.saveAll(existingFragmentEntities);
516 } catch (final StaleStateException staleStateException) {
517 retryUpdateDataNodesIndividually(anchorEntity, existingFragmentEntities);
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) {
526 fragmentRepository.save(dataNodeFragment);
527 } catch (final StaleStateException e) {
528 failedXpaths.add(dataNodeFragment.getXpath());
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()));
539 private void updateFragmentEntityAndDescendantsWithDataNode(final FragmentEntity existingFragmentEntity,
540 final DataNode newDataNode) {
541 existingFragmentEntity.setAttributes(jsonObjectMapper.asJsonString(newDataNode.getLeaves()));
543 final Map<String, FragmentEntity> existingChildrenByXpath = existingFragmentEntity.getChildFragments().stream()
544 .collect(Collectors.toMap(FragmentEntity::getXpath, childFragmentEntity -> childFragmentEntity));
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(),
553 childFragment = existingChildrenByXpath.get(newDataNodeChild.getXpath());
554 updateFragmentEntityAndDescendantsWithDataNode(childFragment, newDataNodeChild);
556 updatedChildFragments.add(childFragment);
559 existingFragmentEntity.getChildFragments().clear();
560 existingFragmentEntity.getChildFragments().addAll(updatedChildFragments);
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);
581 parentEntity.getChildFragments().addAll(updatedChildFragmentEntities);
582 fragmentRepository.save(parentEntity);
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)));
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);
604 public void deleteDataNodes(final String dataspaceName, final String anchorName,
605 final Collection<String> xpathsToDelete) {
606 deleteDataNodes(dataspaceName, anchorName, xpathsToDelete, false);
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);
613 deleteDataNodes(dataspaceName, anchorName);
617 final AnchorEntity anchorEntity = getAnchorEntity(dataspaceName, anchorName);
619 final Collection<String> deleteChecklist = new HashSet<>(xpathsToDelete.size());
620 for (final String xpath : xpathsToDelete) {
622 deleteChecklist.add(CpsPathUtil.getNormalizedXpath(xpath));
623 } catch (final PathParsingException e) {
624 log.warn("Error parsing xpath \"{}\": {}", xpath, e.getMessage());
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);
635 deleteChecklist.removeAll(xpathsToExistingContainers);
638 final Collection<String> xpathsToExistingLists = deleteChecklist.stream()
639 .filter(xpath -> fragmentRepository.existsByAnchorAndXpathStartsWith(anchorEntity, xpath + "["))
640 .collect(Collectors.toList());
641 deleteChecklist.removeAll(xpathsToExistingLists);
643 if (!deleteChecklist.isEmpty()) {
644 throw new DataNodeNotFoundExceptionBatch(dataspaceName, anchorName, deleteChecklist);
647 fragmentRepository.deleteByAnchorIdAndXpaths(anchorEntity.getId(), xpathsToExistingContainers);
648 fragmentRepository.deleteListsByAnchorIdAndXpaths(anchorEntity.getId(), xpathsToExistingLists);
653 public void deleteListDataNode(final String dataspaceName, final String anchorName,
654 final String targetXpath) {
655 deleteDataNode(dataspaceName, anchorName, targetXpath, true);
660 public void deleteDataNode(final String dataspaceName, final String anchorName, final String targetXpath) {
661 deleteDataNode(dataspaceName, anchorName, targetXpath, false);
664 private void deleteDataNode(final String dataspaceName, final String anchorName, final String targetXpath,
665 final boolean onlySupportListNodeDeletion) {
666 final String normalizedXpath = getNormalizedXpath(targetXpath);
668 deleteDataNodes(dataspaceName, anchorName, Collections.singletonList(normalizedXpath),
669 onlySupportListNodeDeletion);
670 } catch (final DataNodeNotFoundExceptionBatch dataNodeNotFoundExceptionBatch) {
671 throw new DataNodeNotFoundException(dataspaceName, anchorName, targetXpath);
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");
680 final String firstChildNodeXpath = newListElements.iterator().next().getXpath();
681 return firstChildNodeXpath.substring(0, firstChildNodeXpath.lastIndexOf('[') + 1);
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);
690 if (newListElement.getChildDataNodes().isEmpty()) {
691 copyAttributesFromNewListElement(existingListElementEntity, newListElement);
692 existingListElementEntity.getChildFragments().clear();
694 updateFragmentEntityAndDescendantsWithDataNode(existingListElementEntity, newListElement);
696 return existingListElementEntity;
699 private static boolean isNewDataNode(final DataNode replacementDataNode,
700 final Map<String, FragmentEntity> existingListElementsByXpath) {
701 return !existingListElementsByXpath.containsKey(replacementDataNode.getXpath());
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());
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));
719 private static boolean isRootXpath(final String xpath) {
720 return "/".equals(xpath) || "".equals(xpath);
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()) {
730 return jsonObjectMapper.asJsonString(currentLeavesAsMap);
733 private AnchorEntity getAnchorEntity(final String dataspaceName, final String anchorName) {
734 final DataspaceEntity dataspaceEntity = dataspaceRepository.getByName(dataspaceName);
735 return anchorRepository.getByDataspaceAndName(dataspaceEntity, anchorName);