Refactor SupportedIfCapability usage
[transportpce.git] / common / src / main / java / org / opendaylight / transportpce / common / mapping / PortMappingVersion221.java
1 /*
2  * Copyright © 2017 Orange, 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.transportpce.common.mapping;
10
11 import com.google.common.util.concurrent.FluentFuture;
12 import java.util.ArrayList;
13 import java.util.Collections;
14 import java.util.Comparator;
15 import java.util.HashMap;
16 import java.util.List;
17 import java.util.Locale;
18 import java.util.Map;
19 import java.util.Map.Entry;
20 import java.util.Optional;
21 import java.util.Set;
22 import java.util.concurrent.ExecutionException;
23 import java.util.stream.Collectors;
24 import org.eclipse.jdt.annotation.NonNull;
25 import org.opendaylight.mdsal.binding.api.DataBroker;
26 import org.opendaylight.mdsal.binding.api.WriteTransaction;
27 import org.opendaylight.mdsal.common.api.CommitInfo;
28 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
29 import org.opendaylight.transportpce.common.StringConstants;
30 import org.opendaylight.transportpce.common.Timeouts;
31 import org.opendaylight.transportpce.common.device.DeviceTransactionManager;
32 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev220316.Network;
33 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev220316.NetworkBuilder;
34 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev220316.OpenroadmNodeVersion;
35 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev220316.cp.to.degree.CpToDegree;
36 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev220316.cp.to.degree.CpToDegreeBuilder;
37 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev220316.cp.to.degree.CpToDegreeKey;
38 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev220316.mapping.Mapping;
39 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev220316.mapping.MappingBuilder;
40 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev220316.mapping.MappingKey;
41 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev220316.mc.capabilities.McCapabilities;
42 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev220316.mc.capabilities.McCapabilitiesBuilder;
43 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev220316.mc.capabilities.McCapabilitiesKey;
44 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev220316.network.Nodes;
45 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev220316.network.NodesBuilder;
46 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev220316.network.NodesKey;
47 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev220316.network.nodes.NodeInfo;
48 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev220316.network.nodes.NodeInfoBuilder;
49 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev220316.switching.pool.lcp.SwitchingPoolLcp;
50 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev220316.switching.pool.lcp.SwitchingPoolLcpBuilder;
51 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev220316.switching.pool.lcp.SwitchingPoolLcpKey;
52 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev220316.switching.pool.lcp.switching.pool.lcp.NonBlockingList;
53 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev220316.switching.pool.lcp.switching.pool.lcp.NonBlockingListBuilder;
54 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev220316.switching.pool.lcp.switching.pool.lcp.NonBlockingListKey;
55 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.optical.channel.types.rev200529.FrequencyGHz;
56 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.types.rev181019.Direction;
57 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.types.rev181019.PortQual;
58 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.types.rev181019.XpdrNodeTypes;
59 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.CircuitPack;
60 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.circuit.pack.Ports;
61 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.circuit.pack.PortsKey;
62 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.circuit.packs.CircuitPacks;
63 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.circuit.packs.CircuitPacksKey;
64 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.degree.ConnectionPorts;
65 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.interfaces.grp.Interface;
66 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.interfaces.grp.InterfaceKey;
67 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.org.openroadm.device.container.OrgOpenroadmDevice;
68 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.org.openroadm.device.container.org.openroadm.device.ConnectionMap;
69 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.org.openroadm.device.container.org.openroadm.device.Degree;
70 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.org.openroadm.device.container.org.openroadm.device.DegreeKey;
71 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.org.openroadm.device.container.org.openroadm.device.Info;
72 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.org.openroadm.device.container.org.openroadm.device.OduSwitchingPools;
73 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.org.openroadm.device.container.org.openroadm.device.Protocols;
74 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.org.openroadm.device.container.org.openroadm.device.SharedRiskGroup;
75 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.org.openroadm.device.container.org.openroadm.device.SharedRiskGroupKey;
76 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.org.openroadm.device.container.org.openroadm.device.Xponder;
77 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.org.openroadm.device.container.org.openroadm.device.connection.map.Destination;
78 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.org.openroadm.device.container.org.openroadm.device.odu.switching.pools.non.blocking.list.PortList;
79 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.port.Interfaces;
80 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.xponder.XpdrPort;
81 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.types.rev191129.NodeTypes;
82 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev170626.EthernetCsmacd;
83 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev170626.InterfaceType;
84 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev170626.OpenROADMOpticalMultiplex;
85 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev170626.OpticalTransport;
86 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev170626.OtnOdu;
87 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev170626.OtnOtu;
88 import org.opendaylight.yang.gen.v1.http.org.openroadm.lldp.rev181019.Protocols1;
89 import org.opendaylight.yang.gen.v1.http.org.openroadm.lldp.rev181019.lldp.container.Lldp;
90 import org.opendaylight.yang.gen.v1.http.org.openroadm.lldp.rev181019.lldp.container.lldp.PortConfig;
91 import org.opendaylight.yang.gen.v1.http.org.openroadm.port.capability.rev181019.Ports1;
92 import org.opendaylight.yang.gen.v1.http.org.openroadm.port.types.rev181019.SupportedIfCapability;
93 import org.opendaylight.yang.gen.v1.http.org.openroadm.switching.pool.types.rev191129.SwitchingPoolTypes;
94 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
95 import org.opendaylight.yangtools.yang.common.Uint16;
96 import org.opendaylight.yangtools.yang.common.Uint32;
97 import org.slf4j.Logger;
98 import org.slf4j.LoggerFactory;
99
100 // FIXME: many common pieces of code between PortMapping Versions 121 and 221 and 710
101 // some mutualization would be helpful
102 public class PortMappingVersion221 {
103
104     private static final Logger LOG = LoggerFactory.getLogger(PortMappingVersion221.class);
105     private static final Map<Direction, String> SUFFIX;
106     private static final Set<Integer> TXRX_SET = Set.of(Direction.Tx.getIntValue(), Direction.Rx.getIntValue());
107
108     private final DataBroker dataBroker;
109     private final DeviceTransactionManager deviceTransactionManager;
110
111     static {
112         SUFFIX =  Map.of(
113             Direction.Tx, "TX",
114             Direction.Rx, "RX",
115             Direction.Bidirectional, "TXRX");
116     }
117
118     public PortMappingVersion221(DataBroker dataBroker, DeviceTransactionManager deviceTransactionManager) {
119         this.dataBroker = dataBroker;
120         this.deviceTransactionManager = deviceTransactionManager;
121     }
122
123     public boolean createMappingData(String nodeId) {
124         LOG.info(PortMappingUtils.CREATE_MAPPING_DATA_LOGMSG, nodeId, "2.2.1");
125         List<Mapping> portMapList = new ArrayList<>();
126         Map<McCapabilitiesKey, McCapabilities> mcCapabilities = new HashMap<>();
127         InstanceIdentifier<Info> infoIID = InstanceIdentifier.create(OrgOpenroadmDevice.class).child(Info.class);
128         Optional<Info> deviceInfoOptional = this.deviceTransactionManager.getDataFromDevice(
129                 nodeId, LogicalDatastoreType.OPERATIONAL, infoIID,
130                 Timeouts.DEVICE_READ_TIMEOUT, Timeouts.DEVICE_READ_TIMEOUT_UNIT);
131         if (deviceInfoOptional.isEmpty()) {
132             LOG.warn(PortMappingUtils.DEVICE_HAS_LOGMSG, nodeId, "no info", "subtree");
133             return false;
134         }
135         Info deviceInfo = deviceInfoOptional.get();
136         NodeInfo nodeInfo = createNodeInfo(deviceInfo);
137         if (nodeInfo == null) {
138             return false;
139         }
140         postPortMapping(nodeId, nodeInfo, null, null, null, null);
141
142         switch (deviceInfo.getNodeType()) {
143
144             case Rdm:
145                 // Get TTP port mapping
146                 if (!createTtpPortMapping(nodeId, deviceInfo, portMapList)) {
147                     // return false if mapping creation for TTP's failed
148                     LOG.warn(PortMappingUtils.UNABLE_MAPPING_LOGMSG, nodeId, PortMappingUtils.CREATE, "TTP's");
149                     return false;
150                 }
151
152                 // Get PP port mapping
153                 if (!createPpPortMapping(nodeId, deviceInfo, portMapList)) {
154                     // return false if mapping creation for PP's failed
155                     LOG.warn(PortMappingUtils.UNABLE_MAPPING_LOGMSG, nodeId, PortMappingUtils.CREATE, "PP's");
156                     return false;
157                 }
158                 // Get MC capabilities
159                 if (!createMcCapabilitiesList(nodeId, deviceInfo, mcCapabilities)) {
160                     // return false if MC capabilites failed
161                     LOG.warn(PortMappingUtils.UNABLE_MC_CAPA_LOGMSG, nodeId);
162                     return false;
163                 }
164                 break;
165             case Xpdr:
166                 if (!createXpdrPortMapping(nodeId, portMapList)) {
167                     LOG.warn(PortMappingUtils.UNABLE_MAPPING_LOGMSG, nodeId, PortMappingUtils.CREATE, "Xponder");
168                     return false;
169                 }
170                 break;
171             default:
172                 LOG.error(PortMappingUtils.UNABLE_MAPPING_LOGMSG,
173                     nodeId, PortMappingUtils.CREATE, deviceInfo.getNodeType() + " - unknown nodetype");
174                 break;
175
176         }
177         return postPortMapping(nodeId, nodeInfo, portMapList, null, null, mcCapabilities);
178     }
179
180     public boolean updateMapping(String nodeId, Mapping oldMapping) {
181         if (nodeId == null) {
182             LOG.error(PortMappingUtils.UNABLE_MAPPING_LOGMSG, "node id null" , PortMappingUtils.UPDATE, "a null value");
183             return false;
184         }
185         if (oldMapping == null) {
186             LOG.error(PortMappingUtils.UNABLE_MAPPING_LOGMSG, nodeId, PortMappingUtils.UPDATE, "a null value");
187             return false;
188         }
189         InstanceIdentifier<Ports> portId = InstanceIdentifier.create(OrgOpenroadmDevice.class)
190                 .child(CircuitPacks.class, new CircuitPacksKey(oldMapping.getSupportingCircuitPackName()))
191                 .child(Ports.class, new PortsKey(oldMapping.getSupportingPort()));
192         try {
193             Ports port = deviceTransactionManager.getDataFromDevice(nodeId, LogicalDatastoreType.OPERATIONAL,
194                 portId, Timeouts.DEVICE_READ_TIMEOUT, Timeouts.DEVICE_READ_TIMEOUT_UNIT).get();
195             Mapping newMapping = updateMappingObject(nodeId, port, oldMapping);
196             LOG.debug(PortMappingUtils.UPDATE_MAPPING_LOGMSG,
197                 nodeId, oldMapping, oldMapping.getLogicalConnectionPoint(), newMapping);
198             final WriteTransaction writeTransaction = this.dataBroker.newWriteOnlyTransaction();
199             InstanceIdentifier<Mapping> mapIID = InstanceIdentifier.create(Network.class)
200                 .child(Nodes.class, new NodesKey(nodeId))
201                 .child(Mapping.class, new MappingKey(oldMapping.getLogicalConnectionPoint()));
202             writeTransaction.merge(LogicalDatastoreType.CONFIGURATION, mapIID, newMapping);
203             FluentFuture<? extends @NonNull CommitInfo> commit = writeTransaction.commit();
204             commit.get();
205             return true;
206         } catch (InterruptedException | ExecutionException e) {
207             LOG.error(PortMappingUtils.UNABLE_MAPPING_LOGMSG,
208                 nodeId, PortMappingUtils.UPDATE, oldMapping.getLogicalConnectionPoint(), e);
209             return false;
210         }
211     }
212
213     private boolean createXpdrPortMapping(String nodeId, List<Mapping> portMapList) {
214         // Creating for Xponder Line and Client Ports
215         OrgOpenroadmDevice device = getXpdrDevice(nodeId);
216         if (device == null) {
217             return false;
218         }
219         Map<String, String> lcpMap = new HashMap<>();
220         Map<String, Mapping> mappingMap = new HashMap<>();
221         getXpdrMaps(device, nodeId, lcpMap, mappingMap);
222         if (device.getConnectionMap() == null) {
223             LOG.warn(PortMappingUtils.NO_CONMAP_LOGMSG, nodeId);
224         } else {
225             for (ConnectionMap cm : device.nonnullConnectionMap().values()) {
226                 String skey = cm.getSource().getCircuitPackName() + "+" + cm.getSource().getPortName();
227                 Destination destination0 = cm.nonnullDestination().values().iterator().next();
228                 String dkey = destination0.getCircuitPackName() + "+" + destination0.getPortName();
229                 if (!lcpMap.containsKey(skey)) {
230                     LOG.error(PortMappingUtils.CONMAP_ISSUE_LOGMSG, nodeId, skey, dkey);
231                     continue;
232                 }
233                 String slcp = lcpMap.get(skey);
234                 Mapping mapping = mappingMap.get(slcp);
235                 mappingMap.remove(slcp);
236                 portMapList.add(createXpdrMappingObject(nodeId, null, null, null, null, mapping,
237                         //dlcp
238                         lcpMap.containsKey(dkey) ? lcpMap.get(dkey) : null,
239                         null));
240             }
241         }
242         if (device.getOduSwitchingPools() != null) {
243             postPortMapping(nodeId, null, null, null, getSwitchingPoolList(device, lcpMap, nodeId), null);
244         }
245         mappingMap.forEach((k,v) -> portMapList.add(v));
246         return true;
247     }
248
249     private OrgOpenroadmDevice getXpdrDevice(String nodeId) {
250         InstanceIdentifier<OrgOpenroadmDevice> deviceIID = InstanceIdentifier.create(OrgOpenroadmDevice.class);
251         Optional<OrgOpenroadmDevice> deviceObject = deviceTransactionManager.getDataFromDevice(nodeId,
252             LogicalDatastoreType.OPERATIONAL, deviceIID,
253             Timeouts.DEVICE_READ_TIMEOUT, Timeouts.DEVICE_READ_TIMEOUT_UNIT);
254         if (deviceObject.isEmpty()) {
255             LOG.error(PortMappingUtils.CANNOT_GET_DEV_CONF_LOGMSG, nodeId);
256             return null;
257         }
258         OrgOpenroadmDevice device = deviceObject.get();
259         if (device.getCircuitPacks() == null) {
260             LOG.warn(PortMappingUtils.MISSING_CP_LOGMSG, nodeId, PortMappingUtils.FOUND);
261             return null;
262         }
263         return device;
264     }
265
266     private void getXpdrMaps(OrgOpenroadmDevice device, String nodeId,
267             Map<String, String> lcpMap, Map<String, Mapping> mappingMap) {
268         List<CircuitPacks> circuitPackList = new ArrayList<>(device.nonnullCircuitPacks().values());
269         circuitPackList.sort(Comparator.comparing(CircuitPack::getCircuitPackName));
270         if (device.getXponder() == null) {
271             LOG.warn(PortMappingUtils.XPDR_LIST_IN_CONF_LOGMSG, nodeId, "not found");
272             // Variables to keep track of number of line ports and client ports
273             int line = 1;
274             int client = 1;
275             // TODO the treatment here inside the 2 nested for-loop is very similar to the one
276             //     when device.getXponder() != null. Some code mutualization must be considered.
277             for (CircuitPacks cp : circuitPackList) {
278                 String circuitPackName = cp.getCircuitPackName();
279                 if (cp.getPorts() == null) {
280                     LOG.warn(PortMappingUtils.NO_PORT_ON_CP_LOGMSG, nodeId, PortMappingUtils.FOUND, circuitPackName);
281                     continue;
282                 }
283                 List<Ports> portList = new ArrayList<>(cp.nonnullPorts().values());
284                 portList.sort(Comparator.comparing(Ports::getPortName));
285                 for (Ports port : portList) {
286                     int[] counters = fillXpdrLcpsMaps(line, client, nodeId,
287                         1, XpdrNodeTypes.Tpdr, circuitPackName, port,
288                         circuitPackList, lcpMap, mappingMap);
289                     line = counters[0];
290                     client = counters[1];
291                 }
292             }
293         } else {
294             LOG.info(PortMappingUtils.XPDR_LIST_IN_CONF_LOGMSG, nodeId, PortMappingUtils.FOUND);
295             for (Xponder xponder : device.nonnullXponder().values()) {
296                 // Variables to keep track of number of line ports and client ports
297                 int line = 1;
298                 int client = 1;
299                 Integer xponderNb = xponder.getXpdrNumber().toJava();
300                 XpdrNodeTypes xponderType = xponder.getXpdrType();
301                 for (XpdrPort xpdrPort : xponder.nonnullXpdrPort().values().stream()
302                         .sorted((xp1, xp2) -> xp1.getIndex().compareTo(xp2.getIndex())).collect(Collectors.toList())) {
303                     Ports port = getXpdrPorts(device, xpdrPort, nodeId);
304                     if (port == null) {
305                         continue;
306                     }
307                     int[] counters = fillXpdrLcpsMaps(line, client, nodeId,
308                         xponderNb, xponderType, xpdrPort.getCircuitPackName(), port,
309                         circuitPackList, lcpMap, mappingMap);
310                     line = counters[0];
311                     client = counters[1];
312                 }
313             }
314         }
315     }
316
317     private Ports getXpdrPorts(OrgOpenroadmDevice device, XpdrPort xpdrPort, String nodeId) {
318         String circuitPackName = xpdrPort.getCircuitPackName();
319         String portName = xpdrPort.getPortName();
320         // If there xponder-subtree has missing circuit-packs or ports,
321         // This gives a null-pointer expection,
322         Optional<CircuitPacks> cpList = device.nonnullCircuitPacks().values().stream()
323                 .filter(cp -> cp.getCircuitPackName().equals(circuitPackName)).findFirst();
324         if (cpList.isEmpty()) {
325             LOG.warn(PortMappingUtils.MISSING_CP_LOGMSG + PortMappingUtils.PORTMAPPING_IGNORE_LOGMSG,
326                 nodeId, circuitPackName);
327             return null;
328         }
329         Optional<Ports> portsList = cpList.get().nonnullPorts().values().stream()
330                 .filter(p -> p.getPortName().equals(portName)).findFirst();
331         if (portsList.isEmpty()) {
332             LOG.warn(PortMappingUtils.NO_ASSOC_FOUND_LOGMSG + PortMappingUtils.PORTMAPPING_IGNORE_LOGMSG,
333                 nodeId, portName, circuitPackName, "in the device");
334             return null;
335         }
336         return portsList.get();
337     }
338
339     private List<SwitchingPoolLcp> getSwitchingPoolList(OrgOpenroadmDevice device,
340             Map<String, String> lcpMap, String nodeId) {
341         List<SwitchingPoolLcp> switchingPoolList = new ArrayList<>();
342         for (OduSwitchingPools odp : device.nonnullOduSwitchingPools().values()) {
343             Map<NonBlockingListKey,NonBlockingList> nbMap = new HashMap<>();
344             for (org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.org.openroadm.device.container.org
345                 .openroadm.device.odu.switching.pools.NonBlockingList nbl : odp.nonnullNonBlockingList().values()) {
346                 if (nbl.getPortList() == null) {
347                     continue;
348                 }
349                 List<String> lcpList = new ArrayList<>();
350                 for (PortList item : nbl.nonnullPortList().values()) {
351                     String key = item.getCircuitPackName() + "+" + item.getPortName();
352                     if (!lcpMap.containsKey(key)) {
353                         LOG.error(PortMappingUtils.NO_ASSOC_FOUND_LOGMSG,
354                             nodeId, item.getPortName(), item.getCircuitPackName(), "to a logical connection point");
355                         continue;
356                     }
357                     lcpList.add(lcpMap.get(key));
358                 }
359                 NonBlockingList nonBlockingList = new NonBlockingListBuilder()
360                     .setNblNumber(nbl.getNblNumber())
361                     .setInterconnectBandwidth(nbl.getInterconnectBandwidth())
362                     .setInterconnectBandwidthUnit(nbl.getInterconnectBandwidthUnit())
363                     .setLcpList(lcpList)
364                     .build();
365                 nbMap.put(nonBlockingList.key(), nonBlockingList);
366             }
367             switchingPoolList.add(
368                 new SwitchingPoolLcpBuilder()
369                     .setSwitchingPoolNumber(odp.getSwitchingPoolNumber())
370                     .setSwitchingPoolType(SwitchingPoolTypes.forValue(odp.getSwitchingPoolType().getIntValue()))
371                     .setNonBlockingList(nbMap)
372                     .build());
373         }
374         return switchingPoolList;
375     }
376
377     private boolean checkPartnerPortNotNull(Ports port) {
378         return (port.getPartnerPort() != null
379             && port.getPartnerPort().getCircuitPackName() != null
380             && port.getPartnerPort().getPortName() != null);
381     }
382
383     private boolean checkPartnerPortNoDir(String circuitPackName, Ports port1, Ports port2) {
384         return (checkPartnerPortNotNull(port2)
385             && port2.getPartnerPort().getCircuitPackName().equals(circuitPackName)
386             && port2.getPartnerPort().getPortName().equals(port1.getPortName()));
387     }
388
389     private boolean checkPartnerPort(String circuitPackName, Ports port1, Ports port2) {
390         return checkPartnerPortNoDir(circuitPackName, port1, port2)
391             && Set.of(port1.getPortDirection().getIntValue(), port2.getPortDirection().getIntValue())
392                 .equals(TXRX_SET);
393     }
394
395
396     private HashMap<Integer, List<org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.srg
397             .CircuitPacks>> getSrgCps(String deviceId, Info ordmInfo) {
398         HashMap<Integer, List<org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.srg
399             .CircuitPacks>> cpPerSrg = new HashMap<>();
400         // Get value for max Srg from info subtree, required for iteration
401         // if not present assume to be 20 (temporary)
402         Integer maxSrg = ordmInfo.getMaxSrgs() == null ? 20 : ordmInfo.getMaxSrgs().toJava();
403         for (int srgCounter = 1; srgCounter <= maxSrg; srgCounter++) {
404             List<org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.srg.CircuitPacks> srgCps
405                 = new ArrayList<>();
406             LOG.debug(PortMappingUtils.GETTING_CP_LOGMSG, deviceId, srgCounter);
407             InstanceIdentifier<SharedRiskGroup> srgIID = InstanceIdentifier.create(OrgOpenroadmDevice.class)
408                 .child(SharedRiskGroup.class, new SharedRiskGroupKey(Uint16.valueOf(srgCounter)));
409             Optional<SharedRiskGroup> ordmSrgObject = this.deviceTransactionManager.getDataFromDevice(deviceId,
410                 LogicalDatastoreType.OPERATIONAL, srgIID,
411                 Timeouts.DEVICE_READ_TIMEOUT, Timeouts.DEVICE_READ_TIMEOUT_UNIT);
412             if (ordmSrgObject.isPresent()) {
413                 srgCps.addAll(ordmSrgObject.get().nonnullCircuitPacks().values());
414                 cpPerSrg.put(ordmSrgObject.get().getSrgNumber().toJava(), srgCps);
415             }
416         }
417         LOG.info(PortMappingUtils.DEVICE_HAS_LOGMSG, deviceId, cpPerSrg.size(), "SRG");
418         return cpPerSrg;
419     }
420
421     private boolean createPpPortMapping(String nodeId, Info deviceInfo, List<Mapping> portMapList) {
422         // Creating mapping data for SRG's PP
423         for (Entry<Integer, List<org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.srg.CircuitPacks>>
424                 srgCpEntry : getSrgCps(nodeId, deviceInfo).entrySet()) {
425             List<String> keys = new ArrayList<>();
426             int portIndex = 1;
427             for (org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.srg.CircuitPacks
428                     cp : srgCpEntry.getValue()) {
429                 String circuitPackName = cp.getCircuitPackName();
430                 List<Ports> portList = getPortList(circuitPackName, nodeId);
431                 Collections.sort(portList, new SortPort221ByName());
432                 for (Ports port : portList) {
433                     if (!checkPortQual(port, circuitPackName, nodeId)) {
434                         continue;
435                     }
436                     String currentKey = circuitPackName + "-" + port.getPortName();
437                     if (keys.contains(currentKey)) {
438                         LOG.debug(PortMappingUtils.PORT_ALREADY_HANDLED_LOGMSG + PortMappingUtils.CANNOT_AS_LCP_LOGMSG,
439                             nodeId, port.getPortName(), circuitPackName);
440                         continue;
441                     }
442                     switch (port.getPortDirection()) {
443                         case Bidirectional:
444                             String lcp = createLogicalConnectionPort(port, srgCpEntry.getKey(), portIndex);
445                             LOG.info(PortMappingUtils.ASSOCIATED_LCP_LOGMSG,
446                                 nodeId, port.getPortName(), circuitPackName, lcp);
447                             portMapList.add(createMappingObject(nodeId, port, circuitPackName, lcp));
448                             portIndex++;
449                             keys.add(currentKey);
450                             break;
451                         case Rx:
452                         case Tx:
453                             Ports port2 = getPartnerPort(port, circuitPackName, nodeId);
454                             if (port2 == null) {
455                                 continue;
456                             }
457                             String lcp1 = createLogicalConnectionPort(port, srgCpEntry.getKey(), portIndex);
458                             LOG.info(PortMappingUtils.ASSOCIATED_LCP_LOGMSG,
459                                 nodeId, port.getPortName(), circuitPackName, lcp1);
460                             String lcp2 = createLogicalConnectionPort(port2, srgCpEntry.getKey(),portIndex);
461                             LOG.info(PortMappingUtils.ASSOCIATED_LCP_LOGMSG,
462                                     nodeId, port2.getPortName(), circuitPackName, lcp2);
463                             portMapList.add(createMappingObject(nodeId, port, circuitPackName, lcp1));
464                             portMapList.add(
465                                 createMappingObject(nodeId ,port2, port.getPartnerPort().getCircuitPackName(), lcp2));
466                             portIndex++;
467                             keys.add(currentKey);
468                             keys.add(port.getPartnerPort().getCircuitPackName() + "-" + port2.getPortName());
469                             break;
470                         default:
471                             LOG.error(PortMappingUtils.UNSUPPORTED_DIR_LOGMSG + PortMappingUtils.CANNOT_AS_LCP_LOGMSG,
472                                 nodeId, port.getPortName(), circuitPackName, port.getPortDirection());
473                     }
474                 }
475             }
476         }
477         return true;
478     }
479
480     private Ports getPartnerPort(Ports port, String circuitPackName, String nodeId) {
481         if (!checkPartnerPortNotNull(port)) {
482             LOG.info(PortMappingUtils.NO_VALID_PARTNERPORT_LOGMSG + PortMappingUtils.CANNOT_AS_LCP_LOGMSG,
483                 nodeId, port.getPortName(), circuitPackName);
484             return null;
485         }
486         InstanceIdentifier<Ports> port2ID = InstanceIdentifier.create(OrgOpenroadmDevice.class)
487             .child(CircuitPacks.class, new CircuitPacksKey(port.getPartnerPort().getCircuitPackName()))
488             .child(Ports.class, new PortsKey(port.getPartnerPort().getPortName()));
489         Optional<Ports> port2Object = this.deviceTransactionManager
490             .getDataFromDevice(nodeId, LogicalDatastoreType.OPERATIONAL, port2ID,
491                 Timeouts.DEVICE_READ_TIMEOUT, Timeouts.DEVICE_READ_TIMEOUT_UNIT);
492         if (port2Object.isEmpty()
493                 || port2Object.get().getPortQual().getIntValue() != PortQual.RoadmExternal.getIntValue()) {
494             LOG.error(PortMappingUtils.NOT_CORRECT_PARTNERPORT_LOGMSG + PortMappingUtils.PARTNERPORT_GET_ERROR_LOGMSG,
495                 nodeId, port.getPartnerPort().getPortName(), port.getPartnerPort().getCircuitPackName(),
496                 port.getPortName(), circuitPackName);
497             return null;
498         }
499         Ports port2 = port2Object.get();
500         if (!checkPartnerPort(circuitPackName, port, port2)) {
501             LOG.error(PortMappingUtils.NOT_CORRECT_PARTNERPORT_LOGMSG + PortMappingUtils.PARTNERPORT_CONF_ERROR_LOGMSG,
502                 nodeId, port2.getPortName(), port.getPartnerPort().getCircuitPackName(),
503                 port.getPortName(), circuitPackName);
504             //TODO check if we really needed to increment portIndex in this condition
505             //     if yes this block should not be in getPartnerPort and must move back to createPpPortMapping
506             return null;
507         }
508         return port2;
509     }
510
511     private List<Ports> getPortList(String circuitPackName, String nodeId) {
512         InstanceIdentifier<CircuitPacks> cpIID = InstanceIdentifier.create(OrgOpenroadmDevice.class)
513             .child(CircuitPacks.class, new CircuitPacksKey(circuitPackName));
514         Optional<CircuitPacks> circuitPackObject = this.deviceTransactionManager.getDataFromDevice(nodeId,
515              LogicalDatastoreType.OPERATIONAL, cpIID,
516              Timeouts.DEVICE_READ_TIMEOUT, Timeouts.DEVICE_READ_TIMEOUT_UNIT);
517         if (circuitPackObject.isEmpty()) {
518             LOG.warn(PortMappingUtils.MISSING_CP_LOGMSG + PortMappingUtils.PORTMAPPING_IGNORE_LOGMSG,
519                 nodeId, circuitPackName);
520             return new ArrayList<>();
521         }
522         if (circuitPackObject.get().getPorts() == null) {
523             LOG.warn(PortMappingUtils.NO_PORT_ON_CP_LOGMSG, nodeId, PortMappingUtils.FOUND, circuitPackName);
524             return new ArrayList<>();
525         }
526         return new ArrayList<>(circuitPackObject.get().nonnullPorts().values());
527     }
528
529     private String createLogicalConnectionPort(Ports port, int index, int portIndex) {
530         if (SUFFIX.containsKey(port.getPortDirection())) {
531             return String.join("-", "SRG" + index, "PP" + portIndex, SUFFIX.get(port.getPortDirection()));
532         }
533         LOG.error(PortMappingUtils.UNSUPPORTED_DIR_LOGMSG,
534             "createLogicalConnectionPort", port, "SRG" + index + "-PP" + portIndex, port.getPortDirection());
535         return null;
536     }
537
538     private Map<Integer, Degree> getDegreesMap(String deviceId, Info ordmInfo) {
539         Map<Integer, Degree> degrees = new HashMap<>();
540
541         // Get value for max degree from info subtree, required for iteration
542         // if not present assume to be 20 (temporary)
543         Integer maxDegree = ordmInfo.getMaxDegrees() == null ? 20 : ordmInfo.getMaxDegrees().toJava();
544
545         for (int degreeCounter = 1; degreeCounter <= maxDegree; degreeCounter++) {
546             LOG.debug(PortMappingUtils.GETTING_CONPORT_LOGMSG, deviceId, degreeCounter);
547             InstanceIdentifier<Degree> deviceIID = InstanceIdentifier.create(OrgOpenroadmDevice.class)
548                 .child(Degree.class, new DegreeKey(Uint16.valueOf(degreeCounter)));
549             Optional<Degree> ordmDegreeObject = this.deviceTransactionManager.getDataFromDevice(deviceId,
550                 LogicalDatastoreType.OPERATIONAL, deviceIID,
551                 Timeouts.DEVICE_READ_TIMEOUT, Timeouts.DEVICE_READ_TIMEOUT_UNIT);
552             if (ordmDegreeObject.isPresent()) {
553                 degrees.put(degreeCounter, ordmDegreeObject.get());
554             }
555         }
556         LOG.info(PortMappingUtils.DEVICE_HAS_LOGMSG,
557             deviceId, degrees.size(), degrees.size() <= 1 ? "degree" : "degrees");
558         return degrees;
559     }
560
561     private Map<Integer, List<ConnectionPorts>> getPerDegreePorts(String deviceId, Info ordmInfo) {
562         Map<Integer, List<ConnectionPorts>> conPortMap = new HashMap<>();
563         getDegreesMap(deviceId, ordmInfo).forEach(
564             (index, degree) -> conPortMap.put(index, new ArrayList<>(degree.nonnullConnectionPorts().values())));
565         return conPortMap;
566     }
567
568     private List<SharedRiskGroup> getSrgs(String deviceId, Info ordmInfo) {
569         List<SharedRiskGroup> srgs = new ArrayList<>();
570
571         // Get value for max Srg from info subtree, required for iteration
572         // if not present assume to be 20 (temporary)
573         Integer maxSrg = ordmInfo.getMaxSrgs() == null ? 20 : ordmInfo.getMaxSrgs().toJava();
574         for (int srgCounter = 1; srgCounter <= maxSrg; srgCounter++) {
575             InstanceIdentifier<SharedRiskGroup> srgIID = InstanceIdentifier.create(OrgOpenroadmDevice.class)
576                 .child(SharedRiskGroup.class, new SharedRiskGroupKey(Uint16.valueOf(srgCounter)));
577             Optional<SharedRiskGroup> ordmSrgObject = this.deviceTransactionManager.getDataFromDevice(deviceId,
578                 LogicalDatastoreType.OPERATIONAL, srgIID,
579                 Timeouts.DEVICE_READ_TIMEOUT, Timeouts.DEVICE_READ_TIMEOUT_UNIT);
580             if (ordmSrgObject.isPresent()) {
581                 srgs.add(ordmSrgObject.get());
582
583             }
584         }
585         return srgs;
586     }
587
588     private Map<String, String> getEthInterfaceList(String nodeId) {
589         LOG.info(PortMappingUtils.GETTING_ETH_LIST_LOGMSG, nodeId);
590         InstanceIdentifier<Protocols> protocoliid = InstanceIdentifier.create(OrgOpenroadmDevice.class)
591             .child(Protocols.class);
592         Optional<Protocols> protocolObject = this.deviceTransactionManager.getDataFromDevice(nodeId,
593             LogicalDatastoreType.OPERATIONAL, protocoliid, Timeouts.DEVICE_READ_TIMEOUT,
594             Timeouts.DEVICE_READ_TIMEOUT_UNIT);
595         if (protocolObject.isEmpty() || protocolObject.get().augmentation(Protocols1.class).getLldp() == null) {
596             LOG.warn(PortMappingUtils.PROCESSING_DONE_LOGMSG, nodeId, PortMappingUtils.CANNOT_GET_LLDP_CONF_LOGMSG);
597             return new HashMap<>();
598         }
599         Map<String, String> cpToInterfaceMap = new HashMap<>();
600         Lldp lldp = protocolObject.get().augmentation(Protocols1.class).getLldp();
601         for (PortConfig portConfig : lldp.nonnullPortConfig().values()) {
602             if (!portConfig.getAdminStatus().equals(PortConfig.AdminStatus.Txandrx)) {
603                 continue;
604             }
605             InstanceIdentifier<Interface> interfaceIID = InstanceIdentifier.create(OrgOpenroadmDevice.class)
606                 .child(Interface.class, new InterfaceKey(portConfig.getIfName()));
607             Optional<Interface> interfaceObject = this.deviceTransactionManager.getDataFromDevice(nodeId,
608                 LogicalDatastoreType.OPERATIONAL, interfaceIID, Timeouts.DEVICE_READ_TIMEOUT,
609                 Timeouts.DEVICE_READ_TIMEOUT_UNIT);
610             if (interfaceObject.isEmpty() || interfaceObject.get().getSupportingCircuitPackName() == null) {
611                 continue;
612             }
613             String supportingCircuitPackName = interfaceObject.get().getSupportingCircuitPackName();
614             cpToInterfaceMap.put(supportingCircuitPackName, portConfig.getIfName());
615             InstanceIdentifier<CircuitPacks> circuitPacksIID = InstanceIdentifier.create(OrgOpenroadmDevice.class)
616                 .child(CircuitPacks.class, new CircuitPacksKey(supportingCircuitPackName));
617             Optional<CircuitPacks> circuitPackObject = this.deviceTransactionManager.getDataFromDevice(
618                 nodeId, LogicalDatastoreType.OPERATIONAL, circuitPacksIID, Timeouts.DEVICE_READ_TIMEOUT,
619                 Timeouts.DEVICE_READ_TIMEOUT_UNIT);
620             if (circuitPackObject.isEmpty() || circuitPackObject.get().getParentCircuitPack() == null) {
621                 continue;
622             }
623             cpToInterfaceMap.put(circuitPackObject.get().getParentCircuitPack().getCircuitPackName(),
624                 portConfig.getIfName());
625         }
626         LOG.info(PortMappingUtils.PROCESSING_DONE_LOGMSG, nodeId, " - success");
627         return cpToInterfaceMap;
628     }
629
630     private List<CpToDegree> getCpToDegreeList(Map<Integer, Degree> degrees, Map<String, String> interfaceList) {
631         List<CpToDegree> cpToDegreeList = new ArrayList<>();
632         for (Degree degree : degrees.values()) {
633             cpToDegreeList.addAll(degree.nonnullCircuitPacks().values().stream()
634                 .map(cp -> createCpToDegreeObject(cp.getCircuitPackName(),
635                     degree.getDegreeNumber().toString(), interfaceList))
636                 .collect(Collectors.toList()));
637         }
638         return cpToDegreeList;
639     }
640
641     private Map<McCapabilitiesKey, McCapabilities> getMcCapabilities(Map<Integer, Degree> degrees,
642             List<SharedRiskGroup> srgs, String nodeId) {
643         LOG.info(PortMappingUtils.GETTING_MC_CAPA_LOGMSG , nodeId, "degrees");
644         Map<McCapabilitiesKey, McCapabilities> mcCapabilities = degrees.values().stream()
645             .map(degree -> createMcCapDegreeObject(degree, nodeId))
646             .collect(Collectors.toMap(McCapabilities::key, mcc -> mcc));
647         // Add the SRG mc-capabilities
648         LOG.info(PortMappingUtils.GETTING_MC_CAPA_LOGMSG , nodeId, "SRGs");
649         mcCapabilities.putAll(srgs.stream().map(srg -> createMcCapSrgObject(srg, nodeId))
650             .collect(Collectors.toMap(McCapabilities::key, mcCapabilities2 -> mcCapabilities2)));
651         return mcCapabilities;
652     }
653
654     private boolean postPortMapping(String nodeId, NodeInfo nodeInfo, List<Mapping> portMapList,
655             List<CpToDegree> cp2DegreeList, List<SwitchingPoolLcp> splList,
656             Map<McCapabilitiesKey, McCapabilities> mcCapabilities) {
657         NodesBuilder nodesBldr = new NodesBuilder().withKey(new NodesKey(nodeId)).setNodeId(nodeId);
658         if (nodeInfo != null) {
659             nodesBldr.setNodeInfo(nodeInfo);
660         }
661         if (portMapList != null) {
662             Map<MappingKey, Mapping> mappingMap = new HashMap<>();
663             // No element in the list below should be null at this stage
664             for (Mapping mapping: portMapList) {
665                 mappingMap.put(mapping.key(), mapping);
666             }
667             nodesBldr.setMapping(mappingMap);
668         }
669         if (cp2DegreeList != null) {
670             Map<CpToDegreeKey, CpToDegree> cpToDegreeMap = new HashMap<>();
671             // No element in the list below should be null at this stage
672             for (CpToDegree cp2Degree: cp2DegreeList) {
673                 cpToDegreeMap.put(cp2Degree.key(), cp2Degree);
674             }
675             nodesBldr.setCpToDegree(cpToDegreeMap);
676         }
677
678         if (splList != null) {
679             Map<SwitchingPoolLcpKey,SwitchingPoolLcp> splMap = new HashMap<>();
680             // No element in the list below should be null at this stage
681             for (SwitchingPoolLcp spl: splList) {
682                 splMap.put(spl.key(), spl);
683             }
684             nodesBldr.setSwitchingPoolLcp(splMap);
685         }
686         if (mcCapabilities != null) {
687             nodesBldr.setMcCapabilities(mcCapabilities);
688         }
689         Map<NodesKey,Nodes> nodesList = new HashMap<>();
690         Nodes nodes = nodesBldr.build();
691         nodesList.put(nodes.key(),nodes);
692
693         Network network = new NetworkBuilder().setNodes(nodesList).build();
694         final WriteTransaction writeTransaction = dataBroker.newWriteOnlyTransaction();
695         InstanceIdentifier<Network> nodesIID = InstanceIdentifier.builder(Network.class).build();
696         writeTransaction.merge(LogicalDatastoreType.CONFIGURATION, nodesIID, network);
697         FluentFuture<? extends @NonNull CommitInfo> commit = writeTransaction.commit();
698         try {
699             commit.get();
700             return true;
701         } catch (InterruptedException | ExecutionException e) {
702             LOG.warn(PortMappingUtils.PORTMAPPING_POST_FAIL_LOGMSG, nodeId, network, e);
703             return false;
704         }
705     }
706
707     private CpToDegree createCpToDegreeObject(String circuitPackName, String degreeNumber,
708             Map<String, String> interfaceList) {
709         return new CpToDegreeBuilder()
710             .withKey(new CpToDegreeKey(circuitPackName))
711             .setCircuitPackName(circuitPackName)
712             .setDegreeNumber(Uint32.valueOf(degreeNumber))
713             .setInterfaceName(interfaceList.get(circuitPackName)).build();
714     }
715
716     private McCapabilities createMcCapDegreeObject(Degree degree, String nodeId) {
717         String mcNodeName =  PortMappingUtils.degreeTtpNodeName(degree.getDegreeNumber().toString(), null);
718         McCapabilitiesBuilder mcCapabilitiesBuilder = new McCapabilitiesBuilder()
719             .withKey(new McCapabilitiesKey(mcNodeName))
720             .setMcNodeName(mcNodeName);
721         if (degree.getMcCapabilities() == null) {
722             LOG.warn(PortMappingUtils.NO_MC_LOGMSG, nodeId, "degree", degree.getDegreeNumber());
723             mcCapabilitiesBuilder
724                 .setCenterFreqGranularity(FrequencyGHz.getDefaultInstance("50"))
725                 .setSlotWidthGranularity(FrequencyGHz.getDefaultInstance("50"));
726         } else {
727             mcCapabilitiesBuilder
728                 .setCenterFreqGranularity(FrequencyGHz.getDefaultInstance(degree.getMcCapabilities()
729                     .getCenterFreqGranularity().getValue().toString()))
730                 .setSlotWidthGranularity(FrequencyGHz.getDefaultInstance(degree.getMcCapabilities()
731                     .getSlotWidthGranularity().getValue().toString()));
732         }
733         return mcCapabilitiesBuilder.build();
734     }
735
736     private McCapabilities createMcCapSrgObject(SharedRiskGroup srg, String nodeId) {
737         String mcNodeName = "SRG" + srg.getSrgNumber().toString() + "-PP";
738         McCapabilitiesBuilder mcCapabilitiesBuilder = new McCapabilitiesBuilder()
739             .withKey(new McCapabilitiesKey(mcNodeName))
740             .setMcNodeName(mcNodeName);
741         if (srg.getMcCapabilities() == null) {
742             LOG.warn(PortMappingUtils.NO_MC_LOGMSG, nodeId, "SRG", srg.getSrgNumber());
743             mcCapabilitiesBuilder
744                 .setCenterFreqGranularity(FrequencyGHz.getDefaultInstance("50"))
745                 .setSlotWidthGranularity(FrequencyGHz.getDefaultInstance("50"));
746         } else {
747             mcCapabilitiesBuilder
748                 .setCenterFreqGranularity(FrequencyGHz.getDefaultInstance(srg.getMcCapabilities()
749                     .getCenterFreqGranularity().getValue().toString()))
750                 .setSlotWidthGranularity(FrequencyGHz.getDefaultInstance(srg.getMcCapabilities()
751                     .getSlotWidthGranularity().getValue().toString()));
752         }
753         return mcCapabilitiesBuilder.build();
754     }
755
756     private Mapping createMappingObject(String nodeId, Ports port, String circuitPackName,
757             String logicalConnectionPoint) {
758         MappingBuilder mpBldr = new MappingBuilder()
759                 .withKey(new MappingKey(logicalConnectionPoint))
760                 .setLogicalConnectionPoint(logicalConnectionPoint)
761                 .setSupportingCircuitPackName(circuitPackName)
762                 .setSupportingPort(port.getPortName())
763                 .setPortDirection(port.getPortDirection().getName());
764         if (port.getAdministrativeState() != null) {
765             mpBldr.setPortAdminState(port.getAdministrativeState().name());
766         }
767         if (port.getOperationalState() != null) {
768             mpBldr.setPortOperState(port.getOperationalState().name());
769         }
770
771         if ((port.getInterfaces() == null)
772             || (!logicalConnectionPoint.contains(StringConstants.TTP_TOKEN)
773                 && !logicalConnectionPoint.contains(StringConstants.NETWORK_TOKEN))) {
774             return mpBldr.build();
775         }
776         mpBldr = updateMappingInterfaces(nodeId, mpBldr, port);
777         return mpBldr.build();
778     }
779
780     private Mapping updateMappingObject(String nodeId, Ports port, Mapping oldmapping) {
781         MappingBuilder mpBldr = new MappingBuilder(oldmapping);
782         updateMappingStates(mpBldr, port, oldmapping);
783         if (port.getInterfaces() == null) {
784             return mpBldr.build();
785         }
786         // Get interfaces provisioned on the port
787         mpBldr = updateMappingInterfaces(nodeId, mpBldr, port);
788         return mpBldr.build();
789     }
790
791     private MappingBuilder updateMappingStates(MappingBuilder mpBldr, Ports port, Mapping oldmapping) {
792         if (port.getAdministrativeState() != null
793             && !port.getAdministrativeState().getName().equals(oldmapping.getPortAdminState())) {
794             mpBldr.setPortAdminState(port.getAdministrativeState().name());
795         }
796         if (port.getOperationalState() != null
797             && !port.getOperationalState().getName().equals(oldmapping.getPortOperState())) {
798             mpBldr.setPortOperState(port.getOperationalState().name());
799         }
800         return mpBldr;
801     }
802
803     private MappingBuilder updateMappingInterfaces(String nodeId, MappingBuilder mpBldr, Ports port) {
804         mpBldr.setSupportingOtu4(null)
805             .setSupportingOdu4(null);
806         for (Interfaces interfaces : port.getInterfaces()) {
807             Optional<Interface> openRoadmInterface = getInterfaceFromDevice(nodeId,
808                 interfaces.getInterfaceName());
809             if (openRoadmInterface.isEmpty()) {
810                 LOG.warn(PortMappingUtils.INTF_ISSUE_LOGMSG,
811                     nodeId, interfaces.getInterfaceName() + "- empty interface");
812                 continue;
813             }
814             LOG.debug(PortMappingUtils.GOT_INTF_LOGMSG,
815                 nodeId, openRoadmInterface.get().getName(), openRoadmInterface.get().getType());
816             Class<? extends InterfaceType> interfaceType
817                 = (Class<? extends InterfaceType>) openRoadmInterface.get().getType();
818             // Check if interface type is OMS or OTS
819             if (interfaceType.equals(OpenROADMOpticalMultiplex.class)) {
820                 mpBldr.setSupportingOms(interfaces.getInterfaceName());
821             }
822             if (interfaceType.equals(OpticalTransport.class)) {
823                 mpBldr.setSupportingOts(interfaces.getInterfaceName());
824             }
825             if (interfaceType.equals(OtnOtu.class)) {
826                 mpBldr.setSupportingOtu4(interfaces.getInterfaceName());
827             }
828             if (interfaceType.equals(OtnOdu.class)) {
829                 mpBldr.setSupportingOdu4(interfaces.getInterfaceName());
830             }
831             if (interfaceType.equals(EthernetCsmacd.class)) {
832                 mpBldr.setSupportingEthernet(interfaces.getInterfaceName());
833             }
834         }
835         return mpBldr;
836     }
837
838     private Mapping createXpdrMappingObject(String nodeId, Ports port, String circuitPackName,
839             String logicalConnectionPoint, String partnerLcp, Mapping mapping, String connectionMapLcp,
840             XpdrNodeTypes xpdrNodeType) {
841         if (mapping != null && connectionMapLcp != null) {
842             // update existing mapping
843             return new MappingBuilder(mapping).setConnectionMapLcp(connectionMapLcp).build();
844         }
845         return createNewXpdrMapping(nodeId, port, circuitPackName, logicalConnectionPoint, partnerLcp, xpdrNodeType);
846     }
847
848     private Mapping createNewXpdrMapping(String nodeId, Ports port, String circuitPackName,
849             String logicalConnectionPoint, String partnerLcp, XpdrNodeTypes xpdrNodeType) {
850         List<Class<? extends org.opendaylight.yang.gen.v1.http.org.openroadm.port.types.rev201211
851             .SupportedIfCapability>> supportedIntf = new ArrayList<>();
852         for (String sup: getSupIfCapList(port)) {
853             if (MappingUtilsImpl.convertSupIfCapa(sup) != null) {
854                 supportedIntf.add(MappingUtilsImpl.convertSupIfCapa(sup));
855             }
856         }
857         MappingBuilder mpBldr = new MappingBuilder()
858                 .withKey(new MappingKey(logicalConnectionPoint))
859                 .setLogicalConnectionPoint(logicalConnectionPoint)
860                 .setSupportingCircuitPackName(circuitPackName)
861                 .setSupportingPort(port.getPortName())
862                 .setPortDirection(port.getPortDirection().getName())
863                 .setLcpHashVal(PortMappingUtils.fnv1size64(nodeId + "-" + logicalConnectionPoint))
864                 .setSupportedInterfaceCapability(supportedIntf);
865         if (port.getPortQual() != null) {
866             mpBldr.setPortQual(port.getPortQual().getName());
867         }
868         if (xpdrNodeType != null) {
869             mpBldr.setXponderType(
870                 org.opendaylight.yang.gen.v1.http.org.openroadm.device.types.rev191129.XpdrNodeTypes.forValue(
871                     xpdrNodeType.getIntValue()));
872         }
873         if (partnerLcp != null) {
874             mpBldr.setPartnerLcp(partnerLcp);
875         }
876         if (port.getAdministrativeState() != null) {
877             mpBldr.setPortAdminState(port.getAdministrativeState().name());
878         }
879         if (port.getOperationalState() != null) {
880             mpBldr.setPortOperState(port.getOperationalState().name());
881         }
882         return mpBldr.build();
883     }
884
885     private List<String> getSupIfCapList(Ports port) {
886         List<Class<? extends SupportedIfCapability>> supIfCapClassList = port.getSupportedInterfaceCapability();
887         if (supIfCapClassList != null) {
888             return supIfCapClassList
889                     .stream().map(e -> e.getSimpleName())
890                     .collect(Collectors.toList());
891         }
892         Ports1 ports1 = port.augmentation(Ports1.class);
893         if (ports1 != null && ports1.getPortCapabilities() != null) {
894             return ports1.getPortCapabilities().getSupportedInterfaceCapability()
895                     .values().stream().map(e -> e.getIfCapType().getSimpleName())
896                     .collect(Collectors.toList());
897         }
898         return Collections.emptyList();
899     }
900
901     private Ports getPort2(Ports port, String nodeId, String circuitPackName, StringBuilder circuitPackName2,
902             //circuitPackName2 will be updated by reference contrary to circuitPackName
903             List<CircuitPacks> circuitPackList, Map<String, String> lcpMap) {
904         if (!checkPartnerPortNotNull(port)) {
905             LOG.warn(PortMappingUtils.NO_VALID_PARTNERPORT_LOGMSG, nodeId, port.getPortName(), circuitPackName);
906             return null;
907         }
908         if (lcpMap.containsKey(circuitPackName + '+' + port.getPortName())) {
909             return null;
910         }
911         Optional<CircuitPacks> cpOpt = circuitPackList.stream()
912             .filter(
913                 cP -> cP.getCircuitPackName().equals(port.getPartnerPort().getCircuitPackName()))
914             .findFirst();
915         if (cpOpt.isEmpty()) {
916             LOG.error(PortMappingUtils.MISSING_CP_LOGMSG, nodeId, port.getPartnerPort().getCircuitPackName());
917             return null;
918         }
919         Optional<Ports> poOpt = cpOpt.get().nonnullPorts().values().stream()
920             .filter(p -> p.getPortName().equals(port.getPartnerPort().getPortName()))
921             .findFirst();
922         if (poOpt.isEmpty()) {
923             LOG.error(PortMappingUtils.NO_PORT_ON_CP_LOGMSG,
924                 nodeId, port.getPartnerPort().getPortName(), port.getPartnerPort().getCircuitPackName());
925             return null;
926         }
927         Ports port2 = poOpt.get();
928         circuitPackName2.append(cpOpt.get().getCircuitPackName());
929         if (!checkPartnerPort(circuitPackName, port, port2)) {
930             LOG.error(PortMappingUtils.NOT_CORRECT_PARTNERPORT_LOGMSG,
931                 nodeId, port2.getPortName(), circuitPackName2, port.getPortName(), circuitPackName);
932             return null;
933         }
934         return port2;
935     }
936
937
938     private void putXpdrLcpsInMaps(int line, String nodeId,
939             Integer xponderNb, XpdrNodeTypes xponderType,
940             String circuitPackName, String circuitPackName2, Ports port, Ports port2,
941             Map<String, String> lcpMap, Map<String, Mapping> mappingMap) {
942         String lcp1 =
943             PortMappingUtils.createXpdrLogicalConnectionPort(xponderNb, line, StringConstants.NETWORK_TOKEN);
944         if (lcpMap.containsKey(lcp1)) {
945             LOG.warn(PortMappingUtils.UNABLE_MAPPING_LOGMSG, nodeId, "add", lcp1 + " - already exist");
946             return;
947         }
948         String lcp2 =
949             PortMappingUtils.createXpdrLogicalConnectionPort(xponderNb, line + 1, StringConstants.NETWORK_TOKEN);
950         if (lcpMap.containsKey(lcp2)) {
951             LOG.warn(PortMappingUtils.UNABLE_MAPPING_LOGMSG, nodeId, "add", lcp2 + " - already exist");
952             return;
953         }
954         lcpMap.put(circuitPackName + '+' + port.getPortName(), lcp1);
955         lcpMap.put(circuitPackName2 + '+' + port2.getPortName(), lcp2);
956         mappingMap.put(lcp1,
957                 createXpdrMappingObject(nodeId, port, circuitPackName, lcp1, lcp2, null, null, xponderType));
958         mappingMap.put(lcp2,
959                 createXpdrMappingObject(nodeId, port2, circuitPackName2, lcp2, lcp1, null, null, xponderType));
960         return;
961     }
962
963     private int[] fillXpdrLcpsMaps(int line, int client, String nodeId,
964             Integer xponderNb, XpdrNodeTypes xponderType,
965             String circuitPackName,  Ports port,
966             List<CircuitPacks> circuitPackList, Map<String, String> lcpMap, Map<String, Mapping> mappingMap) {
967         if (port.getPortQual() == null) {
968             LOG.warn(PortMappingUtils.PORTQUAL_LOGMSG, nodeId, port.getPortName(), circuitPackName, "not found");
969             return new int[] {line, client};
970         }
971
972         switch (port.getPortQual()) {
973
974             case XpdrClient:
975             case SwitchClient:
976                 String lcp0 =
977                     PortMappingUtils.createXpdrLogicalConnectionPort(xponderNb, client, StringConstants.CLIENT_TOKEN);
978                 lcpMap.put(circuitPackName + '+' + port.getPortName(), lcp0);
979                 mappingMap.put(lcp0,
980                     createXpdrMappingObject(nodeId, port, circuitPackName, lcp0, null, null, null, xponderType));
981                 client++;
982                 break;
983
984             case XpdrNetwork:
985             case SwitchNetwork:
986                 line = fillXpdrNetworkLcpsMaps(line, nodeId,
987                         xponderNb, xponderType,
988                         circuitPackName,  port,
989                         circuitPackList,  lcpMap, mappingMap);
990                 break;
991
992             default:
993                 LOG.error(PortMappingUtils.PORTQUAL_LOGMSG,
994                     nodeId, port.getPortName(), circuitPackName, port.getPortQual() + " not supported");
995         }
996         return new int[] {line, client};
997     }
998
999     private int fillXpdrNetworkLcpsMaps(int line, String nodeId,
1000             Integer xponderNb, XpdrNodeTypes xponderType,
1001             String circuitPackName,  Ports port,
1002             List<CircuitPacks> circuitPackList, Map<String, String> lcpMap, Map<String, Mapping> mappingMap) {
1003
1004         switch (port.getPortDirection()) {
1005
1006             case Bidirectional:
1007                 String lcp =
1008                     PortMappingUtils.createXpdrLogicalConnectionPort(xponderNb, line, StringConstants.NETWORK_TOKEN);
1009                 lcpMap.put(circuitPackName + '+' + port.getPortName(), lcp);
1010                 mappingMap.put(lcp,
1011                     createXpdrMappingObject(nodeId, port, circuitPackName, lcp, null, null, null, xponderType));
1012                 line++;
1013                 break;
1014
1015             case Rx:
1016             case Tx:
1017                 StringBuilder circuitPackName2 = new StringBuilder();
1018                 Ports port2 = getPort2(port, nodeId, circuitPackName, circuitPackName2,
1019                         circuitPackList, lcpMap);
1020
1021                 if (port2 == null) {
1022                      //key already present or an error occured and was logged
1023                     return line;
1024                 }
1025
1026                 putXpdrLcpsInMaps(line, nodeId, xponderNb, xponderType,
1027                         circuitPackName, circuitPackName2.toString(), port, port2,
1028                         lcpMap, mappingMap);
1029                 line += 2;
1030                 break;
1031
1032             default:
1033                 LOG.error(PortMappingUtils.UNSUPPORTED_DIR_LOGMSG,
1034                     nodeId, port.getPortName(), circuitPackName, port.getPortDirection());
1035         }
1036
1037         return line;
1038     }
1039
1040     private boolean createMcCapabilitiesList(String nodeId, Info deviceInfo,
1041             Map<McCapabilitiesKey, McCapabilities> mcCapabilitiesMap) {
1042         Map<Integer, Degree> degrees = getDegreesMap(nodeId, deviceInfo);
1043         List<SharedRiskGroup> srgs = getSrgs(nodeId, deviceInfo);
1044         mcCapabilitiesMap.putAll(getMcCapabilities(degrees, srgs, nodeId));
1045         return true;
1046     }
1047
1048     private boolean createTtpPortMapping(String nodeId, Info deviceInfo, List<Mapping> portMapList) {
1049         // Creating mapping data for degree TTP's
1050         Map<Integer, Degree> degrees = getDegreesMap(nodeId, deviceInfo);
1051         Map<String, String> interfaceList = getEthInterfaceList(nodeId);
1052         List<CpToDegree> cpToDegreeList = getCpToDegreeList(degrees, interfaceList);
1053         LOG.info(PortMappingUtils.MAP_LOOKS_LOGMSG, nodeId, interfaceList);
1054         postPortMapping(nodeId, null, null, cpToDegreeList, null, null);
1055
1056         for (Entry<Integer, List<ConnectionPorts>> cpMapEntry : getPerDegreePorts(nodeId, deviceInfo).entrySet()) {
1057             List<ConnectionPorts> cpMapValue = cpMapEntry.getValue();
1058             ConnectionPorts cp1 = cpMapValue.get(0);
1059             String cp1Name = cp1.getCircuitPackName();
1060             switch (cpMapValue.size()) {
1061                 case 1:
1062                     // port is bidirectional
1063                     Ports port = getTtpPort(cp1, cp1Name, nodeId);
1064                     if (port == null) {
1065                         return false;
1066                     }
1067                     if (!checkTtpPort(port, cp1Name, nodeId, true)) {
1068                         continue;
1069                     }
1070                     String logicalConnectionPoint =
1071                             PortMappingUtils.degreeTtpNodeName(cpMapEntry.getKey().toString(), "TXRX");
1072                     LOG.info(PortMappingUtils.ASSOCIATED_LCP_LOGMSG,
1073                         nodeId, port.getPortName(), cp1Name, logicalConnectionPoint);
1074                     portMapList.add(createMappingObject(nodeId, port, cp1Name, logicalConnectionPoint));
1075                     break;
1076                 case 2:
1077                     // ports are unidirectionals
1078                     Ports port1 = getTtpPort(cp1, cp1Name, nodeId);
1079                     if (port1 == null) {
1080                         return false;
1081                     }
1082                     ConnectionPorts cp2 = cpMapValue.get(1);
1083                     String cp2Name = cp2.getCircuitPackName();
1084                     Ports port2 = getTtpPort(cp2, cp2Name, nodeId);
1085                     if (port2 == null) {
1086                         return false;
1087                     }
1088                     if (!checkTtpPortsUnidir(port1, port2, cp1Name, cp2Name, nodeId)) {
1089                         continue;
1090                     }
1091                     String logicalConnectionPoint1 = PortMappingUtils.degreeTtpNodeName(cpMapEntry.getKey().toString(),
1092                             port1.getPortDirection().getName().toUpperCase(Locale.getDefault()));
1093                     LOG.info(PortMappingUtils.ASSOCIATED_LCP_LOGMSG,
1094                         nodeId, port1.getPortName(), cp1Name, logicalConnectionPoint1);
1095                     portMapList.add(createMappingObject(nodeId, port1, cp1Name, logicalConnectionPoint1));
1096                     String logicalConnectionPoint2 = PortMappingUtils.degreeTtpNodeName(cpMapEntry.getKey().toString(),
1097                             port2.getPortDirection().getName().toUpperCase(Locale.getDefault()));
1098                     LOG.info(PortMappingUtils.ASSOCIATED_LCP_LOGMSG,
1099                         nodeId, port2.getPortName(), cp2Name, logicalConnectionPoint2);
1100                     portMapList.add(createMappingObject(nodeId, port2, cp2Name, logicalConnectionPoint2));
1101                     break;
1102                 default:
1103                     LOG.error(PortMappingUtils.NOT_CORRECT_CONPORT_LOGMSG, nodeId, cpMapEntry.getKey());
1104                     continue;
1105                     //TODO should it be continue or return false ?
1106             }
1107         }
1108         return true;
1109     }
1110
1111     private Ports getTtpPort(ConnectionPorts cp, String cpName, String nodeId) {
1112         InstanceIdentifier<Ports> portID = InstanceIdentifier.create(OrgOpenroadmDevice.class)
1113             .child(CircuitPacks.class, new CircuitPacksKey(cpName))
1114             .child(Ports.class, new PortsKey(cp.getPortName()));
1115         LOG.debug(PortMappingUtils.FETCH_CONNECTIONPORT_LOGMSG, nodeId, cp.getPortName(), cpName);
1116         Optional<Ports> portObject = this.deviceTransactionManager.getDataFromDevice(nodeId,
1117             LogicalDatastoreType.OPERATIONAL, portID, Timeouts.DEVICE_READ_TIMEOUT,
1118             Timeouts.DEVICE_READ_TIMEOUT_UNIT);
1119         if (portObject.isEmpty()) {
1120             LOG.error(PortMappingUtils.NO_PORT_ON_CP_LOGMSG, nodeId, cp.getPortName(), cpName);
1121             return null;
1122         }
1123         return portObject.get();
1124     }
1125
1126     private boolean checkPortQual(Ports port, String cpName, String nodeId) {
1127         if (port.getPortQual() == null) {
1128             return false;
1129         }
1130         if (PortQual.RoadmExternal.getIntValue() != port.getPortQual().getIntValue()) {
1131             //used to be LOG.error when called from createTtpPortMapping
1132             LOG.debug(PortMappingUtils.PORT_NOT_RDMEXT_LOGMSG + PortMappingUtils.CANNOT_AS_LCP_LOGMSG,
1133                 nodeId, port.getPortName(), cpName);
1134             return false;
1135         }
1136         return true;
1137     }
1138
1139     private boolean checkTtpPort(Ports port, String cpName, String nodeId, boolean bidirectional) {
1140         if (!checkPortQual(port, cpName, nodeId)) {
1141             return false;
1142         }
1143         if (Direction.Bidirectional.getIntValue() == port.getPortDirection().getIntValue() ^ bidirectional) {
1144         // (a ^ b) makes more sense than (!a && b) here since it can also work for unidirectional links
1145             LOG.error(PortMappingUtils.PORTDIR_ERROR_LOGMSG + PortMappingUtils.CANNOT_AS_LCP_LOGMSG,
1146                 nodeId, port.getPortName(), cpName);
1147             return false;
1148         }
1149         return true;
1150     }
1151
1152     private boolean checkTtpPortsUnidir(Ports port1, Ports port2, String cp1Name, String cp2Name, String nodeId) {
1153         if (!checkTtpPort(port1, cp1Name, nodeId, false)) {
1154             return false;
1155         }
1156         if (!checkTtpPort(port2, cp2Name, nodeId, false)) {
1157             return false;
1158         }
1159         if (!checkPartnerPort(cp1Name, port1, port2)) {
1160             LOG.error(PortMappingUtils.NOT_CORRECT_PARTNERPORT_LOGMSG,
1161                 nodeId, port2.getPortName(), cp2Name, port1.getPortName(), cp1Name);
1162             return false;
1163         }
1164         // Directions checks are the same for cp1 and cp2, no need to check them twice.
1165         if (!checkPartnerPortNoDir(cp2Name, port2, port1)) {
1166             LOG.error(PortMappingUtils.NOT_CORRECT_PARTNERPORT_LOGMSG,
1167                 nodeId, port1.getPortName(), cp1Name, port2.getPortName(), cp2Name);
1168             return false;
1169         }
1170         return true;
1171     }
1172
1173     private NodeInfo createNodeInfo(Info deviceInfo) {
1174         if (deviceInfo.getNodeType() == null) {
1175             // TODO make mandatory in yang
1176             LOG.error(PortMappingUtils.NODE_TYPE_LOGMSG, deviceInfo.getNodeId(), "field missing");
1177             return null;
1178         }
1179         NodeInfoBuilder nodeInfoBldr = new NodeInfoBuilder()
1180                 .setOpenroadmVersion(OpenroadmNodeVersion._221)
1181                 .setNodeClli(
1182                     deviceInfo.getClli() == null || deviceInfo.getClli().isEmpty()
1183                         ? "defaultCLLI"
1184                         : deviceInfo.getClli())
1185                 .setNodeType(NodeTypes.forValue(deviceInfo.getNodeType().getIntValue()));
1186         if (deviceInfo.getModel() != null) {
1187             nodeInfoBldr.setNodeModel(deviceInfo.getModel());
1188         }
1189         if (deviceInfo.getVendor() != null) {
1190             nodeInfoBldr.setNodeVendor(deviceInfo.getVendor());
1191         }
1192         if (deviceInfo.getIpAddress() != null) {
1193             nodeInfoBldr.setNodeIpAddress(deviceInfo.getIpAddress());
1194         }
1195         return nodeInfoBldr.build();
1196     }
1197
1198     private Optional<Interface> getInterfaceFromDevice(String nodeId, String interfaceName) {
1199         InstanceIdentifier<Interface> interfacesIID = InstanceIdentifier.create(OrgOpenroadmDevice.class)
1200             .child(Interface.class, new InterfaceKey(interfaceName));
1201         return deviceTransactionManager.getDataFromDevice(nodeId, LogicalDatastoreType.CONFIGURATION,
1202             interfacesIID, Timeouts.DEVICE_READ_TIMEOUT, Timeouts.DEVICE_READ_TIMEOUT_UNIT);
1203     }
1204 }