| Sectionpanel |
|---|
| borderborderColor | true#C3CDA1 |
|---|
| column | width | 15% | | Include Page |
|---|
TUSCANY: SCA Java Subproject Menu | TUSCANY: SCA Java Subproject Menu | | Include Page |
|---|
TUSCANY: Java SCA Menu New | TUSCANY: Java SCA Menu New | | Column |
|---|
|
| Wiki Markup |
|---|
Welcome to the Apache Tuscany SCA User guide. Here you will find information aimed to help you understand SCA concepts and an example walk through for building your own SCA application.
\\
{panel:title=Apache Tuscany SCA User Guide|borderStyle=solid|borderColor=#C3CDA1|titleBGColor=#C3CDA1|bgColor=#ECF4D1}
* [*Introduction*|#Intro]
* [*Quick Guide to SCA* |#Quick Guide to SCA]
* [*Getting Tuscany SCA Java*|#Getting Tuscany SCA Java]
* [*SCA Contributions and Composites*|#SCA Contributions and Composites]
* [*Tuscany SCA Node*|#Tuscany SCA Node]
* [*Host Embedded*|#Host Embedded]
* [*Tuscany SCA Node Implementation*|#Tuscany SCA Node Implementation]
* [*Hosting Tuscany SCA Nodes*|#Hosting Tuscany SCA Nodes]
* [*Tuscany SCA Domain*|#Tuscany SCA Domain]
* [*Tuscany SCA Extensions*|#Tuscany SCA Extensions]
** [The Extensible Runtime|#The Extensible Runtime]
** [Available Extensions|#Available Extensions]
** [Using Extensions|#Using Extensions]
* [*Tuscany SCA And IDEs*|#Tuscany SCA And IDEs]
** [Using The Samples In An IDE Without Maven|#Using The Samples In An IDE Without Maven]
** [Using The Samples In An IDE If You Have Maven|#Using The Samples In An IDE If You Have Maven]
\\
{panel}
{note:title:Notification}{center}This page is undergoing an update to catch up with the latest code. You are welcome to help review and complete it. Comments the dev list please{center}{note}
h2. {anchor:Intro}{bgcolor:#C3CDA1}Introduction{bgcolor}
This user guide will help you become familiar with SCA concepts and walks you through an example that demonstrates how to build an SCA application. It also describes the different environments that Tuscany supports (such as command line clients or web applications) and how to package up applications to run in these environments.
*There's nothing to it really!* Building SCA applications is easy. One of the main goals of Tuscany and SCA is to avoid imposing rules and requirements on how people write applications. We want to let people write application code the way they want without being concerned about the environment in which it will be used. After all, writing code to handle plumbing just gets in the way of writing the interesting stuff. So basically, you write the code for interesting bits, and Tuscany provides the environment that lets it run. Therefore, this guide is just an example of how an SCA application can be developed and is not a rule.
h2. {anchor:Quick Guide to SCA}{bgcolor:#C3CDA1}Quick Guide to SCA {bgcolor}
The [*quick guide to SCA*|Quick Guide To SCA] gives you an overview of SCA concepts and prepares you to work on the example below. You can skip this step if you are already familiar with SCA.
For more details on SCA please refer to the specifications at [Open SOA web site|http://www.osoa.org].
h2. {anchor:Getting Tuscany SCA Java}{bgcolor:#C3CDA1}Getting Started with Tuscany SCA Java{bgcolor}
There are several guides that show you how to get started with Apache Tuscany SCA Java.
[Getting Started with Tuscany using a Tuscany Distribution from the Command Line|Getting Started with Tuscany ( using the Command Line)]
This is a quick getting started guide that shows you how to download the latest release, run the calculator sample and then how to use the calculator sample project as a basis for you own projects
[Getting Started with Tuscany using a Tuscany Distribution In Eclipse|Getting Started with Tuscany]
This is a quick getting started guide that go trough the steps of building the store scenario using the Tuscany SCA distribution manually installed into Eclipse
[Getting Started with Tuscany using the Tuscany Eclipse Plugin|Getting Started with Tuscany (using Tuscany Eclipse Plugin)]
This is a quick getting started guide that go trough the steps of building the store scenario using the Tuscany Eclipse plugin.
[First Steps - Building your first web services using Tuscany|Build your first Web Services with Tuscany]
This is a quick guide that go trough the steps of exposing your pojo component as web services.
h2. {anchor:SCA Contributions and Composites}{bgcolor:#C3CDA1}SCA Contributions and Composites{bgcolor}
You will have seen from working with the calculator sample ([Getting Started with Tuscany using a Tuscany Distribution from the Command Line|Getting Started with Tuscany ( using the Command Line)]) that an assembly of SCA components is described in a composite file, for example,
{code}
<composite xmlns="http://www.osoa.org/xmlns/sca/1.0"
targetNamespace="http://sample"
xmlns:sample="http://sample"
name="Calculator">
<component name="CalculatorServiceComponent">
<implementation.java class="calculator.CalculatorServiceImpl"/>
<reference name="addService" target="AddServiceComponent" />
<reference name="subtractService" target="SubtractServiceComponent" />
<reference name="multiplyService" target="MultiplyServiceComponent" />
<reference name="divideService" target="DivideServiceComponent" />
</component>
<component name="AddServiceComponent">
<implementation.java class="calculator.AddServiceImpl"/>
</component>
<component name="SubtractServiceComponent">
<implementation.java class="calculator.SubtractServiceImpl"/>
</component>
<component name="MultiplyServiceComponent">
<implementation.java class="calculator.MultiplyServiceImpl"/>
</component>
<component name="DivideServiceComponent">
<implementation.java class="calculator.DivideServiceImpl"/>
</component>
</composite>
{code}
The composite describes how SCA components are implemented and how they are assembled by wiring references to targets. This composite file has some dependencies, in this case the Java class and interface files that are used to implement the SCA components that it defines. The collection of composite files and other artifacts that are required to run an SCA application are collected together into one or more SCA contributions. A contribution can be a simple as a directory in a file system or could be packaged in, for example, a Jar file. SCA does not mandate any particular packing scheme. For our calculator sample you can imagine the contribution holding the calculator composite and all of its dependencies.
!calculator1.png|align=centre!
In fact if you look inside the jar file that the calculator sample produces, you will find the following
{code}
calculator/AddService.class
calculator/AddServiceImpl.class
calculator/CalculatorClient.class
calculator/CalculatorService.class
calculator/CalculatorServiceImpl.class
calculator/DivideService.class
calculator/DivideServiceImpl.class
calculator/MultiplyService.class
calculator/MultiplyServiceImpl.class
calculator/SubtractService.class
calculator/SubtractServiceImpl.class
Calculator.composite
{code}
Which are all the artifacts that are required to run the calculator sample. We just need to add this contribution to the Tuscany SCA java runtime and then call the services that will be enabled.
h2. {anchor:Tuscany SCA Node}{bgcolor:#C3CDA1}Tuscany SCA Node{bgcolor}
In order to run an SCA application Tuscany SCA Java provides a runtime that is wrapped up in a Node. The runtime itself is made up of many of the modules that are present in the modules directory of the Tuscany SCA Java distribution. As you might expect there are functions that read XML, create an in memory mode model of the SCA assembly, create the components and wire them together ready to process incoming messages. All of these functions are wrapped up in a Node. A node is configured using SCA contributions and will run a single composite. When running standalone the node also defines the scope of component services that references can target by name. SCA defines the term Domain to describe this scope.
!calculator2.png|align=centre!
A node runs within a single JVM. A JVM can run many Nodes.
h2. {anchor:Host Embedded}{bgcolor:#C3CDA1}Host Embedded{bgcolor}
For a long time in Tuscany we have had a modules called [host.embedded|SCA JAVA host.embedded] that contains the code required to get the runtime up and running in standalone configuration. This was developed before the distributed domain support was added but the main interface here is called an SCADomain. It's just a very small domain with only one node inside it. You can't see the node and you configure and access it via the SCADomain interface. The majority of samples and tests use this today. However the new SCA Node implementation can work in both standalone and distributed configuration so may be more appropriate in situations other than the simple Tuscany samples and tests. We will convert more samples ant tests to this approach over time to show the benefit of using the node implementation.
h2. {anchor:Tuscany SCA Node Implementation}{bgcolor:#C3CDA1}Tuscany SCA Node Implementation{bgcolor}
Available from release 1.2 there is a new domain/node implementation. The node part of this can be run either stand alone or as part of a distributed domain. Most of the sample and test code has not started using this implementation yet and there may be more changes to the API.
h3. Creating and Configuring Node
Creating a node in code is straightforward. For example,
(!) TODO - This is yet to be ported over to the new node implementation
{code}
node = SCANode2Factory.createSCANodeWithComposite("Calculator.composite");
{code}
The node uses the named composite file to locate the contribution that contains it. The assumption here is that only one contribution is required. If more contributions must be loaded by the node the following interface can be used.
{code}
node = nodeFactory.createSCANode("file:/C:/CalculatorContribution1/Calculator.composite",
new SCAContribution("CalculatorContribution1",
"file:/C:/CalculatorContribution1"),
new SCAContribution("CalculatorContribution2",
"file:/C:/CalculatorContribution2"));
{code}
Where
{code}
"file:/C:/CalculatorContribution1/Calculator.composite"
{code}
Is the explicit location of the composite file to be run and
{code}
new SCAContribution("CalculatorContribution1",
"file:/C:/CalculatorContribution1")
{code}
Shows how to provide contribution details. Multiple contributions can be specified. You might have multiple contributions if, for example, you have chosen to separate common artifacts from those specific to this composite. The contribution containing common artifacts can then be used in other SCA applications without change.
h3. Starting a Node
Once the node is created it is configured and ready for use. It can be started as follows.
{code}
node.start();
{code}
h3. Locating Services
A local service reference can be retrieved in the following way.
{code}
calculatorService = ((SCAClient)node).getService(CalculatorService.class, "CalculatorServiceComponent");
{code}
h3. Stopping a Node
If you are done with the node or need to stop is processing messages use the following.
{code}
node.start();
{code}
h2. {anchor:Hosting Tuscany SCA Nodes}{bgcolor:#C3CDA1}Hosting Tuscany SCA Nodes{bgcolor}
You can run SCA applications in many different ways but the same underlying runtime is used but packaged in slightly different ways as follows
h3. Command Line
Most of the samples that are shipped with the Tuscany SCA Java distribution run from the command line.
(!) TODO
h3. WebApp
Some of the samples that are shipped with the Tuscany SCA Java distribution run as web apps
(!) TODO
h4. Tomcat
Running a Tuscany SCA Java enabled webapp in Tomcat is as simple as copying the webapp to the Tomcat webapps directory.
h4. Geronimo
(!) TODO
h4. WebSphere
Please see this blog entry to learn how to do this: http://jsdelfino.blogspot.com/2007/10/how-to-use-apache-tuscany-with.html
h4. WebLogic
Please see this user's blog to learn how to do this: http://davesowerby.blogspot.com/2008/02/using-tuscany-with-weblogic.html
h3. Eclipse
There are two Getting Started documents that discuss this.
[Getting Started with Tuscany using a Tuscany Distribution In Eclipse|Getting Started with Tuscany]
[Getting Started with Tuscany using the Tuscany Eclipse Plugin|Getting Started with Tuscany (using Tuscany Eclipse Plugin)]
h2. {anchor:Tuscany SCA Domain }{bgcolor:#C3CDA1}Tuscany SCA Domain {bgcolor}
SCA has the concept of a domain. Section 10 of the SCA Assembly specification describes an SCA Domain as defining "the boundary of visibility for all SCA mechanisms". SCA wires can be used to connect components within a single SCA Domain.
From the calculator sample you can see that the wires between the component references and services, formed by adding a target component name to a reference, are resolved inside an SCA domain.
{code}
<component name="CalculatorServiceComponent">
<implementation.java class="calculator.CalculatorServiceImpl"/>
<reference name="addService" target="AddServiceComponent" />
<reference name="subtractService" target="SubtractServiceComponent" />
<reference name="multiplyService" target="MultiplyServiceComponent" />
<reference name="divideService" target="DivideServiceComponent" />
</component>
<component name="AddServiceComponent">
<implementation.java class="calculator.AddServiceImpl"/>
</component>
{code}
The target="AddServiceComponent" of the CalculatorServiceComponent's addService reference refers to the AddServiceComponent defined later on in this composite. A domain can consist of more than one composite and wires can run between components defined in the composites. The SCA Domain describes the boundary within which target component services can be located.
To connect to services outside of the SCA Domain (whether they be services provided by SCA or by other means) you configure an explicit binding, for example, lets assume that the AddServiceComponent is a non-sca web service out there on the network somewhere. As this is outside the SCA domain we can use an explicit remote binding to talk to it.
{code}
<component name="CalculatorServiceComponent">
<implementation.java class="calculator.CalculatorServiceImpl"/>
<reference name="addService" >
<interface.java interface="calculator.AddService" />
<binding.ws uri="http://localhost:8080/sample-calculator-ws-webapp/AddServiceComponent"/>
</reference>
<reference name="subtractService" target="SubtractServiceComponent"></reference>
<reference name="multiplyService" target="MultiplyServiceComponent"></reference>
<reference name="divideService" target="DivideServiceComponent"></reference>
</component>
{code}
Tuscany SCA supports running an SCA Domain in a single Node or spread across multiple Nodes potentially on different machines. We have seen a domain with a single node before.
!calculator2.png|align=centre!
A domain with multiple nodes allows wires to run between components running in the separate nodes which may be running on different JVMs on different machines.
!calculator3.png|align=centre!
When reference and service are in different composites the domain workspace is used to pre-process each composited prior to the composites being deployed to nodes for running.
Contributions (containing the composites) are added to the doman workspace. Configuration must be provided which tells the workspace where the nodes are that are going to run the composites and which composites they will run. Based on this information the workspace make various (2 in the case of 2 composite to run) atom feeds available. Each can be read by a node to determine which composite to run and which contributions must be retrieved in order to provide the artifacts required by the composite.
The workspace processes all the relationships between all composite components and provides a fully configured composite to each node, i.e. all of the binding URIs are filled out based oSo it's basically a pre-processing step. You can simulate the effect by manually adding the full uri to the reference binding.ws in your case.
The calculator-distributed sample is a simple example of the use of the workspace. You can fire up the workspace and play with the gui or look at the 3 xml files in the top directory of that sample which the workspace relies on for configuration.
h3. Starting A Domain
There is a launcher that has a mainline for starting the domain.
(!) TODO
h3. Configuring A Domain Through The Web Interface
To get to the web interface of the default domain point you browser at.
(!) TODO
TBD
h3. Configuring a Domain Through The File System
workspace.xml - indicates the ID and location of each contributions that has been added to the domain.
domain.composite - the virtual domain composite. This is an SCA composite that represents the virtual domain which includes all of the composites that will run in the domain. A URI is provided which indicates which contribution each composite comes from. Ultimately an SCANode2 instance will be started for each composite included in the virtual domain. Each SCANode2 instance can be running on separate/distributed processors. So the virtual domain is a consolidated description of you distributed SCA application
cloud.composite - describes the compute cloud (the set of distributed SCANode2 instances) being used to run the SCA application. Each node is assigned a composite and also has details of the configuration of bindings when they run on that node, for example, the root URI is set. It's possibly slightly confusing that this file is in SCA composite format also but this is a convenience because firstly we didn't have to create a new file format and secondly there may be some benefit in the future of representing this network of nodes as a network of SCA services for management purposes although we don't do that yet.
(!) TODO
h3. Starting A Node
There is a launcher that has a mainline for starting nodes. When run from the command line it expects to be running in the context of the binary distribution where "modules" and "lib" directories are present.
It loads all of the jars from
1) the directory where the launcher class is found.
2) the ../modules directory
3) the ../libs directory
It then repeats the process looking for ../modules and ../lib dirs based on the contents of a TUSCANY_HOME environment variable
With the final list it creates a URLClassLoader with the current classloader as the parent and enforces a parent first classloading strategy.
(!) TODO
h3. Locating A Service
(!) TODO
h3. Stopping a Node
(!) TODO
h2. {anchor:Tuscany SCA Extensions}{bgcolor:#C3CDA1}Tuscany SCA Extensions{bgcolor}
h3. {anchor:The Extensible Runtime}{bgcolor:#C3CDA1}The Extensible Runtime{bgcolor}
The Tuscany SCA runtime comprises a small set of core software which deals with:
* Managing extesions to the Tuscany SCA Runtime(_core_)
* Building and in memory assembly model of SCA applications (_assembly_)
* Processing SCA applcations that are contributed (_contribution_)
* Supporting databindings (_databinding_)
* Supporting Tuscany SCA when its embedded in other environments (_embedded_)
* Supporting Tuscany SCA when its running in a servlet container (_http_)
The collections of interfaces that describe these features are referred to as the System Programming Interface (SPI). The [developer guide|SCA Java Developer Guide] discusses them in more detail but from a user perspective the important thing to realize is that the majority of interesting functionality in Tuscany SCA is provided by extensions which build upon this core SPI. These extensions provide Tuscany SCA with its ability to support a wide variety features.
* Implementation types
* Binding types
* Databinding types
* Interface description styles
* Hosting environments
So to understand how to use the Tuscany SCA runtime is to understand how to use its extensions.
h3. {anchor:Available Extensions}{bgcolor:#C3CDA1}Available Extensions{bgcolor}
More often than not using an extension involves adding information to the SCDL files or the implementation files but this is not always the case. The links below describe each of the extensions and how they can be used and configured.
{table:border=0}
{table-row}
{table-cell}
h3. {anchor:Implementation Types}{bgcolor:#C3CDA1}Implementation Types{bgcolor}
{table-cell}
{table-row}
{table-row}
{table-cell}[implementation.java|SCA Java implementation.java]{table-cell}
{table-cell}Support for SCA components implemented with Java classes{table-cell}
{table-cell}Available from 0.90{table-cell}
{table-row}
{table-row}
{table-cell}[implementation.script|SCA Java implementation.script] {table-cell}
{table-cell}Support for SCA components implemented with scripting languages{table-cell}
{table-cell}Available from 0.90{table-cell}
{table-row}
{table-row}
{table-cell}[implementation.spring|SCA Java implementation.spring]{table-cell}
{table-cell}Support for spring{table-cell}
{table-cell}Available from 0.91{table-cell}
{table-row}
{table-row}
{table-cell}[implementation.resource|SCA Java implementation.resource]{table-cell}
{table-cell}exposes file resources{table-cell}
{table-cell}Available from 0.91{table-cell}
{table-row}
{table-row}
{table-cell}[implementation.bpel|SCA Java implementation.bpel]{table-cell}
{table-cell}Support for components implemented in BPEL{table-cell}
{table-cell}Available from 1.0{table-cell}
{table-row}
{table-row}
{table-cell}[implementation.osgi|SCA Java implementation.osgi]{table-cell}
{table-cell}Support for osgi{table-cell}
{table-cell}Available from 1.0{table-cell}
{table-row}
{table-cell}[implementation.xquery|SCA Java implementation.xquery]{table-cell}
{table-cell}Support for components implemented in xquery{table-cell}
{table-cell}Available from 1.0{table-cell}
{table-row}
{table-row}
{table-cell}[implementation.widget|SCA Java implementation.widget]{table-cell}
{table-cell}Support wiring of SCA components in Web 2.0 style applications{table-cell}
{table-cell}Available from 1.0{table-cell}
{table-row}
{table-cell}
h3. {anchor:Protocol Bindings}{bgcolor:#C3CDA1}Protocol Bindings{bgcolor}
{table-cell}
{table-row}
{table-row}
{table-cell}[binding.ajax|SCA Java binding.ajax]{table-cell}
{table-cell}Communication with AJAX clients{table-cell}
{table-cell}Available from 0.90{table-cell}
{table-row}
{table-row}
{table-cell}[binding.jms|SCA Java binding.jms]{table-cell}
{table-cell}Asynchronous JMS messaging{table-cell}
{table-cell}Available from 1.1{table-cell}
{table-row}
{table-row}
{table-cell}[binding.jsonrpc|SCA Java binding.jsonrpc]{table-cell}
{table-cell}The JSON-RPC protocol{table-cell}
{table-cell}Available from 0.90{table-cell}
{table-row}
{table-row}
{table-cell}[binding.rmi|SCA Java binding.rmi]{table-cell}
{table-cell}The Java RMI protocol{table-cell}
{table-cell}Available from 0.90{table-cell}
{table-row}
{table-row}
{table-cell}[binding.ws|SCA Java binding.ws]{table-cell}
{table-cell}SOAP/HTTP web services{table-cell}
{table-cell}Available from 0.90{table-cell}
{table-row}
{table-row}
{table-cell}[binding.ejb|SCA Java binding.ejb]{table-cell}
{table-cell}EJB Binding{table-cell}
{table-cell}Available from 0.90{table-cell}
{table-row}
{table-row}
{table-cell}[binding.rss|SCA Java binding.rss]{table-cell}
{table-cell}Consumes or provides an RSS feed{table-cell}
{table-cell}Available from 0.91{table-cell}
{table-row}
{table-cell}[binding.atom|SCA Java binding.atom]{table-cell}
{table-cell}supports Atom-publishing (a standard REST protocol), allowing you to create, retrieve, update, delete Atom entries {table-cell}
{table-cell}Available from 0.91{table-cell}
{table-row}
{table-row}
{table-cell}
h3. {anchor:Data Bindings}{bgcolor:#C3CDA1}Data Bindings{bgcolor}
{table-cell}
{table-row}
{table-row}
{table-cell}databinding-axiom{table-cell}
{table-cell}Support for AXIOM databinding{table-cell}
{table-cell}Available from 0.90{table-cell}
{table-row}
{table-row}
{table-cell}databinding-jaxb {table-cell}
{table-cell}Support for JAXB databinding {table-cell}
{table-cell}Available from 0.90{table-cell}
{table-row}
{table-row}
{table-cell}databinding-sdo{table-cell}
{table-cell}Support for SDO databinding {table-cell}
{table-cell}Available from 0.90{table-cell}
{table-row}
{table-row}
{table-cell}databinding-sdo-axiom{table-cell}
{table-cell}Support optimzed SDO to AXIOM transformation{table-cell}
{table-cell}Available from 0.90{table-cell}
{table-row}
{table-row}
{table-cell}
h3. {anchor:Interfaces}{bgcolor:#C3CDA1}Interfaces{bgcolor}
{table-cell}
{table-row}
{table-row}
{table-cell}interface-java{table-cell}
{table-cell}Interfaces described with java interfaces{table-cell}
{table-cell}Available from 0.90{table-cell}
{table-row}
{table-row}
{table-cell}interface-wsdl{table-cell}
{table-cell}Interfaces described with WSDL definitions{table-cell}
{table-cell}Available from 0.90{table-cell}
{table-row}
{table-row}
{table-cell}
h3. {anchor:Hosts}{bgcolor:#C3CDA1}Hosts{bgcolor}
{table-cell}
{table-row}
{table-row}
{table-cell}[host.embedded|SCA JAVA host.embedded]{table-cell}
{table-cell}The original simple embeddable runtime {table-cell}
{table-cell}Available from 0.90{table-cell}
{table-row}
{table-cell}http-jetty{table-cell}
{table-cell}The integration between Tuscany and the Jetty web container{table-cell}
{table-cell}Available from 0.90{table-cell}
{table-row}
{table-row}
{table-cell}http-tomcat{table-cell}
{table-cell}The integration between Tuscany and the Tomcat web container{table-cell}
{table-cell}Available from 0.90{table-cell}
{table-row}
{table}
h3. {anchor:Using Extensions}{bgcolor:#C3CDA1}Using Extensions{bgcolor}
Extensions are loaded into the Tuscany SCA runtime using the Java service loading mechanism. Each extension is packaged as a jar and provides a file;
{code}
META-INF/services/org.apache.tuscany.sca.core.ModuleActivator
{code}
Using this information the Tuscany SCA runtime will load each extensions present on the the Java CLASSPATH. So if you want to use a particular feature make sure that it's available on your classpath. Conversely if you don't want a particular feature to be active remove it from the classpath.
Writing a new extension is a subject in its own right and is described in the [extension guide|SCA Java Extension Development Guide]
h2. {anchor:Tuscany SCA And IDEs}{bgcolor:#C3CDA1}Tuscany SCA And IDEs{bgcolor}
h3. {anchor:Using The Samples In An IDE Without Maven}{bgcolor:#C3CDA1}Using The Samples In An IDE Without Maven{bgcolor}
We don't provide any IDE project files with our disitributions so you will have to import the sample files into your IDE manually. Here's an example of how it can be done using Eclipse. Here the directory tuscany_sca_install_dir is the directory whch holds the Tuscany SCA Java binary installation after it's been extracted from its archive file, for example, for the 0.90 release this will be tuscany-sca-0.90-incubating.
In a new or existing workspace
* Create a new java project to represent the sample you want to work on, e.g.
{noformat}
my working dir/calculator
{noformat}
* Import all of the sample code and resources into this project, e.g.
{noformat}
Use the File,Import menu and then select tuscany_sca_install_dir/samples/calculator from the filesystem
{noformat}
* Configure the source path to include
{noformat}
tuscany_sca_install_dir/samples/calculator/src/main/java
tuscany_sca_install_dir/samples/calculator/src/main/resources
{noformat}
* Configure the output folder to be
{noformat}
tuscany_sca_install_dir/samples/calculator/target
{noformat}
* Configure the build path to include all of the jars provided in
{noformat}
tuscany_sca_install_dir/lib
{noformat}
* If you select calculator.CalculatorClient.java and run as "Java Application" you should see
{noformat}
3 + 2=5.0
3 - 2=1.0
3 * 2=6.0
3 / 2=1.5
{noformat}
The details of how to do this for other development environments will vary but the process will be similar.
h3. {anchor:Using The Samples In An IDE If You Have Maven}{bgcolor:#C3CDA1}Using The Samples In An IDE If You Have Maven{bgcolor}
If you are a Maven user you can use it to generate all of the IDE project files for you automatically. This works best if you generate IDE projects for all of the Apache Tuscany modules. You can then include the ones you are interested in working with in you IDE.
To build IDE project files for all of the modules in Apache Tuscany SCA;
{noformat}
cd sca
{noformat}
If you are an Eclipse user do the following
{noformat}
mvn -Peclipse eclipse:eclipse
{noformat}
If you are an IDEA user do the following
{noformat}
mvn idea:idea
{noformat}
These commands generate project files for each module in Apache Tuscany SCA. The modules you are interested in can now be included in your IDE, for example, in Eclipse, if you create a new Java project and use the option to "create a new project from existing source" you can specify an SCA module directory, which includes the generated project files, and Eclipse will treat it like any other Java project.
{HTMLcomment:hidden}{children:sort=creation}{HTMLcomment}
| #C3CDA1 | | title | Apache Tuscany SCA User Guide |
|---|
| borderStyle | solid |
|---|
| |
| Note |
|---|
| title:Notification |
|---|
| title:Notification |
|---|
|
| Center |
|---|
| This page is undergoing complete re-write to be more like a user guide than it is today. You are welcome to help review and complete it. |
|
| Background Color |
|---|
|
| About Tuscany User Guide |
It is assumed that by now you have browsed through the introduction to SCA section or are familiar with SCA. This user guide helps you learn more about SCA through Tuscany. It starts with building a simple application and progresses into more advanced features through references to samples that reside in Tuscany.
Before we start, let's emphasise that it is Tuscany's goal to provide an implementaiton that avoids imposing rules and requirements on how you write your applications. In fact the goal is to let you write application code without being concerned about the technology you choose or the environment in which it will be used. You focus on your business logic and Tuscany infrastructure will handle the rest.
| Anchor |
|---|
| Create Your First Application |
|---|
| Create Your First Application |
|---|
|
| Background Color |
|---|
|
| Create Your First Application |
This simple exercise provides you with a hands-on experience for creating an SCA calculator application. Although this is a simple application, it will cover the following items:
- Creating SCA POJO-based components
- Composing an application
- Deploying the application
- Modifying the application to use a different binding
Give create a calculator application a try.
| Background Color |
|---|
|
| Create a Webservices component |
Learn how to expose your pojo components as webservices. This will cover
- Creating SCA POJO-based component and exposing it as a webservice
Give Building your first web services using Tuscany a try.
| Anchor |
|---|
| distributed application |
|---|
| distributed application |
|---|
|
| Background Color |
|---|
|
| Create a Distributed Application |
A Tuscany application can be run in a single or multi-node environment. Here we introduce the Tuscany node and SCA domain and explain how the calculator example can be distributed across multiple nodes. We will cover the following:
- What is a node?
- What is the SCA domain
- How to create and application that will run across multiple nodes in a domain
Take a look at Distributed SCA Domain
| Anchor |
|---|
| Create an enterprise Application |
|---|
| Create an enterprise Application |
|---|
|
| Background Color |
|---|
|
| Create a Store Enterprise Application |
Now that you have created a simple calculator application, let's move on to a more interesting application called store. This application is developed in Eclipse enviromment and uses more advanced features that are offered in Tuscany. You will notice that it is as simple to create this application as it was to create the calculator application.
Getting Started with Tuscany using a Tuscany Distribution In Eclipse
This is a quick getting started guide that go trough the steps of building the store scenario using the Tuscany SCA distribution manually installed into Eclipse
Getting Started with Tuscany using the Tuscany Eclipse Plugin
This is a quick getting started guide that go trough the steps of building the store scenario using the Tuscany Eclipse plugin.
| Anchor |
|---|
| Host Environments |
|---|
| Host Environments |
|---|
|
| Background Color |
|---|
|
| Host Environments |
Tusncany applications can be run in a Tuscany standalone environment or in multitude of different host environments. You have seen examples of how to run in standalone environments in the previous sections. Here we cover other platforms.
Tomcat
Running a Tuscany SCA Java enabled webapp in Tomcat is as simple as copying the webapp to the Tomcat webapps directory.
Geronimo
TODO ... get link from Vamsi
WebSphere
Please see this blog entry to learn how to do this: http://jsdelfino.blogspot.com/2007/10/how-to-use-apache-tuscany-with.html
WebLogic
Please see this user's blog to learn how to do this: http://davesowerby.blogspot.com/2008/02/using-tuscany-with-weblogic.html
Eclipse
You can develop and run your applications in Eclipse environment.
Getting Started with Tuscany using a Tuscany Distribution In Eclipse
Tuscany also provides a Tuscany Eclipse plug-in to facilitate the development of SCA applications on Tuscany in the Eclipse environment.
Getting Started with Tuscany using the Tuscany Eclipse Plugin
| Anchor |
|---|
| using extensions |
|---|
| using extensions |
|---|
|
| Background Color |
|---|
|
| Using Extensions |
What are extensions? Well, we call these extensions: bindings, implementation types, interface types, policies. Think of SCA Java infrastructure as providing the framework that supports all these pluggable functionality. Bindings provide protocol handling, implementation types provide support for different languages and programming models, interface types allow enable you to define interfaces in different ways for example Java, WSDL and policies enable you to choose which type of policies you want to apply to your application. You can pick and choose what you need based on your requirements and the technologies that you use. For a complete list of available extensions and their documentation please check this link.
| Background Color |
|---|
|
| Running Tuscany with Java2 Security Enabled |
Tuscany can be enabled to run with Java2 security on.
Running Tuscany with Java 2 Security Enabled
| Anchor |
|---|
| Tuscany dependencies |
|---|
| Tuscany dependencies |
|---|
|
| Background Color |
|---|
|
| Do I need all of Tuscany? |
Tuscany SCA has a very modular architecture. Think of it as building blocks. You pick what you need for your particular application. In 1.x, there is one binary distribution. you can get to a smaller subset through building the source with the appropriate modules that you need. In 2.x code line, we are aiming to provide smaller distributions. For more information about how you can build a smaller distribution please see this link