[jboss-svn-commits] JBL Code SVN: r5424 - labs/jbossesb/trunk/product/core/common/src/org/jboss/soa/esb/services

[jboss-svn-commits at lists.jboss.org]

Author: estebanschifman
Date: 2006-08-02 21:52:22 -0400 (Wed, 02 Aug 2006)
New Revision: 5424

Modified:
   labs/jbossesb/trunk/product/core/common/src/org/jboss/soa/esb/services/InotificationHandler.java
Log:
Added some javadoc

Modified: labs/jbossesb/trunk/product/core/common/src/org/jboss/soa/esb/services/InotificationHandler.java
===================================================================
--- labs/jbossesb/trunk/product/core/common/src/org/jboss/soa/esb/services/InotificationHandler.java	2006-08-03 01:15:37 UTC (rev 5423)
+++ labs/jbossesb/trunk/product/core/common/src/org/jboss/soa/esb/services/InotificationHandler.java	2006-08-03 01:52:22 UTC (rev 5424)
@@ -25,10 +25,37 @@
 import org.jboss.soa.esb.helpers.*;
 import java.io.Serializable;
 
+/**
+ * Use this interface to group all methods that can be useful to
+ * trigger events that can be caught by listeners, within or outside of
+ * the Rosetta framework
+ * 
+ * @author Esteban
+ *
+ */
 public interface InotificationHandler {
 	
 	// REVIEW: Add some Javadoc for this interface!!!
-	
+/**
+ * public void sendNotifications(DomElement p_oP, Serializable p_o)
+ * 
+ * @param p_oP DomElement - A serialized NotificationList object (as a DomElement)
+ * @param p_o  The Serializable object that will be sent to all the
+ * NotificationTarget objects contained in the NotificationList
+ * 
+ *  <p/>Implementations of this interface will be responsible of sending
+ *  the Serializable (arg 1) to destinations determined by each
+ *  NotificationTarget contained in the NotificationList represented by
+ *  arg 0.
+ *  <p/>Please see org.jboss.soa.esb.notification package for existing 
+ *  classes that extend NotificationTarget (Files, Queues, Topics, SqlTable...)
+ *  
+ *  <p/> Invoking processes are responsible to provide dynamic content 
+ *  of notification
+ *  <p/> The NotificationTarget objects can define 'static' content for
+ *  (suc as contents of certain columns in SQL, or message properties for
+ *  JMS notification targets, etc. 
+ */	
 	public void sendNotifications(DomElement p_oP, Serializable p_o) throws Exception;
 
 	public void sendNotifications(Serializable p_o) throws Exception;