From 86897acb78e2ad681b4da4801911dce6fb424b41 Mon Sep 17 00:00:00 2001
From: Ed Warnicke <eaw@cisco.com>
Date: Thu, 26 Dec 2013 10:21:56 -0800
Subject: [PATCH] Fix double translation of messages.

Also, return Collections.emptyList() if we do not have a
result from translation rather than null.

Change-Id: I64e014c8cdbe794570e5f9f525574789fd53a5da
Signed-off-by: Ed Warnicke <eaw@cisco.com>
---
 .../openflow/md/core/translator/ErrorTranslator.java          | 3 ++-
 .../openflow/md/core/translator/ExperimenterTranslator.java   | 3 ++-
 .../openflow/md/core/translator/FlowRemovedTranslator.java    | 3 ++-
 .../MultiPartMessageDescToNodeUpdatedTranslator.java          | 3 ++-
 .../MultiPartReplyPortToNodeConnectorUpdatedTranslator.java   | 3 ++-
 .../MultipartReplyTableFeaturesToTableUpdatedTranslator.java  | 3 ++-
 .../openflow/md/core/translator/PacketInTranslator.java       | 3 ++-
 .../PortStatusMessageToNodeConnectorUpdatedTranslator.java    | 3 ++-
 .../openflow/md/queue/TicketProcessorFactory.java             | 4 ++--
 9 files changed, 18 insertions(+), 10 deletions(-)

diff --git a/openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/translator/ErrorTranslator.java b/openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/translator/ErrorTranslator.java
index bec562615d..565692e0ac 100644
--- a/openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/translator/ErrorTranslator.java
+++ b/openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/translator/ErrorTranslator.java
@@ -1,6 +1,7 @@
 package org.opendaylight.openflowplugin.openflow.md.core.translator;
 
 import java.math.BigInteger;
+import java.util.Collections;
 import java.util.List;
 import java.util.concurrent.CopyOnWriteArrayList;
 
@@ -54,7 +55,7 @@ public class ErrorTranslator implements IMDMessageTranslator<OfHeader, List<Data
             return list;
         } else {
             LOG.error("Message is not of Error Message ");
-            return null;
+            return Collections.emptyList();
         }
     }
 
diff --git a/openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/translator/ExperimenterTranslator.java b/openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/translator/ExperimenterTranslator.java
index af85a5f079..eea892e372 100644
--- a/openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/translator/ExperimenterTranslator.java
+++ b/openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/translator/ExperimenterTranslator.java
@@ -1,6 +1,7 @@
 package org.opendaylight.openflowplugin.openflow.md.core.translator;
 
 import java.math.BigInteger;
+import java.util.Collections;
 import java.util.List;
 import java.util.concurrent.CopyOnWriteArrayList;
 
@@ -52,7 +53,7 @@ public class ExperimenterTranslator implements IMDMessageTranslator<OfHeader, Li
 			return list;
 		}else {
 			LOG.error( "Message is not of Experimenter Error Message " ) ;
-			return null;
+			return Collections.emptyList();
 		}
 	}
 
diff --git a/openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/translator/FlowRemovedTranslator.java b/openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/translator/FlowRemovedTranslator.java
index 300e21afa2..b45edba0f1 100644
--- a/openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/translator/FlowRemovedTranslator.java
+++ b/openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/translator/FlowRemovedTranslator.java
@@ -1,6 +1,7 @@
 package org.opendaylight.openflowplugin.openflow.md.core.translator;
 
 import java.math.BigInteger;
+import java.util.Collections;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
@@ -155,7 +156,7 @@ public class FlowRemovedTranslator implements IMDMessageTranslator<OfHeader, Lis
             return list;
         } else {
             LOG.error("Message is not a flow removed message ");
-            return null;
+            return Collections.emptyList();
         }
     }
 
diff --git a/openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/translator/MultiPartMessageDescToNodeUpdatedTranslator.java b/openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/translator/MultiPartMessageDescToNodeUpdatedTranslator.java
index 3fa527a782..6390c06852 100644
--- a/openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/translator/MultiPartMessageDescToNodeUpdatedTranslator.java
+++ b/openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/translator/MultiPartMessageDescToNodeUpdatedTranslator.java
@@ -1,6 +1,7 @@
 package org.opendaylight.openflowplugin.openflow.md.core.translator;
 
 import java.math.BigInteger;
+import java.util.Collections;
 import java.util.List;
 import java.util.concurrent.CopyOnWriteArrayList;
 
@@ -46,7 +47,7 @@ public class MultiPartMessageDescToNodeUpdatedTranslator implements IMDMessageTr
             list.add(nodeUpdated);
             return list;
         } else {
-            return null;
+            return Collections.emptyList();
         }
     }
 
