Tuscany Samples
The Tuscany Samples are shipped with Tuscany binary and source releases. If you are using tuscany from a release distribution then make sure you are looking at the documentation that corresponds to the samples as they stood at the time of the release.
...
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 current status of the samples in the trunk of our source tree.
...
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. To see Tuscany in action you must launch a component withing a Tuscany runtime environment. Launching contributions is discussed in the "Running Tuscany" section below.
contribution-helloworld
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 director contains information about the various ways you can start Tuscany and run these contributions.
helloworld-contribution
This is the simplest contribution. This contribution describes a composite application with a single component implemented in Java. The component's Java implementation provides service "business logic" for 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.
helloworld-webapp
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
sample is not a contribution in it's own right but demonstrates how to run the helloworld-contribution inside a web application.
callback-api
Note | ||
---|---|---|
| ||
This feels like a learning-more sample. I wouldn't focus on callbacks with the first time user |
sca-scopes
Note | ||
---|---|---|
| ||
This feels like a learning-more sample. I wouldn't focus on scopes with the first time user |
sca-include-contribution
Note | ||
---|---|---|
| ||
This feels like a learning-more sample. I wouldn't focus on scopes with the first time user | ||
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. The sections below describes various means of launching contributions into an executing tuscany runtime.
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.sh contribution-binding-sca-calculator |
embedded-jse
This directory contains sample java launchers for the
tuscany sample contributions. To use the sample JSE launchers with ant execute the command
...
To use this sample launcher to run all of the contributions as junit test cases, execute the command "mvn" in the launcher directory.
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
...
in the launcher directory.
maven
To execute a sample contribution from Maven
...
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.
osgi
The Tuscany runtime can be run in and OSGi container.
...
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.
...
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
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
...
Code Block |
---|
http://localhost:8080/sample-contribution-binding-jsonrpc-calculator-webapp/ |
learning-more
The samples found in the contributions below illustrate how to see more of SCA and Tuscany's features in action. You'll need to employ the information above in the "running tuscany" section to select an appropriate way of runing the contributions in the samples listed below.
async
This sample demonstrates invocation of services offered in both synchronous and asynchronous forms. Asynchroncity is possible by either callback to or polling by the original service invoker.
sample-contribution-implementation-java-calculator-async
In the composite file src/main/resources/Calculator.composite the references "calculatorServiceRefSync" and "calculatorServiceRefAsync" make use of the alternative implementations of the Calculator service described in the CalculatorSync and CalculatorAsync components and implemented in the calculator.CalculatorServiceSyncImpl and calculator.CalculatorServiceAsyncImpljava classes.
embedded-jse-async-sample-launcher
Note that the launcher simply starts and stops a node running the contribution. Within the contribution the CalculatorClient java class, marked with the @EagerInit annotation, runs its calculate method (marked with the @Init annotation), thereby triggering the calculation service to be performed. The calculator service is actually performed by the injected instance of CalculatorServiceProxyImpl, which uses both of its references (one for the sync service, one for the async) to perform calculations. The calculations are then performed by instances of CalculatorServiceSyncImpl and CalculatorServiceAsyncImpl. Note that the Tuscany runtime views the following two interfaces as compatible.
Code Block |
---|
@Remotable public interface CalculatorService { String calculate(Integer n1); } @Remotable @AsyncInvocation public interface CalculatorServiceAsync { void calculateAsync(Integer n1, ResponseDispatch<String> response); } |
binding-comet
Executing the command "mvn" in this sample project creates a web archive suitable for deployment to Tomcat. It makes use of the tuscany coment binding. Comet support 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).
Warning | ||
---|---|---|
| ||
Needs expert review/update |
binding-jsonrpc
This sample demonstrates using a simple calculator service component which makes use of four services for the basic arithmetic functions. In this variant of the calculator sample you can see by looking in the src/main/resources/Calculator.composite xml file that the AddService is configured to be invoked using the json rpc protocol.
contribution-calculator
This variant of the calculator contribution configures the AddService to be accessed via the JSON RPC protocol (see the XML in the Calculator.composite file).
Warning | ||
---|---|---|
| ||
Needs review/completion |
contribution-calculator-webapp
Note | ||
---|---|---|
| ||
Understand and Document |
binding-rmi
In this example the calculator function is split over two contributions in order to demonstrate the remote method invocation binding. The CalculatorService in the CalculatorServiceComponent defined in the CalculatorRMIServer.composite file is configured to be accessible using RMI.
Warning | ||
---|---|---|
| ||
Needs review/completion |
contribution-calculator-reference (for binding-rmi)
This contribution serves the purpose of accessing the services of the calculator service contribution, in particular defining a reference that uses the add service of that contribution using the RMI protocol.
contribution-calculator-service (for binding-rmi)
This contribution defines the calcullators add service to be available via RMI invocation.
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 components.
contribution-calculator (for binding SCA)
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.
binding-ws
This sample contains contrributions which show how the services can be offered via a web service interfaqce.
contribution-calculator (for binding-ws)
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, as configured in the Calculator.composite file in the contribution project.
contribution-helloworld-ws-sdo (for binding-ws)
Note | ||
---|---|---|
| ||
Understand and Document - rework the content of the README as given below |
Code Block |
---|
Hello World Web Service References using SDO Sample =================================================== This sample demonstrates an SCA reference that uses a web service binding which works with SDO. The README in the samples directory (the directory above this) provides general instructions about building and running samples. Take a look there first. To run this sample ------------------ This sample is dependent on helloworld-ws-service. Open a command prompt to start the service. If you are running ant do the following: cd helloworld-ws-service ant run if you don't have ant, issue one of the following commands for windows or *nix: java -cp ..\..\lib\tuscany-sca-manifest.jar;target\sample-helloworld-ws-service.jar helloworld.HelloWorldServer and on *nix do java -cp ../../lib/tuscany-sca-manifest.jar:target/sample-helloworld-ws-service.jar helloworld.HelloWorldServer You should see the following output: Buildfile: build.xml run-server: [java] log4j:WARN No appenders could be found for logger (org.apache.axiom. om.util.StAXUtils). [java] log4j:WARN Please initialize the log4j system properly. [java] Aug 24, 2007 11:17:33 AM org.apache.catalina.core.StandardEngine sta rt [java] INFO: Starting Servlet Engine: Apache Tomcat/6.0.10 [java] Aug 24, 2007 11:17:34 AM org.apache.catalina.startup.ContextConfig d efaultWebConfig [java] INFO: No default web.xml [java] Aug 24, 2007 11:17:34 AM org.apache.catalina.startup.DigesterFactory register [java] WARNING: Could not get url for /javax/servlet/jsp/resources/jsp_2_0. xsd [java] Aug 24, 2007 11:17:34 AM org.apache.catalina.startup.DigesterFactory register [java] WARNING: Could not get url for /javax/servlet/jsp/resources/web-jspt aglibrary_1_1.dtd [java] Aug 24, 2007 11:17:34 AM org.apache.catalina.startup.DigesterFactory register [java] WARNING: Could not get url for /javax/servlet/jsp/resources/web-jspt aglibrary_1_2.dtd [java] Aug 24, 2007 11:17:34 AM org.apache.catalina.startup.DigesterFactory register [java] WARNING: Could not get url for /javax/servlet/jsp/resources/web-jspt aglibrary_2_0.xsd [java] Aug 24, 2007 11:17:34 AM org.apache.catalina.startup.DigesterFactory register [java] WARNING: Could not get url for /javax/servlet/resources/j2ee_web_ser vices_1_1.xsd [java] Aug 24, 2007 11:17:34 AM org.apache.coyote.http11.Http11Protocol ini t [java] INFO: Initializing Coyote HTTP/1.1 on http-8085 [java] Aug 24, 2007 11:17:34 AM org.apache.coyote.http11.Http11Protocol sta rt [java] INFO: Starting Coyote HTTP/1.1 on http-8085 [java] Aug 24, 2007 11:17:34 AM org.apache.tuscany.sca.http.tomcat.TomcatSe rver addServletMapping [java] INFO: Added Servlet mapping: http://localhost:8085/HelloWorldService [java] HelloWorld server started (press enter to shutdown) The server is now ready. Now, open another command window to run the client. cd helloworld-ws-sdo ant run OR if you don't have ant, on Windows do java -cp ..\..\lib\tuscany-sca-manifest.jar;target\sample-helloworld-ws-sdo.jar helloworld.HelloWorldClient and on *nix do java -cp ../../lib/tuscany-sca-manifest.jar:target/sample-helloworld-ws-sdo.jar helloworl.HelloWorldClient You should be able to see the following result: Buildfile: build.xml run: [java] log4j:WARN No appenders could be found for logger (org.apache.axiom. om.util.StAXUtils). [java] log4j:WARN Please initialize the log4j system properly. [java] Injected helloWorldService [java] Called getGreetings [java] Hello David Haney BUILD SUCCESSFUL Total time: 9 seconds Sample Overview --------------- The sample provides a single component that is wired to a reference with a web service binding. The binding refers to WSDL that identifies the service exposed by the helloworld-ws-service sample. helloworld-ws-sdo/ src/ main/ java/ helloworld/ HelloWorldService.java - interface description for HelloWorldServiceComponent HelloWorldServiceComponent.java - component implementation HelloWorldClient.java - starts the SCA Runtime and deploys the helloworldwsclient .composite. It then calls the HelloWorldServiceComponent resources/ wsdl helloworld.wsdl - the service description that the SCA reference uses to bind to service. test/ java/ helloworld/ HelloWorldClientTestCase.java - JUnit test case helloworld-ws-sdo.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 ----------------------------------------- You can build and run the sample with the binary distribution using Ant. Make sure that you have started helloworld-ws-service which this sample is dependent on in a separate command window. You can either follow the instruction at the begining of this sample file or if you want to build and run the service, follow the README under helloworld-ws-service. Now, let's build and run helloworld-ws-sdo sample: cd helloworld-ws-sdo ant ant run You should see the following output from the run target. run: [java] log4j:WARN No appenders could be found for logger (org.apache.axiom. om.util.StAXUtils). [java] log4j:WARN Please initialize the log4j system properly. [java] Injected helloWorldService [java] Called getGreetings [java] Hello World Building And Running The Sample Using Maven ------------------------------------------- You can build and run the sample with either the binary or source distributions using Maven. Please note that you do not need to start helloworld-ws-service in this case since Maven does this for you. cd helloworld-ws-sdo mvn You should see the following output from the test phase. ------------------------------------------------------- T E S T S ------------------------------------------------------- Running helloworld.HelloWorldClientTestCase log4j:WARN No appenders could be found for logger (org.apache.axiom.om.util.StAX Utils). log4j:WARN Please initialize the log4j system properly. log4j:WARN No appenders could be found for logger (org.apache.axiom.om.util.StAX Utils). log4j:WARN Please initialize the log4j system properly. Aug 23, 2007 2:27:32 PM org.apache.catalina.core.StandardEngine start INFO: Starting Servlet Engine: Apache Tomcat/6.0.10 Aug 23, 2007 2:27:32 PM org.apache.catalina.startup.ContextConfig defaultWebConf ig INFO: No default web.xml Aug 23, 2007 2:27:32 PM org.apache.catalina.startup.DigesterFactory register WARNING: Could not get url for /javax/servlet/jsp/resources/jsp_2_0.xsd Aug 23, 2007 2:27:32 PM org.apache.catalina.startup.DigesterFactory register WARNING: Could not get url for /javax/servlet/jsp/resources/web-jsptaglibrary_1_ 1.dtd Aug 23, 2007 2:27:32 PM org.apache.catalina.startup.DigesterFactory register WARNING: Could not get url for /javax/servlet/jsp/resources/web-jsptaglibrary_1_ 2.dtd Aug 23, 2007 2:27:32 PM org.apache.catalina.startup.DigesterFactory register WARNING: Could not get url for /javax/servlet/jsp/resources/web-jsptaglibrary_2_ 0.xsd Aug 23, 2007 2:27:32 PM org.apache.catalina.startup.DigesterFactory register WARNING: Could not get url for /javax/servlet/resources/j2ee_web_services_1_1.xs d Aug 23, 2007 2:27:32 PM org.apache.coyote.http11.Http11Protocol init INFO: Initializing Coyote HTTP/1.1 on http-8085 Aug 23, 2007 2:27:32 PM org.apache.coyote.http11.Http11Protocol start INFO: Starting Coyote HTTP/1.1 on http-8085 Aug 23, 2007 2:27:32 PM org.apache.tuscany.sca.http.tomcat.TomcatServer addServl etMapping INFO: Added Servlet mapping: http://localhost:8085/HelloWorldService Injected helloWorldService Called getGreetings Aug 23, 2007 2:27:34 PM org.apache.coyote.http11.Http11Protocol destroy INFO: Stopping Coyote HTTP/1.1 on http-8085 Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 8.502 sec Results : Tests run: 1, Failures: 0, Errors: 0, Skipped: 0 This shows that the Junit test cases have run successfully. |
distributed-osgi
These samples demonstrate the execution of Tuscany contributions in a distributed OSGI environment.
dosgi-dynamic-calculator
dosgi-dynamic-calculator-operations
implementation-bpel
Note | ||
---|---|---|
| ||
contribution-helloworld-bpel
Note | ||
---|---|---|
| ||
check instructions work and fix up |
...
This shows that the Junit test cases have run successfully.
helloworld-bpel-webapp
implementation-composite
Note | ||
---|---|---|
| ||
Understand and Document |
helloworld-recursive
Note | ||
---|---|---|
| ||
Understand and Document |
helloworld-recursive-ws
Note | ||
---|---|---|
| ||
Understand and Document |
implementation-extension
Note | ||
---|---|---|
| ||
Understand and Document |
implementation-java
Note | ||
---|---|---|
| ||
Understand and Document |
contribution-calculator
Note | ||
---|---|---|
| ||
Understand and Document |
implementation.osgi
dosgi-calculator
dosgi-calculator-operations
Note | ||
---|---|---|
| ||
Understand and Document |
implementation-script
Note | ||
---|---|---|
| ||
Understand and Document |
contribution-calculator
Note | ||
---|---|---|
| ||
Understand and Document |
implementation-spring
Note | ||
---|---|---|
| ||
Understand and Document |
contribution-helloworld-spring
Note | ||
---|---|---|
| ||
Understand and Document |
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
Note | ||
---|---|---|
| ||
Understand and Document |
maven-osgi-junit
Note | ||
---|---|---|
| ||
Understand and Document |
calculator-osgi
Note | ||
---|---|---|
| ||
Understand and Document |
calculator-rest-osgi
Note | ||
---|---|---|
| ||
Understand and Document |
sca-client
Note | ||
---|---|---|
| ||
Understand and Document |
calculator-scaclient
Note | ||
---|---|---|
| ||
Understand and Document |
helloworld-scaclient
Note | ||
---|---|---|
| ||
Understand and Document |
applications
Note | ||
---|---|---|
| ||
Understand and Document |
store
Note | ||
---|---|---|
| ||
Understand and Document |
store-webapp
Note | ||
---|---|---|
| ||
Understand and Document |