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