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

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 current status of the samples in the trunk of our source tree.

In a distribution, the samples source code is found 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.

If you're new to Tuscany SCA start with the getting-started. Samples are generally presented in the form on an SCA contribution (look for directories ending in "-contribution") or as a webapp (look for directories ending in "-webapp"). The directories getting-started, learning-more and applications all contain sample SCA contributions of increasing complexity. The running-tuscany directory describes the various ways you can start the Tuscany runtime and install contributions. For each sample contribution described in this document we do suggest an example way to install it and start the composites it contains however the other approaches in running-tuscany should also work for most sample contributions. The extending-tuscany directory contains some examples of how to build new binding and implementation extensions for using in Tuscany.

In the following text we us <some_text> to mean you have to replace it with whatever is appropriate in your environment. For example <tuscany_bin_distro> means the directory in which you install the Tuscany binary distribution.

Instructions are colour coded as follows:

getting-started

SCA defines a concept called a Contribution which is the way that SCA composite applications are packed for deployment. See sca introduction for more information on SCA concepts.

The getting-started samples consist of simple SCA contributions that you can build and run as your first step to getting up and running with the Tuscany SCA Java runtime.

You can build the sample contributions with either Maven or Ant and the running-tuscany directory contains information about the various ways you can start Tuscany and run these contributions.

helloworld-contribution

This is a simple SCA contribution. It describes a composite application with a single component, HelloWorldComponent, implemented in Java. The component's Java implementation provides service "business logic" for saying hello to a person whose name is supplied as input to the service. The component is described in a composite called helloworld.composite as follows:

<composite xmlns="http://docs.oasis-open.org/ns/opencsa/sca/200912"
           xmlns:tuscany="http://tuscany.apache.org/xmlns/sca/1.1"
           targetNamespace="http://sample"
           name="helloworld">

    <component name="HelloworldComponent">
        <implementation.java class="sample.HelloworldImpl"/>
    </component>

</composite>

The contribution also contains a composite called helloworldws.composite which describes a component, HelloworldWSComponent, that uses the same implementation but uses a web services binding:

<composite xmlns="http://docs.oasis-open.org/ns/opencsa/sca/200912"
           xmlns:tuscany="http://tuscany.apache.org/xmlns/sca/1.1"
           targetNamespace="http://sample"
           name="helloworldws">

    <component name="HelloworldWSComponent">
        <implementation.java class="sample.HelloworldImpl"/>
        <service name="Helloworld">
           <binding.ws />
        </service>
    </component>

</composite>

This gives us a number of options for interacting with the components in this application.

Firstly there is a JUnit test inside this project called HelloworldTestCase.java. This starts the Tuscany runtime and loads the contribution. It then talks to the HelloworldComponent over the default SCA binding (binding.sca) using a local Java proxy.

Secondly the HelloworldWSComponent exposes a service with a web services binding. You can talk to this component using your favourite web services client. You can retrieve the WSDL for the web service automatically (see later)

cd helloworld-contribution
mvn

This will produce the contribution as follows:

helloworld-contribution/target/helloworld-contribution.jar

As the JUnit test deploys and runs the contribution we can use it as a first simple example of a running SCA application.

Response from helloworld.sayHello("Petra") = Hello Petra

To access the web service that the HelloworldWSComponent exposes we have to keep the runtime runntime running.

cd helloworld-contribution
mvn tuscany:run

Binding.ws JAXWS provider - Service URI: http://localhost:8085/HelloworldWSComponent/Helloworld

http://localhost:8085/HelloworldWSComponent/Helloworld?wsdl

For more information on getting started with the Apache Tuscany SCA Java runtime see the getting started page.

helloworld-webapp

This sample is not a contribution in it's own right but demonstrates how to run the helloworld-contribution inside a web application. As it's the same contribution the same two components, HelloworldComponent and HelloworldWSComponnet, will be started.

cd helloworld-webapp
mvn

This will produce a webapp as follows:

helloworld-webapp/target/helloworld.war

You can run this webapp by deploying it to you're favourite webapp container. For example, you can deploy to Tomcat and run as follows:

