svn commit: r895592 - /tuscany/sandbox/travelsample/README

[na...@apache.org]

Author: nash
Date: Mon Jan  4 10:55:22 2010
New Revision: 895592

URL: http://svn.apache.org/viewvc?rev=895592&view=rev
Log:
Add first draft of README file to travel sample (TUSCANY-3399)

Added:
    tuscany/sandbox/travelsample/README

Added: tuscany/sandbox/travelsample/README
URL: http://svn.apache.org/viewvc/tuscany/sandbox/travelsample/README?rev=895592&view=auto
==============================================================================
--- tuscany/sandbox/travelsample/README (added)
+++ tuscany/sandbox/travelsample/README Mon Jan  4 10:55:22 2010
@@ -0,0 +1,210 @@
+Building the travel sample using ant
+------------------------------------
+
+1. Download and unzip JDK 1.6.0_07 or later and set the JAVA_HOME environment
+   variable to the JDK base directory.
+2. Install svn and ant.
+3. Create a local directory to hold the travel sample code.  With this as
+   your current directory, check out the complete travel sample from svn
+   using the following command:
+     svn co http://svn.apache.org/repos/asf/tuscany/sandbox/travelsample
+4. Download and unzip the Tuscany 1.5.1 (or later) binary distribution
+   and set the TUSCANY_HOME environment variable to the base directory
+   containing the unzipped binary distribution.
+5. Download the tuscany-host-corba-jse and tuscany-host-corba-jse-tns
+   jars from the maven repository http://repo1.maven.org/maven2 and set the
+   TUSCANY_HOST_CORBA environment variable to the local directory in which
+   these files are located.
+6. Download and unzip the OpenEJB 3.0 or later binary distribution and set
+   the OPENEJB_HOME environment variable to the base directory containing
+   the unzipped binary distribution.
+7. With the travelsample directory as your current directory, enter the
+   command "ant compile".
+
+Building the travel sample using maven
+--------------------------------------
+
+To be added.
+
+Running the travel sample
+-------------------------
+
+The travel sample consists of a number of related scenarios.  These are
+listed below, together with instructions for running them.
+
+Most of the scenarios are run by opening a single command prompt window
+and entering the command "ant run" into that window.  If a scenario is
+listed with multiple commands, this means that it needs multiple command
+prompt windows.  In this case, each of the listed commands must be entered
+into its own separate command prompt window in the order shown.
+
+For each scenario, the following are given:
+ Directory: the current directory for the command prompt window or windows
+ Command(s): the command or commands for running the scenario
+ Contributions: SCA contributions used in this scenario
+ Launchers: other launcher directories needed by this scenario, if any
+ Services: non-SCA services used in this scenario, if any
+ Clients: non-SCA services used in this scenario, if any
+
+1) Jumpstart - First simple example of using Tuscany
+
+Directory: launchers/jumpstart
+Command: ant run
+Contributions: introducing-trips
+Launchers: common
+
+2) Introducing - Simplified introduction to the travel application
+
+Directory: launchers/introducing
+Command: ant run
+Contributions: introducing-client, introducing-tours, introducing-trips
+Launchers: common
+
+3) Introducing (distributed) - Distributed services with a domain manager
+
+Directory: launchers/introducing-client
+Commands: ant run-domain, ant run-trips, ant run-tours, ant run
+Contributions: introducing-client, introducing-tours, introducing-trips
+Launchers: introducing-domain, introducing-tours, introducing-trips
+
+4) Interaction - Different SCA interaction styles 
+
+Directory: launchers/interaction
+Command: ant run
+Contributions: calendar, common, currency, flight, hotel, interaction-client, 
+   interaction-service-remote, shoppingcart
+Launchers: common
+
+5) Full application - The full interactive travel application
+
+Directory: launchers/fullapp
+Command: ant run
+Contributions: car, common, creditcard-payment-jaxb-policy, currency, flight,
+   fullapp-bespoketrip, fullapp-coordination, fullapp-currency, fullapp-packagedtrip,
+   fullapp-shoppingcart, fullapp-ui, hotel, payment-java-policy, scatours,
+   shoppingcart, travelcatalog, trip, tripbooking
+Launchers: common
+
+6) Full application (distributed) - Distributed services with a domain manager
+
+Directory: launchers/fullapp-nodes
+Commands: ant run-domain, ant run
+Contributions: car, common, creditcard-payment-jaxb-policy, currency, flight,
+   fullapp-bespoketrip, fullapp-coordination, fullapp-currency, fullapp-packagedtrip,
+   fullapp-shoppingcart, fullapp-ui, hotel, payment-java-policy, scatours,
+   shoppingcart, travelcatalog, trip, tripbooking
+Launchers: fullapp-domain
+
+7) Blog feed
+
+Directory: launchers/blog-feed
+Command: ant run
+Contributions: blog-feed
+Launchers: common
+
+8) Data binding
+
+Directory: launchers/databinding
+Command: ant run
+Contributions: creditcard-payment-sdo, databinding-client, payment-java
+Launchers: common
+
+9) Feed logger
+
+Directory: launchers/feed-logger
+Command: ant run
+Contributions: blog-feed
+Launchers: common
+
+10) Help pages
+
+Directory: launchers/help-pages
+Command: ant run
+Contributions: help-pages
+Launchers: common
+
+11) Policy
+
+Directory: launchers/policy
+Command: ant run
+Contributions: creditcard-payment-jaxb-policy, policy-client, payment-java-policy
+Launchers: common
+
+12) SCA currency converter service interoperating with SCA or non-SCA client
+
+12a) SCA client
+
+Directory: launchers/currency-converter
+Command: ant run
+Contributions: currency
+Launchers: common
+
+12b) CORBA client
+
+Directory: clients/currency-converter-corba
+Command: ant run-service, ant run
+Contributions: currency, currency-corba
+Launchers: common, currency-converter-corba
+
+12c) JMS client
+
+Directory: clients/currency-converter-jms
+Commands: ant run-broker, ant run-service, ant run
+Contributions: currency, currency-jms
+Launchers: common, currency-converter-jms
+
+12d) RMI client
+
+Directory: clients/currency-converter-rmi
+Command: ant run-service, ant run
+Contributions: currency, currency-rmi
+Launchers: common, currency-converter-rmi
+
+12e) JAX-WS client
+
+Directory: clients/currency-converter-ws-jaxws
+Command: ant run-service, ant run
+Contributions: currency, currency-ws
+Launchers: common, currency-converter-ws
+
+13) SCA notification service interoperating with non-SCA SMS gateway service
+
+13a) SMS gateway CORBA service
+
+Directory: launchers/notification-corba
+Commands: ant run-nameserver, ant run-smsgateway, ant run 
+Contributions: notification, notification-corba
+Launchers: common
+Services: smsgateway-corba
+
+13b) SMS gateway EJB service
+
+Directory: launchers/notification-ejb
+Commands: ant run-smsgateway, ant run 
+Contributions: notification, notification-ejb
+Launchers: common
+Services: smsgateway-ejb
+
+13c) SMS gateway JMS service
+
+Directory: launchers/notification-corba
+Commands: ant run-broker, ant run-smsgateway, ant run 
+Contributions: notification, notification-jms
+Launchers: common
+Services: smsgateway-jms
+
+13d) SMS gateway RMI service
+
+Directory: launchers/notification-rmi
+Commands: ant run-smsgateway, ant run 
+Contributions: notification, notification-rmi
+Launchers: common
+Services: smsgateway-rmi
+
+13e) SMS gateway JAX-WS service
+
+Directory: launchers/notification-ws
+Commands: ant run-smsgateway, ant run 
+Contributions: notification, notification-ws
+Launchers: common
+Services: smsgateway-jaxws