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