[overlord-commits] Overlord SVN: r343 - cdl/trunk/samples/jbossesb.

overlord-commits at lists.jboss.org overlord-commits at lists.jboss.org
Thu Sep 25 05:21:15 EDT 2008 

Author: objectiser
Date: 2008-09-25 05:21:15 -0400 (Thu, 25 Sep 2008)
New Revision: 343

Modified:
   cdl/trunk/samples/jbossesb/README.txt
   cdl/trunk/samples/jbossesb/SamplesGuide.odt
   cdl/trunk/samples/jbossesb/SamplesGuide.pdf
Log:
Update documentation on the samples

Modified: cdl/trunk/samples/jbossesb/README.txt
===================================================================
--- cdl/trunk/samples/jbossesb/README.txt	2008-09-24 13:51:33 UTC (rev 342)
+++ cdl/trunk/samples/jbossesb/README.txt	2008-09-25 09:21:15 UTC (rev 343)
@@ -1,99 +1,22 @@
-Instructions for examples running:
-=================================
-
-Required to run the Purchasing example:
----------------------------------------
-- ANT 1.6.5 or higher
-- Maven 2.0.8 or higher
-- JBoss AS 4.2.2.GA or higher with the JBoss ESB SAR deployment (jbossesb.sar).
-- JBossESB 4.3.GA 
-
-Folders structure:
--------------------
-- client: It is for running examples' client. 
-- broker: Broker participant. (Broker Example)
-- purchasing: Purchasing participant. (Purchase Example) 
-- creditAgency: CredityAgency participant. (For both Broker and Purchase Example)
-- supplier: supplier participant. (For Broker example)
-
-Settings required to edit before running:
-========================================
-
-File: $samples/pom.xml 
-- Update the "deploy.dir" property value to your JBossAS server directory.
-
-- Before jbossesb-rosetta.jar and jbossesb-config-model.jar get published in jboss maven repository, you need to install these two artifacts into 
-your local repository by using following commands:
-
-mvn install:install-file -Dfile=<path-to-rosetta> -DgroupId=org.jboss.jbossesb 
-    -DartifactId=rosetta -Dversion=4.3 -Dpackaging=jar 
-mvn install:install-file -Dfile=<path-to-configmodel> -DgroupId=org.jboss.jbossesb
-    -DartifactId=config-model -Dversion=1.0.1 -Dpackaging=jar
-
-Notice: Here we are using jbossesb-rosetta 4.3 version, jbossesb-config-model 1.0.1 version.
-
-
-Instructions for deploying the cdl-jbossesb.esb to the JBoss ESB server.
-==========================================
-1. At the $cdl/trunk: run: mvn install.
-2. Copy the 'cdl-jbossesb.esb' from the 'assembly/jbossesb/target' to JBoss ESB server deploy folder.
-
-
-Instructions for deploying samples:
-==========================================
-1. Please make sure you are setting the 'deploy.dir' in $samples/pom.xml properly.
-2. At the $cdl/trunk/samples, run: mvn install, it will deploy the 'purchasing.esb', 'broker.esb', 'creditAgency.esb', 'supplier.esb' to the server deploy folder.
-3. From the $JBossAS, execute the command to start the ESB server: "bin/run.sh", or "bin/run.bat" for windows.
-
-Instructions for running purchasing example:
-===========================================
-
-1 - from the $samples/jbossesb/client, execute the command to run the client: "ant runClient"
-    You will see following in the console.
-
-     [java] =========================================
-     [java] Request: <BuyRequest id="5" ></BuyRequest>
-     [java] Reply: <BuyResponse id="5"></BuyResponse>
-     [java] =========================================
-
-
-Instructions for running broker example:
-=======================================
-
-1 - from the $samples/jbossesb/client, execute the command to run the client: "ant runBrokerClient"
-    You will see following in the console.
-     [java] =========================================
-     [java] Request: <enquiry id="20" ></enquiry>
-     [java] Reply: <quoteList id="20"><quote supplierDesc="{http://www.jboss.org/overlord/loanBroker}Supplier1">10</quote></quoteList>
-     [java] Sending Buy request to Broker...
-     [java] Request: <buy id="20" supplierDesc="{http://www.jboss.org/overlord/loanBroker}Supplier1" quoteValue="10"></buy>
-     [java] Reply: <bookingReference id="20" supplierDesc = "{http://www.jboss.org/overlord/loanBroker}Supplier1">The quote of 10 has been confirmed.</bookingReference>
-     [java] =========================================
-
-Example scenario description:
-===============================
-1 - Purchasing example:
-------------
-The flow for this example would be:
-
-    * Users send an 'buy' request to broker
-    * Broker send a 'credit check' request to the credit agency.
-    * If the credit agency returns a successful message, then the Broker will send a 'BuyResponse' to user.
-    * If the credit agency returns a failed message, then the Broker will send a 'BuyFail' to user.
-
-
-2 - Broker example:
-----------
-
-The flow for this example would be:
-
-    * Users send an 'enquiry' request to broker
-    * Broker sends the request to one or more suppliers concurrently
-    * When all of the quote responses have been received, or a timeout expires, the available information is returned to the user.
-    * User decides whether to:
-          o Cancel the transaction, or
-          o Send a 'buy' request to the broker
-    * If a 'buy' request is received by the broker, it will send a 'credit check' request to the credit agency
-    * If the credit agency returns a successful message, then the Broker sends a 'buy' request to the supplier selected by the User (in the 'buy' request), followed by a confirmation back to the User
-    * If the credit agency returns a failed message, then the Broker will inform the User
-
+Samples Readme
+==============
+
+This folder contains samples associated with the Overlord CDL project.
+
+Information on the samples, and the instructions to run them, can be found in the SamplesGuide.pdf.
+
+For more information on the service validation, and "conversation aware" ESB capabilities, the reader is referred to the documents in the docs folder.
+
+
+Contents of this folder
+-----------------------
+
+brokerage - this folder contains the model and ESB configurations for the Brokerage example, demonstrating the "conversation aware" ESB capability
+
+client - this folder contains the client applications for use with the Brokerage and Purchasing examples
+
+common - this folder contains the ESB configuration for the Credit Agency service, which is used as part of both the Brokerage and Purchasing "conversation aware" ESB examples
+
+purchasing - this folder contains the model and ESB configurations for the Purchasing example, demonstrating the "conversation aware" ESB capability
+
+trailblazer - this folder contains an enhanced version of the JBossESB TrailBlazer example, to demonstrate the service validation capability

Modified: cdl/trunk/samples/jbossesb/SamplesGuide.odt
===================================================================
(Binary files differ)

Modified: cdl/trunk/samples/jbossesb/SamplesGuide.pdf
===================================================================
(Binary files differ)

More information about the overlord-commits mailing list