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