cp helloworld-webapp/target/helloworld.war my_tomcat_install/webapps
my_tomcat_install/bin/catalina run

Once running point your web browser at:

http://localhost:8080/helloworld/hello.html

You'll see a link there to the WSDL that's automatically generated for the web service binding of the HelloworldWSComponent. Again you can use your favourite web services client to send messages to the service.

callback-api

sca-scopes

sca-include-contribution

running-tuscany

Running something in Tuscany requires one or more contributions, and a method of launching the contributions to make the services they provide available. The sections below describes various means of launching contributions with the Tuscany SCA Java runtime. It's not important that you try all of these but they show you what's possible and hopefully show you how to use Tuscany in an environment that makes sense to you.

Some of the running-tuscany sub-directories just contain a README that gives you instructions. For example, maven just tells you how to configure and run contributions using the maven-tuscany-plugin. Others contain code. For example, embedded-jse contains simple Java launchers that show you how to start some of the sample contributions from a Java program.

The sample contributions in getting-started and learning-more should work regardless of which approach you adopt. However some approaches, like embedded-jse, don't have launchers for every single sample contribution.

command-line

You can execute a sample contribution from the command line on Windows or Linux.

To execute a sample contribution from the command line

on Windows, from a command prompt in the samples directory, run the command ...

<tuscany_din_distro>\bin\tuscany.bat "contribution-name"

for example

cd <tuscany_din_distro>\samples\learning-more\binding-sca\calculator-contribution
<tuscany_din_distro>\bin\tuscany.bat sample-binding-sca-calculator-contribution.jar

or on *nix platforms, from a shell prompt in the samples directory, run the command ...

cd <tuscany_din_distro>/samples/learning-more/binding-sca/calculator-contribution
<tuscany_din_distro>/bin/tuscany.sh sample-binding-sca-calculator-contribution.jar

eclipse

To import sample contributions into Eclipse you first need to import the Tuscany runtime. You then need to import the sample contribution into Eclipse as a project. Instructions for doing both of these things can be found here

http://tuscany.apache.org/import-existing-tuscany-sca-projects-into-eclipse.html

Note. these instructions refer to our 1.x code base but it holds true for our 2.x code base.

Once you have a contribution imported into Eclipse and cleanly compiling against the Tuscany runtime jars you probably want to be able to run and debug it. The easiest way to do this is with a simple Java launcher. If you import the running-tuscany/embedded-jse project into Eclipse you'll see a number of such launcher programs which you can copy to launch the contribution(s) of your choice. Alternatively you can add a JUnit test case to the contribution that starts Tuscany and launches the contribution. See maven-junit as an example of how to do this.

embedded-jse

This directory contains sample java launchers for the some of the Tuscany sample contributions from the learning-more directory. It shows you how to embed the Tuscany runtime in a Java program. To make you're own launchers simply copy and existing one and change the details of the contribution being loaded. You'll note that the same launcher code is used inside the contribution unit test demonstrated by maven-junit.

ant <contributionname>

cd embedded-jse
mvn

embedded-osgi

The Tuscany runtime jars will also work within an OSGi enviroment. If you want to load them into a vanilla OSGi environment see the osgi directory. If you want Tuscany to create an OSGi environment for you this directory contains launchers that do just that.

cd embedded-osgi
ant <contributionname>

cd embedded-osgi
mvn

maven

Maven can be used to install contributions. Tuscany has a special plugin (maven-tuscany-plugin) that makes this happen. 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 install the contribution in the Tuscany runtime, start the composite it contains, 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/sca-client/calculator-scaclient.

maven-junit

Maven will run JUnit tests found in a module's src/test/java directory automatically. If you use embedded-jse style code in the JUnit test to install a contribution and start any composites it contains they you can unit test your contributions. This directory contains a contribution and a unit test which installs the contribution using very similar code to that found in embedded-jse.

To run the contributions unit test do the following:

cd maven-junit/calculator-contribution
mvn

maven-junit-osgi

