Changeset 83 for trunk/src/main/java/omq/common/broker/Broker.java

Timestamp:

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

Author:

stoda

Message:

J

File:

• trunk/src/main/java/omq/common/broker/Broker.java (modified) (12 diffs)

trunk/src/main/java/omq/common/broker/Broker.java

@@ -16 +16 @@
 import omq.common.util.ParameterQueue;
 import omq.common.util.Serializer;
+import omq.exception.AlreadyBoundException;
 import omq.exception.InitBrokerException;
 import omq.exception.RemoteException;
@@ -30 +31 @@
 import com.rabbitmq.client.ShutdownSignalException;
 
+/**
+ * A "broker" allows a new connection to a RabbitMQ server. Under this
+ * connection it can have binded object and proxies.
+ * 
+ * @author Sergi Toda <sergi.toda@estudiants.urv.cat>
+ * 
+ */
 public class Broker {
 
@@ -65 +73 @@
         }
 
+        /**
+         * This method stops the broker's connection and all the threads created
+         * 
+         * @throws Exception
+         */
         public void stopBroker() throws Exception {
                 logger.warn("Stopping broker");
@@ -84 +97 @@
                 environment = null;
                 remoteObjs = null;
-                // Serializer.removeSerializers();
         }
 
@@ -95 +107 @@
         }
 
+        /**
+         * This method close the broker's connection
+         * 
+         * @throws IOException
+         */
         public void closeConnection() throws IOException {
                 logger.warn("Clossing connection");
@@ -103 +120 @@
 
         /**
+         * Return the broker's channel
          * 
          * @return Broker's channel
@@ -121 +139 @@
         }
 
+        /**
+         * Returns the remote object for specified reference.
+         * 
+         * @param reference
+         *            - Binding name
+         * @param contract
+         *            - Remote Interface
+         * @return newProxy
+         * @throws RemoteException
+         */
         @SuppressWarnings("unchecked")
         public synchronized <T extends Remote> T lookup(String reference, Class<T> contract) throws RemoteException {
@@ -126 +154 @@
 
                         if (!clientStarted) {
-                                initClient(environment);
-                                clientStarted = true;
+                                initClient();
                         }
 
@@ -144 +171 @@
         }
 
+        /**
+         * Returns the remote object for specified reference. This function returns
+         * an special type of proxy, every method invoked will be multi and
+         * asynchronous.
+         * 
+         * @param reference
+         *            - Binding name
+         * @param contract
+         *            - Remote Interface
+         * @return newProxy
+         * @throws RemoteException
+         */
         @SuppressWarnings("unchecked")
         public synchronized <T extends Remote> T lookupMulti(String reference, Class<T> contract) throws RemoteException {
@@ -161 +200 @@
         }
 
-        public void bind(String reference, RemoteObject remote) throws RemoteException {
+        /**
+         * Binds the reference to the specified remote object. This function uses
+         * the broker's environment
+         * 
+         * @param reference
+         *            - Binding name
+         * @param remote
+         *            - RemoteObject to bind
+         * @throws RemoteException
+         *             If the remote operation failed
+         * @throws AlreadyBoundException
+         *             If name is already bound.
+         */
+        public void bind(String reference, RemoteObject remote) throws RemoteException, AlreadyBoundException {
                 bind(reference, remote, environment);
         }
 
-        public void bind(String reference, RemoteObject remote, Properties env) throws RemoteException {
+        /**
+         * Binds the reference to the specified remote object. This function uses
+         * the broker's environment
+         * 
+         * @param reference
+         *            - Binding name
+         * @param remote
+         *            - RemoteObject to bind
+         * @param env
+         *            - RemoteObject environment. You can set how many threads will
+         *            be listen to the reference, the multiqueue name and the
+         *            properties of the object queue and multiqueue
+         * @throws RemoteException
+         *             If the remote operation failed
+         * @throws AlreadyBoundException
+         *             If name is already bound.
+         */
+        public void bind(String reference, RemoteObject remote, Properties env) throws RemoteException, AlreadyBoundException {
+                if (remoteObjs.containsKey(reference)) {
+                        throw new AlreadyBoundException(reference);
+                }
+                // Try to start the remtoeObject listeners
                 try {
                         remote.startRemoteObject(reference, this, env);
@@ -174 +247 @@
         }
 
+        /**
+         * Unbinds a remoteObject from its reference and kills all the threads
+         * created.
+         * 
+         * @param reference
+         *            - Binding name
+         * @throws RemoteException
+         *             If the remote operation failed
+         * @throws IOException
+         *             If there are problems while killing the threads
+         */
         public void unbind(String reference) throws RemoteException, IOException {
                 if (remoteObjs.containsKey(reference)) {
@@ -184 +268 @@
         }
 
-        public void rebind(String name, Remote obj) throws RemoteException {
-
-        }
-
-        /**
-         * This method ensures the client will have only one ResponseListener and
-         * only one EventDispatcher. Both with the same environment.
-         * 
-         * @param environment
-         * @throws Exception
-         */
-        private synchronized void initClient(Properties environment) throws Exception {
+        /**
+         * This method ensures the client will have only one ResponseListener.
+         * 
+         * @throws Exception
+         */
+        private synchronized void initClient() throws Exception {
                 if (responseListener == null) {
                         responseListener = new ResponseListener(this);
                         responseListener.start();
+                        clientStarted = true;
                 }
         }