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