[jboss-svn-commits] JBL Code SVN: r7503 - labs/jbossesb/trunk/product/core/rosetta/src/org/jboss/soa/esb/couriers

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

Author: kurt.stam at jboss.com
Date: 2006-11-09 13:08:32 -0500 (Thu, 09 Nov 2006)
New Revision: 7503

Modified:
   labs/jbossesb/trunk/product/core/rosetta/src/org/jboss/soa/esb/couriers/CourierFactory.java
Log:
Adding javadoc

Modified: labs/jbossesb/trunk/product/core/rosetta/src/org/jboss/soa/esb/couriers/CourierFactory.java
===================================================================
--- labs/jbossesb/trunk/product/core/rosetta/src/org/jboss/soa/esb/couriers/CourierFactory.java	2006-11-09 18:05:42 UTC (rev 7502)
+++ labs/jbossesb/trunk/product/core/rosetta/src/org/jboss/soa/esb/couriers/CourierFactory.java	2006-11-09 18:08:32 UTC (rev 7503)
@@ -19,14 +19,20 @@
  * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
  * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
  */
-
 package org.jboss.soa.esb.couriers;
-
+/**
+ * 
+ * @author - esteban
+ * @author - kstam at redhat.com
+ *
+ */
 import org.jboss.internal.soa.esb.couriers.TwoWayCourier;
 import org.jboss.soa.esb.addressing.EPR;
 
 public class CourierFactory 
 {
+	private static final CourierFactory _instance = new CourierFactory();
+	
 	// private default constructor
 	private CourierFactory() {}
 
@@ -34,21 +40,41 @@
 	{
 		return _instance;
 	}
-	
-	public static Courier getCourier(EPR outgoing) throws CourierException
+	/**
+	 * Obtain a courier which can perform deliveries only and prime it with the "to address" (toEPR).
+	 * 
+	 * @param toEPR - the 'to address', the address on where to deliver a Message.
+	 * @return
+	 * @throws CourierException if the specific courier implementation cannot be created.
+	 */
+	public static Courier getCourier(EPR toEPR) throws CourierException
 	{
-		return getCourier(outgoing,null);
+		return getCourier(toEPR, null);
 	}
-	
-	public static Courier getPickupCourier(EPR incoming) throws CourierException
+	/**
+	 * Obtain a courier which can perform pickups only and prime it with the "to address" (toEPR) 
+	 * and the "replyTo address" (replyToEPR). 
+	 * 
+	 * @param toEPR      - the 'to address', the address on where to deliver a Message.
+	 * @parem replyToEPR - the 'replyTo address', the address where to deliver the Message we pickup.
+	 * @return
+	 * @throws CourierException if the specific courier implementation cannot be created.
+	 */
+	public static Courier getPickupCourier(EPR replyToEPR) throws CourierException
 	{
-		return getCourier(null, incoming);
+		return getCourier(null, replyToEPR);
 	}
-	
-	public static Courier getCourier(EPR outgoing, EPR incoming) throws CourierException
+	/**
+	 * Obtain a courier which can perform both deliveries and pickups and prime it with 
+	 * the "to address" (toEPR) and the "replyTo address" (replyToEPR). 
+	 * 
+	 * @param toEPR      - the 'to address', the address on where to deliver a Message.
+	 * @parem replyToEPR - the 'replyTo address', the address where to deliver the Message we pickup.
+	 * @return
+	 * @throws CourierException if the specific courier implementation cannot be created.
+	 */
+	public static Courier getCourier(EPR toEPR, EPR replyToEPR) throws CourierException
 	{
-		return new TwoWayCourier(outgoing,incoming);
+		return new TwoWayCourier(toEPR, replyToEPR);
 	}
-	
-	private static final CourierFactory _instance = new CourierFactory();
 }