cps-service/src/main/java/org/onap/cps/api/CpsDeltaService.java

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 2023 TechMahindra Ltd.
   4  *  ================================================================================
   5  *  Licensed under the Apache License, Version 2.0 (the "License");
   6  *  you may not use this file except in compliance with the License.
   7  *  You may obtain a copy of the License at
   8  *
   9  *        http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  *  Unless required by applicable law or agreed to in writing, software
  12  *  distributed under the License is distributed on an "AS IS" BASIS,
  13  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  *  See the License for the specific language governing permissions and
  15  *  limitations under the License.
  16  *
  17  *  SPDX-License-Identifier: Apache-2.0
  18  *  ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.cps.api;
  22
  23 import java.util.Collection;
  24 import java.util.List;
  25 import org.onap.cps.spi.model.DataNode;
  26 import org.onap.cps.spi.model.DeltaReport;
  27
  28 public interface CpsDeltaService {
  29
  30     /**
  31      * Retrieves delta between source data nodes and target data nodes. Source data nodes contain the data which acts as
  32      * the point of reference for delta report, whereas target data nodes contain the data being compared against
  33      * source data node. List of {@link DeltaReport}. Each Delta Report contains information such as action, xpath,
  34      * source-payload and target-payload.
  35      *
  36      * @param sourceDataNodes  collection of {@link DataNode} as source/reference for delta generation
  37      * @param targetDataNodes  collection of {@link DataNode} as target data for delta generation
  38      * @return                 list of {@link DeltaReport} containing delta information
  39      */
  40     List<DeltaReport> getDeltaReports(Collection<DataNode> sourceDataNodes,
  41                                       Collection<DataNode> targetDataNodes);
  42 }