Use constants for PortMapping log messages Step 4

Few PortMapping log messages were redundant and needed to be realigned.
They were fixed previously but this created new string for the words
"create" and "update" and "found".
Sonar complains they are used multiples times.
Since these words are shared among all PortMappingVersion*** classes,
migrating them to constants in the PortMappingUtils class is preferable.

JIRA: TRNSPRTPCE-355 TRNSPRTPCE-356
Signed-off-by: guillaume.lambert <guillaume.lambert@orange.com>
Change-Id: I71a5e8eb654256004f11d10e9f3d3273d79bcede

diff --git a/common/src/main/java/org/opendaylight/transportpce/common/mapping/PortMappingUtils.java b/common/src/main/java/org/opendaylight/transportpce/common/mapping/PortMappingUtils.java
index 0a2ed8cc548dd1c5cf76e3f0fe4f5447d1b0982e..2951e2c81337ce89fd71f51197e308c4ade204ed 100644 (file)
--- a/common/src/main/java/org/opendaylight/transportpce/common/mapping/PortMappingUtils.java
+++ b/common/src/main/java/org/opendaylight/transportpce/common/mapping/PortMappingUtils.java
@@ -32,12 +32,14 @@ public final class PortMappingUtils {
         "- cannot find port config under LLDP";
     public static final String CONMAP_ISSUE_LOGMSG =
         "{} : connection-map analysis for source {} and dest (CP+port) {} - no entry found for source in LCP map";
+    public static final String CREATE = "create";
     public static final String CREATE_MAPPING_DATA_LOGMSG =
         "{} : OpenROADM version {} node - Creating Mapping Data";
     public static final String DEVICE_HAS_LOGMSG =
         "{} : device has {} {}";
     public static final String FETCH_CONNECTIONPORT_LOGMSG =
         "{} : fetching connection-port {} at circuit-pack {}";
+    public static final String FOUND = "found";
     public static final String GETTING_CONPORT_LOGMSG =
         "{} : getting connection-ports for degree number {}";
     public static final String GETTING_CP_LOGMSG =
@@ -94,6 +96,7 @@ public final class PortMappingUtils {
         "{} : unable to create MC capabilities";
     public static final String UNSUPPORTED_DIR_LOGMSG =
         "{} : port {} on {} - unsupported Direction {}";
+    public static final String UPDATE = "update";
     public static final String UPDATE_MAPPING_LOGMSG =
         "{} : Updating old mapping data {} for {} by new mapping data {}";
     public static final String XPDR_LIST_IN_CONF_LOGMSG =

diff --git a/common/src/main/java/org/opendaylight/transportpce/common/mapping/PortMappingVersion121.java b/common/src/main/java/org/opendaylight/transportpce/common/mapping/PortMappingVersion121.java
index 7be7778a2199610bd0b527384e394f263fd2f2ec..7994c4bd80d1c9798e2d9ec69bd0502921131f67 100644 (file)
--- a/common/src/main/java/org/opendaylight/transportpce/common/mapping/PortMappingVersion121.java
+++ b/common/src/main/java/org/opendaylight/transportpce/common/mapping/PortMappingVersion121.java
@@ -128,26 +128,26 @@ public class PortMappingVersion121 {
                 // Get TTP port mapping
                 if (!createTtpPortMapping(nodeId, deviceInfo, portMapList)) {
                     // return false if mapping creation for TTP's failed
-                    LOG.warn(PortMappingUtils.UNABLE_MAPPING_LOGMSG, nodeId, "create", "TTP's");
+                    LOG.warn(PortMappingUtils.UNABLE_MAPPING_LOGMSG, nodeId, PortMappingUtils.CREATE, "TTP's");
                     return false;
                 }
 
                 // Get PP port mapping
                 if (!createPpPortMapping(nodeId, deviceInfo, portMapList)) {
                     // return false if mapping creation for PP's failed
-                    LOG.warn(PortMappingUtils.UNABLE_MAPPING_LOGMSG, nodeId, "create", "PP's");
+                    LOG.warn(PortMappingUtils.UNABLE_MAPPING_LOGMSG, nodeId, PortMappingUtils.CREATE, "PP's");
                     return false;
                 }
                 break;
             case Xpdr:
                 if (!createXpdrPortMapping(nodeId, portMapList)) {
-                    LOG.warn(PortMappingUtils.UNABLE_MAPPING_LOGMSG, nodeId, "create", "Xponder");
+                    LOG.warn(PortMappingUtils.UNABLE_MAPPING_LOGMSG, nodeId, PortMappingUtils.CREATE, "Xponder");
                     return false;
                 }
                 break;
             default:
                 LOG.error(PortMappingUtils.UNABLE_MAPPING_LOGMSG,
-                    nodeId, "create", deviceInfo.getNodeType() + " - unknown nodetype");
+                    nodeId, PortMappingUtils.CREATE, deviceInfo.getNodeType() + " - unknown nodetype");
                 break;
 
         }
@@ -156,11 +156,11 @@ public class PortMappingVersion121 {
 
     public boolean updateMapping(String nodeId, Mapping oldMapping) {
         if (nodeId == null) {
-            LOG.error(PortMappingUtils.UNABLE_MAPPING_LOGMSG, "node id null" , "update", "a null value");
+            LOG.error(PortMappingUtils.UNABLE_MAPPING_LOGMSG, "node id null" , PortMappingUtils.UPDATE, "a null value");
             return false;
         }
         if (oldMapping == null) {
-            LOG.error(PortMappingUtils.UNABLE_MAPPING_LOGMSG, nodeId, "update", "a null value");
+            LOG.error(PortMappingUtils.UNABLE_MAPPING_LOGMSG, nodeId, PortMappingUtils.UPDATE, "a null value");
             return false;
         }
         InstanceIdentifier<Ports> portId = InstanceIdentifier.create(OrgOpenroadmDevice.class)
@@ -182,7 +182,7 @@ public class PortMappingVersion121 {
             return true;
         } catch (InterruptedException | ExecutionException e) {
             LOG.error(PortMappingUtils.UNABLE_MAPPING_LOGMSG,
-                nodeId, "update", oldMapping.getLogicalConnectionPoint(), e);
+                nodeId, PortMappingUtils.UPDATE, oldMapping.getLogicalConnectionPoint(), e);
             return false;
         }
     }
@@ -199,7 +199,7 @@ public class PortMappingVersion121 {
         }
         OrgOpenroadmDevice device = deviceObject.get();
         if (device.getCircuitPacks() == null) {
-            LOG.warn(PortMappingUtils.MISSING_CP_LOGMSG, nodeId, "found");
+            LOG.warn(PortMappingUtils.MISSING_CP_LOGMSG, nodeId, PortMappingUtils.FOUND);
             return false;
         }
         // Variable to keep track of number of line ports
@@ -214,7 +214,7 @@ public class PortMappingVersion121 {
         for (CircuitPacks cp : circuitPackList) {
             String circuitPackName = cp.getCircuitPackName();
             if (cp.getPorts() == null) {
-                LOG.warn(PortMappingUtils.NO_PORT_ON_CP_LOGMSG, nodeId, "found", circuitPackName);
+                LOG.warn(PortMappingUtils.NO_PORT_ON_CP_LOGMSG, nodeId, PortMappingUtils.FOUND, circuitPackName);
                 continue;
             }
             List<Ports> portList = new ArrayList<>(cp.nonnullPorts().values());
@@ -390,7 +390,7 @@ public class PortMappingVersion121 {
             return new ArrayList<>();
         }
         if (circuitPackObject.get().getPorts() == null) {
-            LOG.warn(PortMappingUtils.NO_PORT_ON_CP_LOGMSG, nodeId, "found", circuitPackName);
+            LOG.warn(PortMappingUtils.NO_PORT_ON_CP_LOGMSG, nodeId, PortMappingUtils.FOUND, circuitPackName);
             return new ArrayList<>();
         }
         return new ArrayList<>(circuitPackObject.get().nonnullPorts().values());

diff --git a/common/src/main/java/org/opendaylight/transportpce/common/mapping/PortMappingVersion221.java b/common/src/main/java/org/opendaylight/transportpce/common/mapping/PortMappingVersion221.java
index 3a7839ddd6557123fca3ac1d232cc2f2678a40a7..595af60fa2e4f56e17bb62bf43264e37e8a1134c 100644 (file)
--- a/common/src/main/java/org/opendaylight/transportpce/common/mapping/PortMappingVersion221.java
+++ b/common/src/main/java/org/opendaylight/transportpce/common/mapping/PortMappingVersion221.java
@@ -147,14 +147,14 @@ public class PortMappingVersion221 {
                 // Get TTP port mapping
                 if (!createTtpPortMapping(nodeId, deviceInfo, portMapList)) {
                     // return false if mapping creation for TTP's failed
-                    LOG.warn(PortMappingUtils.UNABLE_MAPPING_LOGMSG, nodeId, "create", "TTP's");
+                    LOG.warn(PortMappingUtils.UNABLE_MAPPING_LOGMSG, nodeId, PortMappingUtils.CREATE, "TTP's");
                     return false;
                 }
 
                 // Get PP port mapping
                 if (!createPpPortMapping(nodeId, deviceInfo, portMapList)) {
                     // return false if mapping creation for PP's failed
-                    LOG.warn(PortMappingUtils.UNABLE_MAPPING_LOGMSG, nodeId, "create", "PP's");
+                    LOG.warn(PortMappingUtils.UNABLE_MAPPING_LOGMSG, nodeId, PortMappingUtils.CREATE, "PP's");
                     return false;
                 }
                 // Get MC capabilities
@@ -166,13 +166,13 @@ public class PortMappingVersion221 {
                 break;
             case Xpdr:
                 if (!createXpdrPortMapping(nodeId, portMapList)) {
-                    LOG.warn(PortMappingUtils.UNABLE_MAPPING_LOGMSG, nodeId, "create", "Xponder");
+                    LOG.warn(PortMappingUtils.UNABLE_MAPPING_LOGMSG, nodeId, PortMappingUtils.CREATE, "Xponder");
                     return false;
                 }
                 break;
             default:
                 LOG.error(PortMappingUtils.UNABLE_MAPPING_LOGMSG,
-                    nodeId, "create", deviceInfo.getNodeType() + " - unknown nodetype");
+                    nodeId, PortMappingUtils.CREATE, deviceInfo.getNodeType() + " - unknown nodetype");
                 break;
 
         }
@@ -181,11 +181,11 @@ public class PortMappingVersion221 {
 
     public boolean updateMapping(String nodeId, Mapping oldMapping) {
         if (nodeId == null) {
-            LOG.error(PortMappingUtils.UNABLE_MAPPING_LOGMSG, "node id null" , "update", "a null value");
+            LOG.error(PortMappingUtils.UNABLE_MAPPING_LOGMSG, "node id null" , PortMappingUtils.UPDATE, "a null value");
             return false;
         }
         if (oldMapping == null) {
-            LOG.error(PortMappingUtils.UNABLE_MAPPING_LOGMSG, nodeId, "update", "a null value");
+            LOG.error(PortMappingUtils.UNABLE_MAPPING_LOGMSG, nodeId, PortMappingUtils.UPDATE, "a null value");
             return false;
         }
         InstanceIdentifier<Ports> portId = InstanceIdentifier.create(OrgOpenroadmDevice.class)
@@ -207,7 +207,7 @@ public class PortMappingVersion221 {
             return true;
         } catch (InterruptedException | ExecutionException e) {
             LOG.error(PortMappingUtils.UNABLE_MAPPING_LOGMSG,
-                nodeId, "update", oldMapping.getLogicalConnectionPoint(), e);
+                nodeId, PortMappingUtils.UPDATE, oldMapping.getLogicalConnectionPoint(), e);
             return false;
         }
     }
@@ -224,7 +224,7 @@ public class PortMappingVersion221 {
         }
         OrgOpenroadmDevice device = deviceObject.get();
         if (device.getCircuitPacks() == null) {
-            LOG.warn(PortMappingUtils.MISSING_CP_LOGMSG, nodeId, "found");
+            LOG.warn(PortMappingUtils.MISSING_CP_LOGMSG, nodeId, PortMappingUtils.FOUND);
             return false;
         }
 
@@ -242,7 +242,7 @@ public class PortMappingVersion221 {
             for (CircuitPacks cp : circuitPackList) {
                 String circuitPackName = cp.getCircuitPackName();
                 if (cp.getPorts() == null) {
-                    LOG.warn(PortMappingUtils.NO_PORT_ON_CP_LOGMSG, nodeId, "found", circuitPackName);
+                    LOG.warn(PortMappingUtils.NO_PORT_ON_CP_LOGMSG, nodeId, PortMappingUtils.FOUND, circuitPackName);
                     continue;
                 }
                 List<Ports> portList = new ArrayList<>(cp.nonnullPorts().values());
@@ -256,7 +256,7 @@ public class PortMappingVersion221 {
                 }
             }
         } else {
-            LOG.info(PortMappingUtils.XPDR_LIST_IN_CONF_LOGMSG, nodeId, "found");
+            LOG.info(PortMappingUtils.XPDR_LIST_IN_CONF_LOGMSG, nodeId, PortMappingUtils.FOUND);
             for (Xponder xponder : deviceObject.get().nonnullXponder().values()) {
                 // Variables to keep track of number of line ports and client ports
                 int line = 1;
@@ -497,7 +497,7 @@ public class PortMappingVersion221 {
             return new ArrayList<>();
         }
         if (circuitPackObject.get().getPorts() == null) {
-            LOG.warn(PortMappingUtils.NO_PORT_ON_CP_LOGMSG, nodeId, "found", circuitPackName);
+            LOG.warn(PortMappingUtils.NO_PORT_ON_CP_LOGMSG, nodeId, PortMappingUtils.FOUND, circuitPackName);
             return new ArrayList<>();
         }
         return new ArrayList<>(circuitPackObject.get().nonnullPorts().values());

diff --git a/common/src/main/java/org/opendaylight/transportpce/common/mapping/PortMappingVersion710.java b/common/src/main/java/org/opendaylight/transportpce/common/mapping/PortMappingVersion710.java
index c36cc86a0bfd4d90cd7b5f56b545caaf8796cec4..7c13bf054dcba3fc0cb35b544d1d0007f40a4a87 100644 (file)
--- a/common/src/main/java/org/opendaylight/transportpce/common/mapping/PortMappingVersion710.java
+++ b/common/src/main/java/org/opendaylight/transportpce/common/mapping/PortMappingVersion710.java
@@ -157,14 +157,14 @@ public class PortMappingVersion710 {
                 // Get TTP port mapping
                 if (!createTtpPortMapping(nodeId, deviceInfo, portMapList)) {
                     // return false if mapping creation for TTP's failed
-                    LOG.warn(PortMappingUtils.UNABLE_MAPPING_LOGMSG, nodeId, "create", "TTP's");
+                    LOG.warn(PortMappingUtils.UNABLE_MAPPING_LOGMSG, nodeId, PortMappingUtils.CREATE, "TTP's");
                     return false;
                 }
 
                 // Get PP port mapping
                 if (!createPpPortMapping(nodeId, deviceInfo, portMapList)) {
                     // return false if mapping creation for PP's failed
-                    LOG.warn(PortMappingUtils.UNABLE_MAPPING_LOGMSG, nodeId, "create", "PP's");
+                    LOG.warn(PortMappingUtils.UNABLE_MAPPING_LOGMSG, nodeId, PortMappingUtils.CREATE, "PP's");
                     return false;
                 }
                 // Get MC capabilities
@@ -176,7 +176,7 @@ public class PortMappingVersion710 {
                 break;
             case Xpdr:
                 if (!createXpdrPortMapping(nodeId, portMapList)) {
-                    LOG.warn(PortMappingUtils.UNABLE_MAPPING_LOGMSG, nodeId, "create", "Xponder");
+                    LOG.warn(PortMappingUtils.UNABLE_MAPPING_LOGMSG, nodeId, PortMappingUtils.CREATE, "Xponder");
                     return false;
                 }
                 // In the case of 7.1 models, even XPDR advertizes mc-capabilities,
@@ -190,7 +190,7 @@ public class PortMappingVersion710 {
                 break;
             default:
                 LOG.error(PortMappingUtils.UNABLE_MAPPING_LOGMSG,
-                    nodeId, "create", deviceInfo.getNodeType() + " - unknown nodetype");
+                    nodeId, PortMappingUtils.CREATE, deviceInfo.getNodeType() + " - unknown nodetype");
                 break;
 
         }
@@ -199,11 +199,11 @@ public class PortMappingVersion710 {
 
     public boolean updateMapping(String nodeId, Mapping oldMapping) {
         if (nodeId == null) {
-            LOG.error(PortMappingUtils.UNABLE_MAPPING_LOGMSG, "node id null" , "update", "a null value");
+            LOG.error(PortMappingUtils.UNABLE_MAPPING_LOGMSG, "node id null" , PortMappingUtils.UPDATE, "a null value");
             return false;
         }
         if (oldMapping == null) {
-            LOG.error(PortMappingUtils.UNABLE_MAPPING_LOGMSG, nodeId, "update", "a null value");
+            LOG.error(PortMappingUtils.UNABLE_MAPPING_LOGMSG, nodeId, PortMappingUtils.UPDATE, "a null value");
             return false;
         }
         InstanceIdentifier<Ports> portId = InstanceIdentifier.create(OrgOpenroadmDevice.class)
@@ -225,7 +225,7 @@ public class PortMappingVersion710 {
             return true;
         } catch (InterruptedException | ExecutionException e) {
             LOG.error(PortMappingUtils.UNABLE_MAPPING_LOGMSG,
-                nodeId, "update", oldMapping.getLogicalConnectionPoint(), e);
+                nodeId, PortMappingUtils.UPDATE, oldMapping.getLogicalConnectionPoint(), e);
             return false;
         }
     }
@@ -308,7 +308,7 @@ public class PortMappingVersion710 {
         }
         OrgOpenroadmDevice device = deviceObject.get();
         if (device.getCircuitPacks() == null) {
-            LOG.warn(PortMappingUtils.MISSING_CP_LOGMSG, nodeId, "found");
+            LOG.warn(PortMappingUtils.MISSING_CP_LOGMSG, nodeId, PortMappingUtils.FOUND);
             return false;
         }
 
@@ -326,7 +326,7 @@ public class PortMappingVersion710 {
             for (CircuitPacks cp : circuitPackList) {
                 String circuitPackName = cp.getCircuitPackName();
                 if (cp.getPorts() == null) {
-                    LOG.warn(PortMappingUtils.NO_PORT_ON_CP_LOGMSG, nodeId, "found", circuitPackName);
+                    LOG.warn(PortMappingUtils.NO_PORT_ON_CP_LOGMSG, nodeId, PortMappingUtils.FOUND, circuitPackName);
                     continue;
                 }
                 List<Ports> portList = new ArrayList<>(cp.nonnullPorts().values());
@@ -340,7 +340,7 @@ public class PortMappingVersion710 {
                 }
             }
         } else {
-            LOG.info(PortMappingUtils.XPDR_LIST_IN_CONF_LOGMSG, nodeId, "found");
+            LOG.info(PortMappingUtils.XPDR_LIST_IN_CONF_LOGMSG, nodeId, PortMappingUtils.FOUND);
             for (Xponder xponder : deviceObject.get().nonnullXponder().values()) {
                 // Variables to keep track of number of line ports and client ports
                 int line = 1;
@@ -582,7 +582,7 @@ public class PortMappingVersion710 {
             return new ArrayList<>();
         }
         if (circuitPackObject.get().getPorts() == null) {
-            LOG.warn(PortMappingUtils.NO_PORT_ON_CP_LOGMSG, nodeId, "found", circuitPackName);
+            LOG.warn(PortMappingUtils.NO_PORT_ON_CP_LOGMSG, nodeId, PortMappingUtils.FOUND, circuitPackName);
             return new ArrayList<>();
         }
         return new ArrayList<>(circuitPackObject.get().nonnullPorts().values());