You can use a special Tuscany Maven plugin (maven-osgi-junit-plugin) to unit test contributions in a JUnit environment. This relies on adding some configuration to the Maven pom.xml. For example, if you look in maven-junit-osgi/calculator-osgi you'll see:

            <plugin>
                <groupId>org.apache.tuscany.maven.plugins</groupId>
                <artifactId>maven-osgi-junit-plugin</artifactId>
                <version>1.0</version>
                <dependencies>
                   <dependency>
                      <groupId>org.apache.tuscany.sca</groupId>
                      <artifactId>tuscany-node-launcher-equinox</artifactId>
                      <version>${pom.version}</version>
                   </dependency>
                </dependencies>
                <executions>
                    <execution>
                        <id>osgi-test</id>
                        <phase>test</phase>
                        <goals>
                            <goal>test</goal>
                        </goals>
                        <configuration>
                            <systemProperties>
                                <property>
                                    <name>osgi.configuration.area</name>
                                    <value>${project.build.directory}/equinox</value>
                                </property>
                            </systemProperties>
                        </configuration>
                    </execution>
                </executions>
            </plugin>

This configures the maven-osgi-junit-plugin to use the tuscany-node-launcher-equinox to install the contribution represented by the calculator-osgi directory. As an alternative to this configuration you could use the contents of tuscany-node-launcher-equinox directly in your JUnit test to launch the Tuscany runtime using OSGi.

To run the contributions unit test do the following:

cd maven-junit/calculator-contribution
mvn

osgi

The Tuscany runtime can be run in a vanilla OSGi container such as Equinox. To do this you have to:

• launch the OSGi container itself
• load the Tuscany runtime bundles (all our jars are bundles) into the container
• install a contribution packaged as an OSGi bundle

For example, to install a contribution in Equinox do the following

On Windows, run

java -jar ..\..\..\modules\osgi-3.5.0-v20090520.jar -configuration ..\..\..\features\configuration -clean -console

On *Unix, run

java -jar ../../../modules/osgi-3.5.0-v20090520.jar -configuration ../../../features/configuration -clean -console

You should see the osgi console:

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.

osgi> ss

Then you can install and start contributions as bundles by doing the following:

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

Running on Felix

See http://tuscany.apache.org/documentation-2x/running-tuscany-sca-2x-with-equinox-and-felix.html

shell

This directory contains a sample shell program supporting simple commands to start and stop SCA composites.

To build the sample shell do this:

mvn install

To run it:

./sca

at the prompt:

start myNode ../../applications/store/target/sample-store.jar

or:

start myNode http://people.apache.org/~jsdelfino/tuscany/java/test/sample-store.jar

also try:

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.

./sca <scripts/test.txt

or

./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.

webapp

Tuscany can be embedded inside a webapp alongside one or more SCA contributions. 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:

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:

<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

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:

http://localhost:8080/sample-binding-jsonrpc-calculator-webapp/

learning-more

The samples found in the contributions below illustrate more of SCA and Tuscany's features in action. The contributions here are primarily focused on demonstrating the various SCA extensions that the Tuscany runtime supports, for example, bindings and implementations. The directories are named to let you easily find a sample of the extension you're interested in.

You can identify contributions here as the name of the directory from which they are built ends with "-contribution". There are also webapp samples here. The names of these directories end with "-webapp".

Refer to the information above in the "running-tuscany" section to find the various options for installing these sample contributions. We present an single default approach for each sample as an example.

async

This sample demonstrates the SCA asynchronous progamming model in action as typified by services that are configured with the asyncInvocation intent. For example, from calculator-contribution

@Remotable
@AsyncInvocation
public interface CalculatorServiceAsync {
    void calculateAsync(Integer n1, ResponseDispatch<String> response);
}

A client component can access an asynchronous service either synchronously or asynchronously. Asynchronous reference interfaces also have a special form, again from calculator-contribution:

@Remotable
public interface CalculateReferenceAsync {
	// Sync
	public String calculate(Integer i1);

	// Aysnc Poll
	public Response<String> calculateAsync(Integer i1);

	// Async Callback
	public Future<String> calculateAsync(Integer i1, AsyncHandler<String> handler);
}

calculator-contribution

This contribution defines synchronous and asynchronous component services and a client component which references both. During the test the client component exercise all three styles of reference interface operation against both the synchronous and asynchronous service.

