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