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 static org.onap.cps.spi.PaginationOption.NO_PAGINATION;
28 import com.google.common.collect.ImmutableSet;
29 import com.google.common.collect.ImmutableSet.Builder;
30 import io.micrometer.core.annotation.Timed;
31 import java.io.Serializable;
32 import java.util.ArrayList;
33 import java.util.Collection;
34 import java.util.Collections;
35 import java.util.HashMap;
36 import java.util.HashSet;
37 import java.util.List;
40 import java.util.regex.Matcher;
41 import java.util.regex.Pattern;
42 import java.util.stream.Collectors;
43 import javax.transaction.Transactional;
44 import lombok.RequiredArgsConstructor;
45 import lombok.extern.slf4j.Slf4j;
46 import org.hibernate.StaleStateException;
47 import org.onap.cps.cpspath.parser.CpsPathQuery;
48 import org.onap.cps.cpspath.parser.CpsPathUtil;
49 import org.onap.cps.cpspath.parser.PathParsingException;
50 import org.onap.cps.spi.CpsDataPersistenceService;
51 import org.onap.cps.spi.FetchDescendantsOption;
52 import org.onap.cps.spi.PaginationOption;
53 import org.onap.cps.spi.entities.AnchorEntity;
54 import org.onap.cps.spi.entities.DataspaceEntity;
55 import org.onap.cps.spi.entities.FragmentEntity;
56 import org.onap.cps.spi.exceptions.AlreadyDefinedException;
57 import org.onap.cps.spi.exceptions.ConcurrencyException;
58 import org.onap.cps.spi.exceptions.CpsAdminException;
59 import org.onap.cps.spi.exceptions.CpsPathException;
60 import org.onap.cps.spi.exceptions.DataNodeNotFoundException;
61 import org.onap.cps.spi.exceptions.DataNodeNotFoundExceptionBatch;
62 import org.onap.cps.spi.model.DataNode;
63 import org.onap.cps.spi.model.DataNodeBuilder;
64 import org.onap.cps.spi.repository.AnchorRepository;
65 import org.onap.cps.spi.repository.DataspaceRepository;
66 import org.onap.cps.spi.repository.FragmentRepository;
67 import org.onap.cps.spi.utils.SessionManager;
68 import org.onap.cps.utils.JsonObjectMapper;
69 import org.springframework.dao.DataIntegrityViolationException;
70 import org.springframework.stereotype.Service;
74 @RequiredArgsConstructor
75 public class CpsDataPersistenceServiceImpl implements CpsDataPersistenceService {
77 private final DataspaceRepository dataspaceRepository;
78 private final AnchorRepository anchorRepository;
79 private final FragmentRepository fragmentRepository;
80 private final JsonObjectMapper jsonObjectMapper;
81 private final SessionManager sessionManager;
83 private static final String REG_EX_FOR_OPTIONAL_LIST_INDEX = "(\\[@.+?])?)";
86 public void addChildDataNodes(final String dataspaceName, final String anchorName,
87 final String parentNodeXpath, final Collection<DataNode> dataNodes) {
88 final AnchorEntity anchorEntity = getAnchorEntity(dataspaceName, anchorName);
89 addChildrenDataNodes(anchorEntity, parentNodeXpath, dataNodes);
93 public void addListElements(final String dataspaceName, final String anchorName, final String parentNodeXpath,
94 final Collection<DataNode> newListElements) {
95 final AnchorEntity anchorEntity = getAnchorEntity(dataspaceName, anchorName);
96 addChildrenDataNodes(anchorEntity, parentNodeXpath, newListElements);
100 public void addMultipleLists(final String dataspaceName, final String anchorName, final String parentNodeXpath,
101 final Collection<Collection<DataNode>> newLists) {
102 final AnchorEntity anchorEntity = getAnchorEntity(dataspaceName, anchorName);
103 final Collection<String> failedXpaths = new HashSet<>();
104 for (final Collection<DataNode> newList : newLists) {
106 addChildrenDataNodes(anchorEntity, parentNodeXpath, newList);
107 } catch (final AlreadyDefinedException alreadyDefinedException) {
108 failedXpaths.addAll(alreadyDefinedException.getAlreadyDefinedObjectNames());
111 if (!failedXpaths.isEmpty()) {
112 throw AlreadyDefinedException.forDataNodes(failedXpaths, anchorEntity.getName());
116 private void addNewChildDataNode(final AnchorEntity anchorEntity, final String parentNodeXpath,
117 final DataNode newChild) {
118 final FragmentEntity parentFragmentEntity = getFragmentEntity(anchorEntity, parentNodeXpath);
119 final FragmentEntity newChildAsFragmentEntity = convertToFragmentWithAllDescendants(anchorEntity, newChild);
120 newChildAsFragmentEntity.setParentId(parentFragmentEntity.getId());
122 fragmentRepository.save(newChildAsFragmentEntity);
123 } catch (final DataIntegrityViolationException e) {
124 throw AlreadyDefinedException.forDataNodes(Collections.singletonList(newChild.getXpath()),
125 anchorEntity.getName());
129 private void addChildrenDataNodes(final AnchorEntity anchorEntity, final String parentNodeXpath,
130 final Collection<DataNode> newChildren) {
131 final FragmentEntity parentFragmentEntity = getFragmentEntity(anchorEntity, parentNodeXpath);
132 final List<FragmentEntity> fragmentEntities = new ArrayList<>(newChildren.size());
134 for (final DataNode newChildAsDataNode : newChildren) {
135 final FragmentEntity newChildAsFragmentEntity =
136 convertToFragmentWithAllDescendants(anchorEntity, newChildAsDataNode);
137 newChildAsFragmentEntity.setParentId(parentFragmentEntity.getId());
138 fragmentEntities.add(newChildAsFragmentEntity);
140 fragmentRepository.saveAll(fragmentEntities);
141 } catch (final DataIntegrityViolationException e) {
142 log.warn("Exception occurred : {} , While saving : {} children, retrying using individual save operations",
143 e, fragmentEntities.size());
144 retrySavingEachChildIndividually(anchorEntity, parentNodeXpath, newChildren);
148 private void retrySavingEachChildIndividually(final AnchorEntity anchorEntity, final String parentNodeXpath,
149 final Collection<DataNode> newChildren) {
150 final Collection<String> failedXpaths = new HashSet<>();
151 for (final DataNode newChild : newChildren) {
153 addNewChildDataNode(anchorEntity, parentNodeXpath, newChild);
154 } catch (final AlreadyDefinedException e) {
155 failedXpaths.add(newChild.getXpath());
158 if (!failedXpaths.isEmpty()) {
159 throw AlreadyDefinedException.forDataNodes(failedXpaths, anchorEntity.getName());
164 public void storeDataNodes(final String dataspaceName, final String anchorName,
165 final Collection<DataNode> dataNodes) {
166 final AnchorEntity anchorEntity = getAnchorEntity(dataspaceName, anchorName);
167 final List<FragmentEntity> fragmentEntities = new ArrayList<>(dataNodes.size());
169 for (final DataNode dataNode: dataNodes) {
170 final FragmentEntity fragmentEntity = convertToFragmentWithAllDescendants(anchorEntity, dataNode);
171 fragmentEntities.add(fragmentEntity);
173 fragmentRepository.saveAll(fragmentEntities);
174 } catch (final DataIntegrityViolationException exception) {
175 log.warn("Exception occurred : {} , While saving : {} data nodes, Retrying saving data nodes individually",
176 exception, dataNodes.size());
177 storeDataNodesIndividually(anchorEntity, dataNodes);
181 private void storeDataNodesIndividually(final AnchorEntity anchorEntity, final Collection<DataNode> dataNodes) {
182 final Collection<String> failedXpaths = new HashSet<>();
183 for (final DataNode dataNode: dataNodes) {
185 final FragmentEntity fragmentEntity = convertToFragmentWithAllDescendants(anchorEntity, dataNode);
186 fragmentRepository.save(fragmentEntity);
187 } catch (final DataIntegrityViolationException e) {
188 failedXpaths.add(dataNode.getXpath());
191 if (!failedXpaths.isEmpty()) {
192 throw AlreadyDefinedException.forDataNodes(failedXpaths, anchorEntity.getName());
197 * Convert DataNode object into Fragment and places the result in the fragments placeholder. Performs same action
198 * for all DataNode children recursively.
200 * @param anchorEntity anchorEntity
201 * @param dataNodeToBeConverted dataNode
202 * @return a Fragment built from current DataNode
204 private FragmentEntity convertToFragmentWithAllDescendants(final AnchorEntity anchorEntity,
205 final DataNode dataNodeToBeConverted) {
206 final FragmentEntity parentFragment = toFragmentEntity(anchorEntity, dataNodeToBeConverted);
207 final Builder<FragmentEntity> childFragmentsImmutableSetBuilder = ImmutableSet.builder();
208 for (final DataNode childDataNode : dataNodeToBeConverted.getChildDataNodes()) {
209 final FragmentEntity childFragment = convertToFragmentWithAllDescendants(anchorEntity, childDataNode);
210 childFragmentsImmutableSetBuilder.add(childFragment);
212 parentFragment.setChildFragments(childFragmentsImmutableSetBuilder.build());
213 return parentFragment;
216 private FragmentEntity toFragmentEntity(final AnchorEntity anchorEntity, final DataNode dataNode) {
217 return FragmentEntity.builder()
218 .anchor(anchorEntity)
219 .xpath(dataNode.getXpath())
220 .attributes(jsonObjectMapper.asJsonString(dataNode.getLeaves()))
225 @Timed(value = "cps.data.persistence.service.datanode.get",
226 description = "Time taken to get a data node")
227 public Collection<DataNode> getDataNodes(final String dataspaceName, final String anchorName,
229 final FetchDescendantsOption fetchDescendantsOption) {
230 final String targetXpath = getNormalizedXpath(xpath);
231 final Collection<DataNode> dataNodes = getDataNodesForMultipleXpaths(dataspaceName, anchorName,
232 Collections.singletonList(targetXpath), fetchDescendantsOption);
233 if (dataNodes.isEmpty()) {
234 throw new DataNodeNotFoundException(dataspaceName, anchorName, xpath);
240 @Timed(value = "cps.data.persistence.service.datanode.batch.get",
241 description = "Time taken to get data nodes")
242 public Collection<DataNode> getDataNodesForMultipleXpaths(final String dataspaceName, final String anchorName,
243 final Collection<String> xpaths,
244 final FetchDescendantsOption fetchDescendantsOption) {
245 final AnchorEntity anchorEntity = getAnchorEntity(dataspaceName, anchorName);
246 Collection<FragmentEntity> fragmentEntities = getFragmentEntities(anchorEntity, xpaths);
247 fragmentEntities = fragmentRepository.prefetchDescendantsOfFragmentEntities(fetchDescendantsOption,
249 return createDataNodesFromFragmentEntities(fetchDescendantsOption, fragmentEntities);
252 private Collection<FragmentEntity> getFragmentEntities(final AnchorEntity anchorEntity,
253 final Collection<String> xpaths) {
254 final Collection<String> nonRootXpaths = new HashSet<>(xpaths);
255 final boolean haveRootXpath = nonRootXpaths.removeIf(CpsDataPersistenceServiceImpl::isRootXpath);
257 final Collection<String> normalizedXpaths = new HashSet<>(nonRootXpaths.size());
258 for (final String xpath : nonRootXpaths) {
260 normalizedXpaths.add(CpsPathUtil.getNormalizedXpath(xpath));
261 } catch (final PathParsingException e) {
262 log.warn("Error parsing xpath \"{}\": {}", xpath, e.getMessage());
266 normalizedXpaths.addAll(fragmentRepository.findAllXpathByAnchorAndParentIdIsNull(anchorEntity));
269 return fragmentRepository.findByAnchorAndXpathIn(anchorEntity, normalizedXpaths);
272 private FragmentEntity getFragmentEntity(final AnchorEntity anchorEntity, final String xpath) {
273 final FragmentEntity fragmentEntity;
274 if (isRootXpath(xpath)) {
275 fragmentEntity = fragmentRepository.findOneByAnchorId(anchorEntity.getId()).orElse(null);
277 fragmentEntity = fragmentRepository.getByAnchorAndXpath(anchorEntity, getNormalizedXpath(xpath));
279 if (fragmentEntity == null) {
280 throw new DataNodeNotFoundException(anchorEntity.getDataspace().getName(), anchorEntity.getName(), xpath);
282 return fragmentEntity;
286 @Timed(value = "cps.data.persistence.service.datanode.query",
287 description = "Time taken to query data nodes")
288 public List<DataNode> queryDataNodes(final String dataspaceName, final String anchorName, final String cpsPath,
289 final FetchDescendantsOption fetchDescendantsOption) {
290 final DataspaceEntity dataspaceEntity = dataspaceRepository.getByName(dataspaceName);
291 final AnchorEntity anchorEntity = anchorRepository.getByDataspaceAndName(dataspaceEntity, anchorName);
292 final CpsPathQuery cpsPathQuery;
294 cpsPathQuery = CpsPathUtil.getCpsPathQuery(cpsPath);
295 } catch (final PathParsingException e) {
296 throw new CpsPathException(e.getMessage());
299 Collection<FragmentEntity> fragmentEntities;
300 fragmentEntities = fragmentRepository.findByAnchorAndCpsPath(anchorEntity, cpsPathQuery);
301 if (cpsPathQuery.hasAncestorAxis()) {
302 final Collection<String> ancestorXpaths = processAncestorXpath(fragmentEntities, cpsPathQuery);
303 fragmentEntities = fragmentRepository.findByAnchorAndXpathIn(anchorEntity, ancestorXpaths);
305 fragmentEntities = fragmentRepository.prefetchDescendantsOfFragmentEntities(fetchDescendantsOption,
307 return createDataNodesFromFragmentEntities(fetchDescendantsOption, fragmentEntities);
311 @Timed(value = "cps.data.persistence.service.datanode.query.anchors",
312 description = "Time taken to query data nodes across all anchors or list of anchors")
313 public List<DataNode> queryDataNodesAcrossAnchors(final String dataspaceName, final String cpsPath,
314 final FetchDescendantsOption fetchDescendantsOption,
315 final PaginationOption paginationOption) {
316 final DataspaceEntity dataspaceEntity = dataspaceRepository.getByName(dataspaceName);
317 final CpsPathQuery cpsPathQuery;
319 cpsPathQuery = CpsPathUtil.getCpsPathQuery(cpsPath);
320 } catch (final PathParsingException e) {
321 throw new CpsPathException(e.getMessage());
324 final List<Long> anchorIds;
325 if (paginationOption == NO_PAGINATION) {
326 anchorIds = Collections.EMPTY_LIST;
328 anchorIds = getAnchorIdsForPagination(dataspaceEntity, cpsPathQuery, paginationOption);
329 if (anchorIds.isEmpty()) {
330 return Collections.emptyList();
333 Collection<FragmentEntity> fragmentEntities =
334 fragmentRepository.findByDataspaceAndCpsPath(dataspaceEntity, cpsPathQuery, anchorIds);
336 if (cpsPathQuery.hasAncestorAxis()) {
337 final Collection<String> ancestorXpaths = processAncestorXpath(fragmentEntities, cpsPathQuery);
338 if (anchorIds.isEmpty()) {
339 fragmentEntities = fragmentRepository.findByDataspaceAndXpathIn(dataspaceEntity, ancestorXpaths);
341 fragmentEntities = fragmentRepository.findByAnchorIdsAndXpathIn(
342 anchorIds.toArray(new Long[0]), ancestorXpaths.toArray(new String[0]));
346 fragmentEntities = fragmentRepository.prefetchDescendantsOfFragmentEntities(fetchDescendantsOption,
348 return createDataNodesFromFragmentEntities(fetchDescendantsOption, fragmentEntities);
351 private List<Long> getAnchorIdsForPagination(final DataspaceEntity dataspaceEntity, final CpsPathQuery cpsPathQuery,
352 final PaginationOption paginationOption) {
353 return fragmentRepository.findAnchorIdsForPagination(dataspaceEntity, cpsPathQuery, paginationOption);
356 private List<DataNode> createDataNodesFromFragmentEntities(final FetchDescendantsOption fetchDescendantsOption,
357 final Collection<FragmentEntity> fragmentEntities) {
358 final List<DataNode> dataNodes = new ArrayList<>(fragmentEntities.size());
359 for (final FragmentEntity fragmentEntity : fragmentEntities) {
360 dataNodes.add(toDataNode(fragmentEntity, fetchDescendantsOption));
362 return Collections.unmodifiableList(dataNodes);
365 private static String getNormalizedXpath(final String xpathSource) {
366 if (isRootXpath(xpathSource)) {
370 return CpsPathUtil.getNormalizedXpath(xpathSource);
371 } catch (final PathParsingException e) {
372 throw new CpsPathException(e.getMessage());
377 public String startSession() {
378 return sessionManager.startSession();
382 public void closeSession(final String sessionId) {
383 sessionManager.closeSession(sessionId, SessionManager.WITH_COMMIT);
387 public void lockAnchor(final String sessionId, final String dataspaceName,
388 final String anchorName, final Long timeoutInMilliseconds) {
389 sessionManager.lockAnchor(sessionId, dataspaceName, anchorName, timeoutInMilliseconds);
393 public Integer countAnchorsForDataspaceAndCpsPath(final String dataspaceName, final String cpsPath) {
394 final DataspaceEntity dataspaceEntity = dataspaceRepository.getByName(dataspaceName);
395 final CpsPathQuery cpsPathQuery;
397 cpsPathQuery = CpsPathUtil.getCpsPathQuery(cpsPath);
398 } catch (final PathParsingException e) {
399 throw new CpsPathException(e.getMessage());
401 final List<Long> anchorIdList = getAnchorIdsForPagination(dataspaceEntity, cpsPathQuery, NO_PAGINATION);
402 return anchorIdList.size();
405 private static Set<String> processAncestorXpath(final Collection<FragmentEntity> fragmentEntities,
406 final CpsPathQuery cpsPathQuery) {
407 final Set<String> ancestorXpath = new HashSet<>();
408 final Pattern pattern =
409 Pattern.compile("(.*/" + Pattern.quote(cpsPathQuery.getAncestorSchemaNodeIdentifier())
410 + REG_EX_FOR_OPTIONAL_LIST_INDEX + "/.*");
411 for (final FragmentEntity fragmentEntity : fragmentEntities) {
412 final Matcher matcher = pattern.matcher(fragmentEntity.getXpath());
413 if (matcher.matches()) {
414 ancestorXpath.add(matcher.group(1));
417 return ancestorXpath;
420 private DataNode toDataNode(final FragmentEntity fragmentEntity,
421 final FetchDescendantsOption fetchDescendantsOption) {
422 final List<DataNode> childDataNodes = getChildDataNodes(fragmentEntity, fetchDescendantsOption);
423 Map<String, Serializable> leaves = new HashMap<>();
424 if (fragmentEntity.getAttributes() != null) {
425 leaves = jsonObjectMapper.convertJsonString(fragmentEntity.getAttributes(), Map.class);
427 return new DataNodeBuilder()
428 .withXpath(fragmentEntity.getXpath())
430 .withDataspace(fragmentEntity.getAnchor().getDataspace().getName())
431 .withAnchor(fragmentEntity.getAnchor().getName())
432 .withChildDataNodes(childDataNodes).build();
435 private List<DataNode> getChildDataNodes(final FragmentEntity fragmentEntity,
436 final FetchDescendantsOption fetchDescendantsOption) {
437 if (fetchDescendantsOption.hasNext()) {
438 return fragmentEntity.getChildFragments().stream()
439 .map(childFragmentEntity -> toDataNode(childFragmentEntity, fetchDescendantsOption.next()))
440 .collect(Collectors.toList());
442 return Collections.emptyList();
446 public void batchUpdateDataLeaves(final String dataspaceName, final String anchorName,
447 final Map<String, Map<String, Serializable>> updatedLeavesPerXPath) {
448 final AnchorEntity anchorEntity = getAnchorEntity(dataspaceName, anchorName);
450 final Collection<String> xpathsOfUpdatedLeaves = updatedLeavesPerXPath.keySet();
451 final Collection<FragmentEntity> fragmentEntities = getFragmentEntities(anchorEntity, xpathsOfUpdatedLeaves);
453 for (final FragmentEntity fragmentEntity : fragmentEntities) {
454 final Map<String, Serializable> updatedLeaves = updatedLeavesPerXPath.get(fragmentEntity.getXpath());
455 final String mergedLeaves = mergeLeaves(updatedLeaves, fragmentEntity.getAttributes());
456 fragmentEntity.setAttributes(mergedLeaves);
460 fragmentRepository.saveAll(fragmentEntities);
461 } catch (final StaleStateException staleStateException) {
462 retryUpdateDataNodesIndividually(anchorEntity, fragmentEntities);
467 public void updateDataNodesAndDescendants(final String dataspaceName, final String anchorName,
468 final Collection<DataNode> updatedDataNodes) {
469 final AnchorEntity anchorEntity = getAnchorEntity(dataspaceName, anchorName);
471 final Map<String, DataNode> xpathToUpdatedDataNode = updatedDataNodes.stream()
472 .collect(Collectors.toMap(DataNode::getXpath, dataNode -> dataNode));
474 final Collection<String> xpaths = xpathToUpdatedDataNode.keySet();
475 Collection<FragmentEntity> existingFragmentEntities = getFragmentEntities(anchorEntity, xpaths);
476 existingFragmentEntities = fragmentRepository.prefetchDescendantsOfFragmentEntities(
477 FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS, existingFragmentEntities);
479 for (final FragmentEntity existingFragmentEntity : existingFragmentEntities) {
480 final DataNode updatedDataNode = xpathToUpdatedDataNode.get(existingFragmentEntity.getXpath());
481 updateFragmentEntityAndDescendantsWithDataNode(existingFragmentEntity, updatedDataNode);
485 fragmentRepository.saveAll(existingFragmentEntities);
486 } catch (final StaleStateException staleStateException) {
487 retryUpdateDataNodesIndividually(anchorEntity, existingFragmentEntities);
491 private void retryUpdateDataNodesIndividually(final AnchorEntity anchorEntity,
492 final Collection<FragmentEntity> fragmentEntities) {
493 final Collection<String> failedXpaths = new HashSet<>();
494 for (final FragmentEntity dataNodeFragment : fragmentEntities) {
496 fragmentRepository.save(dataNodeFragment);
497 } catch (final StaleStateException e) {
498 failedXpaths.add(dataNodeFragment.getXpath());
501 if (!failedXpaths.isEmpty()) {
502 final String failedXpathsConcatenated = String.join(",", failedXpaths);
503 throw new ConcurrencyException("Concurrent Transactions", String.format(
504 "DataNodes : %s in Dataspace :'%s' with Anchor : '%s' are updated by another transaction.",
505 failedXpathsConcatenated, anchorEntity.getDataspace().getName(), anchorEntity.getName()));
509 private void updateFragmentEntityAndDescendantsWithDataNode(final FragmentEntity existingFragmentEntity,
510 final DataNode newDataNode) {
511 existingFragmentEntity.setAttributes(jsonObjectMapper.asJsonString(newDataNode.getLeaves()));
513 final Map<String, FragmentEntity> existingChildrenByXpath = existingFragmentEntity.getChildFragments().stream()
514 .collect(Collectors.toMap(FragmentEntity::getXpath, childFragmentEntity -> childFragmentEntity));
516 final Collection<FragmentEntity> updatedChildFragments = new HashSet<>();
517 for (final DataNode newDataNodeChild : newDataNode.getChildDataNodes()) {
518 final FragmentEntity childFragment;
519 if (isNewDataNode(newDataNodeChild, existingChildrenByXpath)) {
520 childFragment = convertToFragmentWithAllDescendants(existingFragmentEntity.getAnchor(),
523 childFragment = existingChildrenByXpath.get(newDataNodeChild.getXpath());
524 updateFragmentEntityAndDescendantsWithDataNode(childFragment, newDataNodeChild);
526 updatedChildFragments.add(childFragment);
529 existingFragmentEntity.getChildFragments().clear();
530 existingFragmentEntity.getChildFragments().addAll(updatedChildFragments);
535 public void replaceListContent(final String dataspaceName, final String anchorName, final String parentNodeXpath,
536 final Collection<DataNode> newListElements) {
537 final AnchorEntity anchorEntity = getAnchorEntity(dataspaceName, anchorName);
538 final FragmentEntity parentEntity = getFragmentEntity(anchorEntity, parentNodeXpath);
539 final String listElementXpathPrefix = getListElementXpathPrefix(newListElements);
540 final Map<String, FragmentEntity> existingListElementFragmentEntitiesByXPath =
541 extractListElementFragmentEntitiesByXPath(parentEntity.getChildFragments(), listElementXpathPrefix);
542 parentEntity.getChildFragments().removeAll(existingListElementFragmentEntitiesByXPath.values());
543 final Set<FragmentEntity> updatedChildFragmentEntities = new HashSet<>();
544 for (final DataNode newListElement : newListElements) {
545 final FragmentEntity existingListElementEntity =
546 existingListElementFragmentEntitiesByXPath.get(newListElement.getXpath());
547 final FragmentEntity entityToBeAdded = getFragmentForReplacement(parentEntity, newListElement,
548 existingListElementEntity);
549 updatedChildFragmentEntities.add(entityToBeAdded);
551 parentEntity.getChildFragments().addAll(updatedChildFragmentEntities);
552 fragmentRepository.save(parentEntity);
557 public void deleteDataNodes(final String dataspaceName, final String anchorName) {
558 final DataspaceEntity dataspaceEntity = dataspaceRepository.getByName(dataspaceName);
559 anchorRepository.findByDataspaceAndName(dataspaceEntity, anchorName)
560 .ifPresent(anchorEntity -> fragmentRepository.deleteByAnchorIn(Collections.singletonList(anchorEntity)));
565 public void deleteDataNodes(final String dataspaceName, final Collection<String> anchorNames) {
566 final DataspaceEntity dataspaceEntity = dataspaceRepository.getByName(dataspaceName);
567 final Collection<AnchorEntity> anchorEntities =
568 anchorRepository.findAllByDataspaceAndNameIn(dataspaceEntity, anchorNames);
569 fragmentRepository.deleteByAnchorIn(anchorEntities);
574 public void deleteDataNodes(final String dataspaceName, final String anchorName,
575 final Collection<String> xpathsToDelete) {
576 deleteDataNodes(dataspaceName, anchorName, xpathsToDelete, false);
579 private void deleteDataNodes(final String dataspaceName, final String anchorName,
580 final Collection<String> xpathsToDelete, final boolean onlySupportListDeletion) {
581 final boolean haveRootXpath = xpathsToDelete.stream().anyMatch(CpsDataPersistenceServiceImpl::isRootXpath);
583 deleteDataNodes(dataspaceName, anchorName);
587 final AnchorEntity anchorEntity = getAnchorEntity(dataspaceName, anchorName);
589 final Collection<String> deleteChecklist = new HashSet<>(xpathsToDelete.size());
590 for (final String xpath : xpathsToDelete) {
592 deleteChecklist.add(CpsPathUtil.getNormalizedXpath(xpath));
593 } catch (final PathParsingException e) {
594 log.warn("Error parsing xpath \"{}\": {}", xpath, e.getMessage());
598 final Collection<String> xpathsToExistingContainers =
599 fragmentRepository.findAllXpathByAnchorAndXpathIn(anchorEntity, deleteChecklist);
600 if (onlySupportListDeletion) {
601 final Collection<String> xpathsToExistingListElements = xpathsToExistingContainers.stream()
602 .filter(CpsPathUtil::isPathToListElement).collect(Collectors.toList());
603 deleteChecklist.removeAll(xpathsToExistingListElements);
605 deleteChecklist.removeAll(xpathsToExistingContainers);
608 final Collection<String> xpathsToExistingLists = deleteChecklist.stream()
609 .filter(xpath -> fragmentRepository.existsByAnchorAndXpathStartsWith(anchorEntity, xpath + "["))
610 .collect(Collectors.toList());
611 deleteChecklist.removeAll(xpathsToExistingLists);
613 if (!deleteChecklist.isEmpty()) {
614 throw new DataNodeNotFoundExceptionBatch(dataspaceName, anchorName, deleteChecklist);
617 fragmentRepository.deleteByAnchorIdAndXpaths(anchorEntity.getId(), xpathsToExistingContainers);
618 fragmentRepository.deleteListsByAnchorIdAndXpaths(anchorEntity.getId(), xpathsToExistingLists);
623 public void deleteListDataNode(final String dataspaceName, final String anchorName,
624 final String targetXpath) {
625 deleteDataNode(dataspaceName, anchorName, targetXpath, true);
630 public void deleteDataNode(final String dataspaceName, final String anchorName, final String targetXpath) {
631 deleteDataNode(dataspaceName, anchorName, targetXpath, false);
634 private void deleteDataNode(final String dataspaceName, final String anchorName, final String targetXpath,
635 final boolean onlySupportListNodeDeletion) {
636 final String normalizedXpath = getNormalizedXpath(targetXpath);
638 deleteDataNodes(dataspaceName, anchorName, Collections.singletonList(normalizedXpath),
639 onlySupportListNodeDeletion);
640 } catch (final DataNodeNotFoundExceptionBatch dataNodeNotFoundExceptionBatch) {
641 throw new DataNodeNotFoundException(dataspaceName, anchorName, targetXpath);
645 private static String getListElementXpathPrefix(final Collection<DataNode> newListElements) {
646 if (newListElements.isEmpty()) {
647 throw new CpsAdminException("Invalid list replacement",
648 "Cannot replace list elements with empty collection");
650 final String firstChildNodeXpath = newListElements.iterator().next().getXpath();
651 return firstChildNodeXpath.substring(0, firstChildNodeXpath.lastIndexOf('[') + 1);
654 private FragmentEntity getFragmentForReplacement(final FragmentEntity parentEntity,
655 final DataNode newListElement,
656 final FragmentEntity existingListElementEntity) {
657 if (existingListElementEntity == null) {
658 return convertToFragmentWithAllDescendants(parentEntity.getAnchor(), newListElement);
660 if (newListElement.getChildDataNodes().isEmpty()) {
661 copyAttributesFromNewListElement(existingListElementEntity, newListElement);
662 existingListElementEntity.getChildFragments().clear();
664 updateFragmentEntityAndDescendantsWithDataNode(existingListElementEntity, newListElement);
666 return existingListElementEntity;
669 private static boolean isNewDataNode(final DataNode replacementDataNode,
670 final Map<String, FragmentEntity> existingListElementsByXpath) {
671 return !existingListElementsByXpath.containsKey(replacementDataNode.getXpath());
674 private void copyAttributesFromNewListElement(final FragmentEntity existingListElementEntity,
675 final DataNode newListElement) {
676 final FragmentEntity replacementFragmentEntity =
677 FragmentEntity.builder().attributes(jsonObjectMapper.asJsonString(
678 newListElement.getLeaves())).build();
679 existingListElementEntity.setAttributes(replacementFragmentEntity.getAttributes());
682 private static Map<String, FragmentEntity> extractListElementFragmentEntitiesByXPath(
683 final Set<FragmentEntity> childEntities, final String listElementXpathPrefix) {
684 return childEntities.stream()
685 .filter(fragmentEntity -> fragmentEntity.getXpath().startsWith(listElementXpathPrefix))
686 .collect(Collectors.toMap(FragmentEntity::getXpath, fragmentEntity -> fragmentEntity));
689 private static boolean isRootXpath(final String xpath) {
690 return "/".equals(xpath) || "".equals(xpath);
693 private String mergeLeaves(final Map<String, Serializable> updateLeaves, final String currentLeavesAsString) {
694 Map<String, Serializable> currentLeavesAsMap = new HashMap<>();
695 if (currentLeavesAsString != null) {
696 currentLeavesAsMap = jsonObjectMapper.convertJsonString(currentLeavesAsString, Map.class);
697 currentLeavesAsMap.putAll(updateLeaves);
700 if (currentLeavesAsMap.isEmpty()) {
703 return jsonObjectMapper.asJsonString(currentLeavesAsMap);
706 private AnchorEntity getAnchorEntity(final String dataspaceName, final String anchorName) {
707 final DataspaceEntity dataspaceEntity = dataspaceRepository.getByName(dataspaceName);
708 return anchorRepository.getByDataspaceAndName(dataspaceEntity, anchorName);