cd learning-more/async/calculator-contribution
ant

cd running-tuscany/embedded-jse
ant sample-implementation-java-calculator-async-contribution

cd learning-more/async/calculator-contribution
mvn

cd running-tuscany/embedded-jse
mvn

binding-comet

The Comet protocol allows a servlet to process IO asynchronously, receiving events when data is available for reading on the connection (rather than always using a blocking read), and writing data back on connections asynchronously (most likely responding to some event raised from some other source).

weather-webapp

Executing the command "mvn" in this sample project creates a web archive suitable for deployment to Tomcat. It makes use of the tuscany comet binding.

cd learning-more/binding-commet/weather-webapp
mvn

The webapp can be installed and run as follows:

cd learning-more/binding-commet/weather-webapp
cp target/sample-binding-comet-1.0.war <your_container_deployment-dir>
start the container as appropriate

binding-jms

This binding supports message orient communication via the JMS API.

helloworld-webapp

This contribution packages an SCA application inside a webapp. The application has two components which exchange helloworld style messages over the JMS binding.

cd learning-more/binding-jms/helloworld-webapp
mvn

The webapp can be installed and run as follows:

cd learning-more/binding-jms/helloworld-webapp
cp target/helloworld-jms.war <your_container_deployment-dir>
start the container as appropriate

Once the webapp is deployed point your browser at:

http://localhost:8080/helloworld-jms/

binding-jsonrpc

This binding supports communication over the JSON-RPC protocol.

calculator-contribution

This sample demonstrates using the simple calculator service component which makes use of four other services for add, subtract, multiply and divide functions. In this variant of the calculator sample the AddService is configured to be invoked using the JSON-RPC protocol. You can see the configuration by looking in the src/main/resources/Calculator.composite xml file.

cd learning-more/binding-jsonrpc/calculator-contribution
ant

cd running-tuscany/embedded-jse
ant sample-implementation-java-calculator-async-contribution

cd learning-more/binding-jsonrpc/calculator-contribution
mvn

cd running-tuscany/embedded-jse
mvn

calculator-webapp

This contribution packages the same calculator-contribution inside a webapp.

cd learning-more/binding-jsonrpc/calculator-webapp
mvn

The webapp can be installed and run as follows:

cd learning-more/binding-jsonrpc/calculator-webapp
cp target/sample-binding-jsonrpc-calculator-webapp.war <your_container_deployment-dir>
start the container as appropriate

Once the webapp is deployed point your browser at:

http://localhost:8080/sample-binding-jsonrpc-calculator-webapp/

binding-rmi

In this example the calculator function is split over two contributions in order to demonstrate the remote method invocation binding (binding.rmi). The calculator-service-contribution contains a composite which defines a CalculatorServiceComponent which exposes a CalculatorService using binding.rmi. The calculator-reference-contribution contains a composite which also defines a CalculatorServiceComponent but which in this case calls the add, subtract, multiple and divide operations offered by the component in the calculator-service-contribution. The two contributions are run using separate Tuscany nodes and the resulting components communicate over RMI. Both contributions must be deployed and started for the sample to work;

cd running-tuscany/embedded-jse
ant sample-binding-rmi-calculator-contribution

cd running-tuscany/embedded-jse
mvn

calculator-service-contribution

This contribution defines a CalculatorServiceComponent whose add, subtract, multiply and divide operations are available over RMI.

cd learning-more/binding-rmi/calculator-service-contribution
ant

cd learning-more/binding-rmi/calculator-service-contribution
mvn

calculator-reference-contribution

This contribution defines a CalculatorServiceComponent which accesses the service version of the component using binding.rmi.

cd learning-more/binding-rmi/calculator-reference-contribution
ant

cd learning-more/binding-rmi/calculator-reference-contribution
mvn

binding-sca

This sample is the simplest sample other than that shown in the getting starting section. It uses the default SCA protocol for communicating between the various components of the caluclator application.

calculator-contribution

The service and reference definitions in the Calculator.composite and CalculatorClient.composite files have no binding attributes, thereby defaulting to the SCA binding for communication between the running instances of the components.

cd learning-more/binding-sca/calculator-contribution
ant

