Fix findbugs violations in southbound-impl
[ovsdb.git] / southbound / southbound-impl / src / main / java / org / opendaylight / ovsdb / southbound / transactions / md / OvsdbBridgeUpdateCommand.java
1 /*
2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
3  *
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
7  */
8
9 package org.opendaylight.ovsdb.southbound.transactions.md;
10
11 import static org.opendaylight.ovsdb.southbound.SouthboundUtil.schemaMismatchLog;
12
13 import com.google.common.base.Optional;
14 import com.google.common.base.Preconditions;
15 import com.google.common.net.InetAddresses;
16 import java.net.InetAddress;
17 import java.net.NetworkInterface;
18 import java.net.SocketException;
19 import java.util.ArrayList;
20 import java.util.Enumeration;
21 import java.util.List;
22 import java.util.Map;
23 import java.util.Map.Entry;
24 import java.util.Set;
25 import org.apache.commons.lang3.math.NumberUtils;
26 import org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction;
27 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
28 import org.opendaylight.ovsdb.lib.error.SchemaVersionMismatchException;
29 import org.opendaylight.ovsdb.lib.message.TableUpdates;
30 import org.opendaylight.ovsdb.lib.notation.UUID;
31 import org.opendaylight.ovsdb.lib.schema.DatabaseSchema;
32 import org.opendaylight.ovsdb.lib.schema.typed.TyperUtils;
33 import org.opendaylight.ovsdb.schema.openvswitch.Bridge;
34 import org.opendaylight.ovsdb.schema.openvswitch.Controller;
35 import org.opendaylight.ovsdb.southbound.InstanceIdentifierCodec;
36 import org.opendaylight.ovsdb.southbound.OvsdbConnectionInstance;
37 import org.opendaylight.ovsdb.southbound.SouthboundConstants;
38 import org.opendaylight.ovsdb.southbound.SouthboundMapper;
39 import org.opendaylight.ovsdb.southbound.SouthboundUtil;
40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.DatapathId;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeAugmentation;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeAugmentationBuilder;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeName;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeProtocolBase;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeRef;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbNodeAugmentation;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbNodeAugmentationBuilder;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbNodeRef;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.BridgeExternalIds;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.BridgeExternalIdsBuilder;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.BridgeExternalIdsKey;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.BridgeOtherConfigs;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.BridgeOtherConfigsBuilder;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.BridgeOtherConfigsKey;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.ControllerEntry;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.ProtocolEntry;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.ProtocolEntryKey;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.ManagedNodeEntry;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.ManagedNodeEntryBuilder;
62 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
63 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
64 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeBuilder;
65 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
66 import org.opendaylight.yangtools.yang.binding.DataObject;
67 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
68 import org.slf4j.Logger;
69 import org.slf4j.LoggerFactory;
70
71 public class OvsdbBridgeUpdateCommand extends AbstractTransactionCommand {
72     private static final Logger LOG = LoggerFactory.getLogger(OvsdbBridgeUpdateCommand.class);
73     private final InstanceIdentifierCodec instanceIdentifierCodec;
74     private final Map<UUID,Bridge> updatedBridgeRows;
75     private final Map<UUID, Bridge> oldBridgeRows;
76
77     public OvsdbBridgeUpdateCommand(InstanceIdentifierCodec instanceIdentifierCodec, OvsdbConnectionInstance key,
78             TableUpdates updates, DatabaseSchema dbSchema) {
79         super(key,updates,dbSchema);
80         this.instanceIdentifierCodec = instanceIdentifierCodec;
81         updatedBridgeRows = TyperUtils.extractRowsUpdated(Bridge.class, getUpdates(), getDbSchema());
82         oldBridgeRows = TyperUtils.extractRowsOld(Bridge.class, getUpdates(), getDbSchema());
83     }
84
85     @Override
86     public void execute(ReadWriteTransaction transaction) {
87         if (updatedBridgeRows == null || updatedBridgeRows.isEmpty()) {
88             return;
89         }
90
91         final InstanceIdentifier<Node> connectionIId = getOvsdbConnectionInstance().getInstanceIdentifier();
92         Optional<Node> connection = SouthboundUtil.readNode(transaction, connectionIId);
93         if (!connection.isPresent()) {
94             return;
95         }
96
97         for (Entry<UUID, Bridge> entry : updatedBridgeRows.entrySet()) {
98             updateBridge(transaction, entry.getValue(), connectionIId);
99         }
100     }
101
102     private void updateBridge(ReadWriteTransaction transaction,
103             Bridge bridge, InstanceIdentifier<Node> connectionIId) {
104         // Update the connection node to let it know it manages this bridge
105         Node connectionNode = buildConnectionNode(bridge);
106         transaction.merge(LogicalDatastoreType.OPERATIONAL, connectionIId, connectionNode);
107
108         // Update the bridge node with whatever data we are getting
109         InstanceIdentifier<Node> bridgeIid = getInstanceIdentifier(bridge);
110         Node bridgeNode = buildBridgeNode(bridge);
111         transaction.merge(LogicalDatastoreType.OPERATIONAL, bridgeIid, bridgeNode);
112         deleteEntries(transaction, protocolEntriesToRemove(bridgeIid,bridge));
113         deleteEntries(transaction, externalIdsToRemove(bridgeIid,bridge));
114         deleteEntries(transaction, bridgeOtherConfigsToRemove(bridgeIid,bridge));
115     }
116
117     private <T extends DataObject> void deleteEntries(ReadWriteTransaction transaction,
118             List<InstanceIdentifier<T>> entryIids) {
119         for (InstanceIdentifier<T> entryIid: entryIids) {
120             transaction.delete(LogicalDatastoreType.OPERATIONAL, entryIid);
121         }
122     }
123
124     private List<InstanceIdentifier<BridgeOtherConfigs>> bridgeOtherConfigsToRemove(
125             InstanceIdentifier<Node> bridgeIid, Bridge bridge) {
126         Preconditions.checkNotNull(bridgeIid);
127         Preconditions.checkNotNull(bridge);
128         List<InstanceIdentifier<BridgeOtherConfigs>> result = new ArrayList<>();
129
130         Bridge oldBridge = oldBridgeRows.get(bridge.getUuid());
131
132         if (oldBridge != null && oldBridge.getOtherConfigColumn() != null) {
133             for (Entry<String, String> otherConfig:
134                 oldBridge.getOtherConfigColumn().getData().entrySet()) {
135                 if (bridge.getOtherConfigColumn() == null
136                         || !bridge.getOtherConfigColumn().getData().containsKey(otherConfig.getKey())) {
137                     InstanceIdentifier<BridgeOtherConfigs> iid = bridgeIid
138                             .augmentation(OvsdbBridgeAugmentation.class)
139                             .child(BridgeOtherConfigs.class,
140                                     new BridgeOtherConfigsKey(otherConfig.getKey()));
141                     result.add(iid);
142                 }
143             }
144         }
145         return result;
146     }
147
148     private List<InstanceIdentifier<BridgeExternalIds>> externalIdsToRemove(
149             InstanceIdentifier<Node> bridgeIid, Bridge bridge) {
150         Preconditions.checkNotNull(bridgeIid);
151         Preconditions.checkNotNull(bridge);
152         List<InstanceIdentifier<BridgeExternalIds>> result = new ArrayList<>();
153
154         Bridge oldBridge = oldBridgeRows.get(bridge.getUuid());
155
156         if (oldBridge != null && oldBridge.getExternalIdsColumn() != null) {
157             for (Entry<String, String> externalId:
158                 oldBridge.getExternalIdsColumn().getData().entrySet()) {
159                 if (bridge.getExternalIdsColumn() == null
160                         || !bridge.getExternalIdsColumn().getData().containsKey(externalId.getKey())) {
161                     InstanceIdentifier<BridgeExternalIds> iid = bridgeIid
162                             .augmentation(OvsdbBridgeAugmentation.class)
163                             .child(BridgeExternalIds.class,
164                                     new BridgeExternalIdsKey(externalId.getKey()));
165                     result.add(iid);
166                 }
167             }
168         }
169         return result;
170     }
171
172     private List<InstanceIdentifier<ProtocolEntry>> protocolEntriesToRemove(
173             InstanceIdentifier<Node> bridgeIid, Bridge bridge) {
174         Preconditions.checkNotNull(bridgeIid);
175         Preconditions.checkNotNull(bridge);
176         List<InstanceIdentifier<ProtocolEntry>> result = new ArrayList<>();
177         Bridge oldBridge = oldBridgeRows.get(bridge.getUuid());
178
179         try {
180             if (oldBridge != null && oldBridge.getProtocolsColumn() != null) {
181                 for (String protocol : oldBridge.getProtocolsColumn().getData()) {
182                     if (bridge.getProtocolsColumn() == null || !bridge.getProtocolsColumn().getData()
183                                 .contains(protocol)) {
184                         Class<? extends OvsdbBridgeProtocolBase> proto = SouthboundConstants.OVSDB_PROTOCOL_MAP
185                                 .inverse().get(protocol);
186                         InstanceIdentifier<ProtocolEntry> iid = bridgeIid
187                                 .augmentation(OvsdbBridgeAugmentation.class)
188                                 .child(ProtocolEntry.class,
189                                         new ProtocolEntryKey(proto));
190                         result.add(iid);
191                     }
192                 }
193             }
194         } catch (SchemaVersionMismatchException e) {
195             schemaMismatchLog("protocols", "Bridge", e);
196         }
197         return result;
198     }
199
200     private Node buildConnectionNode(
201             Bridge bridge) {
202         //Update node with managed node reference
203         NodeBuilder connectionNode = new NodeBuilder();
204         connectionNode.setNodeId(getOvsdbConnectionInstance().getNodeId());
205
206         OvsdbNodeAugmentationBuilder ovsdbConnectionAugmentationBuilder = new OvsdbNodeAugmentationBuilder();
207         List<ManagedNodeEntry> managedBridges = new ArrayList<>();
208         InstanceIdentifier<Node> bridgeIid =
209                 SouthboundMapper.createInstanceIdentifier(instanceIdentifierCodec, getOvsdbConnectionInstance(),
210                         bridge);
211         ManagedNodeEntry managedBridge = new ManagedNodeEntryBuilder().setBridgeRef(
212                 new OvsdbBridgeRef(bridgeIid)).build();
213         managedBridges.add(managedBridge);
214         ovsdbConnectionAugmentationBuilder.setManagedNodeEntry(managedBridges);
215
216         connectionNode.addAugmentation(OvsdbNodeAugmentation.class, ovsdbConnectionAugmentationBuilder.build());
217
218         LOG.debug("Update node with bridge node ref {}",
219                 ovsdbConnectionAugmentationBuilder.getManagedNodeEntry().iterator().next());
220         return connectionNode.build();
221     }
222
223     private Node buildBridgeNode(Bridge bridge) {
224         NodeBuilder bridgeNodeBuilder = new NodeBuilder();
225         NodeId bridgeNodeId = getNodeId(bridge);
226         bridgeNodeBuilder.setNodeId(bridgeNodeId);
227         OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder = new OvsdbBridgeAugmentationBuilder();
228         ovsdbBridgeAugmentationBuilder.setBridgeName(new OvsdbBridgeName(bridge.getName()));
229         ovsdbBridgeAugmentationBuilder.setBridgeUuid(new Uuid(bridge.getUuid().toString()));
230         setDataPath(ovsdbBridgeAugmentationBuilder, bridge);
231         setDataPathType(ovsdbBridgeAugmentationBuilder, bridge);
232         setProtocol(ovsdbBridgeAugmentationBuilder, bridge);
233         setExternalIds(ovsdbBridgeAugmentationBuilder, bridge);
234         setOtherConfig(ovsdbBridgeAugmentationBuilder, bridge);
235         setFailMode(ovsdbBridgeAugmentationBuilder, bridge);
236         setOpenFlowNodeRef(ovsdbBridgeAugmentationBuilder, bridge);
237         setManagedBy(ovsdbBridgeAugmentationBuilder);
238         setAutoAttach(ovsdbBridgeAugmentationBuilder, bridge);
239         setStpEnalbe(ovsdbBridgeAugmentationBuilder,bridge);
240         bridgeNodeBuilder.addAugmentation(OvsdbBridgeAugmentation.class, ovsdbBridgeAugmentationBuilder.build());
241
242         LOG.debug("Built with the intent to store bridge data {}",
243                 ovsdbBridgeAugmentationBuilder.build());
244         return bridgeNodeBuilder.build();
245     }
246
247     private void setAutoAttach(OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder,
248             Bridge bridge) {
249         try {
250             if (bridge.getAutoAttachColumn() != null
251                     && bridge.getAutoAttachColumn().getData() != null
252                     && !bridge.getAutoAttachColumn().getData().isEmpty()) {
253                 Set<UUID> uuids = bridge.getAutoAttachColumn().getData();
254                 for (UUID uuid : uuids) {
255                     ovsdbBridgeAugmentationBuilder.setAutoAttach(new Uuid(uuid.toString()));
256                 }
257             }
258         } catch (SchemaVersionMismatchException e) {
259             schemaMismatchLog("auto_attach", "Bridge", e);
260         }
261     }
262
263     private void setManagedBy(OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder) {
264         InstanceIdentifier<Node> connectionNodePath = getOvsdbConnectionInstance().getInstanceIdentifier();
265         ovsdbBridgeAugmentationBuilder.setManagedBy(new OvsdbNodeRef(connectionNodePath));
266     }
267
268     private void setDataPathType(OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder,
269             Bridge bridge) {
270         ovsdbBridgeAugmentationBuilder.setDatapathType(
271                 SouthboundMapper.createDatapathType(bridge.getDatapathTypeColumn().getData()));
272     }
273
274     private void setFailMode(OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder,
275             Bridge bridge) {
276         if (bridge.getFailModeColumn() != null
277                 && bridge.getFailModeColumn().getData() != null
278                 && !bridge.getFailModeColumn().getData().isEmpty()) {
279             String[] failmodeArray = new String[bridge.getFailModeColumn().getData().size()];
280             bridge.getFailModeColumn().getData().toArray(failmodeArray);
281             ovsdbBridgeAugmentationBuilder.setFailMode(
282                     SouthboundConstants.OVSDB_FAIL_MODE_MAP.inverse().get(failmodeArray[0]));
283         }
284     }
285
286     private void setOtherConfig(OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder,
287             Bridge bridge) {
288         Map<String, String> otherConfigs = bridge
289                 .getOtherConfigColumn().getData();
290         if (otherConfigs != null && !otherConfigs.isEmpty()) {
291             List<BridgeOtherConfigs> otherConfigList = new ArrayList<>();
292             for (Entry<String, String> entry : otherConfigs.entrySet()) {
293                 String otherConfigKey = entry.getKey();
294                 String otherConfigValue = entry.getValue();
295                 if (otherConfigKey != null && otherConfigValue != null) {
296                     otherConfigList.add(new BridgeOtherConfigsBuilder()
297                             .setBridgeOtherConfigKey(otherConfigKey)
298                             .setBridgeOtherConfigValue(otherConfigValue)
299                             .build());
300                 }
301             }
302             ovsdbBridgeAugmentationBuilder.setBridgeOtherConfigs(otherConfigList);
303         }
304     }
305
306     private void setExternalIds(OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder,
307             Bridge bridge) {
308         Map<String, String> externalIds = bridge.getExternalIdsColumn()
309                 .getData();
310         if (externalIds != null && !externalIds.isEmpty()) {
311             List<BridgeExternalIds> externalIdsList = new ArrayList<>();
312             for (Entry<String, String> entry : externalIds.entrySet()) {
313                 String externalIdKey = entry.getKey();
314                 String externalIdValue = entry.getValue();
315                 if (externalIdKey != null && externalIdValue != null) {
316                     externalIdsList.add(new BridgeExternalIdsBuilder()
317                             .setBridgeExternalIdKey(externalIdKey)
318                             .setBridgeExternalIdValue(externalIdValue)
319                             .build());
320                 }
321             }
322             ovsdbBridgeAugmentationBuilder.setBridgeExternalIds(externalIdsList);
323         }
324     }
325
326     private void setProtocol(OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder,
327             Bridge bridge) {
328         final List<ProtocolEntry> protocols = SouthboundMapper.createMdsalProtocols(bridge);
329         if (!protocols.isEmpty()) {
330             ovsdbBridgeAugmentationBuilder.setProtocolEntry(protocols);
331         }
332     }
333
334     private void setDataPath(OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder,
335             Bridge bridge) {
336         DatapathId dpid = SouthboundMapper.createDatapathId(bridge);
337         if (dpid != null) {
338             ovsdbBridgeAugmentationBuilder.setDatapathId(dpid);
339         }
340     }
341
342     private void setStpEnalbe(OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder,
343                               Bridge bridge) {
344         if (bridge.getStpEnableColumn() != null) {
345             Boolean stpEnable = bridge.getStpEnableColumn().getData();
346             if (stpEnable != null) {
347                 ovsdbBridgeAugmentationBuilder.setStpEnable(stpEnable);
348             }
349         }
350     }
351
352     private void setOpenFlowNodeRef(OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder,
353             Bridge bridge) {
354         Map<UUID, Controller> updatedControllerRows =
355                 TyperUtils.extractRowsUpdated(Controller.class, getUpdates(), getDbSchema());
356         LOG.debug("setOpenFlowNodeRef: updatedControllerRows: {}", updatedControllerRows);
357         for (ControllerEntry controllerEntry: SouthboundMapper.createControllerEntries(bridge, updatedControllerRows)) {
358             if (controllerEntry != null
359                 && controllerEntry.isIsConnected() != null && controllerEntry.isIsConnected()) {
360                 String [] controllerTarget = controllerEntry.getTarget().getValue().split(":");
361                 IpAddress bridgeControllerIpAddress = null;
362                 for (String targetElement : controllerTarget) {
363                     if (InetAddresses.isInetAddress(targetElement)) {
364                         bridgeControllerIpAddress = new IpAddress(targetElement.toCharArray());
365                         continue;
366                     }
367                     if (NumberUtils.isNumber(targetElement)) {
368                         continue;
369                     }
370                 }
371                 try {
372                     Enumeration<NetworkInterface> networkInterfaces = NetworkInterface.getNetworkInterfaces();
373                 networkInterfacesLoop:
374                     while (networkInterfaces.hasMoreElements()) {
375                         NetworkInterface networkInterface = networkInterfaces.nextElement();
376                         Enumeration<InetAddress> networkInterfaceAddresses = networkInterface.getInetAddresses();
377                         while (networkInterfaceAddresses.hasMoreElements()) {
378                             InetAddress networkInterfaceAddress = networkInterfaceAddresses.nextElement();
379                             if (bridgeControllerIpAddress.getIpv4Address().getValue()
380                                     .equals(networkInterfaceAddress.getHostAddress())) {
381                                 ovsdbBridgeAugmentationBuilder.setBridgeOpenflowNodeRef(
382                                         getOvsdbConnectionInstance().getInstanceIdentifier());
383                                 break networkInterfacesLoop;
384                             }
385                         }
386                     }
387                 } catch (SocketException e) {
388                     LOG.warn("Error getting local ip address", e);
389                 }
390             }
391         }
392     }
393
394     private InstanceIdentifier<Node> getInstanceIdentifier(Bridge bridge) {
395         return SouthboundMapper.createInstanceIdentifier(instanceIdentifierCodec, getOvsdbConnectionInstance(),
396                 bridge);
397     }
398
399     private NodeId getNodeId(Bridge bridge) {
400         NodeKey nodeKey = getInstanceIdentifier(bridge).firstKeyOf(Node.class);
401         return nodeKey.getNodeId();
402     }
403 }