2 * Copyright (c) 2016, 2017 Ericsson India Global Services Pvt Ltd. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.netvirt.elan.l2gw.ha.commands;
10 import static org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType.OPERATIONAL;
11 import static org.opendaylight.netvirt.elan.l2gw.ha.HwvtepHAUtil.isEmptyList;
13 import java.io.Serializable;
14 import java.util.ArrayList;
15 import java.util.Collections;
16 import java.util.Comparator;
17 import java.util.List;
18 import java.util.Objects;
19 import java.util.stream.Collectors;
20 import org.eclipse.jdt.annotation.NonNull;
21 import org.eclipse.jdt.annotation.Nullable;
22 import org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction;
23 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
24 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
25 import org.opendaylight.netvirt.elan.l2gw.ha.HwvtepHAUtil;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.physical.locator.set.attributes.LocatorSet;
27 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TpId;
28 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
29 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPoint;
30 import org.opendaylight.yangtools.concepts.Builder;
31 import org.opendaylight.yangtools.yang.binding.DataObject;
32 import org.opendaylight.yangtools.yang.binding.Identifier;
33 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
34 import org.slf4j.Logger;
35 import org.slf4j.LoggerFactory;
40 public abstract class MergeCommand<T extends DataObject, Y extends Builder, Z extends DataObject>
41 extends BaseCommand<T> implements IMergeCommand<T, Y, Z> {
43 private static final Logger LOG = LoggerFactory.getLogger(MergeCommand.class);
45 public List<T> transformOpData(List<T> existingData, List<T> src, InstanceIdentifier<Node> nodePath) {
46 if (isEmptyList(src)) {
47 return new ArrayList<>();
49 List<T> added = diffOf(src, existingData);//do not add existing data again
50 return transform(nodePath, added);
53 public List<T> transformConfigData(List<T> updatedSrc, InstanceIdentifier<Node> nodePath) {
54 if (isEmptyList(updatedSrc)) {
55 return new ArrayList<>();//what difference returning null makes ?
57 return transform(nodePath, updatedSrc);
61 public List<T> diffByKey(List<T> updated, final List<T> original) {
62 if (updated == null) {
63 return new ArrayList<>();
65 if (original == null) {
66 return new ArrayList<>(updated);
69 List<T> result = new ArrayList<>();
70 for (T ele : updated) {
71 boolean present = false;
72 for (T orig : original) {
73 if (Objects.equals(getKey(ele), getKey(orig))) {
85 //TODO validate the perf of the following against direct setting of the data in dst node
86 public void transformUpdate(List<T> existing,
89 InstanceIdentifier<Node> nodePath,
90 LogicalDatastoreType datastoreType,
91 ReadWriteTransaction tx) {
93 if (updated == null) {
94 updated = new ArrayList<>();
97 orig = new ArrayList<>();
99 List<T> added = new ArrayList<>(updated);
101 added.removeAll(orig);
102 added = diffOf(added, existing);//do not add the existing data again
103 if (added.size() > 0) {
104 for (T addedItem : added) {
105 InstanceIdentifier<T> transformedId = generateId(nodePath, addedItem);
106 T transformedItem = transform(nodePath, addedItem);
107 String nodeId = transformedId.firstKeyOf(Node.class).getNodeId().getValue();
108 LOG.trace("adding {} {} {}", getDescription(), nodeId, getKey(transformedItem));
109 tx.put(datastoreType, transformedId, transformedItem, WriteTransaction.CREATE_MISSING_PARENTS);
112 List<T> removed = new ArrayList<>(orig);
113 removed = diffByKey(removed, updated);
115 List<T> removedTransformed = new ArrayList<>();
116 for (T ele : removed) {
117 removedTransformed.add(transform(nodePath, ele));
120 List<T> skip = diffByKey(removedTransformed, existing);//skip the ones which are not present in cfg ds
121 removedTransformed = diffByKey(removedTransformed, skip);
122 if (removedTransformed.size() > 0) {
123 for (T removedItem : removedTransformed) {
124 InstanceIdentifier<T> transformedId = generateId(nodePath, removedItem);
125 String nodeId = transformedId.firstKeyOf(Node.class).getNodeId().getValue();
126 LOG.trace("removing {} {} {}",getDescription(), nodeId, getKey(removedItem));
127 tx.delete(datastoreType, transformedId);
132 public List<T> transform(InstanceIdentifier<Node> nodePath, List<T> list) {
134 return list.stream().map(t -> transform(nodePath, t)).collect(Collectors.toList());
136 return new ArrayList<>();
139 public abstract T transform(InstanceIdentifier<Node> nodePath, T objT);
141 List<T> getDataSafe(Z existingData) {
142 if (existingData == null) {
143 return Collections.EMPTY_LIST;
145 List<T> result = getData(existingData);
146 if (result == null) {
147 return Collections.EMPTY_LIST;
153 public void mergeOperationalData(Y dst,
156 InstanceIdentifier<Node> nodePath) {
157 List<T> origDstData = getDataSafe(existingData);
158 List<T> srcData = getDataSafe(src);
159 List<T> data = transformOpData(origDstData, srcData, nodePath);
161 if (!isEmptyList(data)) {
162 String nodeId = nodePath.firstKeyOf(Node.class).getNodeId().getValue();
163 LOG.trace("merging op {} to {} size {}",getDescription(), nodeId, data.size());
168 public void mergeConfigData(Y dst,
170 InstanceIdentifier<Node> nodePath) {
171 List<T> data = getDataSafe(src);
172 List<T> transformed = transformConfigData(data, nodePath);
173 setData(dst, transformed);
174 if (!isEmptyList(data)) {
175 String nodeId = nodePath.firstKeyOf(Node.class).getNodeId().getValue();
176 LOG.trace("copying config {} to {} size {}",getDescription(), nodeId, data.size());
181 public void mergeOpUpdate(Z origDst,
184 InstanceIdentifier<Node> nodePath,
185 ReadWriteTransaction tx) {
186 List<T> updatedData = getData(updatedSrc);
187 List<T> origData = getData(origSrc);
188 List<T> existingData = getData(origDst);
189 transformUpdate(existingData, updatedData, origData, nodePath, OPERATIONAL, tx);
192 boolean areSameSize(@Nullable List objA, @Nullable List objB) {
193 if (HwvtepHAUtil.isEmptyList(objA) && HwvtepHAUtil.isEmptyList(objB)) {
196 if (!HwvtepHAUtil.isEmptyList(objA) && !HwvtepHAUtil.isEmptyList(objB)) {
197 return objA.size() == objB.size();
203 static LocatorSetComparator locatorSetComparator = new LocatorSetComparator();
205 static class LocatorSetComparator implements Comparator<LocatorSet>, Serializable {
206 private static final long serialVersionUID = 1L;
209 public int compare(final LocatorSet updatedLocatorSet, final LocatorSet origLocatorSet) {
210 InstanceIdentifier<?> updatedLocatorRefIndentifier = updatedLocatorSet.getLocatorRef().getValue();
211 TpId updatedLocatorSetTpId = updatedLocatorRefIndentifier.firstKeyOf(TerminationPoint.class).getTpId();
213 InstanceIdentifier<?> origLocatorRefIndentifier = origLocatorSet.getLocatorRef().getValue();
214 TpId origLocatorSetTpId = origLocatorRefIndentifier.firstKeyOf(TerminationPoint.class).getTpId();
216 if (updatedLocatorSetTpId.equals(origLocatorSetTpId)) {
224 public abstract List<T> getData(Z node);
226 public abstract void setData(Y builder, List<T> data);
228 public abstract InstanceIdentifier<T> generateId(InstanceIdentifier<Node> id, T node);
230 public abstract Identifier getKey(T data);
232 public abstract String getDescription();
234 public abstract T withoutUuid(T data);