Tuscany Samples
The Tuscany Samples samples are shipped with Tuscany binary and source releases. If you are using tuscany from a release distribution then To make sure that you are 're looking at the documentation that corresponds to the samples as they stood at the time of the release ...
[2.0-beta-Samples documentation|2.0-beta-Samples documentation]If however you are working with a snapshot distribution, or using samples code from the trunk of our source repository, then you've come to the right place, as the documentation here reflects the curtrent status of the samples in the trunk of our source tree.
In a distribution, the samples source code is found in either a binary or source code distribution in the samples directory, directly under the root directory. The following sections are laid out to match the structure of the samples directory and its subdirectories.
Table of Contents | ||||
---|---|---|---|---|
|
getting-started
The basic package of SCA application artifacts is a contribution which for this simple sample is found in contribution-helloworld. There's also a directory which contains all you need to make a web application archive which can be deployed to a web container such as Tomcat, so that the sayHello service can be run in the web container.
contribution-helloworld
In this folder you'll find the simplest contribution, implemented in Java, that implements the "business logic" of saying hello to a person whose name is supplied as input to the service. This contribution contains Java implementation code offering the service String sayHello(String name), where the implementation of the service prepends "Hello" to the name and prints the result to the console.
helloworld-webapp
Warning | ||
---|---|---|
| ||
It's not at all clear how this is supposed to work once it is in the web container - I have asked on the dev list |
running-tuscany
Running something in Tuscany requires one or more contributions, and a method of launching the contributions to make them available as services. In the sections below is described various means of launching contributions into an executing tuscany runtime.
launcher-command-line
To execute a sample contribution from the command line on Windows, from a command prompt in the samples directory, run the command ...
Code Block |
---|
..\bin\tuscany.bat "contribution-name"
|
for example
Code Block |
---|
..\bin\tuscany.bat contribution-binding-sca-calculator
|
or on *nix platforms, from a shell prompt in the samples directory, run the command ...
Code Block |
---|
../bin/tuscany.sh contribution-binding-sca-calculator
|
launcher-embedded-jse
This directory contains sample java launchers for the
tuscany sample contributions. To use the sample JSE launchers with ant execute the command
Code Block |
---|
ant run-<contributionname>
|
where run-<contributionname> is one of the targets in the build.xml file
To use this sample launcher to run all of the contributions as junit test cases, execute the command "mvn" in the launcher directory.
launcher-embedded-osgi
The launchers implemented in the src/main/java/launchers directory each launch a specific contribution into the OSGI runtime.
To use this sample OSGI launcher with ant excute the command
Code Block |
---|
ant run-<contributionname>
|
where run-<contributionname> is one of the targets in the build.xml file
To use this sample launcher to run all of the contributions as junit test cases,
execute the command
Code Block |
---|
mvn |
in the launcher directory.
launcher-maven
To execute a sample contribution from Maven
look for contributions that have the following configuration in their pom.xml file:
<plugin>
<groupId>org.apache.tuscany.maven.plugins</groupId>
<artifactId>maven-tuscany-plugin</artifactId>
<version>2.0-SNAPSHOT</version>
</plugin>
For contributions that have this, for example, learning-more/binding-sca/contribution-calculator, do the following
cd samples/learning-more/binding-sca/contribution-calculator
mvn tuscany:run
This will launch the contribution in the Tuscany runtime and then wait. At this point you can use
other clients to send messages to services that the running SCA applcation exposes,
for example, try learning-more/calculator-scaclient.
launcher-osgi
The Tuscany runtime can be run in and OSGi container.
Running in Equinox
On Windows, run
Code Block |
---|
java \-jar ..\..\modules\osgi-3.5.0-v20090520.jar \-configuration ..\..\features\configuration \-clean \-console
|
On *Unix, run
Code Block |
---|
java \-jar ../../modules/osgi-3.5.0-v20090520.jar \-configuration ../../features/configuration \-clean \-console
|
You should see the osgi console:
Code Block |
---|
osgi>
osgi> Jun 22, 2009 1:32:27 PM org.apache.tuscany.sca.extensibility.equinox.EquinoxServiceDiscoveryActivator start
INFO: Equinox-based service discoverer is now configured.
|
You can run "ss" command under the osgi> to see the status of the bundles.
Code Block |
---|
osgi> ss
|
Then you can install and start contributions as bundles by doing the following:
Code Block |
---|
osgi> install file:./path/to/contribution_bundle.jar
|
Note that contribution_bundle.jar will need an activator in order to register the bundle as a SCA contribution
Warning |
---|
see samples/???? |
Running on Felix
See http://tuscany.apache.org/documentation-2x/running-tuscany-sca-2x-with-equinox-and-felix.html
launcher-shell
This directory contains a sample shell program supporting simple commands to
start and stop SCA composites.
To build the sample shell do this:
Code Block |
---|
mvn install
|
To run it:
Code Block |
---|
./sca
|
at the prompt:
Code Block |
---|
start myNode ../../applications/store/target/sample-store.jar
|
or:
Code Block |
---|
start myNode http://people.apache.org/~jsdelfino/tuscany/java/test/sample-store.jar
|
also try:
Code Block |
---|
status
stop myNode
bye
|
Starting and stopping composites is pretty fast. To see that, try the following
two scripts, which start/stop the sample store composite 10 times.
Code Block |
---|
./sca <scripts/test.txt
|
or
Code Block |
---|
./sca <scripts/test-remote.txt
|
The shell can also run as a Webapp. To try it install target/scashell.war in
a Web container, point your Web browser to http://localhost:8080/scashell
and try the links on that page.
launcher-webapp
To execute sample webapp based contributions (contributions that have webapp at the end of their name) you
can build the contribution using maven and then copy the resulting war file to your container of choice
For example, for binding-jsonrpc/contribution-calculator-webapp, do the following
Code Block |
---|
cd samples/binding-jsonrpc/contribution-calculator-webapp
mvn
cp target/sample-contribution-binding-jsonrpc-calculator-webapp.war your_container_deployment-dir
|
As an alternative sample webapp based contributions can be run within Jetty directly from Maven, look for
webapp contributions that have the following configuration in their pom.xml file:
Code Block |
---|
<plugin>
<groupId>org.mortbay.jetty</groupId>
<artifactId>maven-jetty-plugin</artifactId>
<version>6.1.18</version>
</plugin>
|
For contributions that have this, for example, binding-jsonrpc/contribution-calculator-webapp, do the following
Code Block |
---|
cd samples/binding-sca/contribution-calculator
mvn jetty:run
|
This will launch the contribution in the Jetty runtime and then wait. At this point you can use
HTTP clients to send messages to services that the running SCA applcation exposes. For this
example try pointing your browser at:
Code Block |
---|
http://localhost:8080/sample-contribution-binding-jsonrpc-calculator-webapp/
|
learning-more
The samples found in the contributions below illustrate how to get more of of SCA and Tuscany's features.
contributions
...
title | TODO |
---|
matches the distribution you have downloaded select the appropriate link below:
2.0-Beta1 samples documentation
helloworld-bpel
Note | ||
---|---|---|
| ||
check instructions work and fix up |
This sample demonstrates an SCA service implemented by a BPEL process.
If you just want to run it to see what happens open a command prompt, navigate
to this sample directory, and do
Code Block |
---|
ant compile run
|
OR if you don't have ant, on Windows do
Code Block |
---|
mkdir target\classes
mkdir target\wsdl2java-source
java -cp ..\..\lib\tuscany-sca-manifest.jar org.apache.tuscany.sdo.generate.XSD2JavaGenerator -targetDirectory target/wsdl2java-source -prefix HelloWorld -noContainment -noUnsettable src/main/resources/helloworld.wsdl
java -cp ..\..\lib\tuscany-sca-manifest.jar org.apache.tuscany.tools.wsdl2java.generate.WSDL2JavaGenerator -targetDirectory target/wsdl2java-source src/main/resources/helloworld.wsdl
unzip ..\..\lib\ode-dao-jpa-ojpa-derby-1.1.zip -d target\database
javac -d target\classes -cp target\classes;..\..\lib\tuscany-sca-manifest.jar -sourcepath src\main\java;target\wsdl2java-source -target 1.5 -g -source 1.5 src\main\java\helloworld\BPELClient.java
copy src\main\resources\* target\classes
java -cp ..\..\lib\tuscany-sca-manifest.jar;target\classes;target\database helloworld.BPELClient
|
and on *nix do
Code Block |
---|
mkdir target/classes
mkdir target/wsdl2java-source
java -cp ../../lib/tuscany-sca-manifest.jar org.apache.tuscany.sdo.generate.XSD2JavaGenerator -targetDirectory target/wsdl2java-source -prefix HelloWorld -noContainment -noUnsettable src/main/resources/helloworld.wsdl
java -cp ../../lib/tuscany-sca-manifest.jar org.apache.tuscany.tools.wsdl2java.generate.WSDL2JavaGenerator -targetDirectory target/wsdl2java-source src/main/resources/helloworld.wsdl
unzip ../../lib/ode-dao-jpa-ojpa-derby-1.1.zip -d target/database
javac -d target/classes -cp target/classes;../../lib/tuscany-sca-manifest.jar -sourcepath src/main/java;target/wsdl2java-source -target 1.5 -g -source 1.5 src/main/java/helloworld/BPELClient.java
cp src/main/resources/* target/classes
java -cp ../../lib/tuscany-sca-manifest.jar:target/classes:target/database helloworld.BPELClient
|
The sample will start an embedded BPEL engine, deploy a process and invoke it.
Sample Overview
The sample provides a single component that is wired to a service with a
web service binding.
Code Block |
---|
helloworld-bpel/
src/
main/
java/
helloworld/
BPELClient.java - client application for
BEPELHelloWorldComponent
resources/
deploy.xml - ODE deployment descriptor
helloworld.bpel - helloworld bpel process
helloworld.componentType - helloworld bpel service description
helloworld.composite - the SCA assembly for this sample
helloworld.wsdl - the service description that describes
the bpel process
log4j.properties - logging configuration
test/
java/
helloworld/
BPELHelloWorldTestCase.java - JUnit test case
helloworld-bpel.png - a pictorial representation of the
sample .composite file
build.xml - the Ant build file
pom.xml - the Maven build file
|
Building And Running The Sample Using Ant
With the binary distribution the sample can be built and run using Ant as
follows
Code Block |
---|
cd helloworld-bpel
ant compile
ant run
|
You should see the following output from the run target.
Code Block |
---|
run:
[java] Starting BPELHelloWorldComponent
[java] >>> Deploying : D:\temp\SCA1.1-RC1\tuscany-sca-1.1-incubating\samples\helloworld-bpel\target\classes
[java] ::arg:::::: <?xml version="1.0" encoding="UTF-8"?>
[java] <hello xmlns="http://tuscany.apache.org/implementation/bpel/example/helloworld.wsdl"><message xmlns="http://tuscany.apache.org/implementation/bpel/exampl
e/helloworld.wsdl">Hello</message></hello>
[java] ::message:: <?xml version="1.0" encoding="UTF-8"?>
[java] <message><TestPart><hello xmlns="http://tuscany.apache.org/implementation/bpel/example/helloworld.wsdl"><message xmlns="http://tuscany.apache.org/impleme
ntation/bpel/example/helloworld.wsdl">Hello</message></hello></TestPart></message>
[java] Status: RESPONSE
[java] Response: <?xml version="1.0" encoding="UTF-8"?>
[java] <message><TestPart><hello xmlns="http://tuscany.apache.org/implementation/bpel/example/helloworld.wsdl">Hello World</hello></TestPart></message>
[java] Hello World
[java] Stopping BPELHelloWorldComponent
[java] Stopped !!!
BUILD SUCCESSFUL
Total time: 36 seconds
|
Building And Running The Sample Using Maven
With either the binary or source distributions the sample can be built and run
using Maven as follows. When using Maven, a simple test is present that exercise
the same logic as the client to invoke the BPEl process.
Code Block |
---|
cd helloworld-bpel
mvn
|
You should see the following output from the test phase.
Code Block |
---|
-------------------------------------------------------
T E S T S
-------------------------------------------------------
Running helloworld.BPELHelloWorldTestCase
Starting BPELHelloWorldComponent
>>> Deploying : D:\dev\Opensource\Apache\Tuscany\source\java-sca-1.1\samples\helloworld-bpel\target\classes
::arg:::::: <?xml version="1.0" encoding="UTF-8"?>
<hello xmlns="http://tuscany.apache.org/implementation/bpel/example/helloworld.wsdl"><message xmlns="http://tuscany.apache.org/implementation/bpel/example/helloworld
.wsdl">Hello</message></hello>
::message:: <?xml version="1.0" encoding="UTF-8"?>
<message><TestPart><hello xmlns="http://tuscany.apache.org/implementation/bpel/example/helloworld.wsdl"><message xmlns="http://tuscany.apache.org/implementation/bpel
/example/helloworld.wsdl">Hello</message></hello></TestPart></message>
Status: RESPONSE
Response: <?xml version="1.0" encoding="UTF-8"?>
<message><TestPart><hello xmlns="http://tuscany.apache.org/implementation/bpel/example/helloworld.wsdl">Hello World</hello></TestPart></message>
Stopping BPELHelloWorldComponent
Stopped !!!
Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 18.656 sec
Results :
Tests run: 1, Failures: 0, Errors: 0, Skipped: 0
[INFO] [jar:jar]
[INFO] Building jar: D:\dev\Opensource\Apache\Tuscany\source\java-sca-1.1\samples\helloworld-bpel\target\sample-helloworld-bpel.jar
[INFO] [install:install]
[INFO] Installing D:\dev\Opensource\Apache\Tuscany\source\java-sca-1.1\samples\helloworld-bpel\target\sample-helloworld-bpel.jar to C:\Documents and Settings\lresend
e\.m2\repository\org\apache\tuscany\sca\sample-helloworld-bpel\1.1-incubating-SNAPSHOT\sample-helloworld-bpel-1.1-incubating-SNAPSHOT.jar
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESSFUL
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 53 seconds
[INFO] Finished at: Sun Jan 13 09:54:39 PST 2008
[INFO] Final Memory: 24M/43M
[INFO] ------------------------------------------------------------------------
|
This shows that the Junit test cases have run successfully.
helloworld-recursive
Note | ||
---|---|---|
| ||
Understand and Document |
helloworld-recursive-ws
Note | ||
---|---|---|
| ||
Understand and Document |
helloworld-scaclient
Note | ||
---|---|---|
| ||
Understand and Document |
helloworld-spring
Note | ||
---|---|---|
| ||
Understand and Document |
helloworld-ws-sdo
Note | ||
---|---|---|
| ||
Understand and Document |
webapps
The contributions in the following sections may be deployed to a web container, for example Tomcat. To create the web archive for deployment to the container, run the command
mvn
in the root directory of the contributions directory structure, then deploy the resulting .war file to your web container.
Note |
---|
Should this be "See the instructions for webapps in the "running tuscany" section? |
helloworld-bpel
helloworld-jaxrs
helloworld-jms
helloworld-js-client
helloworld-jsf
helloworld-jsp
helloworld-servlet
helloworld-spring
helloworld-stripes
async
Note | ||
---|---|---|
| ||
document |
embedded-jse-async-sample-launcher
sample-contribution-implementation-java-calculator-async
binding-comet
Note | ||
---|---|---|
| ||
Understand and Document |
binding-jsonrpc
Note | ||
---|---|---|
| ||
Understand and Document |
contribution-calculator
Note | ||
---|---|---|
| ||
Understand and Document |
contribution-calculator-webapp
Note | ||
---|---|---|
| ||
Understand and Document |
binding-rmi
Note | ||
---|---|---|
| ||
Document |
contribution-calculator-reference
Note | ||
---|---|---|
| ||
Document |
contribution-calculator-service
Note | ||
---|---|---|
| ||
Document |
binding-sca
Note | ||
---|---|---|
| ||
Understand and Document |
contribution-calculator
Note | ||
---|---|---|
| ||
Understand and Document |
binding-ws
Note | ||
---|---|---|
| ||
Understand and Document |
Note | ||
---|---|---|
| ||
Understand and Document |
contribution-calculator
distributed-osgi
dynamic
dosgi-dynamic-calculator
dosgi-dynamic-calculator-operations
implementation.osgi
dosgi-calculator
dosgi-calculator-operations
implementation-extension
implementation-java
contribution-calculator
implementation-script
contribution-calculator
logging-scribe
maven-osgi-junit
calculator-osgi
calculator-rest-osgi
sca-client
calculator-scaclient
applications
store
Note | ||
---|---|---|
| ||
Understand and Document |
...