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/04/25 23:11:16 UTC
svn commit: r937875 -
/tuscany/sca-java-1.x/trunk/tutorials/travelsample/distribution/src/main/release/README
Author: nash
Date: Sun Apr 25 21:11:16 2010
New Revision: 937875
URL: http://svn.apache.org/viewvc?rev=937875&view=rev
Log:
Restructure the README file
Modified:
tuscany/sca-java-1.x/trunk/tutorials/travelsample/distribution/src/main/release/README
Modified: tuscany/sca-java-1.x/trunk/tutorials/travelsample/distribution/src/main/release/README
URL: http://svn.apache.org/viewvc/tuscany/sca-java-1.x/trunk/tutorials/travelsample/distribution/src/main/release/README?rev=937875&r1=937874&r2=937875&view=diff
==============================================================================
--- tuscany/sca-java-1.x/trunk/tutorials/travelsample/distribution/src/main/release/README (original)
+++ tuscany/sca-java-1.x/trunk/tutorials/travelsample/distribution/src/main/release/README Sun Apr 25 21:11:16 2010
@@ -1,266 +1,461 @@
+README for the Apache Tuscany SCA Travel Sample 1.0 April 2010
+==============================================================
-Running the travel sample from the source directories
------------------------------------------------------
+Structure of the travel sample
+------------------------------
+
+The travel sample consists of the following directory tree:
+
+lib dependencies for the travel sample (see notes below)
+ jaxws jars from the JAX-WS reference implementation
+ junit the Junit jar
+ openejb jars from the OpenEJB binary distribution
+travelsample top-level directory for the travel sample
+ binaries builds a binaries-only package for the travel sample
+ clients non-SCA clients for the travel sample
+ contributions SCA contributions for the travel sample
+ distribution builds the travel sample distribution
+ domainconfig configuration files for the domain manager
+ launchers launcher programs for the travel sample
+ services non-SCA services used by the travel sample
+ testdomain scratch directory for trying out the domain manager
+ util utility code used by other parts of the travel sample
+
+Note1: The travel sample depends on the Apache Tuscany SCA Java 1.x binary
+distribution, which is downloaded separately from the travel sample.
+To avoid needless duplication, the "lib" directory of the travel sample
+only contains dependencies that aren't provided in the current release
+of the Tuscany SCA Java 1.x binary distribution.
+
+Note2: Before attempting to build or run the travel sample, you will need to
+download the Apache Tuscany SCA Java 1.6 (or later) binary distribution and
+set your TUSCANY_HOME environment variable to a local directory containing
+the unpacked binary distribution.
+
+
+Overview of the travel sample
+-----------------------------
+
+The travel sample consists of a number of related scenarios. For each
+scenario, this section lists the following:
+ Description: A description of the scenario.
+ Contributions: SCA contributions used in the scenario. Each contribution
+ is a subdirectory of the travelsample/contributions directory.
+ Launchers: Launchers used in the scenario. Each launcher is a subdirectory
+ of the travelsample/launchers directory.
+ Services: Non-SCA services used in the scenario, if any. Each non-SCA
+ service is a subdirectory of the travelsample/services directory.
+ Clients: Non-SCA clients used in the scenario, if any. Each non-SCA
+ client is a subdirectory of the travelsample/clients directory.
+ Webapp: Web application (.war) file used to run the scenario, for those
+ scenarios that use contributions packaged as web applications and
+ deployed in a Web application server such as Tomcat.
-The travel sample consists of a number of related scenarios. These scenarios
-are listed below, together with instructions for running them. The instructions
-in this section will work irrespective of whether the travel sample was built
-using ant or maven.
-
-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.
-
-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.
-
-Some of the scenarios are packaged as web applications (.war files). Instead
-of being run from the command line, these are deployed to a suitable web
-application server (such as Apache Tomcat) and run from a browser.
-
-For each scenario, the following are listed below:
- Command(s): the command or commands for running the scenario, if any
- Directory: the current directory for the command prompt window or windows
- Webapp: .war file to be deployed for this scenario, if any
- URL(s): browser URL or URLs used to run this scenario, if any
- Contributions: SCA contributions used in this scenario
- Launchers: other launcher directories used in this scenario, if any
- Services: non-SCA services used in this scenario, if any
- Clients: non-SCA clients used in this scenario, if any
+Details of how to build and run these scenarios can be found in later
+sections of this file.
-1) Jumpstart - First simple example of using Tuscany
+1) Jumpstart - First simple example of using Tuscany
-Command: ant run
-Directory: launchers/jumpstart
+Description: *** to be added ***
Contributions: introducing-trips
+Launchers: jumpstart
2) Introducing - Simplified introduction to the travel application
-Command: ant run
-Directory: launchers/introducing
+Description: *** to be added ***
Contributions: introducing-client, introducing-tours, introducing-trips
+Launchers: introducing
3) Introducing (distributed) - Distributed services with a domain manager
-Commands: ant run-domain, ant run-trips, ant run-tours, ant run
-Directory: launchers/introducing-client
+Description: *** to be added ***
Contributions: introducing-client, introducing-tours, introducing-trips
-Launchers: introducing-domain, introducing-tours, introducing-trips
+Launchers: introducing-client, introducing-domain, introducing-tours,
+ introducing-trips
-4) Interaction - Different SCA interaction styles
+4) Interaction - Different SCA interaction styles
-Command: ant run
-Directory: launchers/interaction
+Description: Each SCA interaction pattern is demonstrated using a component
+ from the travel booking application. Were going to see the Hotel, Calendar,
+ CurrencyConverter and ShoppingCart components used here. These components
+ don't work in isolation so for each interaction pattern we've written a
+ simple client component. For example, the InteractionLocalClient component
+ demonstrates local interactions by sending a local message to the Calendar
+ component. The launcher starts two nodes (node1 and node2) which are used
+ to run samples for all of the interaction patterns. The first node "node1"
+ loads the contributions common, currency, calendar, shoppingcart, and
+ interaction-client, and runs the client.composite from the interaction-client
+ contribution. The local interaction patterns are demonstrated by clients
+ calling the currency, calendar, and shoppingcart components locally within
+ node1. The second node node2 loads the contributions common, hotel, and
+ interaction-service-remote, and runs the service.composite from the
+ interaction-service-remote contribution. This node provides the hotel
+ component that's used by client components in node1 for sending remote
+ messages to demonstrate the remote interaction pattern.
Contributions: calendar, common, currency, flight, hotel, interaction-client,
interaction-service-remote, shoppingcart
+Launchers: interaction
5) Full application - The full interactive travel application
-Command: ant run
-Directory: launchers/fullapp
-URL: http://localhost:8080/scatours
+Description: *** to be added ***
Contributions: car, common, creditcard-payment-jaxb-policy, currency, flight,
fullapp-bespoketrip, fullapp-coordination, fullapp-currency, fullapp-packagedtrip,
fullapp-shoppingcart, fullapp-ui, hotel, payment-spring-policy, scatours,
shoppingcart, travelcatalog, trip, tripbooking
+Launchers: fullapp
6) Full application (distributed) - Distributed services with a domain manager
-Commands: ant run-domain, ant run
-Directory: launchers/fullapp-nodes
-URL: http://localhost:8080/scatours
+Description: *** to be added ***
Contributions: car, common, creditcard-payment-jaxb-policy, currency, flight,
fullapp-bespoketrip, fullapp-coordination, fullapp-currency, fullapp-packagedtrip,
fullapp-shoppingcart, fullapp-ui, hotel, payment-spring-policy, scatours,
shoppingcart, travelcatalog, trip, tripbooking
-Launchers: fullapp-domain
+Launchers: fullapp-domain, fullapp-nodes
7) Building blocks - Using SCA composites as application building blocks
-Commands: ant run
-Directory: launchers/buildingblocks
+Description: *** to be added ***
Contributions: buildingblocks, buildingblocks-client, introducing-trips
+Launchers: buildingblocks
8) Blog feed
-Command: ant run
-Directory: launchers/blog-feed
-URLs: http://localhost:8090/BlogAtom, http://localhost:8090/BlogRSS,
- http://localhost:8090/BlogAtomAPIs, http://localhost:8090/BlogRSSAPIs
+Description: *** to be added ***
Contributions: blog-feed
+Launchers: blog-feed
9) Data binding
-Command: ant run
-Directory: launchers/databinding
+Description: *** to be added ***
Contributions: creditcard-payment-sdo, databinding-client, payment-java
+Launchers: databinding
10) Feed logger
-Command: ant run
-Directory: launchers/feed-logger
+Description: *** to be added ***
Contributions: feed-logger
+Launchers: feed-logger
11) Help pages
-Command: ant run
-Directory: launchers/help-pages
-URL: http://localhost:8085/help/index.html
+Description: *** to be added ***
Contributions: help-pages
+Launchers: help-pages
12) Policy
-Command: ant run
-Directory: launchers/policy
+Description: *** to be added ***
Contributions: creditcard-payment-jaxb-policy, payment-java-policy, policy-client
+Launchers: policy
13) Payment service with different implementation types
+Description: *** to be added ***
+
13a) implementation.bpel
-Command: ant run
-Directory: launchers/payment-bpel
+Description: *** to be added ***
Contributions: creditcard-payment-jaxb, emailgateway, payment-bpel, payment-bpel-process
+Launchers: payment-bpel
13b) implementation.script written in Groovy
-Command: ant run
-Directory: launchers/payment-groovy
+Description: *** to be added ***
Contributions: creditcard-payment-jaxb, emailgateway, payment-groovy
+Launchers: payment-groovy
13c) implementation.java
-Command: ant run
-Directory: launchers/payment-java
+Description: *** to be added ***
Contributions: creditcard-payment-jaxb, payment-java
+Launchers: payment-java
13d) implementation.java with policy
-Command: ant run
-Directory: launchers/payment-java-policy
+Description: *** to be added ***
Contributions: creditcard-payment-jaxb-policy, payment-java-policy
+Launchers: payment-java-policy
13e) implementation.spring
-Command: ant run
-Directory: launchers/payment-spring
+Description: *** to be added ***
Contributions: creditcard-payment-jaxb, payment-spring
+Launchers: payment-spring
13f) implementation.spring with SCA tags
-Command: ant run
-Directory: launchers/payment-spring-scatag
+Description: *** to be added ***
Contributions: creditcard-payment-jaxb, payment-spring-scatag
+Launchers: payment-spring-scatag
-14) SCA service packaged in a web application
+14) SCA credit card payment service packaged as a web application
-Webapp: scatours-contribution-creditcard-payment-webapp.war
+Description: *** to be added ***
Contributions: creditcard-payment-jaxb, creditcard-payment-webapp
-URL: http://localhost:8080/scatours-contribution-creditcard-payment-webapp
-
-Note: The host name and port number may differ depending on the configuration
-of the web application server.
+Webapp: creditcard-payment-webapp
15) SCA currency converter service interoperating with SCA or non-SCA client
+Description: *** to be added ***
+
15a) SCA client
-Command: ant run
-Directory: launchers/currency-converter
+Description: *** to be added ***
Contributions: currency
+Launchers: currency-converter
15b) CORBA client
-Commands: ant run, ant run-client
-Directory: launchers/currency-converter-corba
+Description: *** to be added ***
Contributions: currency, currency-corba
+Launchers: currency-converter-corba
Clients: currency-converter-corba
15c) JMS client
-Commands: ant run, ant run-client
-Directory: launchers/currency-converter-jms
+Description: *** to be added ***
Contributions: currency, currency-jms
+Launchers: currency-converter-jms
Clients: currency-converter-jms
15d) RMI client
-Commands: ant run, ant run-client
-Directory: launchers/currency-converter-rmi
+Description: *** to be added ***
Contributions: currency, currency-rmi
+Launchers: currency-converter-rmi
Clients: currency-converter-rmi
15e) JAX-WS client
-Commands: ant run, ant run-client
-Directory: launchers/currency-converter-ws
+Description: *** to be added ***
Contributions: currency, currency-ws
+Launchers: currency-converter-ws
Clients: currency-converter-ws-jaxws
15f) Web application JSP client
-Webapp: scatours-contribution-currency-jsp.war
+Description: *** to be added ***
Contributions: currency, currency-jsp
-URL: http://localhost:8080/scatours-contribution-currency-jsp
-
-Note: The URL host name and port number may differ depending on the
-configuration of the web application server.
+Webapp: scatours-contribution-currency-jsp.war
15g) Web application servlet client
-Webapp: scatours-contribution-currency-servlet.war
+Description: *** to be added ***
Contributions: currency, currency-servlet
-URL: http://localhost:8080/scatours-contribution-currency-servlet
-
-Note: The URL host name and port number may differ depending on the
-configuration of the web application server.
+Webapp: scatours-contribution-currency-servlet.war
16) SCA notification service interoperating with non-SCA SMS gateway service
+Description: *** to be added ***
+
16a) SMS gateway CORBA service
-Commands: ant run-smsgateway, ant run
-Directory: launchers/notification-corba
+Description: *** to be added ***
Contributions: notification, notification-corba
Services: smsgateway-corba
+Launchers: notification-corba
16b) SMS gateway EJB service
-Commands: ant run-smsgateway, ant run
-Directory: launchers/notification-ejb
+Description: *** to be added ***
Contributions: notification, notification-ejb
Services: smsgateway-ejb
+Launchers: notification-ejb
16c) SMS gateway JMS service
-Commands: ant run-smsgateway, ant run
-Directory: launchers/notification-jms
+Description: *** to be added ***
Contributions: notification, notification-jms
Services: smsgateway-jms
+Launchers: notification-jms
16d) SMS gateway RMI service
-Commands: ant run-smsgateway, ant run
-Directory: launchers/notification-rmi
+Description: *** to be added ***
Contributions: notification, notification-rmi
Services: smsgateway-rmi
+Launchers: notification-rmi
16e) SMS gateway JAX-WS service
-Commands: ant run-smsgateway, ant run
-Directory: launchers/notification-ws
+Description: *** to be added ***
Contributions: notification, notification-ws
Services: smsgateway-jaxws
+Launchers: notification-ws
+
+
+Building the travel sample
+--------------------------
+
+Please see the BUILDING file in the travel sample distribution for full
+details of how to build the travel sample using Maven or Ant.
+
+
+Running travel sample scenarios from launcher source directories
+----------------------------------------------------------------
+
+After building the travel sample using either Maven or Ant, you can run
+all the scenarios that have launchers by using ant scripts in the
+subdirectories of the travelsample/launchers directory. For scenarios
+that are packaged as web applications and don't have launchers, the next
+section describes how you can run these.
+
+You can run the launcher ant scripts as follows:
+ 1. Open a command prompt.
+ 2. Change directory to travelsample/launchers/<launcher-dir> where
+ <launcher-dir> is the launcher directory for the scenario that you
+ want to run.
+ 3. Enter the command shown in Table 1 below. This command is usually
+ "ant run". This runs an ant script that sets the necessary
+ classpath and invokes the launcher class.
+ 4. Some scenarios require the above steps to be repeated multiple times
+ with different commands. These cases are indicated by entries in
+ Table 1 with more than one command listed. For these scenarios, all
+ the listed commands should be entered in separate command prompts
+ from the same current directory and in the same order as shown.
+ 5. Some scenarios have a browser-based user interface which is started
+ by entering the URL shown in Table 1 in a browser after running the
+ launcher or launchers for the scenario. The recommended browser is
+ Firefox as some scenarios don't work with Internet Explorer.
+
+Table 1. Running scenarios packaged as launchers and contributions
+-----------------------------------------------------------------------------------------------------
+| Scenario Launcher directory Commands URLs |
+-----------------------------------------------------------------------------------------------------
+| 1) Jumpstart | jumpstart | ant run | |
+-----------------------------------------------------------------------------------------------------
+| 2) Introducing | introducing | ant run | |
+-----------------------------------------------------------------------------------------------------
+| 3) Introducing | introducing-client | ant run-domain | |
+| (distributed) | | ant run-trips | |
+| | | ant run-tours | |
+| | | ant run | |
+-----------------------------------------------------------------------------------------------------
+| 4) Interaction | interaction | ant run | |
+-----------------------------------------------------------------------------------------------------
+| 5) Full application | fullapp | ant run | http://localhost:8080/scatours |
+-----------------------------------------------------------------------------------------------------
+| 6) Full application | fullapp-nodes | ant run-domain | |
+| (distributed) | | ant run | |
+-----------------------------------------------------------------------------------------------------
+| 7) Building blocks | buildingblocks | ant run | |
+-----------------------------------------------------------------------------------------------------
+| 8) Blog feed | blog-feed | ant run | http://localhost:8090/BlogAtom |
+| | | | http://localhost:8090/BlogRSS |
+| | | | http://localhost:8090/BlogAtomAPIs |
+| | | | http://localhost:8090/BlogRSSAPIs |
+-----------------------------------------------------------------------------------------------------
+| 9) Data binding | databinding | ant run | |
+-----------------------------------------------------------------------------------------------------
+| 10) Feed logger | feed-logger | ant run | |
+-----------------------------------------------------------------------------------------------------
+| 11) Help pages | help-pages | ant run | http://localhost:8085/help/index.html |
+-----------------------------------------------------------------------------------------------------
+| 12) Policy | policy | ant run | |
+-----------------------------------------------------------------------------------------------------
+| 13) Payment service implementation types |
+| |
+| Impl type Launcher directory Commands URLs |
+-----------------------------------------------------------------------------------------------------
+| 13a) BPEL | payment-bpel | ant run | |
+-----------------------------------------------------------------------------------------------------
+| 13b) Groovy | payment-groovy | ant run | |
+-----------------------------------------------------------------------------------------------------
+| 13c) Java | payment-java | ant run | |
+-----------------------------------------------------------------------------------------------------
+| 13d) Java + policy | payment-java-policy | ant run | |
+-----------------------------------------------------------------------------------------------------
+| 13e) Spring | payment-spring | ant run | |
+-----------------------------------------------------------------------------------------------------
+| 13f) Spring SCA tags | payment-spring-scatag | ant run | |
+-----------------------------------------------------------------------------------------------------
+| 15) Currency converter service binding types |
+| |
+| Binding type Launcher directory Commands URLs |
+-----------------------------------------------------------------------------------------------------
+| 15a) SCA | currency-converter | ant run | |
+-----------------------------------------------------------------------------------------------------
+| 15b) CORBA | currency-converter-corba | ant run | |
+| | | ant run-client | |
+-----------------------------------------------------------------------------------------------------
+| 15c) JMS | currency-converter-jms | ant run | |
+| | | ant run-client | |
+-----------------------------------------------------------------------------------------------------
+| 15d) RMI | currency-converter-rmi | ant run | |
+| | | ant run-client | |
+-----------------------------------------------------------------------------------------------------
+| 15e) WS | currency-converter-ws | ant run | |
+| | | ant run-client | |
+-----------------------------------------------------------------------------------------------------
+| 16) Notification reference binding types |
+| |
+| Binding type Launcher directory Commands URLs |
+-----------------------------------------------------------------------------------------------------
+| 16a) CORBA | notification-corba | ant run-smsgateway | |
+| | | ant run | |
+-----------------------------------------------------------------------------------------------------
+| 16b) EJB | notification-ejb | ant run-smsgateway | |
+| | | ant run | |
+-----------------------------------------------------------------------------------------------------
+| 16c) JMS | notification-jms | ant run-smsgateway | |
+| | | ant run | |
+-----------------------------------------------------------------------------------------------------
+| 16d) RMI | notification-rmi | ant run-smsgateway | |
+| | | ant run | |
+-----------------------------------------------------------------------------------------------------
+| 16e) WS | notification-ws | ant run-smsgateway | |
+| | | ant run | |
+-----------------------------------------------------------------------------------------------------
+
+
+Running travel sample scenarios in a Web application server
+-----------------------------------------------------------
+
+Some scenarios are packaged as web applications (.war files) and don't
+have launchers. After building the travel sample using either Maven or Ant,
+you can use a Web application server to run these scenarios.
+
+You can run these web applications as follows:
+ 1. Deploy the web application (.war) file to a Web application server
+ such as Tomcat. The .war file can be found in the directory
+ travelsample/contributions/<contrib-dir>/target where <contrib-dir>
+ is the contribution directory listed in Table 2 below. The name of
+ the .war file is scatours-contribution-<contrib-dir>.war.
+ 2. Start the browser-based user interface for the scenario by entering
+ its URL in a browser. The URL for each scenario is shown in Table 2.
+ The recommended browser is Firefox because some scenarios don't work
+ with Internet Explorer.
+
+Table 2. Running scenarios packaged as web applications
+--------------------------------------------------------------------------------------------------------------------------
+| Scenario | Contribution directory | URL |
+--------------------------------------------------------------------------------------------------------------------------
+| 14) Credit card | creditcard-payment-webapp | http://localhost:8080/scatours-contribution-creditcard-payment-webapp |
+| webapp service | | | |
+--------------------------------------------------------------------------------------------------------------------------
+| 15f) Currency | currency-jsp | http://localhost:8080/scatours-contribution-currency-jsp | |
+| converter JSP | | |
+--------------------------------------------------------------------------------------------------------------------------
+| 15g) Currency | currency-servlet | http://localhost:8080/scatours-contribution-currency-servlet | |
+| converter | | |
+| servlet | | |
+--------------------------------------------------------------------------------------------------------------------------
+
+Note: The host name and port number in the above URLs may differ depending
+on the configuration of the Web application server in which the web application
+was deployed.
-Running the travel sample from the "binaries" directory
--------------------------------------------------------
+Running travel sample scenarios from the "binaries" directory
+-------------------------------------------------------------
-If the travel sample was built using maven, a binaries/target directory
+If the travel sample was built using Maven, a binaries/target directory
will be created with subdirectories containing all the built jar and war
-files and runtime dependencies for the jar files.
+files and runtime dependencies for these files. This enables you to see
+how a Tuscany application can be packaged in binary form by an application
+developer for distribution to users of the application.
The following subdirectories of binaries/target contain jar and war files
for the travel sample:
@@ -272,7 +467,7 @@ for the travel sample:
webapps - war files for the travel sample
The following subdirectories of binaries/target contain runtime dependencies
-for the above jar files:
+for the above 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
@@ -280,153 +475,162 @@ for the above jar files:
ode - JPA Derby database needed by the ODE runtime
openejb - OpenEJB 3.1.2 runtime jars needed by the travel sample
-You can run each of the scenarios from the appropriate subdirectory of the
-binaries/target directory using ant scripts that are included in these
-subdirectories.
-
-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 to the appropriate subdirectory of binaries/target
-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
-
-To run a jar, you need to use 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
-binaries/target/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 was built using the "mvn -Pselfcontained" command, you can
-use the "java -jar" command to run the travel sample executable jars directly as
-n 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 binaries/target subdirectories. These are run from the "launchers"
-subdirectory unlesss otherwise indicated.
-
- 1) Jumpstart - First simple example of using Tuscany
- ant run-jumpstart
-
- 2) Introducing - Simplified introduction to the travel application
- ant run-introducing
-
- 3) Introducing (distributed) - Distributed services with a domain manager
- ant run-introducing-domain
- ant run-introducing-trips
- ant run-introducing-tours
- ant run-introducing-client
-
- 4) Interaction - Different SCA interaction styles
- ant run-interaction
-
- 5) Full application - The full interactive travel application
- jant run-fullapp
-
- 6) Full application (distributed) - Distributed services with a domain manager
- ant run-fullapp-domain
- ant run-fullapp-nodes
+You can run the travel sample scenarios that have launchers by doing
+the following:
+ 1. Open a command prompt.
+ 2. Change directory to travelsample/binaries/target/<runtime-dir> where
+ <runtime-dir> is the directory for the scenario shown in Table 3 below.
+ 3. Enter the command for the scenario shown in Table 3. This runs an
+ ant script that sets the necessary classpath and invokes the launcher class.
+ 4. Some scenarios require the above steps to be repeated multiple times
+ with different commands. These cases are indicated by entries in
+ Table 3 with more than one directory and command listed. For these
+ scenarios, all the listed commands should be entered in separate command
+ prompts from the listed current directories in the same order as shown.
+ 5. Some scenarios have a browser-based user interface which is started
+ by entering the URL shown in Table 3 in a browser after running the
+ launcher or launchers for the scenario. The recommended browser is
+ Firefox as some scenarios don't work with Internet Explorer.
+
+Table 3. Running scenarios with launchers from the binaries directory
+--------------------------------------------------------------------------------------------------------
+| Scenario | Directory | Commands | URLs |
+--------------------------------------------------------------------------------------------------------
+| 1) Jumpstart | launchers | ant run-jumpstart | |
+--------------------------------------------------------------------------------------------------------
+| 2) Introducing | launchers | ant run-introducing | |
+--------------------------------------------------------------------------------------------------------
+| 3) Introducing | launchers | ant run-introducing-domain | |
+| (distributed) | launchers | ant run-introducing-trips | |
+| | launchers | ant run-introducing-tours | |
+| | launchers | ant run-introducing-client | |
+--------------------------------------------------------------------------------------------------------
+| 4) Interaction | launchers | ant run-interaction | |
+--------------------------------------------------------------------------------------------------------
+| 5) Full application | launchers | ant run-fullapp | http://localhost:8080/scatours |
+--------------------------------------------------------------------------------------------------------
+| 6) Full application | launchers | ant run-fullapp-domain | |
+| (distributed) | launchers | ant run-fullapp-nodes | |
+--------------------------------------------------------------------------------------------------------
+| 7) Building blocks | launchers | ant run-buildingblocks | |
+--------------------------------------------------------------------------------------------------------
+| 8) Blog feed | launchers | ant run-blog-feed | http://localhost:8090/BlogAtom |
+| | | | http://localhost:8090/BlogRSS |
+| | | | http://localhost:8090/BlogAtomAPIs |
+| | | | http://localhost:8090/BlogRSSAPIs |
+--------------------------------------------------------------------------------------------------------
+| 9) Data binding | launchers | ant run-databinding | |
+--------------------------------------------------------------------------------------------------------
+| 10) Feed logger | launchers | ant run-feed-logger | |
+--------------------------------------------------------------------------------------------------------
+| 11) Help pages | launchers | ant run-help-pages | http://localhost:8085/help/index.html |
+--------------------------------------------------------------------------------------------------------
+| 12) Policy | launchers | ant run-policy | |
+--------------------------------------------------------------------------------------------------------
+| 13) Payment service implementation types |
+| |
+| Impl type Directory Commands URLs |
+--------------------------------------------------------------------------------------------------------
+| 13a) BPEL | launchers | ant run-payment-bpel | |
+--------------------------------------------------------------------------------------------------------
+| 13b) Groovy | launchers | ant run-payment-groovy | |
+--------------------------------------------------------------------------------------------------------
+| 13c) Java | launchers | ant run-payment-java | |
+--------------------------------------------------------------------------------------------------------
+| 13d) Java + policy | launchers | ant run-payment-java-policy | |
+--------------------------------------------------------------------------------------------------------
+| 13e) Spring | launchers | ant run-payment-spring | |
+--------------------------------------------------------------------------------------------------------
+| 13f) Spring SCA tags | launchers | ant run-payment-spring-scatag | |
+--------------------------------------------------------------------------------------------------------
+| 15) Currency converter service binding types |
+| |
+| Binding type Directories Commands URLs |
+--------------------------------------------------------------------------------------------------------
+| 15a) SCA | launchers | ant run-currency-converter | |
+--------------------------------------------------------------------------------------------------------
+| 15b) CORBA | launchers | ant run-currency-converter-corba | |
+| | clients | ant run-currency-converter-corba | |
+--------------------------------------------------------------------------------------------------------
+| 15c) JMS | launchers | ant run-currency-converter-jms | |
+| | clients | ant run-currency-converter-jms | |
+--------------------------------------------------------------------------------------------------------
+| 15d) RMI | launchers | ant run-currency-converter-rmi | |
+| | clients | ant run-currency-converter-rmi | |
+--------------------------------------------------------------------------------------------------------
+| 15e) WS | launchers | ant run-currency-converter-ws | |
+| | clients | ant run-currency-converter-ws-jaxws | |
+--------------------------------------------------------------------------------------------------------
+| 16) Notification reference binding types |
+| |
+| Binding type Directories Commands URLs |
+--------------------------------------------------------------------------------------------------------
+| 16a) CORBA | services | ant run-smsgateway-corba | |
+| | launchers | ant run-notification-corba | |
+--------------------------------------------------------------------------------------------------------
+| 16b) EJB | services | ant run-smsgateway-ejb | |
+| | launchers | ant run-notification-ejb | |
+--------------------------------------------------------------------------------------------------------
+| 16c) JMS | services | ant run-smsgateway-jms | |
+| | launchers | ant run-notification-jms | |
+--------------------------------------------------------------------------------------------------------
+| 16d) RMI | services | ant run-smsgateway-rmi | |
+| | launchers | ant run-notification-rmi | |
+--------------------------------------------------------------------------------------------------------
+| 16e) WS | services | ant run-smsgateway-jaxws | |
+| | launchers | ant run-notification-ws | |
+--------------------------------------------------------------------------------------------------------
+
+The scenarios packaged as web applications can be run using .war files
+from the binaries/target/webapps directory as follows:
+ 1. Deploy the web application (.war) file to a Web application server
+ such as Tomcat. The .war file can be found in the directory
+ travelsample/binaries/target/webapps and has the name listed in
+ Table 4 below.
+ 2. Start the browser-based user interface for the scenario by entering
+ its URL in a browser. The URL for each scenario is shown in Table 4.
+ The recommended browser is Firefox because some scenarios don't work
+ with Internet Explorer.
+
+Table 4. Running scenarios packaged as web applications
+----------------------------------------------------------------------------------------------------------------------------------------------------
+| Scenario | Web application file | URL |
+----------------------------------------------------------------------------------------------------------------------------------------------------
+| 14) Credit card | scatours-contribution-creditcard-payment-webapp.war | http://localhost:8080/scatours-contribution-creditcard-payment-webapp |
+| webapp service | | | |
+----------------------------------------------------------------------------------------------------------------------------------------------------
+| 15f) Currency | scatours-contribution-currency-jsp.war | http://localhost:8080/scatours-contribution-currency-jsp | |
+| converter JSP | | |
+----------------------------------------------------------------------------------------------------------------------------------------------------
+| 15g) Currency | scatours-contribution-currency-servlet.war | http://localhost:8080/scatours-contribution-currency-servlet | |
+| converter | | |
+| servlet | | |
+----------------------------------------------------------------------------------------------------------------------------------------------------
+
+Note: The host name and port number in the above URLs may differ depending
+on the configuration of the Web application server in which the web application
+was deployed.
- 7) Building blocks - Using SCA composites as application building blocks
- ant run-buildingblocks
- 8) Blog feed
- ant run-blog-feed
-
- 9) Data binding
- ant run-databinding
-
-10) Feed logger
- ant run-feed-logger
-
-11) Help pages
- ant run-help-pages
-
-12) Policy
- ant run-policy
-
-13) Payment service with different implementation types
-
-13a) implementation.bpel
- ant run-payment-bpel
-
-13b) implementation.script written in Groovy
- ant run-payment-groovy
-
-13c) implementation.java
- ant run-payment-java
-
-13d) implementation.java with policy
- ant run-payment-java-policy
-
-13e) implementation.spring
- ant run-payment-spring
-
-13f) implementation.spring with SCA tags
- ant run-payment-spring-scatag
-
-14) SCA service packaged in a web application
- deploy webapps/scatours-contribution-creditcard-payment-webapp.war to Tomcat
-
-15) SCA currency converter service interoperating with SCA or non-SCA client
-
-15a) SCA client
- ant run-currency-converter
-
-15b) CORBA client
- ant run-currency-converter-corba
- ant run-currency-converter-corba (from "clients" directory)
-
-15c) JMS client
- ant run-currency-converter-jms
- ant run-currency-converter-jms (from "clients" directory)
-
-15d) RMI client
- ant run-currency-converter-rmi
- ant run-currency-converter-rmi (from "clients" directory)
-
-15e) JAX-WS client
- ant run-currency-converter-ws
- ant run-currency-converter-ws-jaxws (from "clients" directory)
-
-15f) Web application JSP client
- deploy webapps/scatours-contribution-currency-jsp.war to Tomcat
-
-15g) Web application servlet client
- deploy webapps/scatours-contribution-currency-servlet.war to Tomcat
-
-16) SCA notification service interoperating with non-SCA SMS gateway service
-
-16a) SMS gateway CORBA service
- ant run-smsgateway-corba (from "services" directory)
- ant run-notification-corba
-
-16b) SMS gateway EJB service
- ant run-smsgateway-ejb (from "services" directory)
- ant run-notification-ejb
-
-16c) SMS gateway JMS service
- ant run-smsgateway-jms (from "services" directory)
- ant run-notification-jms
-
-16d) SMS gateway RMI service
- ant run-smsgateway-rmi (from "services" directory)
- ant run-notification-rmi
-
-16e) SMS gateway JAX-WS service
- ant run-smsgateway-jaxws (from "services" directory)
- ant run-notification-ws
+Building and running the self-contained travel sample
+-----------------------------------------------------
+The travel sample can be built using the "mvn -Pselfcontained" command. This
+puts all of its runtime dependencies under the binaries/target directory and
+doesn't use any files from the Tuscany SCA Java binary distribution.
+
+If the travel sample has been built in this way, you can run it as described
+in the previous section using the same ant scripts. Alternatively you can
+use the "java -jar" command to run the travel sample executable jars directly
+using the manifest dependencies in the jar files. For example, the commands
+ ant run-currency-converter-ws
+ ant run-currency-converter-ws-jaxws
+ ant run-smsgateway-corba
+could be replaced by the commands
+ java -jar scatours-launcher-currency-converter-ws.jar
+ java -jar scatours-client-currency-converter-ws-jaxws.jar
+ java -jar scatours-service-smsgateway-corba.jar
+
Cross-reference of contributions to scenarios
---------------------------------------------