[hornetq-commits] JBoss hornetq SVN: r11385 - branches/Branch_2_2_EAP/src/main/org/hornetq/api/core/client.

[do-not-reply at jboss.org]

Author: clebert.suconic at jboss.com
Date: 2011-09-21 12:51:08 -0400 (Wed, 21 Sep 2011)
New Revision: 11385

Modified:
   branches/Branch_2_2_EAP/src/main/org/hornetq/api/core/client/ClientSession.java
Log:
javadoc

Modified: branches/Branch_2_2_EAP/src/main/org/hornetq/api/core/client/ClientSession.java
===================================================================
--- branches/Branch_2_2_EAP/src/main/org/hornetq/api/core/client/ClientSession.java	2011-09-21 15:54:17 UTC (rev 11384)
+++ branches/Branch_2_2_EAP/src/main/org/hornetq/api/core/client/ClientSession.java	2011-09-21 16:51:08 UTC (rev 11385)
@@ -569,7 +569,10 @@
    void addMetaData(String key, String data) throws HornetQException;
 
    /**
-    * Attach any metadata to the session. Throws an exception if there's already a metadata available
+    * Attach any metadata to the session. Throws an exception if there's already a metadata available.
+    * You can use this metadata to ensure that there is no other session with the same meta-data you are passing as an argument.
+    * This is useful to simulate unique client-ids, where you may want to avoid multiple instances of your client application connected.
+    * 
     * @throws HornetQException 
     */
    void addUniqueMetaData(String key, String data) throws HornetQException;