QPID-5266: include the client product string in connection open log message

git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk@1536163 13f79535-47bb-0310-9956-ffa450edef68

5 files changed, 49 insertions, 17 deletions

diff --git a/qpid/java/broker-core/src/main/java/org/apache/qpid/server/logging/messages/ConnectionMessages.java b/qpid/java/broker-core/src/main/java/org/apache/qpid/server/logging/messages/ConnectionMessages.java
index 639705edbf..2766f0c1f1 100644
--- a/qpid/java/broker-core/src/main/java/org/apache/qpid/server/logging/messages/ConnectionMessages.java
+++ b/qpid/java/broker-core/src/main/java/org/apache/qpid/server/logging/messages/ConnectionMessages.java
@@ -60,12 +60,12 @@ public class ConnectionMessages
 
     /**
      * Log a Connection message of the Format:
-     * <pre>CON-1001 : Open[ : Client ID : {0}][ : Protocol Version : {1}][ : Client Version : {2}]</pre>
+     * <pre>CON-1001 : Open[ : Client ID : {0}][ : Protocol Version : {1}][ : Client Version : {2}][ : Client Product : {3}]</pre>
      * Optional values are contained in [square brackets] and are numbered
      * sequentially in the method call.
      *
      */
-    public static LogMessage OPEN(String param1, String param2, String param3, boolean opt1, boolean opt2, boolean opt3)
+    public static LogMessage OPEN(String param1, String param2, String param3, String param4, boolean opt1, boolean opt2, boolean opt3, boolean opt4)
     {
         String rawMessage = _messages.getString("OPEN");
         StringBuffer msg = new StringBuffer();
@@ -108,11 +108,21 @@ public class ConnectionMessages
 
             // Use 'end + 1' to remove the ']' from the output
             msg.append(parts[3].substring(end + 1));
+
+            // Add Option : : Client Product : {3}.
+            end = parts[4].indexOf(']');
+            if (opt4)
+            {
+                msg.append(parts[4].substring(0, end));
+            }
+
+            // Use 'end + 1' to remove the ']' from the output
+            msg.append(parts[4].substring(end + 1));
         }
 
         rawMessage = msg.toString();
 
-        final Object[] messageArguments = {param1, param2, param3};
+        final Object[] messageArguments = {param1, param2, param3, param4};
         // Create a new MessageFormat to ensure thread safety.
         // Sharing a MessageFormat and using applyPattern is not thread safe
         MessageFormat formatter = new MessageFormat(rawMessage, _currentLocale);
diff --git a/qpid/java/broker-core/src/main/java/org/apache/qpid/server/logging/messages/Connection_logmessages.properties b/qpid/java/broker-core/src/main/java/org/apache/qpid/server/logging/messages/Connection_logmessages.properties
index a99bcc7352..ad9896a659 100644
--- a/qpid/java/broker-core/src/main/java/org/apache/qpid/server/logging/messages/Connection_logmessages.properties
+++ b/qpid/java/broker-core/src/main/java/org/apache/qpid/server/logging/messages/Connection_logmessages.properties
@@ -21,6 +21,6 @@
 # 0 - Client id
 # 1 - Protocol Version
 # 2 - Client Version
-OPEN = CON-1001 : Open[ : Client ID : {0}][ : Protocol Version : {1}][ : Client Version : {2}]
+OPEN = CON-1001 : Open[ : Client ID : {0}][ : Protocol Version : {1}][ : Client Version : {2}][ : Client Product : {3}]
 CLOSE = CON-1002 : Close
 IDLE_CLOSE = CON-1003 : Closed due to inactivity
diff --git a/qpid/java/broker-core/src/main/java/org/apache/qpid/server/protocol/AMQConnectionModel.java b/qpid/java/broker-core/src/main/java/org/apache/qpid/server/protocol/AMQConnectionModel.java
index 19c5d03e0c..180653af0e 100644
--- a/qpid/java/broker-core/src/main/java/org/apache/qpid/server/protocol/AMQConnectionModel.java
+++ b/qpid/java/broker-core/src/main/java/org/apache/qpid/server/protocol/AMQConnectionModel.java
@@ -79,6 +79,8 @@ public interface AMQConnectionModel extends StatisticsGatherer
 
     String getClientVersion();
 
+    String getClientProduct();
+
     String getPrincipalAsString();
 
     long getSessionCountLimit();
diff --git a/qpid/java/broker-core/src/test/java/org/apache/qpid/server/logging/messages/ConnectionMessagesTest.java b/qpid/java/broker-core/src/test/java/org/apache/qpid/server/logging/messages/ConnectionMessagesTest.java
index b2951ae54a..fedc3fc52b 100644
--- a/qpid/java/broker-core/src/test/java/org/apache/qpid/server/logging/messages/ConnectionMessagesTest.java
+++ b/qpid/java/broker-core/src/test/java/org/apache/qpid/server/logging/messages/ConnectionMessagesTest.java
@@ -27,27 +27,29 @@ import java.util.List;
  */
 public class ConnectionMessagesTest extends AbstractTestMessages
 {
-    public void testConnectionOpen_WithClientIDProtocolVersionClientVersion()
+    public void testConnectionOpen_WithClientIDProtocolVersionClientVersionClientProduct()
     {
         String clientID = "client";
         String protocolVersion = "8-0";
         String clientVersion = "1.2.3_4";
+        String clientProduct = "myProduct";
 
-        _logMessage = ConnectionMessages.OPEN(clientID, protocolVersion, clientVersion, true , true, true);
+        _logMessage = ConnectionMessages.OPEN(clientID, protocolVersion, clientVersion, clientProduct , true, true, true, true);
         List<Object> log = performLog();
 
         String[] expected = {"Open :", "Client ID", clientID,
                              ": Protocol Version :", protocolVersion,
-                             ": Client Version :", clientVersion};
+                             ": Client Version :", clientVersion,
+                             ": Client Product :", clientProduct};
 
         validateLogMessage(log, "CON-1001", expected);
     }
 
