additional client properties can now be specified via ConnectionFactory.setClientProperties(...)

Author: Vlad Ionescu

src/com/rabbitmq/client/ConnectionFactory.java

@@ -73,6 +73,10 @@ public class ConnectionFactory implements Cloneable {
     /** Default value for desired heartbeat interval; zero for none */
     public static final int DEFAULT_HEARTBEAT = 0;
 
+    /** Default extra client properties to be sent to the server */
+    public static final Map<String, Object> DEFAULT_CLIENT_PROPERTIES =
+            new HashMap<String, Object>();
+
     /** The default host to connect to */
     public static final String DEFAULT_HOST = "localhost";
 
@@ -90,15 +94,16 @@ public class ConnectionFactory implements Cloneable {
      */
     public static final String DEFAULT_SSL_PROTOCOL = "SSLv3";
 
-    private String username               = DEFAULT_USER;
-    private String password               = DEFAULT_PASS;
-    private String virtualHost            = DEFAULT_VHOST;
-    private String host                   = DEFAULT_HOST;
-    private int port                      = USE_DEFAULT_PORT;
-    private int requestedChannelMax       = DEFAULT_CHANNEL_MAX;
-    private int requestedFrameMax         = DEFAULT_FRAME_MAX;
-    private int requestedHeartbeat        = DEFAULT_HEARTBEAT;
-    private SocketFactory factory         = SocketFactory.getDefault();
+    private String username                       = DEFAULT_USER;
+    private String password                       = DEFAULT_PASS;
+    private String virtualHost                    = DEFAULT_VHOST;
+    private String host                           = DEFAULT_HOST;
+    private int port                              = USE_DEFAULT_PORT;
+    private int requestedChannelMax               = DEFAULT_CHANNEL_MAX;
+    private int requestedFrameMax                 = DEFAULT_FRAME_MAX;
+    private int requestedHeartbeat                = DEFAULT_HEARTBEAT;
+    private Map<String, Object> _clientProperties = DEFAULT_CLIENT_PROPERTIES;
+    private SocketFactory factory                 = SocketFactory.getDefault();
 
     /**
      * Instantiate a ConnectionFactory with a default set of parameters.
@@ -236,6 +241,22 @@ public void setRequestedHeartbeat(int requestedHeartbeat) {
         this.requestedHeartbeat = requestedHeartbeat;
     }
 
+    /**
+     * Retrieve the map of extra client properties to be sent to the server
+     * @return the map of extra client properties
+     */
+    public Map<String, Object> getClientProperties() {
+        return _clientProperties;
+    }
+
+    /**
+     * Set the extra client properties to be sent to the server
+     * @param clientProperties the map of extra client properties
+     */
+    public void setClientProperties(Map<String, Object> clientProperties) {
+        _clientProperties = clientProperties;
+    }
+
     /**
      * Retrieve the socket factory used to make connections with.
      */

src/com/rabbitmq/client/impl/AMQConnection.java

@@ -72,18 +72,19 @@ public class AMQConnection extends ShutdownNotifierComponent implements Connecti
     /** Timeout used while waiting for a connection.close-ok (milliseconds) */
     public static final int CONNECTION_CLOSING_TIMEOUT = 10000;
 
-    private static final Object[] DEFAULT_CLIENT_PROPERTIES = new Object[] {
-        "product", LongStringHelper.asLongString("RabbitMQ"),
-        "version", LongStringHelper.asLongString(ClientVersion.VERSION),
-        "platform", LongStringHelper.asLongString("Java"),
-        "copyright", LongStringHelper.asLongString(
-            "Copyright (C) 2007-2008 LShift Ltd., " +
-            "Cohesive Financial Technologies LLC., " +
-            "and Rabbit Technologies Ltd."),
-        "information", LongStringHelper.asLongString(
-            "Licensed under the MPL.  " +
-            "See http://www.rabbitmq.com/")
-    };
+    private static final Object[] DEFAULT_CLIENT_PROPERTIES_ARRAY =
+        new Object[] {
+            "product", LongStringHelper.asLongString("RabbitMQ"),
+            "version", LongStringHelper.asLongString(ClientVersion.VERSION),
+            "platform", LongStringHelper.asLongString("Java"),
+            "copyright", LongStringHelper.asLongString(
+                "Copyright (C) 2007-2008 LShift Ltd., " +
+                "Cohesive Financial Technologies LLC., " +
+                "and Rabbit Technologies Ltd."),
+            "information", LongStringHelper.asLongString(
+                "Licensed under the MPL.  " +
+                "See http://www.rabbitmq.com/")
+        };
 
     private static final Version clientVersion =
         new Version(AMQP.PROTOCOL.MAJOR, AMQP.PROTOCOL.MINOR);
@@ -159,6 +160,7 @@ public void ensureIsOpen()
 
     private final String _username, _password, _virtualHost;
     private final int _requestedChannelMax, _requestedFrameMax, _requestedHeartbeat;
+    private final Map<String, Object> _clientProperties;
 
     /** {@inheritDoc} */
     public String getHost() {
@@ -207,6 +209,8 @@ public AMQConnection(ConnectionFactory factory,
         _requestedChannelMax = factory.getRequestedChannelMax();
         _requestedFrameMax = factory.getRequestedFrameMax();
         _requestedHeartbeat = factory.getRequestedHeartbeat();
+        _clientProperties =
+                buildClientPropertiesTable(factory.getClientProperties());
 
         this.factory = factory;
         _frameHandler = frameHandler;
@@ -274,10 +278,8 @@ public void start(boolean insist)
         LongString saslResponse = LongStringHelper.asLongString("\0" + _username +
                                                                 "\0" + _password);
         AMQImpl.Connection.StartOk startOk =
-            new AMQImpl.Connection.StartOk(buildClientPropertiesTable(),
-                                           "PLAIN",
-                                           saslResponse,
-                                           "en_US");
+            new AMQImpl.Connection.StartOk(_clientProperties, "PLAIN",
+                                           saslResponse, "en_US");
 
         AMQP.Connection.Tune connTune =
             (AMQP.Connection.Tune) _channel0.exnWrappingRpc(startOk).getMethod();
@@ -397,9 +399,11 @@ public void writeFrame(Frame f) throws IOException {
         _lastActivityTime = System.nanoTime();
     }
 
-    public Map<String, Object> buildClientPropertiesTable() {
-        Map<String, Object> props = Frame.buildTable(DEFAULT_CLIENT_PROPERTIES);
-        props.putAll(_params.getClientProperties());
+    private static Map<String, Object> buildClientPropertiesTable(
+                                    Map<String, Object> extraClientProperties) {
+        Map<String, Object> props =
+                Frame.buildTable(DEFAULT_CLIENT_PROPERTIES_ARRAY);
+        props.putAll(extraClientProperties);
         return props;
     }