Changeset 83 for trunk/src/main/java/omq/common/util/OmqConnectionFactory.java

Timestamp:

07/08/13 13:29:24 (11 years ago)

Author:

stoda

Message:

J

File:

• trunk/src/main/java/omq/common/util/OmqConnectionFactory.java (modified) (6 diffs)

trunk/src/main/java/omq/common/util/OmqConnectionFactory.java

@@ -13 +13 @@
 
 /**
+ * This class creates RabbitMQ connections
  * 
  * @author Sergi Toda <sergi.toda@estudiants.urv.cat>
@@ -23 +24 @@
         private static int connectionTimeout = 2 * 1000;
 
+        /**
+         * If this class is wanted to use as a singleton class this is the init
+         * function
+         * 
+         * @param env
+         *            - environment that sets the properties needed by RabbitMQ
+         * @throws KeyManagementException
+         * @throws NoSuchAlgorithmException
+         * @throws IOException
+         */
         public static void init(Properties env) throws KeyManagementException, NoSuchAlgorithmException, IOException {
                 if (connection == null) {
@@ -29 +40 @@
         }
 
+        /**
+         * This function returns a working connection.
+         * 
+         * @param env
+         *            - used if it's necessary to create a new connection
+         * @return workingConnection
+         * @throws Exception
+         */
         public static Connection getNewWorkingConnection(Properties env) throws Exception {
                 Connection connection = null;
@@ -50 +69 @@
         }
 
+        /**
+         * This function creates a new rabbitmq connection using the properties set
+         * in env
+         * 
+         * @param env
+         *            - Properties needed to create a new connection: username,
+         *            password, rabbit_host, rabbit_port, enable_ssl (optional)
+         * @return new Connection
+         * @throws IOException
+         * @throws KeyManagementException
+         * @throws NoSuchAlgorithmException
+         */
         public static Connection getNewConnection(Properties env) throws IOException, KeyManagementException, NoSuchAlgorithmException {
                 // Get login info of rabbitmq
@@ -59 +90 @@
                 int port = Integer.parseInt(env.getProperty(ParameterQueue.RABBIT_PORT));
 
-                boolean ssl = Boolean.parseBoolean(env.getProperty(ParameterQueue.ENABLE_SSL));
+                boolean ssl = Boolean.parseBoolean(env.getProperty(ParameterQueue.ENABLE_SSL, "false"));
 
                 // Start a new connection and channel
@@ -78 +109 @@
         }
 
+        /**
+         * This method creates a new channel if the singleton pattern is used
+         * 
+         * @return new Channel
+         * @throws IOException
+         */
         public static Channel getNewChannel() throws IOException {
                 Channel channel = connection.createChannel();