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