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