diff --git a/openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/translator/MultiPartReplyPortToNodeConnectorUpdatedTranslator.java b/openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/translator/MultiPartReplyPortToNodeConnectorUpdatedTranslator.java
index 2b019132dd..e79bbc7cef 100644
--- a/openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/translator/MultiPartReplyPortToNodeConnectorUpdatedTranslator.java
+++ b/openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/translator/MultiPartReplyPortToNodeConnectorUpdatedTranslator.java
@@ -1,6 +1,7 @@
 package org.opendaylight.openflowplugin.openflow.md.core.translator;
 
 import java.math.BigInteger;
+import java.util.Collections;
 import java.util.List;
 import java.util.concurrent.CopyOnWriteArrayList;
 
@@ -57,7 +58,7 @@ public class MultiPartReplyPortToNodeConnectorUpdatedTranslator implements IMDMe
             }
             return list;
         } else {
-            return null;
+            return Collections.emptyList();
         }
     }
 
diff --git a/openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/translator/MultipartReplyTableFeaturesToTableUpdatedTranslator.java b/openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/translator/MultipartReplyTableFeaturesToTableUpdatedTranslator.java
index 7cdb682a59..219cb4916d 100644
--- a/openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/translator/MultipartReplyTableFeaturesToTableUpdatedTranslator.java
+++ b/openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/translator/MultipartReplyTableFeaturesToTableUpdatedTranslator.java
@@ -1,6 +1,7 @@
 package org.opendaylight.openflowplugin.openflow.md.core.translator;
 
 import java.math.BigInteger;
+import java.util.Collections;
 import java.util.List;
 import java.util.concurrent.CopyOnWriteArrayList;
 
@@ -52,7 +53,7 @@ public class MultipartReplyTableFeaturesToTableUpdatedTranslator implements
             return listDataObject ;
             
 		}
-		return null;
+		return Collections.emptyList();
 		
 	}
 	
diff --git a/openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/translator/PacketInTranslator.java b/openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/translator/PacketInTranslator.java
index a93567d70e..b7d5f7a00b 100644
--- a/openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/translator/PacketInTranslator.java
+++ b/openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/translator/PacketInTranslator.java
@@ -1,6 +1,7 @@
 package org.opendaylight.openflowplugin.openflow.md.core.translator;
 
 import java.math.BigInteger;
+import java.util.Collections;
 import java.util.List;
 import java.util.concurrent.CopyOnWriteArrayList;
 
@@ -87,6 +88,6 @@ public class PacketInTranslator implements IMDMessageTranslator<OfHeader, List<D
                 return list;
            } 
         } 
-        return null;
+        return Collections.emptyList();
     }
 }
diff --git a/openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/translator/PortStatusMessageToNodeConnectorUpdatedTranslator.java b/openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/translator/PortStatusMessageToNodeConnectorUpdatedTranslator.java
index 4a297141fa..bd44bc6679 100644
--- a/openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/translator/PortStatusMessageToNodeConnectorUpdatedTranslator.java
+++ b/openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/translator/PortStatusMessageToNodeConnectorUpdatedTranslator.java
@@ -1,6 +1,7 @@
 package org.opendaylight.openflowplugin.openflow.md.core.translator;
 
 import java.math.BigInteger;
+import java.util.Collections;
 import java.util.List;
 import java.util.concurrent.CopyOnWriteArrayList;
 
@@ -51,7 +52,7 @@ public class PortStatusMessageToNodeConnectorUpdatedTranslator implements IMDMes
             return list;
         } else {
             // TODO - Do something smarter than returning null if translation fails... what Exception should we throw here?
-            return null;
+            return Collections.emptyList();
         }
     }
 }
diff --git a/openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/queue/TicketProcessorFactory.java b/openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/queue/TicketProcessorFactory.java
index c4ff3e2b3f..ff37cba315 100644
--- a/openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/queue/TicketProcessorFactory.java
+++ b/openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/queue/TicketProcessorFactory.java
@@ -122,8 +122,8 @@ public class TicketProcessorFactory<IN, OUT> {
                             cookie = conductor.getAuxiliaryKey();
                         }
                         List<OUT> translatorOutput = translator.translate(cookie, conductor.getSessionContext(), message);
-                        if(translatorOutput != null) {
-                            result.addAll(translator.translate(cookie, conductor.getSessionContext(), message));
+                        if(translatorOutput != null && !translatorOutput.isEmpty()) {
+                            result.addAll(translatorOutput);
                         }
                     }
                 } else {
-- 
2.36.6