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