Fix so that operational store correctly removes bridge-other-configs
[ovsdb.git] / southbound / southbound-impl / src / main / java / org / opendaylight / ovsdb / southbound / transactions / md / OvsdbBridgeUpdateCommand.java
1 package org.opendaylight.ovsdb.southbound.transactions.md;
2
3 import java.util.ArrayList;
4 import java.util.List;
5 import java.util.Map;
6 import java.util.Map.Entry;
7 import java.util.Set;
8
9 import org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction;
10 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
11 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
12 import org.opendaylight.ovsdb.lib.message.TableUpdates;
13 import org.opendaylight.ovsdb.lib.notation.UUID;
14 import org.opendaylight.ovsdb.lib.schema.DatabaseSchema;
15 import org.opendaylight.ovsdb.lib.schema.typed.TyperUtils;
16 import org.opendaylight.ovsdb.schema.openvswitch.Bridge;
17 import org.opendaylight.ovsdb.southbound.OvsdbClientKey;
18 import org.opendaylight.ovsdb.southbound.SouthboundConstants;
19 import org.opendaylight.ovsdb.southbound.SouthboundMapper;
20 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
21 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.DatapathId;
22 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeAugmentation;
23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeAugmentationBuilder;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeName;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeProtocolBase;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeRef;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbNodeAugmentation;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbNodeAugmentationBuilder;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbNodeRef;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.BridgeExternalIds;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.BridgeExternalIdsBuilder;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.BridgeExternalIdsKey;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.BridgeOtherConfigs;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.BridgeOtherConfigsBuilder;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.BridgeOtherConfigsKey;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.ProtocolEntry;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.ProtocolEntryKey;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.ManagedNodeEntry;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.ManagedNodeEntryBuilder;
40 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
41 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
42 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeBuilder;
43 import org.opendaylight.yangtools.yang.binding.DataObject;
44 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
45 import org.slf4j.Logger;
46 import org.slf4j.LoggerFactory;
47
48 import com.google.common.base.Optional;
49 import com.google.common.base.Preconditions;
50
51 public class OvsdbBridgeUpdateCommand extends AbstractTransactionCommand {
52     private static final Logger LOG = LoggerFactory.getLogger(OvsdbBridgeUpdateCommand.class);
53     private Map<UUID,Bridge> updatedBridgeRows;
54     private Map<UUID, Bridge> oldBridgeRows;
55
56     public OvsdbBridgeUpdateCommand(OvsdbClientKey key, TableUpdates updates,
57             DatabaseSchema dbSchema) {
58         super(key,updates,dbSchema);
59         updatedBridgeRows = TyperUtils.extractRowsUpdated(Bridge.class, getUpdates(), getDbSchema());
60         oldBridgeRows = TyperUtils.extractRowsOld(Bridge.class, getUpdates(), getDbSchema());
61     }
62
63     @Override
64     public void execute(ReadWriteTransaction transaction) {
65         for (Entry<UUID, Bridge> entry : updatedBridgeRows.entrySet()) {
66             updateBridge(transaction, entry.getValue());
67         }
68     }
69
70     private void updateBridge(ReadWriteTransaction transaction,
71             Bridge bridge) {
72         final InstanceIdentifier<Node> connectionIId = getKey().toInstanceIndentifier();
73         Optional<Node> connection = readNode(transaction, getKey().toInstanceIndentifier());
74         if (connection.isPresent()) {
75             LOG.debug("Connection {} is present",connection);
76
77             // Update the connection node to let it know it manages this bridge
78             Node connectionNode = buildConnectionNode(bridge);
79             transaction.merge(LogicalDatastoreType.OPERATIONAL, connectionIId, connectionNode);
80
81             // Update the bridge node with whatever data we are getting
82             InstanceIdentifier<Node> bridgeIid = SouthboundMapper.createInstanceIdentifier(getKey(),bridge);
83             Node bridgeNode = buildBridgeNode(bridge);
84             transaction.merge(LogicalDatastoreType.OPERATIONAL, bridgeIid, bridgeNode);
85             deleteEntries(transaction, protocolEntriesToRemove(bridgeIid,bridge));
86             deleteEntries(transaction, externalIdsToRemove(bridgeIid,bridge));
87             deleteEntries(transaction, bridgeOtherConfigsToRemove(bridgeIid,bridge));
88         }
89     }
90
91     private <T extends DataObject> void deleteEntries(ReadWriteTransaction transaction,
92             List<InstanceIdentifier<T>> entryIids) {
93         for (InstanceIdentifier<T> entryIid: entryIids) {
94             transaction.delete(LogicalDatastoreType.OPERATIONAL, entryIid);
95         }
96     }
97
98     private List<InstanceIdentifier<BridgeOtherConfigs>> bridgeOtherConfigsToRemove(
99             InstanceIdentifier<Node> bridgeIid, Bridge bridge) {
100         Preconditions.checkNotNull(bridgeIid);
101         Preconditions.checkNotNull(bridge);
102         List<InstanceIdentifier<BridgeOtherConfigs>> result =
103                 new ArrayList<InstanceIdentifier<BridgeOtherConfigs>>();
104
105         Bridge oldBridge = oldBridgeRows.get(bridge.getUuid());
106
107         if (oldBridge != null && oldBridge.getOtherConfigColumn() != null) {
108             for (Entry<String, String> otherConfig:
109                 oldBridge.getOtherConfigColumn().getData().entrySet()) {
110                 if (bridge.getOtherConfigColumn() == null
111                         || !bridge.getOtherConfigColumn().getData().containsKey(otherConfig.getKey())) {
112                     InstanceIdentifier<BridgeOtherConfigs> iid = bridgeIid
113                             .augmentation(OvsdbBridgeAugmentation.class)
114                             .child(BridgeOtherConfigs.class,
115                                     new BridgeOtherConfigsKey(otherConfig.getKey()));
116                     result.add(iid);
117                 }
118             }
119         }
120         return result;
121     }
122
123     private List<InstanceIdentifier<BridgeExternalIds>> externalIdsToRemove(
124             InstanceIdentifier<Node> bridgeIid, Bridge bridge) {
125         Preconditions.checkNotNull(bridgeIid);
126         Preconditions.checkNotNull(bridge);
127         List<InstanceIdentifier<BridgeExternalIds>> result =
128                 new ArrayList<InstanceIdentifier<BridgeExternalIds>>();
129
130         Bridge oldBridge = oldBridgeRows.get(bridge.getUuid());
131
132         if (oldBridge != null && oldBridge.getExternalIdsColumn() != null) {
133             for (Entry<String, String> externalId:
134                 oldBridge.getExternalIdsColumn().getData().entrySet()) {
135                 if (bridge.getExternalIdsColumn() == null
136                         || !bridge.getExternalIdsColumn().getData().containsKey(externalId.getKey())) {
137                     InstanceIdentifier<BridgeExternalIds> iid = bridgeIid
138                             .augmentation(OvsdbBridgeAugmentation.class)
139                             .child(BridgeExternalIds.class,
140                                     new BridgeExternalIdsKey(externalId.getKey()));
141                     result.add(iid);
142                 }
143             }
144         }
145         return result;
146     }
147
148     private List<InstanceIdentifier<ProtocolEntry>> protocolEntriesToRemove(
149             InstanceIdentifier<Node> bridgeIid, Bridge bridge) {
150         Preconditions.checkNotNull(bridgeIid);
151         Preconditions.checkNotNull(bridge);
152         List<InstanceIdentifier<ProtocolEntry>> result =
153                 new ArrayList<InstanceIdentifier<ProtocolEntry>>();
154         Bridge oldBridge = oldBridgeRows.get(bridge.getUuid());
155
156         if (oldBridge != null && oldBridge.getProtocolsColumn() != null) {
157             for (String protocol: oldBridge.getProtocolsColumn().getData()) {
158                 if (bridge.getProtocolsColumn() == null
159                         || !bridge.getProtocolsColumn().getData().contains(protocol)) {
160                     Class<? extends OvsdbBridgeProtocolBase> proto =
161                             SouthboundConstants.OVSDB_PROTOCOL_MAP.inverse().get(protocol);
162                     InstanceIdentifier<ProtocolEntry> iid = bridgeIid
163                             .augmentation(OvsdbBridgeAugmentation.class)
164                             .child(ProtocolEntry.class,
165                                     new ProtocolEntryKey(proto));
166                     result.add(iid);
167                 }
168             }
169         }
170         return result;
171     }
172
173     private Optional<Node> readNode(ReadWriteTransaction transaction,
174             final InstanceIdentifier<Node> connectionIid) {
175         Optional<Node> node = Optional.absent();
176         try {
177             node = transaction.read(LogicalDatastoreType.OPERATIONAL, connectionIid).checkedGet();
178         } catch (final ReadFailedException e) {
179             LOG.debug("Read Operational/DS for Node fail! {}", connectionIid, e);
180         }
181         return node;
182     }
183
184     private Node buildConnectionNode(
185             Bridge bridge) {
186         //Update node with managed node reference
187         NodeBuilder connectionNode = new NodeBuilder();
188         connectionNode.setNodeId(SouthboundMapper.createNodeId(getKey().getIp(),getKey().getPort()));
189
190         OvsdbNodeAugmentationBuilder ovsdbConnectionAugmentationBuilder = new OvsdbNodeAugmentationBuilder();
191         List<ManagedNodeEntry> managedBridges = new ArrayList<ManagedNodeEntry>();
192         InstanceIdentifier<Node> bridgeIid = SouthboundMapper.createInstanceIdentifier(getKey(),bridge);
193         ManagedNodeEntry managedBridge = new ManagedNodeEntryBuilder().setBridgeRef(
194                 new OvsdbBridgeRef(bridgeIid)).build();
195         managedBridges.add(managedBridge);
196         ovsdbConnectionAugmentationBuilder.setManagedNodeEntry(managedBridges);
197
198         connectionNode.addAugmentation(OvsdbNodeAugmentation.class, ovsdbConnectionAugmentationBuilder.build());
199
200         LOG.debug("Update node with bridge node ref {}",ovsdbConnectionAugmentationBuilder.toString());
201         return connectionNode.build();
202     }
203
204     private Node buildBridgeNode(Bridge bridge) {
205         NodeBuilder bridgeNodeBuilder = new NodeBuilder();
206         InstanceIdentifier<Node> bridgeIid = SouthboundMapper.createInstanceIdentifier(getKey(),bridge);
207         NodeId bridgeNodeId = SouthboundMapper.createManagedNodeId(bridgeIid);
208         bridgeNodeBuilder.setNodeId(bridgeNodeId);
209         OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder = new OvsdbBridgeAugmentationBuilder();
210         ovsdbBridgeAugmentationBuilder.setBridgeName(new OvsdbBridgeName(bridge.getName()));
211         ovsdbBridgeAugmentationBuilder.setBridgeUuid(new Uuid(bridge.getUuid().toString()));
212         setDataPath(ovsdbBridgeAugmentationBuilder, bridge);
213         setDataPathType(ovsdbBridgeAugmentationBuilder, bridge);
214         setProtocol(ovsdbBridgeAugmentationBuilder, bridge);
215         setExternalIds(ovsdbBridgeAugmentationBuilder, bridge);
216         setOtherConfig(ovsdbBridgeAugmentationBuilder, bridge);
217         setFailMode(ovsdbBridgeAugmentationBuilder, bridge);
218         setManagedBy(ovsdbBridgeAugmentationBuilder);
219         bridgeNodeBuilder.addAugmentation(OvsdbBridgeAugmentation.class, ovsdbBridgeAugmentationBuilder.build());
220
221         LOG.debug("Built with the intent to store bridge data {}",
222                 ovsdbBridgeAugmentationBuilder.toString());
223         return bridgeNodeBuilder.build();
224     }
225
226     private void setManagedBy(OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder) {
227         InstanceIdentifier<Node> connectionNodePath = getKey().toInstanceIndentifier();
228         ovsdbBridgeAugmentationBuilder.setManagedBy(new OvsdbNodeRef(connectionNodePath));
229     }
230
231     private void setDataPathType(OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder,
232             Bridge bridge) {
233         ovsdbBridgeAugmentationBuilder.setDatapathType(
234                 SouthboundMapper.createDatapathType(bridge.getDatapathTypeColumn().getData()));
235     }
236
237     private void setFailMode(OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder,
238             Bridge bridge) {
239         if (bridge.getFailModeColumn() != null
240                 && bridge.getFailModeColumn().getData() != null
241                 && !bridge.getFailModeColumn().getData().isEmpty()) {
242             String[] failmodeArray = new String[bridge.getFailModeColumn().getData().size()];
243             bridge.getFailModeColumn().getData().toArray(failmodeArray);
244             ovsdbBridgeAugmentationBuilder.setFailMode(
245                     SouthboundConstants.OVSDB_FAIL_MODE_MAP.inverse().get(failmodeArray[0]));
246         }
247     }
248
249     private void setOtherConfig(OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder,
250             Bridge bridge) {
251         Map<String, String> otherConfigs = bridge
252                 .getOtherConfigColumn().getData();
253         if (otherConfigs != null && !otherConfigs.isEmpty()) {
254             Set<String> otherConfigKeys = otherConfigs.keySet();
255             List<BridgeOtherConfigs> otherConfigList = new ArrayList<BridgeOtherConfigs>();
256             String otherConfigValue;
257             for (String otherConfigKey : otherConfigKeys) {
258                 otherConfigValue = otherConfigs.get(otherConfigKey);
259                 if (otherConfigKey != null && otherConfigValue != null) {
260                     otherConfigList.add(new BridgeOtherConfigsBuilder()
261                             .setBridgeOtherConfigKey(otherConfigKey)
262                             .setBridgeOtherConfigValue(otherConfigValue)
263                             .build());
264                 }
265             }
266             ovsdbBridgeAugmentationBuilder.setBridgeOtherConfigs(otherConfigList);
267         }
268     }
269
270     private void setExternalIds(OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder,
271             Bridge bridge) {
272         Map<String, String> externalIds = bridge.getExternalIdsColumn()
273                 .getData();
274         if (externalIds != null && !externalIds.isEmpty()) {
275             Set<String> externalIdKeys = externalIds.keySet();
276             List<BridgeExternalIds> externalIdsList = new ArrayList<BridgeExternalIds>();
277             String externalIdValue;
278             for (String externalIdKey : externalIdKeys) {
279                 externalIdValue = externalIds.get(externalIdKey);
280                 if (externalIdKey != null && externalIdValue != null) {
281                     externalIdsList.add(new BridgeExternalIdsBuilder()
282                             .setBridgeExternalIdKey(externalIdKey)
283                             .setBridgeExternalIdValue(externalIdValue)
284                             .build());
285                 }
286             }
287             ovsdbBridgeAugmentationBuilder.setBridgeExternalIds(externalIdsList);
288         }
289     }
290
291     private void setProtocol(OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder,
292             Bridge bridge) {
293         if (SouthboundMapper.createMdsalProtocols(bridge) != null
294                 && SouthboundMapper.createMdsalProtocols(bridge).size() > 0) {
295             ovsdbBridgeAugmentationBuilder.setProtocolEntry(SouthboundMapper.createMdsalProtocols(bridge));
296         }
297     }
298
299     private void setDataPath(OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder,
300             Bridge bridge) {
301         DatapathId dpid = SouthboundMapper.createDatapathId(bridge);
302         if (dpid != null) {
303             ovsdbBridgeAugmentationBuilder.setDatapathId(dpid);
304         }
305     }
306 }