Reduced ConnectionFactory's API, moving getDefaultClientProperties

over to AMQConnection; added more documentation; start from a
filled-in table, rather than augmenting the table with other
parameters at connect time, to permit inspection and modification of
default values.

Author: tonyg

src/com/rabbitmq/client/ConnectionFactory.java

@@ -98,7 +98,7 @@ public class ConnectionFactory implements Cloneable {
     private int requestedChannelMax               = DEFAULT_CHANNEL_MAX;
     private int requestedFrameMax                 = DEFAULT_FRAME_MAX;
     private int requestedHeartbeat                = DEFAULT_HEARTBEAT;
-    private Map<String, Object> _clientProperties = getDefaultClientProperties();
+    private Map<String, Object> _clientProperties = AMQConnection.defaultClientProperties();
     private SocketFactory factory                 = SocketFactory.getDefault();
 
     /**
@@ -238,25 +238,23 @@ public void setRequestedHeartbeat(int requestedHeartbeat) {
     }
 
     /**
-     * Retrieve the default table of extra client properties to be sent to the
-     * server.
-     * @return the map of extra client properties
-     */
-    public static Map<String, Object> getDefaultClientProperties() {
-        return new HashMap<String, Object>();
-    }
-
-    /**
-     * Retrieve the map of extra client properties to be sent to the server
-     * @return the map of extra client properties
+     * Retrieve the currently-configured table of client properties
+     * that will be sent to the server during connection
+     * startup. Clients may add, delete, and alter keys in this
+     * table. Such changes will take effect when the next new
+     * connection is started using this factory.
+     * @return the map of client properties
+     * @see setClientProperties()
      */
     public Map<String, Object> getClientProperties() {
         return _clientProperties;
     }
 
     /**
-     * Set the extra client properties to be sent to the server
+     * Replace the table of client properties that will be sent to the
+     * server during subsequent connection startups.
      * @param clientProperties the map of extra client properties
+     * @see getClientProperties()
      */
     public void setClientProperties(Map<String, Object> clientProperties) {
         _clientProperties = clientProperties;

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

@@ -73,19 +73,27 @@ 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_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/")
-        };
+    /**
+     * Retrieve a copy of the default table of client properties that
+     * will be sent to the server during connection startup. This
+     * method is called when each new ConnectionFactory instance is
+     * constructed.
+     * @return a map of client properties
+     * @see Connection.getClientProperties()
+     */
+    public static Map<String, Object> defaultClientProperties() {
+        return Frame.buildTable(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);
@@ -218,8 +226,7 @@ public AMQConnection(ConnectionFactory factory,
         _requestedChannelMax = factory.getRequestedChannelMax();
         _requestedFrameMax = factory.getRequestedFrameMax();
         _requestedHeartbeat = factory.getRequestedHeartbeat();
-        _clientProperties =
-                buildClientPropertiesTable(factory.getClientProperties());
+        _clientProperties = new HashMap<String, Object>(factory.getClientProperties());
 
         this.factory = factory;
         _frameHandler = frameHandler;
@@ -414,14 +421,6 @@ public void writeFrame(Frame f) throws IOException {
         _lastActivityTime = System.nanoTime();
     }
 
-    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;
-    }
-
     private static int negotiatedMaxValue(int clientValue, int serverValue) {
         return (clientValue == 0 || serverValue == 0) ?
             Math.max(clientValue, serverValue) :