You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tuscany.apache.org by na...@apache.org on 2010/02/22 11:21:06 UTC
svn commit: r912526 -
/tuscany/sca-java-1.x/trunk/tutorials/travelsample/README
Author: nash
Date: Mon Feb 22 10:21:05 2010
New Revision: 912526
URL: http://svn.apache.org/viewvc?rev=912526&view=rev
Log:
Update README for recent changes
Modified:
tuscany/sca-java-1.x/trunk/tutorials/travelsample/README
Modified: tuscany/sca-java-1.x/trunk/tutorials/travelsample/README
URL: http://svn.apache.org/viewvc/tuscany/sca-java-1.x/trunk/tutorials/travelsample/README?rev=912526&r1=912525&r2=912526&view=diff
==============================================================================
--- tuscany/sca-java-1.x/trunk/tutorials/travelsample/README (original)
+++ tuscany/sca-java-1.x/trunk/tutorials/travelsample/README Mon Feb 22 10:21:05 2010
@@ -2,8 +2,8 @@
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.
+1. Download and unzip JDK 6 update 7 (or later) or JDK 5 update 22, 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
@@ -12,10 +12,13 @@
4. Download and unzip the Tuscany SCA Java 1.6 (or later) binary distribution
and set the TUSCANY_HOME environment variable to the base directory
containing the unzipped binary distribution.
-5. Download and unzip the OpenEJB 3.0 (or later) binary distribution and set
+5. Download and unzip the OpenEJB 3.1.2 (or later) binary distribution and set
the OPENEJB_HOME environment variable to the base directory containing
the unzipped binary distribution.
-6. With the travelsample directory as your current directory, enter the
+6. If you are using JDK 5, download and unzip the JAX-WS reference implementation
+ version 2.1.7 and set the JAXWS_HOME environment variable to the base directory
+ containing the unzipped download.
+7. With the travelsample directory as your current directory, enter the
command "ant compile".
@@ -25,8 +28,8 @@
Most of the steps are similar to the above. For completeness, a full list
of the steps needed is given here.
-1. Download and unzip JDK 1.6.0_07 (or later) and set the JAVA_HOME
- environment variable to the JDK base directory.
+1. Download and unzip JDK 6 update 7 (or later) or JDK 5 update 22, and set
+ the JAVA_HOME environment variable to the JDK base directory.
2. Install svn and maven.
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
@@ -39,6 +42,11 @@
5. With the travelsample directory as your current directory, enter the
command "mvn". You will need a live internet connection so that maven
can download any required files to your local repository.
+6. By default the maven build produces a binary distribution that is an
+ add-on delta to the Tuscany SCA Java 1.6 binary distribution. If you
+ want to produce a fully self-contained binary distribution for the
+ travel sample, you can use the command "mvn -Pselfcontained" instead
+ of "mvn" to do this.
Running the travel sample from the build directories
@@ -55,6 +63,9 @@
prompt windows. In this case, each of the listed commands must be entered
into its own separate command prompt window in the order shown.
+Before running these scenarios, you need to perform the setup described above
+in "Building the travel sample using ant" if you have not already done this.
+
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
@@ -260,129 +271,159 @@
-----------------------------------------------------------
If the travel sample was built using maven, a binary distribution
-directory will be created containing all the built jar files together with
-a "lib" directory containing a complete set of runtime dependencies for
-these jar files. You can run each of the scenarios from the binary
-distribution by running one or more jar files using the "java -jar" command.
-
-The jar files that you need to run for each scenario are listed below.
-If multiple jar files are listed for a scenario, they must be run in
-separate processes in the order listed. The current directory for
-the "java -jar" command must be set as follows:
+directory will be created containing all the built jar files, together with
+some directories containing runtime dependencies for these jar files.
+
+The following directories contain the jar files for the travel sample:
+ clients - non-SCA clients using various communication technologies
+ contributions - SCA contributions for the travel sample
+ launchers - executable launchers for the travel sample
+ services - non-SCA services using various communication technologies
+ util - jar files needed by other jars in the travel sample
+
+The following directories contain runtime dependencies of the above jar files:
+ domainconfig - domain configuration files
+ jaxws - JAX-WS runtime jars neeed when running the travel sample on JDK 5
+ lib - Tuscany runtime jars and their dependencies needed by the travel sample
+ (only present if the travel sample was built using "mvn -Pselfcontained")
+ openejb - OpenEJB 3.1.2 runtime jars needed by the travel sample
+
+You can run each of the scenarios from the binary distribution by running one
+or more jar files using ant scripts that are included in the binary distribution.
+
+The ant commands that you need to use for running each scenario are listed below.
+If multiple ant commands are listed for a scenario, they must be run in
+separate processes in the order listed. The current directory when invoking
+the ant command must be set as follows:
launchers/scatours-launcher-*.jar are run from the launchers directory
clients/scatours-client-*.jar are run from the clients directory
- services/scatours-service-*.jar are run from the services directory
-
-For example, to run the "jumpstart" scenario, you would set your
-current directory to the distribution "launchers" directory and run
-the command
- java -jar scatours-launcher-jumpstart.jar
-
-Here is a complete list of the launcher commands needed to run the
-scenarios described above.
+ services/scatours-service-*.jar are run from the services directory
+
+To run a jar, you need to used the command "ant run-jarsuffix" where
+"jarsuffix" is the last part of the jar file name omitting the standard prefix
+"scatours-client", "scatours-launcher" or "scatours-service". For example,
+to run the "jumpstart" scenario, you would set your current directory to the
+binary distribution "launchers" directory and run the command
+ ant run-jumpstart
+This runs the travel sample jar file scatours-launcher-jumpstart.jar using a
+classpath with the required runtime dependencies from the Tuscany SCA binary
+distribution. The location of the Tuscany SCA binary distribution is specified
+by the TUSCANY_HOME environment variable).
+
+If the travel sample binary distribution was built using the "mvn -Pselfcontained"
+command, you can use the "java -jar" command to run the travel sample executable
+jars directly as an alternative to using ant scripts. For example, instead of
+using the command
+ ant run-jumpstart
+you can use the command
+ java -jar scatours-launcher-jumpstart.jar
+
+Here is a complete list of the ant commands to run the scenarios described above
+from the travel sample binary distribution. These are run from the "launchers"
+directory unlesss otherwise indicated.
1) Jumpstart - First simple example of using Tuscany
- java -jar scatours-launcher-jumpstart.jar
+ ant run-jumpstart
2) Introducing - Simplified introduction to the travel application
- java -jar scatours-launcher-introducing.jar
+ ant run-introducing
3) Introducing (distributed) - Distributed services with a domain manager
- java -jar scatours-launcher-introducing-domain.jar
- java -jar scatours-launcher-introducing-trips.jar
- java -jar scatours-launcher-introducing-tours.jar
- java -jar scatours-launcher-introducing-client.jar
+ ant run-introducing-domain
+ ant run-introducing-trips
+ ant run-introducing-tours
+ ant run-introducing-client
4) Interaction - Different SCA interaction styles
- java -jar scatours-launcher-interaction.jar
+ ant run-interaction
5) Full application - The full interactive travel application
- java -jar scatours-launcher-fullapp.jar
+ jant run-fullapp
6) Full application (distributed) - Distributed services with a domain manager
- java -jar scatours-launcher-fullapp-domain.jar
- java -jar scatours-launcher-fullapp-nodes.jar
+ ant run-fullapp-domain
+ ant run-fullapp-nodes
7) Building blocks - Using SCA composites as application building blocks
- java -jar scatours-launcher-buildingblocks.jar
+ ant run-buildingblocks
8) Blog feed
- java -jar scatours-launcher-blog-feed.jar
+ ant run-blog-feed
9) Data binding
- java -jar scatours-launcher-databinding.jar
+ ant run-databinding
10) Feed logger
- java -jar scatours-launcher-feed-logger.jar
+ ant run-feed-logger
11) Help pages
- java -jar scatours-launcher-help-pages.jar
+ ant run-help-pages
12) Policy
- java -jar scatours-launcher-policy.jar
+ ant run-policy
13) Payment service with different implementation types
13a) implementation.bpel
- java -jar scatours-launcher-payment-bpel.jar
+ ant run-payment-bpel
13b) implementation.script written in Groovy
- java -jar scatours-launcher-payment-groovy.jar
+ ant run-payment-groovy
13c) implementation.java
- java -jar scatours-launcher-payment-java.jar
+ ant run-payment-java
13d) implementation.java with policy
- java -jar scatours-launcher-payment-java-policy.jar
+ ant run-payment-java-policy
13e) implementation.spring
- java -jar scatours-launcher-payment-spring.jar
+ ant run-payment-spring
13f) implementation.spring with SCA tags
- java -jar scatours-launcher-payment-spring-scatag.jar
+ ant run-payment-spring-scatag
14) SCA currency converter service interoperating with SCA or non-SCA client
14a) SCA client
- java -jar scatours-launcher-currency-converter.jar
+ ant run-currency-converter
14b) CORBA client
- java -jar scatours-launcher-currency-converter-corba.jar
- java -jar scatours-client-currency-converter-corba.jar
+ ant run-currency-converter-corba
+ ant run-currency-converter-corba (from "clients" directory)
14c) JMS client
- java -jar scatours-launcher-currency-converter-jms.jar
- java -jar scatours-client-currency-converter-jms.jar
+ ant run-currency-converter-jms
+ ant run-currency-converter-jms (from "clients" directory)
14d) RMI client
- java -jar scatours-launcher-currency-converter-rmi.jar
- java -jar scatours-client-currency-converter-rmi.jar
+ ant run-currency-converter-rmi
+ ant run-currency-converter-rmi (from "clients" directory)
14e) JAX-WS client
- java -jar scatours-launcher-currency-converter-ws.jar
- java -jar scatours-client-currency-converter-ws-jaxws.jar
+ ant run-currency-converter-ws
+ ant run-currency-converter-ws-jaxws (from "clients" directory)
15) SCA notification service interoperating with non-SCA SMS gateway service
15a) SMS gateway CORBA service
- java -jar scatours-service-smsgateway-corba.jar
- java -jar scatours-launcher-notification-corba.jar
+ ant run-smsgateway-corba (from "services" directory)
+ ant run-notification-corba
15b) SMS gateway EJB service
- java -jar scatours-service-smsgateway-ejb.jar
- java -jar scatours-launcher-notification-ejb.jar
+ ant run-smsgateway-ejb (from "services" directory)
+ ant run-notification-ejb
15c) SMS gateway JMS service
- java -jar scatours-service-smsgateway-jms.jar
- java -jar scatours-launcher-notification-jms.jar
+ ant run-smsgateway-jms (from "services" directory)
+ ant run-notification-jms
15d) SMS gateway RMI service
- java -jar scatours-service-smsgateway-rmi.jar
- java -jar scatours-launcher-notification-rmi.jar
+ ant run-smsgateway-rmi (from "services" directory)
+ ant run-notification-rmi
15e) SMS gateway JAX-WS service
- java -jar scatours-service-smsgateway-jaxws.jar
- java -jar scatours-launcher-notification-ws.jar
+ ant run-smsgateway-jaxws (from "services" directory)
+ ant run-notification-ws
Cross-reference of contributions to scenarios