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