This page will move to the website when it is complete. Please help to complete it. Thanks.
What this is about
As of release 1.3 Tuscany SCA is distributed via one binary distribution that includes everything. Based on user feedback, choice of a smaller distribution packages is desireable. Tuscany community is in the process of addressing this requirement. Please see mailing list for that discussion. This is not the purpose of this page.
Tuscany users have asked for a write-up that highlights module dependencies. This enables them to build their own distribution which may have a lower or higher granularity than the pre-packaged binary distributions. Purpose of this page is to help users understand how to build their own tuscany SCA light distribution based on module dependency knowledge that is shared here.
Therefore:
This page is not about building Tuscany building binary distributions to distribute
This page is about understanding dependencies so that users can build their own distribution
How to build your own distribution
Let's first understand the different categories of module types in Tuscany. This understanding will help us determine how to put the modules together to have a runnable and useful system.
Tuscany Modules Categorized
SCA programming Model: Assembly, Deployment, Management
SCA provides a programming model for Construction, Assembly, Deployment and Management of network of services. Modules under these catetories support the SCA programming model.
Tuscany Container
Modules in this category are specific to running SCA in a Tuscany environment.
Tuscany container also provides plug points for different host types, bindings, implementations, policies as well as deployment and management (contributions and domain handling).
Policy
Module in this category include support for enabling policies as well as policy types.
Binding
Modules in this category include various bindings that support different protocols. Typically Bindings are used with SCA programming model, Tuscany container and some component implementation types.
Implementation
Modules in this category include support for different component types. Basic SCA environment is needed to use any of these modules.
Host Environment
Modules in this category include support for different host environments, such as Tomcat, Jetty, etc.
Module Category Dependency
This section explains the dependencies amongst various categories. This information can be used to define the scope of modules needed to perform different tasks using Tuscany.
Category |
Dependency |
SCA Programming Model |
None. It runs in any container |
Tuscany Container |
SCA Programming Model. Note that Tuscany Container has plug points for various host environments, but is not dependent on any. |
policy |
Tuscany Container and SCA PM |
Binding |
Tuscany Container and some host environment depending on the protocol type |
Implementation |
Tuscany Container |
Tuscany Modules Break Down by Category
Note All modules that represent models are highlighted in green. A model out of a category can be used without dependency on the rest of the category. One use case may be tooling.
Category |
Description |
SCA constructs |
Tuscany Modules |
Detail |
SCA PM |
SCA assembly |
composite |
assembly |
Model interfaces for the SCA assembly |
SCA PM |
Java Interface |
interface.java |
interface |
Model for interface/operation |
SCA PM |
WSDL Interface |
interface.wsdl |
interface |
Interface processor for JAXWS annotation |
Policy |
Policy |
intent |
policy |
Model for policy |
Tuscany Container |
Contribution Processing |
|
contribution |
Process SCA contribution (archives) and build the model for containing artifacts |
Tuscany Container |
Extensibility |
|
extensibility |
Provide the extensibility to plugin tuscany extensions such as utilities, XML processors, |
Tuscany Container |
Runtime core and SPI for extensions |
|
core |
Core activates SCA composite and build up the invocation chain between |
Tuscany Container |
Databinding |
|
databinding |
A framework to deal with data representation and transformation |
SCA PM |
SCA API |
|
sca-api |
SCA Java common APIs and Annotations |
Tuscany Container |
SCA Node API, Impl and Launchers |
|
node-api |
Api used to Start/Stop SCA node which bootstraps SCA runtime to run the application. |
Tuscany Container |
SCA Domain Manager |
|
domain-manager |
Define and manage domain |
Tuscany Container |
Serviceability: Monitoring, Logging and Tracing |
|
monitor |
|
Host Types |
Host environments |
|
host-http |
HTTP protocol support for all http-based bindings |
Binding |
Feed bindings: |
binding.atom |
binding-atom |
Feed support, including atom and rss protocols. Needs http type host environment. |
Binding |
JSONRPC binding |
binding.jsonrpc |
binding-jsonrpc |
JSONRPC for AJAX. Needs http type host environment. |
Binding |
RMI binding |
binding.rmi |
binding-rmi |
RMI |
Binding |
JMS binding |
binding.jms |
binding-jms |
JMS |
Binding |
EJB binding |
binding.ejb |
binding-ejb |
EJB |
Binding |
CORBA binding |
binding.corba |
binding-corba |
CORBA |
Binding |
GData binding |
binding.gdata |
binding-gdata |
GData |
Binding |
HTTP binding |
binding.http |
binding-http |
|
Binding |
Web Service binding |
|
binding-ws |
|
Binding |
SCA binding |
binding.sca |
binding-sca |
One of the binding-sca-(types) is needed. The default is corba? |
Binding |
Java implementation |
implementation.java |
implementation-java |
Java component types |
Implementation |
BPEL implementation |
implementation.bpel |
implementation-bpel |
Use BPEL components in a composite application. Based on Apache Ode. |
Implementation |
EJB implementation |
implementation.ejb |
implementation-ejb |
EJBs as components in a composition |
Implementation |
Scripting language based implementation |
implementation.script |
implementation-script |
enables using Groovy, JavaScript, Ruby, Python as components. |
Implementation |
Spring implementation |
implementation.spring |
implementation-spring |
enables inclusion of Spring beans in a composite |
Implementation |
Widgets |
? |
implementation-widget |
|
Implementation |
OSGi implementation |
implementation.osgi |
implementation-osgi |
enables incusion of OSGI bundles in a composite |
Implementation |
HTTP Resource implementation |
implementation.resource |
implementation-resource |
HTTP resource type component |
Implementation |
XQuery implementation |
implementation.xquery |
implementation-xquery |
Xquery component |
Implementation |
Data Access Services |
|
data-api |
|
Minimum rquired to build and run SCA applications
What is the minimum number of modules required to develop SCA applications using Tuscany?
Well, it really depends on what you want to do. Let's look at some scenarios.
Want to develop SCA applications but use our container
Use SCA PM
Want to develop SCA applications in Tuscany based on POJOs
Use SCA PM, Tuscany Container, implementation.java, SCA default binding
Want to reference external services using webservice
Use SCA PM, Tuscany Container, implementation.java, Webservices Binding
Want to write a tool for SCA
Use the modules related to SCA models, (what else?)