X-Git-Url: http://git.argeo.org/?a=blobdiff_plain;f=org.argeo.slc.webapp%2Fsrc%2Fmain%2Fwebapp%2Fargeo-ria-src%2Fclass%2Forg%2Fargeo%2Fria%2Fremote%2FJmsClient.js;h=63711e74b724420a9a454e8ea0e333d6826e0230;hb=614cd339a65450805c1684af40bba14db6a8333f;hp=792b87c164c2e5b5b6f7f97cb35b0d1c531cab38;hpb=cc5155c7c9dbc6359043051df64fd4f2bbe28e62;p=gpl%2Fargeo-slc.git

diff --git a/org.argeo.slc.webapp/src/main/webapp/argeo-ria-src/class/org/argeo/ria/remote/JmsClient.js b/org.argeo.slc.webapp/src/main/webapp/argeo-ria-src/class/org/argeo/ria/remote/JmsClient.js
index 792b87c16..63711e74b 100644
--- a/org.argeo.slc.webapp/src/main/webapp/argeo-ria-src/class/org/argeo/ria/remote/JmsClient.js
+++ b/org.argeo.slc.webapp/src/main/webapp/argeo-ria-src/class/org/argeo/ria/remote/JmsClient.js
@@ -1,3 +1,7 @@
+/**
+ * A standard client for sending/receiving JMS message.
+ * It is based on ActiveMQ Ajax implementation.
+ */
 qx.Class.define("org.argeo.ria.remote.JmsClient", {
 
 	type : "singleton",
@@ -8,7 +12,7 @@ qx.Class.define("org.argeo.ria.remote.JmsClient", {
 	},
 	members : {
   		// The URI of the MessageListenerServlet
-		uri : '/org.argeo.slc.webapp/amq',		
+		uri : '../amq',		
 
 		// Polling. Set to true (default) if waiting poll for messages is needed
 		poll : true,
@@ -20,13 +24,20 @@ qx.Class.define("org.argeo.ria.remote.JmsClient", {
 		_pollDelay : 0,
 
 		_first : true,
+		/**
+		 * Trigger at each poll event.
+		 * @param first {Boolean} Whether it is the first event to be triggered. 
+		 */
 		_pollEvent : function(first) {},
 		_handlers : new Array(),
 
+		/**
+		 * Parses the XML response to a message POST.
+		 * @param response {qx.io.remote.Response} The query response
+		 */
 		_messageHandler : function(response) {
-			var doc = response.getContent();
-			var NSMap = {slc:"http://argeo.org/projects/slc/schemas"};
-			var messages = org.argeo.ria.util.Element.selectNodes(doc, "//response", NSMap);
+			var doc = response.getContent();			
+			var messages = org.argeo.ria.util.Element.selectNodes(doc, "//response");
 			for(var i=0;i<messages.length;i++){
 				var id = messages[i].getAttribute("id");
 				if(id && this._handlers[id]){
@@ -35,6 +46,10 @@ qx.Class.define("org.argeo.ria.remote.JmsClient", {
 			}
 		},
 		
+		/**
+		 * Parses the empty response of a poll GET query.
+		 * @param response {qx.io.remote.Response} The query response
+		 */
 		_pollHandler : function(response) {
 			try {
 				this._messageHandler(response);
@@ -50,6 +65,10 @@ qx.Class.define("org.argeo.ria.remote.JmsClient", {
 				this._sendPoll();
 		},
 
+		/**
+		 * Send a poll query : GET query and no paramter at all. 
+		 * @param request {qx.io.remote.Request} A request object
+		 */
 		_sendPoll : function(request) {
 			if(this.interrupt) return;
 			var request = new qx.io.remote.Request(this.uri, "GET", "application/xml");
@@ -58,9 +77,13 @@ qx.Class.define("org.argeo.ria.remote.JmsClient", {
 			request.send();
 		},
 
-		// Add a function that gets called on every poll response, after all received
-		// messages have been handled.  The poll handler is past a boolean that indicates
-		// if this is the first poll for the page.
+		/**
+		 * Add a function that gets called on every poll response, after all received
+		 * messages have been handled.  The poll handler is past a boolean that indicates
+		 * if this is the first poll for the page.
+		 * 
+		 * @param func {Function} The handler to be called. 
+		 */
 		addPollHandler : function(func) {
 			var old = this._pollEvent;
 			this._pollEvent = function(first) {
@@ -69,33 +92,86 @@ qx.Class.define("org.argeo.ria.remote.JmsClient", {
 			}
 		},
 
-		// Send a JMS message to a destination (eg topic://MY.TOPIC).  Message should be xml or encoded
-		// xml content.
-		sendMessage : function(destination, message) {
-			this._sendMessage(destination, message, 'send');
+		/**
+		 * Send a JMS message to a destination (eg topic://MY.TOPIC).  
+		 * Message should be xml or encoded xml content.
+		 * 
+		 * @param destination {String} The topic destination
+		 * @param message {String} XML encoded message
+		 * @param properties {Map} A map of additional parameters to add to the query.
+		 */
+		sendMessage : function(destination, message, properties) {
+			this._sendMessage(destination, message, 'send', properties);
 		},
 
-		// Listen on a channel or topic.   handler must be a function taking a message arguement
+		/**
+		 * Listen on a channel or topic.   handler must be a function taking a message arguement
+		 * @param id {String} A unique identifier for this handler
+		 * @param destination {String} The topic to listen to (topic://MY.TOPIC) 
+		 * @param handler {Function} The handler to trigger when receiving a message 
+		 * @param context {Object} An object to bind on the handler.
+		 */
 		addListener : function(id, destination, handler, context) {
 			this._handlers[id] = qx.lang.Function.bind(handler, context);
 			this._sendMessage(destination, id, 'listen');
 		},
 
-		// remove Listener from channel or topic.
+		/**
+		 * Remove Listener from channel or topic.
+		 * @param id {String} identifier of the handler to remove.
+		 * @param destination {String} The topic to listen to (topic://MY.TOPIC) 
+		 */ 
 		removeListener : function(id, destination) {
 			this._handlers[id] = null;
 			this._sendMessage(destination, id, 'unlisten');
 		},
-
-		_sendMessage : function(destination, message, type) {
+		
+		/**
+		 * Send a message of a given type.
+		 * @param destination {String} The topic to listen to (topic://MY.TOPIC) 
+		 * @param message {String} XML encoded message
+		 * @param type {String} The JMS-Type of message (listen, unlisten, send).
+		 * @param properties {Map} A map of additional parameters to add to the query.
+		 */
+		_sendMessage : function(destination, message, type, properties) {
 			var req = new qx.io.remote.Request(this.uri, "POST", "text/plain");
-			req.setParameter("destination", destination);
-			req.setParameter("message", message);
-			req.setParameter("type", type);
+			if(!properties) properties = {};			
+			properties["destination"] = destination;
+			properties["message"] = message;
+			properties["type"] = type;
+	        var vParametersList = [];
+	
+	        for (var vId in properties)
+	        {
+	          var value = properties[vId];
+	          if (value instanceof Array)
+	          {
+	            for (var i=0; i<value.length; i++)
+	            {
+	              vParametersList.push(encodeURIComponent(vId) +
+	                                   "=" +
+	                                   encodeURIComponent(value[i]));
+	            }
+	          }
+	          else
+	          {
+	            vParametersList.push(encodeURIComponent(vId) +
+	                                 "=" +
+	                                 encodeURIComponent(value));
+	          }
+	        }	
+	        if (vParametersList.length > 0)
+	        {
+	          req.setData(vParametersList.join("&"));
+	        }
+			
 			//req.addListener("completed", this.endBatch, this);
 			req.send();
 		},
 
+		/**
+		 * Starts a poll on the JMS server.
+		 */
 		startPolling : function() {
 			if (this.poll){
 				this.interrupt = false;
@@ -106,6 +182,9 @@ qx.Class.define("org.argeo.ria.remote.JmsClient", {
 			}
 		},
 		
+		/**
+		 * Stops polling the JMS server.
+		 */
 		stopPolling : function(){
 			this.interrupt = true;
 		}