Tuscany SamplesThe 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. 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. getting-startedThe 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-helloworldIn 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-webappTODO 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-tuscanyRunning 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-lineTo execute a sample contribution from the command line on Windows, from a command prompt in the samples directory, run the command ... ..\bin\tuscany.bat "contribution-name" for example ..\bin\tuscany.bat contribution-binding-sca-calculator or on *nix platforms, from a shell prompt in the samples directory, run the command ... ../bin/tuscany.sh contribution-binding-sca-calculator embedded-jseThis directory contains sample java launchers for the 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. embedded-osgiThe launchers implemented in the src/main/java/launchers directory each launch a specific contribution into the OSGI runtime. 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, mvn in the launcher directory. mavenTo execute a sample contribution from Maven look for contributions that have the following configuration in their pom.xml file: <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 This will launch the contribution in the Tuscany runtime and then wait. At this point you can use osgiThe Tuscany runtime can be run in and OSGi container. Running in Equinox 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 see samples/???? Running on Felix See http://tuscany.apache.org/documentation-2x/running-tuscany-sca-2x-with-equinox-and-felix.html shellThis directory contains a sample shell program supporting simple commands to 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 ./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 webappTo execute sample webapp based contributions (contributions that have webapp at the end of their name) you 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 <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://localhost:8080/sample-contribution-binding-jsonrpc-calculator-webapp/ learning-moreThe 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. asyncThis 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-asyncIn 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-launcherNote 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. @Remotable public interface CalculatorService { String calculate(Integer n1); } @Remotable @AsyncInvocation public interface CalculatorServiceAsync { void calculateAsync(Integer n1, ResponseDispatch<String> response); } binding-cometExecuting 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). TODO Needs expert review/update binding-jsonrpcThis 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-calculatorThis variant of the calculator contribution configures the AddService to be accessed via the JSON RPC protocol (see the XML in the Calculator.composite file). TODO Needs review/completion contribution-calculator-webappTODO Understand and Document binding-rmiIn 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. TODO 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-scaThis sample is the simplest sample other than that shown in the getting starting section. contribution-calculatorTODO Understand and Document binding-wsTODO Understand and Document contribution-calculatorcontribution-helloworld-ws-sdoTODO Understand and Document distributed-osgiThese samples demonstrate the execution of Tuscany contributions in a distributed OSGI environment. dosgi-dynamic-calculatordosgi-dynamic-calculator-operationsimplementation-bpelTODO contribution-helloworld-bpelTODO 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 ant compile run OR if you don't have ant, on Windows do 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 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 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 cd helloworld-bpel ant compile ant run You should see the following output from the run target. 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 cd helloworld-bpel mvn You should see the following output from the test phase. \------------------------------------------------------\- 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-bpel-webappimplementation-compositeTODO Understand and Document helloworld-recursiveTODO Understand and Document helloworld-recursive-wsTODO Understand and Document implementation-extensionTODO Understand and Document implementation-javaTODO Understand and Document contribution-calculatorTODO Understand and Document implementation.osgidosgi-calculatordosgi-calculator-operationsTODO Understand and Document implementation-scriptTODO Understand and Document contribution-calculatorTODO Understand and Document implementation-springTODO Understand and Document contribution-helloworld-springTODO Understand and Document helloworld-spring-webappimplementation-webapphelloworld-jaxrs-webapphelloworld-jms-webapphelloworld-js-client-webapphelloworld-jsf-webapphelloworld-jsp-webapphelloworld-servlet-webapphelloworld-stripes-webapplogging-scribeTODO Understand and Document maven-osgi-junitTODO Understand and Document calculator-osgiTODO Understand and Document calculator-rest-osgiTODO Understand and Document sca-clientTODO Understand and Document calculator-scaclientTODO Understand and Document helloworld-scaclientTODO Understand and Document applicationsTODO Understand and Document storeTODO Understand and Document store-webappTODO Understand and Document |