cd running-tuscany/embedded-jse
ant sample-binding-sca-calculator-contribution

cd learning-more/binding-sca/calculator-contribution
mvn

cd running-tuscany/embedded-jse
mvn

binding-ws

The web service binding allows components to expose and call services using SOAP formatted messages primarily over HTTP.

calculator-contribution

This contribution provides the four arithmetic operations in the calculator service, with the AddService being accessible as a web service via the URL http://localhost:8085/AddServiceComponent^{Image Removed}, as configured in the Calculator.composite file.

cd learning-more/binding-ws/calculator-contribution
ant

cd running-tuscany/embedded-jse
ant sample-binding-ws-calculator-contribution

cd learning-more/binding-ws/calculator-contribution
mvn

cd running-tuscany/embedded-jse
mvn

contribution-helloworld-ws-sdo

This sample demonstrates an SCA reference that uses a web service binding which works with SDO. Instead if using JAXB style Java beans in the service interface they are replaced with SDO object.

distributed-osgi

These samples demonstrate the execution of Tuscany contributions in a OSGI environment. In particular the two bundle project in this directory define calculator objects that communicate with one another using the mechanisms defined in the OSGi remote services specifications. Here the Tuscany SCA runtime provides dynamic service discovery functionality. The calculator objects are registered as services directly with the OSGi bundle context by the bundle activator. Under the covers SCA provides the remote service disovery features that allow OSGi registered service to discover and communicate with one another across two JVMs.

To run the sample each bundle must be build using maven and then loaded into a separate OSGi environment into which the Tuscany SCA runtime has already been installed (See "osgi" under running-tuscany)

dosgi-dynamic-calculator-operations

This bundle provides the calculator add, subtract, multiple, divide operations services.

cd learning-more/distributed-osgi/dosgi-dynamic-calculator-operations
mvn

To run the bundle see "osgi" under running-tuscany. In short do the following:

On Windows, run

java -jar ..\..\..\..\modules\osgi-3.5.0-v20090520.jar -configuration ..\..\..\..\features\configuration -clean -console

You should see the osgi console. You can run "ss" command under the osgi> to see the status of the bundles.

osgi> ss

Then you can install and start the bundle that's just been built:

osgi> install file:./target/sample-dosgi-dynamic-calculator-operations.jar

dosgi-dynamic-calculator

cd learning-more/distributed-osgi/dosgi-dynamic-calculator
mvn

To run the bundle see "osgi" under running-tuscany. In short do the following:

On Windows, run

java -jar ..\..\..\..\modules\osgi-3.5.0-v20090520.jar -configuration ..\..\..\..\features\configuration -clean -console

You should see the osgi console. You can run "ss" command under the osgi> to see the status of the bundles.

osgi> ss

Then you can install and start the bundle that's just been built:

osgi> install file:./target/sample-dosgi-dynamic-calculator.jar

You should see the calculator service start.

implementation-bpel

BPEL component implementations will be useful to those who wish to describe a sequence of calls that must be made to other component services.

contribution-helloworld-bpel

cd learning-more/implementation-bpel/helloworld-bpel-contribution
ant

????

cd learning-more/implementation-bpel/helloworld-bpel-contribution
mvn

????

helloworld-bpel-webapp

implementation-composite

helloworld-recursive

helloworld-recursive-ws

implementation-java

contribution-calculator

implementation.osgi

dosgi-calculator

dosgi-calculator-operations

implementation-script

contribution-calculator

implementation-spring

contribution-helloworld-spring

helloworld-spring-webapp

implementation-webapp

helloworld-jaxrs-webapp

helloworld-jms-webapp

helloworld-js-client-webapp

helloworld-jsf-webapp

helloworld-jsp-webapp

helloworld-servlet-webapp

helloworld-stripes-webapp

logging-scribe

maven-osgi-junit

calculator-osgi

calculator-rest-osgi

sca-client

calculator-scaclient

helloworld-scaclient

extending-tuscany

binding-extension

implementation-extension

applications

store

store-webapp

...

...

matches the distribution you have downloaded select the appropriate link below:

2.0-Beta1 samples documentation