PortMapping Refactoring step 1
[transportpce.git] / common / src / main / java / org / opendaylight / transportpce / common / mapping / PortMappingVersion121.java
index 5ad42df29c3aeae672961446b02dfba51c63151f..661a532bb95d9bbab9973a33c20f1510711adba6 100644 (file)
@@ -10,7 +10,6 @@ package org.opendaylight.transportpce.common.mapping;
 
 import com.google.common.util.concurrent.FluentFuture;
 import java.util.ArrayList;
-import java.util.Collection;
 import java.util.Collections;
 import java.util.Comparator;
 import java.util.HashMap;
@@ -170,7 +169,7 @@ public class PortMappingVersion121 {
             Ports port = deviceTransactionManager.getDataFromDevice(nodeId, LogicalDatastoreType.OPERATIONAL,
                 portId, Timeouts.DEVICE_READ_TIMEOUT, Timeouts.DEVICE_READ_TIMEOUT_UNIT).get();
             Mapping newMapping = updateMappingObject(nodeId, port, oldMapping);
-            LOG.debug("{} : Updating old mapping Data {} for {} by new mapping data {}",
+            LOG.debug(PortMappingUtils.UPDATE_MAPPING_LOGMSG,
                 nodeId, oldMapping, oldMapping.getLogicalConnectionPoint(), newMapping);
             final WriteTransaction writeTransaction = this.dataBroker.newWriteOnlyTransaction();
             InstanceIdentifier<Mapping> mapIID = InstanceIdentifier.create(Network.class)
@@ -193,7 +192,7 @@ public class PortMappingVersion121 {
         Optional<OrgOpenroadmDevice> deviceObject = deviceTransactionManager.getDataFromDevice(nodeId,
             LogicalDatastoreType.OPERATIONAL, deviceIID,
             Timeouts.DEVICE_READ_TIMEOUT, Timeouts.DEVICE_READ_TIMEOUT_UNIT);
-        if (!deviceObject.isPresent()) {
+        if (deviceObject.isEmpty()) {
             LOG.error(PortMappingUtils.CANNOT_GET_DEV_CONF_LOGMSG, nodeId);
             return false;
         }
@@ -217,8 +216,6 @@ public class PortMappingVersion121 {
                 LOG.warn(PortMappingUtils.NO_PORT_ON_CP_LOGMSG, nodeId, "found", circuitPackName);
                 continue;
             }
-
-            // com.google.common.collect.ImmutableList implementation of List
             List<Ports> portList = new ArrayList<>(cp.nonnullPorts().values());
             portList.sort(Comparator.comparing(Ports::getPortName));
             for (Ports port : portList) {
@@ -230,27 +227,24 @@ public class PortMappingVersion121 {
             }
         }
 
-        Collection<ConnectionMap> connectionMap = deviceObject.get().nonnullConnectionMap().values();
-        for (ConnectionMap cm : connectionMap) {
+        for (ConnectionMap cm : deviceObject.get().nonnullConnectionMap().values()) {
             String skey = cm.getSource().getCircuitPackName() + "+" + cm.getSource().getPortName();
-            String slcp = lcpMap.containsKey(skey) ? lcpMap.get(skey) : null;
             Destination destination0 = cm.nonnullDestination().values().iterator().next();
             String dkey = destination0.getCircuitPackName() + "+" + destination0.getPortName();
-            if (slcp == null) {
-                LOG.error("{} : Error in connection-map analysis for source {} and destination (CP+port) {}",
-                    nodeId, skey, dkey);
+            if (!lcpMap.containsKey(skey)) {
+                LOG.error(PortMappingUtils.CONMAP_ISSUE_LOGMSG, nodeId, skey, dkey);
                 continue;
             }
-            String dlcp = lcpMap.containsKey(dkey) ? lcpMap.get(dkey) : null;
+            String slcp = lcpMap.get(skey);
             Mapping mapping = mappingMap.get(slcp);
             mappingMap.remove(slcp);
-            portMapList.add(createXpdrMappingObject(nodeId, null, null, null, null, mapping, dlcp));
+            portMapList.add(createXpdrMappingObject(nodeId, null, null, null, null, mapping,
+                //dlcp
+                lcpMap.containsKey(dkey) ? lcpMap.get(dkey) : null));
         }
 
-        if (!mappingMap.isEmpty()) {
-            for (Mapping m : mappingMap.values()) {
-                portMapList.add(m);
-            }
+        for (Mapping m : mappingMap.values()) {
+            portMapList.add(m);
         }
         return true;
     }
@@ -286,7 +280,7 @@ public class PortMappingVersion121 {
         for (int srgCounter = 1; srgCounter <= maxSrg; srgCounter++) {
             List<org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.srg.CircuitPacks> srgCps
                 = new ArrayList<>();
-            LOG.debug("{} : Getting Circuitpacks for Srg Number {}", deviceId, srgCounter);
+            LOG.debug(PortMappingUtils.GETTING_CP_LOGMSG, deviceId, srgCounter);
             InstanceIdentifier<SharedRiskGroup> srgIID = InstanceIdentifier.create(OrgOpenroadmDevice.class)
                 .child(SharedRiskGroup.class, new SharedRiskGroupKey(Uint16.valueOf(srgCounter)));
             Optional<SharedRiskGroup> ordmSrgObject = this.deviceTransactionManager.getDataFromDevice(deviceId,
@@ -341,13 +335,13 @@ public class PortMappingVersion121 {
                     }
 
                     if (Port.PortQual.RoadmExternal.getIntValue() != port.getPortQual().getIntValue()) {
-                        LOG.debug("{} : port {} on {} is not roadm-external" + PortMappingUtils.CANNOT_AS_LCP_LOGMSG,
+                        LOG.debug(PortMappingUtils.PORT_NOT_RDMEXT_LOGMSG + PortMappingUtils.CANNOT_AS_LCP_LOGMSG,
                             nodeId, port.getPortName(), circuitPackName);
                         continue;
                     }
 
                     if (keys.contains(currentKey)) {
-                        LOG.debug("{} : port {} on {} has already been handled" + PortMappingUtils.CANNOT_AS_LCP_LOGMSG,
+                        LOG.debug(PortMappingUtils.PORT_ALREADY_HANDLED_LOGMSG + PortMappingUtils.CANNOT_AS_LCP_LOGMSG,
                             nodeId, port.getPortName(), circuitPackName);
                         continue;
                     }
@@ -366,7 +360,7 @@ public class PortMappingVersion121 {
                         case Rx:
                         case Tx:
                             if (!checkPartnerPortNotNull(port)) {
-                                LOG.info(PortMappingUtils.NO_VALID_PARTNERPORT_UNIDIR_LOGMSG
+                                LOG.info(PortMappingUtils.NO_VALID_PARTNERPORT_LOGMSG
                                         + PortMappingUtils.CANNOT_AS_LCP_LOGMSG,
                                     nodeId, port.getPortName(), circuitPackName);
                                 continue;
@@ -442,7 +436,7 @@ public class PortMappingVersion121 {
         Integer maxDegree = ordmInfo.getMaxDegrees() == null ? 20 : ordmInfo.getMaxDegrees().toJava();
 
         for (int degreeCounter = 1; degreeCounter <= maxDegree; degreeCounter++) {
-            LOG.debug("{} : Getting Connection ports for Degree Number {}", deviceId, degreeCounter);
+            LOG.debug(PortMappingUtils.GETTING_CONPORT_LOGMSG, deviceId, degreeCounter);
             InstanceIdentifier<Degree> deviceIID = InstanceIdentifier.create(OrgOpenroadmDevice.class)
                 .child(Degree.class, new DegreeKey(Uint16.valueOf(degreeCounter)));
             Optional<Degree> ordmDegreeObject = this.deviceTransactionManager.getDataFromDevice(deviceId,
@@ -486,7 +480,7 @@ public class PortMappingVersion121 {
             Optional<Interface> interfaceObject = this.deviceTransactionManager.getDataFromDevice(nodeId,
                 LogicalDatastoreType.OPERATIONAL, interfaceIID, Timeouts.DEVICE_READ_TIMEOUT,
                 Timeouts.DEVICE_READ_TIMEOUT_UNIT);
-            if (!interfaceObject.isPresent() || (interfaceObject.get().getSupportingCircuitPackName() == null)) {
+            if (interfaceObject.isEmpty() || interfaceObject.get().getSupportingCircuitPackName() == null) {
                 continue;
             }
             String supportingCircuitPackName = interfaceObject.get().getSupportingCircuitPackName();
@@ -497,7 +491,7 @@ public class PortMappingVersion121 {
             Optional<CircuitPacks> circuitPackObject = this.deviceTransactionManager.getDataFromDevice(
                 nodeId, LogicalDatastoreType.OPERATIONAL, circuitPacksIID, Timeouts.DEVICE_READ_TIMEOUT,
                 Timeouts.DEVICE_READ_TIMEOUT_UNIT);
-            if (!circuitPackObject.isPresent() || (circuitPackObject.get().getParentCircuitPack() == null)) {
+            if (circuitPackObject.isEmpty() || circuitPackObject.get().getParentCircuitPack() == null) {
                 continue;
             }
             cpToInterfaceMap.put(circuitPackObject.get().getParentCircuitPack().getCircuitPackName(),
@@ -510,7 +504,6 @@ public class PortMappingVersion121 {
     private List<CpToDegree> getCpToDegreeList(Map<Integer, Degree> degrees, Map<String, String> interfaceList) {
         List<CpToDegree> cpToDegreeList = new ArrayList<>();
         for (Degree degree : degrees.values()) {
-            LOG.debug("Inside CP to degree list");
             cpToDegreeList.addAll(degree.nonnullCircuitPacks().values().stream()
                 .map(cp -> createCpToDegreeObject(cp.getCircuitPackName(),
                     degree.getDegreeNumber().toString(), interfaceList))
@@ -556,7 +549,7 @@ public class PortMappingVersion121 {
             commit.get();
             return true;
         } catch (InterruptedException | ExecutionException e) {
-            LOG.warn("Failed to post {}", network, e);
+            LOG.warn(PortMappingUtils.PORTMAPPING_POST_FAIL_LOGMSG, nodeId, network, e);
             return false;
         }
     }
@@ -621,11 +614,12 @@ public class PortMappingVersion121 {
             try {
                 Optional<Interface> openRoadmInterface = this.openRoadmInterfaces.getInterface(nodeId,
                     interfaces.getInterfaceName());
-                if (!openRoadmInterface.isPresent()) {
-                    LOG.warn("{} : Interface {} was null!", nodeId, interfaces.getInterfaceName());
+                if (openRoadmInterface.isEmpty()) {
+                    LOG.warn(PortMappingUtils.INTF_ISSUE_LOGMSG,
+                        nodeId, interfaces.getInterfaceName() + "- empty interface");
                     continue;
                 }
-                LOG.debug("{} : interface get from device is {} and of type {}",
+                LOG.debug(PortMappingUtils.GOT_INTF_LOGMSG,
                     nodeId, openRoadmInterface.get().getName(), openRoadmInterface.get().getType());
                 Class<? extends InterfaceType> interfaceType
                     = (Class<? extends InterfaceType>) openRoadmInterface.get().getType();
@@ -637,7 +631,7 @@ public class PortMappingVersion121 {
                     mpBldr.setSupportingOts(interfaces.getInterfaceName());
                 }
             } catch (OpenRoadmInterfaceException ex) {
-                LOG.warn("{} : Error while getting interface {} - ", nodeId, interfaces.getInterfaceName(), ex);
+                LOG.warn(PortMappingUtils.INTF_ISSUE_LOGMSG, nodeId, interfaces.getInterfaceName(), ex);
             }
         }
         return mpBldr;
@@ -679,7 +673,7 @@ public class PortMappingVersion121 {
             //circuitPackName2 will be updated by reference contrary to circuitPackName
             List<CircuitPacks> circuitPackList, Map<String, String> lcpMap) {
         if (!checkPartnerPortNotNull(port)) {
-            LOG.warn("{} : port {} on {} - Error in the configuration ", nodeId, port.getPortName(), circuitPackName);
+            LOG.warn(PortMappingUtils.NO_VALID_PARTNERPORT_LOGMSG, nodeId, port.getPortName(), circuitPackName);
             return null;
         }
         if (lcpMap.containsKey(circuitPackName + '+' + port.getPortName())) {
@@ -688,15 +682,15 @@ public class PortMappingVersion121 {
         Optional<CircuitPacks> cpOpt = circuitPackList.stream()
             .filter(cP -> cP.getCircuitPackName().equals(port.getPartnerPort().getCircuitPackName()))
             .findFirst();
-        if (!cpOpt.isPresent()) {
-            LOG.error("{} : Error fetching circuit-pack {}", nodeId, port.getPartnerPort().getCircuitPackName());
+        if (cpOpt.isEmpty()) {
+            LOG.error(PortMappingUtils.MISSING_CP_LOGMSG, nodeId, port.getPartnerPort().getCircuitPackName());
             return null;
         }
         Optional<Ports> poOpt = cpOpt.get().nonnullPorts().values().stream()
             .filter(p -> p.getPortName().equals(port.getPartnerPort().getPortName()))
             .findFirst();
-        if (!poOpt.isPresent()) {
-            LOG.error("{} : Error fetching port {} on {}",
+        if (poOpt.isEmpty()) {
+            LOG.error(PortMappingUtils.NO_PORT_ON_CP_LOGMSG,
                 nodeId, port.getPartnerPort().getPortName(), port.getPartnerPort().getCircuitPackName());
             return null;
         }
@@ -741,7 +735,7 @@ public class PortMappingVersion121 {
             List<CircuitPacks> circuitPackList, Map<String, String> lcpMap, Map<String, Mapping> mappingMap) {
 
         if (port.getPortQual() == null) {
-            LOG.warn("{} : port {} on {} - PortQual was not found", nodeId, port.getPortName(), circuitPackName);
+            LOG.warn(PortMappingUtils.PORTQUAL_LOGMSG, nodeId, port.getPortName(), circuitPackName, "not found");
             return new int[] {line, client};
         }
 
@@ -764,8 +758,8 @@ public class PortMappingVersion121 {
                 break;
 
             default:
-                LOG.error("{} : port {} on {} - unsupported PortQual {}",
-                    nodeId, port.getPortName(), circuitPackName, port.getPortQual());
+                LOG.error(PortMappingUtils.PORTQUAL_LOGMSG,
+                    nodeId, port.getPortName(), circuitPackName, port.getPortQual() + " not supported");
         }
         return new int[] {line, client};
     }
@@ -817,27 +811,26 @@ public class PortMappingVersion121 {
         Map<Integer, Degree> degrees = getDegreesMap(nodeId, deviceInfo);
         Map<String, String> interfaceList = getEthInterfaceList(nodeId);
         List<CpToDegree> cpToDegreeList = getCpToDegreeList(degrees, interfaceList);
-        LOG.info("{} : Map looks like this {}", nodeId, interfaceList);
+        LOG.info(PortMappingUtils.MAP_LOOKS_LOGMSG, nodeId, interfaceList);
         postPortMapping(nodeId, null, null, cpToDegreeList);
 
         Map<Integer, List<ConnectionPorts>> connectionPortMap = getPerDegreePorts(nodeId, deviceInfo);
         for (Entry<Integer, List<ConnectionPorts>> cpMapEntry : connectionPortMap.entrySet()) {
-            switch (connectionPortMap.get(cpMapEntry.getKey()).size()) {
+            List<ConnectionPorts> cpMapValue = cpMapEntry.getValue();
+            ConnectionPorts cp1 = cpMapValue.get(0);
+            String cp1Name = cp1.getCircuitPackName();
+            switch (cpMapValue.size()) {
                 case 1:
                     // port is bidirectional
-                    String cpName = connectionPortMap.get(cpMapEntry.getKey()).get(0).getCircuitPackName();
                     InstanceIdentifier<Ports> portID = InstanceIdentifier.create(OrgOpenroadmDevice.class)
-                        .child(CircuitPacks.class, new CircuitPacksKey(cpName))
-                        .child(Ports.class,
-                                new PortsKey(connectionPortMap.get(cpMapEntry.getKey()).get(0).getPortName()));
-                    LOG.debug(PortMappingUtils.FETCH_CONNECTIONPORT_LOGMSG,
-                        nodeId, connectionPortMap.get(cpMapEntry.getKey()).get(0).getPortName(), cpName);
+                        .child(CircuitPacks.class, new CircuitPacksKey(cp1Name))
+                        .child(Ports.class, new PortsKey(cp1.getPortName()));
+                    LOG.debug(PortMappingUtils.FETCH_CONNECTIONPORT_LOGMSG, nodeId, cp1.getPortName(), cp1Name);
                     Optional<Ports> portObject = this.deviceTransactionManager.getDataFromDevice(nodeId,
                         LogicalDatastoreType.OPERATIONAL, portID, Timeouts.DEVICE_READ_TIMEOUT,
                         Timeouts.DEVICE_READ_TIMEOUT_UNIT);
-                    if (!portObject.isPresent()) {
-                        LOG.error(PortMappingUtils.NO_PORT_ON_CP_LOGMSG,
-                            nodeId, connectionPortMap.get(cpMapEntry.getKey()).get(0).getPortName(), cpName);
+                    if (portObject.isEmpty()) {
+                        LOG.error(PortMappingUtils.NO_PORT_ON_CP_LOGMSG, nodeId, cp1.getPortName(), cp1Name);
                         return false;
                     }
                     Ports port = portObject.get();
@@ -846,51 +839,46 @@ public class PortMappingVersion121 {
                     }
                     if (Port.PortQual.RoadmExternal.getIntValue() != port.getPortQual().getIntValue()) {
                         LOG.error(PortMappingUtils.CANNOT_CREATE_LCP_LOGMSG + PortMappingUtils.PORTQUAL_ERROR_LOGMSG,
-                            nodeId, port.getPortName(), cpName);
+                            nodeId, port.getPortName(), cp1Name);
                         continue;
                     }
                     if (Direction.Bidirectional.getIntValue() != port.getPortDirection().getIntValue()) {
                         LOG.error(PortMappingUtils.CANNOT_CREATE_LCP_LOGMSG + PortMappingUtils.PORTDIR_ERROR_LOGMSG,
-                            nodeId, port.getPortName(), cpName);
+                            nodeId, port.getPortName(), cp1Name);
                         continue;
                     }
 
                     String logicalConnectionPoint =
                             PortMappingUtils.degreeTtpNodeName(cpMapEntry.getKey().toString(), "TXRX");
                     LOG.info(PortMappingUtils.ASSOCIATED_LCP_LOGMSG,
-                        nodeId, port.getPortName(), cpName, logicalConnectionPoint);
-                    portMapList.add(createMappingObject(nodeId, port, cpName, logicalConnectionPoint));
+                        nodeId, port.getPortName(), cp1Name, logicalConnectionPoint);
+                    portMapList.add(createMappingObject(nodeId, port, cp1Name, logicalConnectionPoint));
                     break;
                 case 2:
                     // ports are unidirectionals
-                    String cp1Name = connectionPortMap.get(cpMapEntry.getKey()).get(0).getCircuitPackName();
-                    String cp2Name = connectionPortMap.get(cpMapEntry.getKey()).get(1).getCircuitPackName();
+                    ConnectionPorts cp2 = cpMapValue.get(1);
+                    String cp2Name = cp2.getCircuitPackName();
                     InstanceIdentifier<Ports> port1ID = InstanceIdentifier.create(OrgOpenroadmDevice.class)
                         .child(CircuitPacks.class, new CircuitPacksKey(cp1Name))
-                        .child(Ports.class,
-                            new PortsKey(connectionPortMap.get(cpMapEntry.getKey()).get(0).getPortName()));
-                    LOG.debug(PortMappingUtils.FETCH_CONNECTIONPORT_LOGMSG,
-                        nodeId, connectionPortMap.get(cpMapEntry.getKey()).get(0).getPortName(), cp1Name);
+                        .child(Ports.class, new PortsKey(cp1.getPortName()));
+                    LOG.debug(PortMappingUtils.FETCH_CONNECTIONPORT_LOGMSG, nodeId, cp1.getPortName(), cp1Name);
                     Optional<Ports> port1Object = this.deviceTransactionManager.getDataFromDevice(nodeId,
                         LogicalDatastoreType.OPERATIONAL, port1ID, Timeouts.DEVICE_READ_TIMEOUT,
                         Timeouts.DEVICE_READ_TIMEOUT_UNIT);
                     InstanceIdentifier<Ports> port2ID = InstanceIdentifier.create(OrgOpenroadmDevice.class)
                         .child(CircuitPacks.class, new CircuitPacksKey(cp2Name))
-                        .child(Ports.class,
-                            new PortsKey(connectionPortMap.get(cpMapEntry.getKey()).get(1).getPortName()));
+                        .child(Ports.class, new PortsKey(cp2.getPortName()));
                     LOG.debug(PortMappingUtils.FETCH_CONNECTIONPORT_LOGMSG,
-                        nodeId, connectionPortMap.get(cpMapEntry.getKey()).get(1).getPortName(), cp2Name);
+                        nodeId, cp2.getPortName(), cp2Name);
                     Optional<Ports> port2Object = this.deviceTransactionManager.getDataFromDevice(nodeId,
                         LogicalDatastoreType.OPERATIONAL, port2ID, Timeouts.DEVICE_READ_TIMEOUT,
                         Timeouts.DEVICE_READ_TIMEOUT_UNIT);
-                    if (!port1Object.isPresent() || !port2Object.isPresent()) {
-                        LOG.error(PortMappingUtils.NO_PORT_ON_CP_LOGMSG,
-                            nodeId, connectionPortMap.get(cpMapEntry.getKey()).get(0).getPortName(), cp1Name);
+                    if (port1Object.isEmpty()) {
+                        LOG.error(PortMappingUtils.NO_PORT_ON_CP_LOGMSG, nodeId, cp1.getPortName(), cp1Name);
                         return false;
                     }
-                    if (!port2Object.isPresent()) {
-                        LOG.error(PortMappingUtils.NO_PORT_ON_CP_LOGMSG,
-                            nodeId, connectionPortMap.get(cpMapEntry.getKey()).get(1).getPortName(), cp2Name);
+                    if (port2Object.isEmpty()) {
+                        LOG.error(PortMappingUtils.NO_PORT_ON_CP_LOGMSG, nodeId, cp2.getPortName(), cp2Name);
                         return false;
                     }
 
@@ -934,7 +922,7 @@ public class PortMappingVersion121 {
                     portMapList.add(createMappingObject(nodeId, port2, cp2Name, logicalConnectionPoint2));
                     break;
                 default:
-                    LOG.error("{} : Number of connection port for DEG{} is incorrect", nodeId, cpMapEntry.getKey());
+                    LOG.error(PortMappingUtils.NOT_CORRECT_CONPORT_LOGMSG, nodeId, cpMapEntry.getKey());
                     continue;
             }
         }
@@ -945,12 +933,16 @@ public class PortMappingVersion121 {
 
         if (deviceInfo.getNodeType() == null) {
             // TODO make mandatory in yang
-            LOG.error("Node type field is missing");
+            LOG.error(PortMappingUtils.NODE_TYPE_LOGMSG, deviceInfo.getNodeId(), "field missing");
             return null;
         }
 
         NodeInfoBuilder nodeInfoBldr = new NodeInfoBuilder()
-                .setOpenroadmVersion(OpenroadmNodeVersion._121);
+                .setOpenroadmVersion(OpenroadmNodeVersion._121)
+                .setNodeClli(
+                    deviceInfo.getClli() == null || deviceInfo.getClli().isEmpty()
+                        ? "defaultCLLI"
+                        : deviceInfo.getClli());
         // TODO check if we can use here .setNodeType(NodeTypes.forValue(..) such as with 221
         switch (deviceInfo.getNodeType().getIntValue()) {
             case 1:
@@ -958,14 +950,9 @@ public class PortMappingVersion121 {
                 nodeInfoBldr.setNodeType(NodeTypes.forValue(deviceInfo.getNodeType().getIntValue()));
                 break;
             default:
-                LOG.error("Error with node-type of {}", deviceInfo.getNodeId());
+                LOG.error(PortMappingUtils.NODE_TYPE_LOGMSG, deviceInfo.getNodeId(), "value not supported");
                 // TODO: is this protection useful ? it is not present in Portmapping 221
         }
-        if (deviceInfo.getClli() != null && !deviceInfo.getClli().isEmpty()) {
-            nodeInfoBldr.setNodeClli(deviceInfo.getClli());
-        } else {
-            nodeInfoBldr.setNodeClli("defaultCLLI");
-        }
         if (deviceInfo.getModel() != null) {
             nodeInfoBldr.setNodeModel(deviceInfo.getModel());
         }