Wiki Markup |
---|
(!) This page will move to the website when it is complete. Please help to complete it. Thanks.
h1. 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 binary distributions to distribute
*This page is about* understanding dependencies so that users can build their own distribution
h1. 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.
h2. 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.
h3. 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 |
h3. 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.
| {color:#330099}{*}Category{*}{color} | *Description* | {color:#330099}{*}SCA constructs{*}{color} | {color:#330099}{*}Tuscany Modules{*}{color} | {color:#330099}{*}Detail{*}{color} |
| SCA PM | SCA assembly | composite \\
componentType | {color:#009900}assembly{color} \\ assembly-xml \\
assembly-xsd | Model interfaces for the SCA assembly \\
XML Reader, Writer and Resolver \\
XSDs for the assemlby model |
| SCA PM | Java Interface | interface.java | {color:#009900}interface{color} \\ interface-java \\
interface-java-xml | Model for interface/operation \\
across Java and WS \\
Model for java interface \\
Reader/Writer for interface.java \\ |
| SCA PM | WSDL Interface | interface.wsdl | interface \\
interface-java-jaxws \\
interface-wsdl \\
interface-wsdl-xml \\
\\
xsd \\
xsd-xml | Interface processor for JAXWS annotation \\
WSDL port type as the interface definition \\
Reader/Writer for interface.wsdl \\
\\
Model for XSD artifacts \\
Reader/Writer to load/save XSDs |
| Policy | Policy | intent \\
policySet | {color:#009900}policy{color} \\
policy-xml \\
policy-xml-ws \\
\\
policy-logging \\
policy-security \\
policy-security-jsr250 \\
policy-security-ws \\
policy-transaction \\
\\ {color:#009900}definitions{color} \\
definitions-xml | Model for policy \\
Read/Writer for policy XML \\
Reader/Writer for WS policy XML |
| Tuscany Container | Contribution Processing | | {color:#009900}contribution{color} \\ contribution-xml \\
contribution-impl \\
contribution-java \\
contribution-namespace \\
contribution-osgi \\
contribution-resource | Process SCA contribution (archives) and build the model for containing artifacts |
| Tuscany Container | Extensibility | | {color:#009900}extensibility{color} \\ extensibility-equinox | Provide the extensibility to plugin tuscany extensions such as utilities, XML processors, \\
binding providers, \\
implementation providers and databindings |
| Tuscany Container | Runtime core and SPI for extensions | | {color:#009900}core{color} \\ core-spi \\
core-databinding \\ | Core activates SCA composite and build up the invocation chain between \\
SCA services and references over the bindings |
| Tuscany Container | Databinding | | {color:#009900}databinding{color} \\
\\
databinding-axiom \\
databinding-fastinfoset \\
databinding-jaxb \\
databinding-jaxb-axiom \\
databinding-json \\
databinding-saxon \\
databinding-sdo \\
databinding-sdo-axiom \\
databinding-xmlbeans | 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 \\
node-dynamic \\
node-impl \\
node-launcher \\
node-launcher-equinox \\
thirdparty-library \\
\\
node-launcher-webapp \\
node-manager \\
implementation-node \\
implementation-node-runtime \\
host-embedded | Api used to Start/Stop SCA node which bootstraps SCA runtime to run the application. |
| Tuscany Container | SCA Domain Manager | | domain-manager \\
workspace \\
workspace-impl \\
workspace-xml | Define and manage domain |
| Tuscany Container | Serviceability: Monitoring, Logging and Tracing | | {color:#009900}monitor{color} \\
monitor-logging \\
tracing-aspectj \\ | |
| {color:#000000}Host Types{color} | {color:#000000}Host environments{color} | | {color:#000000}host-http{color} \\ {color:#000000}host-jetty{color} \\ {color:#000000}host-tomcat{color} \\ {color:#000000}host-webapp{color} \\ {color:#000000}host-webapp-junit{color} | {color:#000000}HTTP protocol support for all http-based bindings{color} |
| {color:#000000}Binding{color} | {color:#000000}Feed bindings:{color} \\ {color:#000000}Atom{color} \\ {color:#000000}RSS{color} | {color:#000000}binding.atom{color} \\ {color:#000000}binding.rss{color} | {color:#000000}binding-atom{color} \\ {color:#000000}binding-atom-abdera{color} \\ {color:#000000}binding-rss{color} \\ {color:#000000}binding-rss-rome{color} | {color:#000000}Feed support, including atom and rss protocols. Needs http type host environment.{color} |
| {color:#000000}Binding{color} | {color:#000000}JSONRPC binding{color} | {color:#000000}binding.jsonrpc{color} | {color:#000000}binding-jsonrpc{color} \\ {color:#000000}binding-jsonrpc-runtime{color} | {color:#000000}JSONRPC for AJAX. Needs http type host environment. {color} |
| {color:#000000}Binding{color} | {color:#000000}RMI binding{color} | {color:#000000}binding.rmi{color} | {color:#000000}binding-rmi{color} \\ {color:#000000}host-rmi{color} | {color:#000000}RMI{color} |
| {color:#000000}Binding{color} | {color:#000000}JMS binding{color} | {color:#000000}binding.jms{color} | {color:#000000}binding-jms{color} \\ {color:#000000}binding-jms-runtime{color} | {color:#000000}JMS{color} |
| {color:#000000}Binding{color} | {color:#000000}EJB binding{color} | {color:#000000}binding.ejb{color} | {color:#000000}binding-ejb{color} \\ {color:#000000}binding-ejb-runtime{color} \\ {color:#000000}host-ejb{color} \\ {color:#000000}host-openejb{color} | {color:#000000}EJB{color} |
| {color:#000000}Binding{color} | {color:#000000}CORBA binding{color} | {color:#000000}binding.corba{color} | {color:#000000}binding-corba{color} \\ {color:#000000}binding-corba-runtime{color} \\ {color:#000000}host-corba{color} \\ {color:#000000}host-corba-jee{color} \\ {color:#000000}host-corba-jse{color} \\ {color:#000000}host-corba-jse-tns{color} | {color:#000000}CORBA{color} |
| {color:#000000}Binding{color} | {color:#000000}GData binding{color} | {color:#000000}binding.gdata{color} | {color:#000000}binding-gdata{color} \\ {color:#000000}binding-gdata-runtime{color} \\ {color:#000000}binding-gdata-gsoc{color} \\ {color:#000000}binding-gdata-runtime-gsoc{color} | {color:#000000}GData{color} |
| {color:#000000}Binding{color} | {color:#000000}HTTP binding{color} | {color:#000000}binding.http{color} | {color:#000000}binding-http{color} \\ {color:#000000}binding-http-runtime{color} \\ | {color:#000000} {color} |
| {color:#000000}Binding{color} | {color:#000000}Web Service binding{color} | {color:#000000} {color} | {color:#000000}binding-ws{color} \\ {color:#000000}binding-ws-axis2{color} \\ {color:#000000}binding-ws-axis2-policy{color} \\ {color:#000000}binding-ws-wsdlgen{color} \\ {color:#000000}binding-ws-xml{color} | {color:#000000} {color} |
| {color:#000000}Binding{color} | {color:#000000}SCA binding{color} | {color:#000000}binding.sca{color} | {color:#000000}binding-sca{color} \\ {color:#000000}binding-sca-xml{color} \\ {color:#000000}binding-sca-axis2{color} \\ {color:#000000}binding-sca-corba{color} \\ {color:#000000}binding-sca-jms{color} \\ {color:#000000}endpoint{color} | {color:#000000} {color} One of the binding-sca-(types) is needed. The default is corba? |
| {color:#000000}Binding{color} | {color:#000000}Java implementation{color} | {color:#000000}implementation.java{color} | {color:#000000}implementation-java{color} \\ {color:#000000}implementation-java-xml{color} \\ {color:#000000}implementation-java-runtime{color} | {color:#000000} {color} Java component types |
| {color:#000000}Implementation{color} | {color:#000000}BPEL implementation{color} | {color:#000000}implementation.bpel{color} | {color:#000000}implementation-bpel{color} \\ {color:#000000}implementation-bpel-jbpm{color} \\ {color:#000000}implementation-bpel-ode{color} | {color:#000000} {color} Use BPEL components in a composite application. Based on Apache Ode. |
| {color:#000000}Implementation{color} | {color:#000000}EJB implementation{color} | {color:#000000}implementation.ejb{color} | {color:#000000}implementation-ejb{color} | {color:#000000} {color} EJBs as components in a composition |
| {color:#000000}Implementation{color} | {color:#000000}Scripting language based implementation{color} | {color:#000000}implementation.script{color} | {color:#000000}implementation-script{color} | {color:#000000} {color} enables using Groovy, JavaScript, Ruby, Python as components. |
| {color:#000000}Implementation{color} | {color:#000000}Spring implementation{color} | {color:#000000}implementation.spring{color} | {color:#000000}implementation-spring{color} | {color:#000000} {color} enables inclusion of Spring beans in a composite |
| {color:#000000}Implementation{color} | {color:#000000} {color} Widgets | {color:#000000}?{color} | {color:#000000}implementation-widget{color} \\ {color:#000000}implementation-widget-runtime{color} | {color:#000000} {color} |
| {color:#000000}Implementation{color} | {color:#000000}OSGi implementation{color} | {color:#000000}implementation.osgi{color} | {color:#000000}implementation-osgi{color} | {color:#000000} {color}enables incusion of OSGI bundles in a composite |
| {color:#000000}Implementation{color} | {color:#000000}HTTP Resource implementation{color} | {color:#000000}implementation.resource{color} | {color:#000000}implementation-resource{color} \\ {color:#000000}implementation-resource-runtime{color} | {color:#000000} {color} HTTP resource type component |
| {color:#000000}Implementation{color} | {color:#000000}XQuery implementation{color} | {color:#000000}implementation.xquery{color} | {color:#000000}implementation-xquery{color} | {color:#000000} Xquery component{color} |
| {color:#000000}Implementation{color} | {color:#000000}Data Access Services{color} | {color:#000000} {color} | {color:#000000}data-api{color} \\ {color:#000000}data-engine-helper{color} \\ {color:#000000}implementation-das{color} \\ {color:#000000}implementation-data-xml{color} | |
h2. Some of the use cases for Tuscany
h3. Use Tuscany as a runtime and grab some features
Example: How to develop SCA applications in Tuscany based on POJOs
Use SCA PM, Tuscany Container, implementation.java, SCA default binding
h3. Adopt the programming model to create a component model for your own runtime
Example: Want to use SCA for configuration of and ESB engine
Use SCA PM
h3. Embed Tuscany within your application server
Example: Embed Tuscany with an application server such Geronimo
Pick the features that are needed to run on the platform. In some cases you need to use host SPIs to provide the platform specific behavior which includes Tuscany extension.
h3. Create tools for SCA
Example: Write a development tool for SCA
use SCA PM.
h3. and so on please help add different scenarios
h2. How to create your own distribution
Link to page describing how to create a POM.xml and use maven, .. {TBD}
Talk about how the third party plays a role here.
|
This page will move to the website when it is complete. Please help to complete it. Thanks. What this is aboutAs 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 binary distributions to distribute This page is about understanding dependencies so that users can build their own distribution How to build your own distributionLet'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 CategorizedSCA 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 DependencyThis 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 CategoryNote 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 componentType | assembly assembly-xml assembly-xsd | Model interfaces for the SCA assembly XML Reader, Writer and Resolver XSDs for the assemlby model |
SCA PM | Java Interface | interface.java | interface interface-java interface-java-xml | Model for interface/operation across Java and WS Model for java interface Reader/Writer for interface.java
|
SCA PM | WSDL Interface | interface.wsdl | interface
interface-java-jaxws
interface-wsdl
interface-wsdl-xml
xsd
xsd-xml Interface processor for JAXWS annotation
WSDL port type as the interface definition
Reader/Writer for interface.wsdl
Model for XSD artifacts
Reader/Writer to load/save XSDs Policy | Policy | intent policySet | policy
policy-xml
policy-xml-ws
policy-logging
policy-security
policy-security-jsr250
policy-security-ws
policy-transaction
definitions
definitions-xml Model for policy Read/Writer for policy XML Reader/Writer for WS policy XML | Tuscany Container | Contribution Processing | | contribution contribution-xml contribution-impl contribution-java contribution-namespace contribution-osgi contribution-resource | Process SCA contribution (archives) and build the model for containing artifacts |
Tuscany Container | Extensibility | | extensibility extensibility-equinox | Provide the extensibility to plugin tuscany extensions such as utilities, XML processors, binding providers, implementation providers and databindings |
Tuscany Container | Runtime core and SPI for extensions | | core core-spi core-databinding
| Core activates SCA composite and build up the invocation chain between SCA services and references over the bindings |
Tuscany Container | Databinding | | databinding
databinding-axiom
databinding-fastinfoset
databinding-jaxb
databinding-jaxb-axiom
databinding-json
databinding-saxon
databinding-sdo
databinding-sdo-axiom
databinding-xmlbeans 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
node-dynamic
node-impl
node-launcher
node-launcher-equinox
thirdparty-library
node-launcher-webapp
node-manager
implementation-node
implementation-node-runtime
host-embedded Api used to Start/Stop SCA node which bootstraps SCA runtime to run the application. | Tuscany Container | SCA Domain Manager | | domain-manager workspace workspace-impl workspace-xml | Define and manage domain |
Tuscany Container | Serviceability: Monitoring, Logging and Tracing | | monitor monitor-logging tracing-aspectj
| |
Host Types | Host environments | | host-http host-jetty host-tomcat host-webapp host-webapp-junit | HTTP protocol support for all http-based bindings |
Binding | Feed bindings: Atom RSS | binding.atom binding.rss | binding-atom binding-atom-abdera binding-rss binding-rss-rome | Feed support, including atom and rss protocols. Needs http type host environment. |
Binding | JSONRPC binding | binding.jsonrpc | binding-jsonrpc binding-jsonrpc-runtime | JSONRPC for AJAX. Needs http type host environment. |
Binding | RMI binding | binding.rmi | binding-rmi host-rmi | RMI |
Binding | JMS binding | binding.jms | binding-jms binding-jms-runtime | JMS |
Binding | EJB binding | binding.ejb | binding-ejb binding-ejb-runtime host-ejb host-openejb | EJB |
Binding | CORBA binding | binding.corba | binding-corba binding-corba-runtime host-corba host-corba-jee host-corba-jse host-corba-jse-tns | CORBA |
Binding | GData binding | binding.gdata | binding-gdata binding-gdata-runtime binding-gdata-gsoc binding-gdata-runtime-gsoc | GData |
Binding | HTTP binding | binding.http | binding-http binding-http-runtime
| |
Binding | Web Service binding | | binding-ws binding-ws-axis2 binding-ws-axis2-policy binding-ws-wsdlgen binding-ws-xml | |
Binding | SCA binding | binding.sca | binding-sca binding-sca-xml binding-sca-axis2 binding-sca-corba binding-sca-jms endpoint | One of the binding-sca-(types) is needed. The default is corba? |
Binding | Java implementation | implementation.java | implementation-java implementation-java-xml implementation-java-runtime | Java component types |
Implementation | BPEL implementation | implementation.bpel | implementation-bpel implementation-bpel-jbpm implementation-bpel-ode | 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-widget-runtime | |
Implementation | OSGi implementation | implementation.osgi | implementation-osgi | enables incusion of OSGI bundles in a composite |
Implementation | HTTP Resource implementation | implementation.resource | implementation-resource implementation-resource-runtime | HTTP resource type component |
Implementation | XQuery implementation | implementation.xquery | implementation-xquery | Xquery component |
Implementation | Data Access Services | | data-api data-engine-helper implementation-das implementation-data-xml | |
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
Use the modules related to SCA models, (what else?)
and so on please help add different scenarios