diff options
Diffstat (limited to 'site/trunk/site-publish/sca-java-web-applications.html')
| -rw-r--r-- | site/trunk/site-publish/sca-java-web-applications.html | 248 |
1 files changed, 248 insertions, 0 deletions
diff --git a/site/trunk/site-publish/sca-java-web-applications.html b/site/trunk/site-publish/sca-java-web-applications.html new file mode 100644 index 0000000000..36d2dc61dc --- /dev/null +++ b/site/trunk/site-publish/sca-java-web-applications.html @@ -0,0 +1,248 @@ + +<!-- + + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE- 2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> + + +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<HTML> + <HEAD> + <!-- generateKeywords macro --> + <META name="description" content="Apache Tuscany"> + <META name="keywords" content="apache, apache tuscany, tuscany, service, services, fabric, soa, service oriented architecture, sca, service component architecture, das, sdo, csa, ruby, opensource"> + <!-- generateKeywords macro end --> + + <LINK type="text/css" rel="stylesheet" href="http://tuscany.apache.org/stylesheets/default.css"> + <LINK rel="SHORTCUT ICON" href="https://cwiki.apache.org/confluence/display/TUSCANY/$images/favicon.ico"> + <TITLE>Apache Tuscany : SCA Java Web Applications</TITLE> + <META http-equiv="Content-Type" content="text/html;charset=UTF-8"></HEAD> + + <BODY onload="init()"> + <!-- topNav macro --> + <TABLE valign="top" border="0" cellspacing="0" cellpadding="0" width="100%" background="http://tuscany.apache.org/images/TuscanyLogoNEW_Text_120px_bg.jpg"> + <TR> + <TD valing="top" align="left"> + <A href="https://cwiki.apache.org/confluence/pages/viewpage.action?spaceKey=TUSCANY&title=$siteroot"><IMG src="http://tuscany.apache.org/images/TuscanyLogoNEW_Text_120px_bg.jpg" height="91" width="25" border="0"></A> + </TD> + <TD> + <A href="http://tuscany.apache.org/"><IMG src="http://tuscany.apache.org/images/TuscanyLogo.jpg" border="0"></A> + </TD> + + <TD width="100%"> + + </TD> + + <!-- Adds the edit page link to the top banner--> + <TD valign="bottom"> + <DIV style="padding: 2px 10px; margin: 0px;"> + <A href="https://cwiki.apache.org/confluence/pages/editpage.action?pageId=106453"> + <IMG src="http://tuscany.apache.org/images/notep_16.gif" height="16" width="16" border="0" align="absmiddle" title="Edit Page"></A> + </DIV> + </TD> + + </TR> + </TABLE> + <!-- topNav macro end --> + + <!-- breadCrumbs macro --> + <TABLE border="0" cellpadding="2" cellspacing="0" width="100%"> + <TR class="topBar"> + <TD align="left" valign="middle" class="topBarDiv" nowrap="true" width="100%"> + <A href="home.html" title="Apache Tuscany">Apache Tuscany</A> > <A href="home.html" title="Home">Home</A> > <A href="sca-overview.html" title="SCA Overview">SCA Overview</A> > <A href="sca-java.html" title="SCA Java">SCA Java</A> > <A href="java-sca-documentation-menu.html" title="Java SCA Documentation Menu">Java SCA Documentation Menu</A> > <A href="" title="SCA Java Web Applications">SCA Java Web Applications</A> + </TD> + + <TD align="right" valign="middle" class="topBarDiv" align="left" nowrap="true"> + <A href="http://mail-archives.apache.org/mod_mbox/tuscany-user">User List</A> | <A href="http://mail-archives.apache.org/mod_mbox/tuscany-dev">Dev List</A> | <A href="http://issues.apache.org/jira/browse/Tuscany">Issue Tracker</A> + </TD> + </TR> + </TABLE> + <!-- breadCrumbs macro end --> + + + <TABLE border="0" cellpadding="0" width="100%" bgcolor="#FFFFFF"> + <TR> + <TD align="left" valign="top"> + + <!-- pageContent macro --> + <DIV id="PageContent"> + + <DIV class="pagecontent"> + <DIV class="wiki-content"> + <TABLE class="sectionMacro" border="0" cellpadding="5" cellspacing="0" width="100%"><TBODY><TR> +<TD class="confluenceTd" valign="top" width="15%"> +<DIV class="panel" style="background-color: #ECF4D1;border-color: #C3CDA1;border-style: solid;border-width: 1px;"><DIV class="panelHeader" style="border-bottom-width: 1px;border-bottom-style: solid;border-bottom-color: #C3CDA1;background-color: #C3CDA1;"><B>General</B></DIV><DIV class="panelContent" style="background-color: #ECF4D1;"> +<P><A href="home.html" title="Home">Home</A><BR> +<A href="http://www.apache.org/licenses/LICENSE-2.0.html" class="external-link" rel="nofollow">License </A><BR> +<A href="sca-java-get-involved.html" title="SCA Java Get Involved">Get Involved</A><BR> +<A href="sca-java-found-a-bug.html" title="SCA Java Found A Bug">Found a Bug?</A></P> +</DIV></DIV> + +<DIV class="panel" style="background-color: #ECF4D1;border-color: #b4b4b5;border-style: solid;border-width: 1px;"><DIV class="panelHeader" style="border-bottom-width: 1px;border-bottom-style: solid;border-bottom-color: #b4b4b5;background-color: #C3CDA1;"><B>SCA Java</B></DIV><DIV class="panelContent" style="background-color: #ECF4D1;"> +<P><A href="sca-java.html" title="SCA Java">SCA Java Home</A><BR> +<A href="tuscany-dashboard.html" title="Tuscany Dashboard">SCA Dashboard</A><BR> +<A href="java-sca-tools.html" title="Java SCA Tools">Tools </A><BR> +<A href="tuscany-sca-java-faq.html" title="Tuscany SCA Java - FAQ">FAQ</A></P> +</DIV></DIV> + +<DIV class="panel" style="background-color: #ECF4D1;border-color: #b4b4b5;border-style: solid;border-width: 1px;"><DIV class="panelHeader" style="border-bottom-width: 1px;border-bottom-style: solid;border-bottom-color: #b4b4b5;background-color: #C3CDA1;"><B>SCA Java 1.x</B></DIV><DIV class="panelContent" style="background-color: #ECF4D1;"> +<P><A href="sca-java-releases.html" title="SCA Java Releases">Downloads</A><BR> +<A href="java-sca-documentation-menu.html" title="Java SCA Documentation Menu">Documentation</A><BR> +<A href="https://svn.apache.org/repos/asf/tuscany/sca-java-1.x/trunk/" class="external-link" rel="nofollow">1.x Source Code</A><BR> +<A href="http://tinyurl.com/8rlxd3" class="external-link" rel="nofollow">Roadmap</A></P> +</DIV></DIV> + +<DIV class="panel" style="background-color: #ECF4D1;border-color: #b4b4b5;border-style: solid;border-width: 1px;"><DIV class="panelHeader" style="border-bottom-width: 1px;border-bottom-style: solid;border-bottom-color: #b4b4b5;background-color: #C3CDA1;"><B>SCA Java 2.x</B></DIV><DIV class="panelContent" style="background-color: #ECF4D1;"> +<P><A href="sca-java-2x-releases.html" title="SCA Java 2.x Releases">Downloads</A><BR> +<A href="http://tuscany.apache.org/documentation-2x/" class="external-link" rel="nofollow">Documentation</A><BR> +<A href="https://svn.apache.org/repos/asf/tuscany/sca-java-2.x/trunk/" class="external-link" rel="nofollow">2.x Source Code</A><BR> +<A href="http://tinyurl.com/8rlxd3" class="external-link" rel="nofollow">Roadmap</A></P> +</DIV></DIV> + + +<DIV class="panel" style="background-color: #ECF4D1;border-color: #b4b4b5;border-style: solid;border-width: 1px;"><DIV class="panelHeader" style="border-bottom-width: 1px;border-bottom-style: solid;border-bottom-color: #b4b4b5;background-color: #C3CDA1;"><B>Documentation</B></DIV><DIV class="panelContent" style="background-color: #ECF4D1;"> +<P><A href="sca-java-user-guide.html" title="SCA Java User Guide">User Guide</A><BR> +<A href="sca-java-architecture-guide.html" title="SCA Java Architecture Guide">Architecture Guide</A><BR> +<A href="sca-java-development-guide.html" title="SCA Java Development Guide">Developer Guide</A><BR> +<A href="sca-java-extension-development-guide.html" title="SCA Java Extension Development Guide">Extension Developer Guide</A></P> +</DIV></DIV> + +<DIV class="panel" style="background-color: #ECF4D1;border-color: #b4b4b5;border-style: solid;border-width: 1px;"><DIV class="panelHeader" style="border-bottom-width: 1px;border-bottom-style: solid;border-bottom-color: #b4b4b5;background-color: #C3CDA1;"><B>Resources</B></DIV><DIV class="panelContent" style="background-color: #ECF4D1;"> +<P><A href="tuscany-sca-java-faq.html" title="Tuscany SCA Java - FAQ">FAQ</A><BR> +<A href="https://svn.apache.org/repos/asf/incubator/tuscany/java/sca" class="external-link" rel="nofollow">Source Code</A></P> +</DIV></DIV> +</TD> +<TD class="confluenceTd" valign="top" width="85%"> + +<H3><A name="SCAJavaWebApplications-UsingTuscanyinJEEWebApplications"></A>Using Tuscany in JEE Web Applications</H3> + +<P>This page describes how to use Tuscany in JEE Web Applications.</P> + +<P>You can use a JEE Web application as a container for running Tuscany SCA applications, and this enables building applications which combine both JEE features and SCA features. When running Tuscany in a Web application there is a single SCA domain contained entirely within the web application (see note at bottom of page). </P> + +<P>When using Tuscany in Web applications there are three aspects to consider:</P> +<OL> + <LI>Configuring the Web application</LI> + <LI>Configuring the Tuscany SCA domain</LI> + <LI>Accessing the SCA services within the SCA domain</LI> +</OL> + + +<H3><A name="SCAJavaWebApplications-Configuringthewebapplication"></A>Configuring the web application</H3> + +<P>All the Tuscany jar's and dependencies must be included in the WEB-INF/lib folder. Some configuration in the web.xml file is required - a ContextListener is needed when using non-HTTP based SCA services so that the Tuscany runtime is started when the Web Application starts, a Servlet Filter is required when using HTTP based SCA services. The simplest approach is to always include both ContextListener and Filter definitions in the web.xml so that everything works for all types of SCA configuration. </P> + +<P>The following show the XML snippets show the necessary definitions for the web.xml file: </P> +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +<listener> + <listener-class>org.apache.tuscany.sca.host.webapp.TuscanyContextListener</listener-class> +</listener> +</PRE> +</DIV></DIV> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +<filter> + <filter-name>tuscany</filter-name> + <filter-class>org.apache.tuscany.sca.host.webapp.TuscanyServletFilter</filter-class> +</filter> + +<filter-mapping> + <filter-name>tuscany</filter-name> + <url-pattern>/*</url-pattern> +</filter-mapping> + +</PRE> +</DIV></DIV> + +<H3><A name="SCAJavaWebApplications-ConfiguringtheTuscanySCAdomain"></A>Configuring the Tuscany SCA domain</H3> + +<P>Tuscany treats the entire Web application as a single contribution and the deployable composites within the contribution can be configured in three ways:</P> +<OL> + <LI>by including a META-INF/sca-contributions.xml</LI> + <LI>by including deployable composite files within a folder named META-INF/sca-deployables</LI> + <LI>by using what is known as an "application composite" which is a single composite file named WEB-INF/web.composite</LI> +</OL> + + + +<H3><A name="SCAJavaWebApplications-AccessingtheSCAserviceswithintheSCAdomain"></A>Accessing the SCA services within the SCA domain</H3> + +<P>For JSPs you can use an SCA taglib or access the SCADomain directly. To use the taglib, declare it with:</P> + + <DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"><%@ taglib uri=<SPAN class="code-quote">"http:<SPAN class="code-comment">//www.osoa.org/sca/sca_jsp.tld"</SPAN> prefix=<SPAN class="code-quote">"sca"</SPAN> %></SPAN></PRE> +</DIV></DIV> + +<P>and then you can define references to services with the sca:reference tag, eg:</P> + + <DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"><sca:reference name=<SPAN class="code-quote">"CalculatorServiceComponent"</SPAN> type=<SPAN class="code-quote">"calculator.CalculatorService"</SPAN> /></PRE> +</DIV></DIV> + +<P>That treats the domain as one big "virtual" component with every service in the domain being available as a reference in the JSP</P> + +<P>The Tuscany SCADomain object is stored in the Web applications ServletContext object so application code can get hold of that and use the SCADomain just like when running Tuscany applications in a standalone JSE environment. For example, a JSP can do the follow:</P> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +<% + SCADomain scaDomain = (SCADomain) application.getAttribute(<SPAN class="code-quote">"org.apache.tuscany.sca.SCADomain"</SPAN>); + CalculatorService calculatorService = (CalculatorService)scaDomain.getService(CalculatorService.class, <SPAN class="code-quote">"CalculatorServiceComponent"</SPAN>); +%> +</PRE> +</DIV></DIV> + + +<H3><A name="SCAJavaWebApplications-SamplesshowingTuscanyinJEEWebApplications"></A>Samples showing Tuscany in JEE Web Applications</H3> + +<P>Tuscany comes with several samples using JEE Web Applications. The simplest is the <A href="https://svn.apache.org/repos/asf/tuscany/tags/java/sca/1.3.2/samples/calculator-webapp/" class="external-link" rel="nofollow">calculator-webapp </A> which shows a JSP invoking an SCA component. Another is the <A href="https://svn.apache.org/repos/asf/tuscany/tags/java/sca/1.3.2/samples/calculator-ws-webapp/" class="external-link" rel="nofollow">calculator-ws-webapp </A> which extends the calculator-webapp sample to use SCA Web Services, another is the <A href="https://svn.apache.org/repos/asf/tuscany/tags/java/sca/1.3.2/demos/alert-aggregator-webapp/" class="external-link" rel="nofollow">alert-aggregator</A> demo which shows a more complete application. </P> + +<DIV class="panelMacro"><TABLE class="infoMacro"><COLGROUP><COL width="24"><COL></COLGROUP><TR><TD valign="top"><IMG src="https://cwiki.apache.org/confluence/images/icons/emoticons/information.gif" width="16" height="16" align="absmiddle" alt="" border="0"></TD><TD><B>The OASIS SCA JEE specification</B><BR>What is described on this page is Tuscany support that has been implemented ahead of on going work in the OASIS JEE specification. <BR> +The OASIS JEE specification has now made more progress and Tuscany will be updating the Web application support in line with the specification.<BR> +See the <A href="http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=sca-j-jee" class="external-link" rel="nofollow">SCA-J JEE Subcommittee </A> page and the Tuscany dev list for more information.</TD></TR></TABLE></DIV> + +<DIV class="panelMacro"><TABLE class="infoMacro"><COLGROUP><COL width="24"><COL></COLGROUP><TR><TD valign="top"><IMG src="https://cwiki.apache.org/confluence/images/icons/emoticons/information.gif" width="16" height="16" align="absmiddle" alt="" border="0"></TD><TD><B>The Tuscany-Geronimo integration plugin</B><BR>As one of the steps to supporting the OASIS JEE specification there is ongoing work integrating Tuscany into the Apache Geronimo JEE application server. More information about that is available on the <A href="http://cwiki.apache.org/confluence/display/TUSCANYWIKI/Installing%20Tuscany%20Plugin%20for%20Geronimo" class="external-link" rel="nofollow">plugin </A> page.</TD></TR></TABLE></DIV> + +</TD></TR></TBODY></TABLE> + </DIV> + </DIV> + </DIV> + <!-- pageContent macro end --> + + </TD> + </TR> + </TABLE> + + <!-- footer macro --> + <SCRIPT src="http://www.google-analytics.com/urchin.js" type="text/javascript"> + </SCRIPT> + <SCRIPT type="text/javascript"> + _uacct = "UA-1174707-5"; + urchinTracker(); + </SCRIPT> + + <A href="http://www.statcounter.com/" target="_blank"><IMG src="http://c26.statcounter.com/counter.php?sc_project=2619156&java=0&security=94bd7e7d&invisible=0" alt="website stats" border="0"></A> + + <DIV class="footer"> + Copyright � 2003-2012, The Apache Software Foundation </BR> + Apache Tuscany and the Apache Tuscany project logo are trademarks of The Apache Software Foundation. + </DIV> + <!-- footer macro end --> + + </BODY> +</HTML> |