-    public void testConnectionOpen_WithClientIDNoProtocolVersionNoClientVersion()
+    public void testConnectionOpen_WithClientIDNoProtocolVersionNoClientVersionNoClientProduct()
     {
         String clientID = "client";        
 
-        _logMessage = ConnectionMessages.OPEN(clientID, null, null, true, false, false);
+        _logMessage = ConnectionMessages.OPEN(clientID, null, null, null, true, false, false, false);
         List<Object> log = performLog();
 
         String[] expected = {"Open :", "Client ID", clientID};
@@ -55,11 +57,11 @@ public class ConnectionMessagesTest extends AbstractTestMessages
         validateLogMessage(log, "CON-1001", expected);
     }
 
-    public void testConnectionOpen_WithNOClientIDProtocolVersionNoClientVersion()
+    public void testConnectionOpen_WithNOClientIDProtocolVersionNoClientVersionNoClientProduct()
     {
         String protocolVersion = "8-0";
 
-        _logMessage = ConnectionMessages.OPEN(null, protocolVersion, null, false , true, false);
+        _logMessage = ConnectionMessages.OPEN(null, protocolVersion, null, null , false, true, false, false);
         List<Object> log = performLog();
 
         String[] expected = {"Open", ": Protocol Version :", protocolVersion};
@@ -67,11 +69,11 @@ public class ConnectionMessagesTest extends AbstractTestMessages
         validateLogMessage(log, "CON-1001", expected);
     }
 
-    public void testConnectionOpen_WithNOClientIDNoProtocolVersionClientVersion()
+    public void testConnectionOpen_WithNOClientIDNoProtocolVersionClientVersionNoClientProduct()
     {
         String clientVersion = "1.2.3_4";
 
-        _logMessage = ConnectionMessages.OPEN(null, null, clientVersion, false , false, true);
+        _logMessage = ConnectionMessages.OPEN(null, null, clientVersion, null , false, false, true, false);
         List<Object> log = performLog();
 
         String[] expected = {"Open", ": Client Version :", clientVersion};
@@ -79,11 +81,11 @@ public class ConnectionMessagesTest extends AbstractTestMessages
         validateLogMessage(log, "CON-1001", expected);
     }
 
-    public void testConnectionOpen_WithNOClientIDNoProtocolVersionNullClientVersion()
+    public void testConnectionOpen_WithNOClientIDNoProtocolVersionNullClientVersionNoClientProduct()
     {
         String clientVersion = null;
 
-        _logMessage = ConnectionMessages.OPEN(null, null, clientVersion , false , false, true);
+        _logMessage = ConnectionMessages.OPEN(null, null, clientVersion , null , false, false, true, false);
         List<Object> log = performLog();
 
         String[] expected = {"Open", ": Client Version :", clientVersion};
@@ -91,9 +93,21 @@ public class ConnectionMessagesTest extends AbstractTestMessages
         validateLogMessage(log, "CON-1001", true, expected);
     }
 
-    public void testConnectionOpen_WithNoClientIDNoProtocolVersionNoClientVersion()
+    public void testConnectionOpen_WithNOClientIDNoProtocolVersionNoClientVersionNullClientProduct()
     {
-        _logMessage = ConnectionMessages.OPEN(null, null, null, false, false, false);
+        String clientProduct = null;
+
+        _logMessage = ConnectionMessages.OPEN(null, null, null , clientProduct , false, false, false, true);
+        List<Object> log = performLog();
+
+        String[] expected = {"Open", ": Client Product :", clientProduct};
+
+        validateLogMessage(log, "CON-1001", true, expected);
+    }
+
+    public void testConnectionOpen_WithNoClientIDNoProtocolVersionNoClientVersionNoClientProduct()
+    {
+        _logMessage = ConnectionMessages.OPEN(null, null, null, null, false, false, false, false);
         List<Object> log = performLog();
 
         String[] expected = {"Open"};
diff --git a/qpid/java/broker-core/src/test/java/org/apache/qpid/server/subscription/MockSubscription.java b/qpid/java/broker-core/src/test/java/org/apache/qpid/server/subscription/MockSubscription.java
index b26d7530aa..77f09dc567 100644
--- a/qpid/java/broker-core/src/test/java/org/apache/qpid/server/subscription/MockSubscription.java
+++ b/qpid/java/broker-core/src/test/java/org/apache/qpid/server/subscription/MockSubscription.java
@@ -530,6 +530,12 @@ public class MockSubscription implements Subscription
         }
 
         @Override
+        public String getClientProduct()
+        {
+            return null;
+        }
+
+        @Override
         public String getPrincipalAsString()
         {
             return null;