diff options
Diffstat (limited to 'site/trunk/site-publish/documentation-2x/sca-java-implementationweb.html')
| -rw-r--r-- | site/trunk/site-publish/documentation-2x/sca-java-implementationweb.html | 364 |
1 files changed, 364 insertions, 0 deletions
diff --git a/site/trunk/site-publish/documentation-2x/sca-java-implementationweb.html b/site/trunk/site-publish/documentation-2x/sca-java-implementationweb.html new file mode 100644 index 0000000000..4c4911c090 --- /dev/null +++ b/site/trunk/site-publish/documentation-2x/sca-java-implementationweb.html @@ -0,0 +1,364 @@ + + + + + + +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<HTML> + <HEAD> + <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"> + + <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/TUSCANYxDOCx2x/$images/favicon.ico"> + <TITLE>SCA Java implementation.web : Apache Tuscany</TITLE> + <META http-equiv="Content-Type" content="text/html;charset=UTF-8"></HEAD> + + <STYLE> + .spacetree * ul { + padding-left:0px; + margin-left: 0px; + } + .spacetree * li { + margin-left: 5px; + padding-left:5px; + } + </STYLE> + + <BODY onload="init()"> + <!-- topNav --> + <TABLE border="0" cellpadding="2" cellspacing="0" width="100%"> + <TR class="topBar"> + <TD align="left" valign="middle" class="topBarDiv" align="left" nowrap=""> + <A href="https://cwiki.apache.org/geronimo"> Home</A> > <A href="index.html" title="Apache Tuscany Docs 2.x">Apache Tuscany Docs 2.x</A> > <A href="index.html" title="Index">Index</A> > <A href="sca-java-extensions-guide.html" title="SCA Java Extensions Guide">SCA Java Extensions Guide</A> > <A href="" title="SCA Java implementation.web">SCA Java implementation.web</A> + </TD> + <TD align="right" valign="middle" nowrap=""> + <FORM name="search" action="http://www.google.com/search" method="get"> + <INPUT type="hidden" name="ie" value="UTF-8"> + <INPUT type="hidden" name="oe" value="UTF-8"> + <INPUT type="hidden" name="domains" value=""> + <INPUT type="hidden" name="sitesearch" value=""> + <INPUT type="text" name="q" maxlength="255" value=""> + <INPUT type="submit" name="btnG" value="Google Search"> + </FORM> + </TD> + </TR> + </TABLE> + + + <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="index.html" title="Apache Tuscany Docs 2.x">Apache Tuscany Docs 2.x</A> > <A href="index.html" title="Index">Index</A> > <A href="sca-java-extensions-guide.html" title="SCA Java Extensions Guide">SCA Java Extensions Guide</A> > <A href="" title="SCA Java implementation.web">SCA Java implementation.web</A> + </TD> + + <TD align="right" valign="middle" class="topBarDiv" align="left" nowrap="true"> + <A href="http://tuscany.apache.org/">Tuscany Home</A> | <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> + + <TABLE border="0" cellpadding="0" width="100%" bgcolor="#FFFFFF"> + <TR> + <TD valign="top" align="left" width="22%" bgcolor="#F9F9F9" class="noprint"> + <DIV class="tabletitle">Table of Contents</DIV> + <DIV class="spacetree"> + + + </DIV> + </TD> + <TD align="left" valign="top" width="78%"> + <!-- pageContent --> + <DIV id="PageContent"> + <DIV class="pageheader" style="padding: 6px 0px 0px 0px;"> + <!-- We'll enable this once we figure out how to access (and save) the logo resource --> + <!--img src="http://geronimo.apache.org/images/confluence_logo.gif" style="float: left; margin: 4px 4px 4px 10px;" border="0"--> + <DIV style="margin: 0px 10px 0px 10px" class="smalltext">Apache Tuscany Docs 2.x</DIV> + <DIV style="margin: 0px 10px 8px 10px" class="pagetitle">SCA Java implementation.web</DIV> + + <DIV class="greynavbar" align="right" style="padding: 2px 10px; margin: 0px;"> +<!-- --> + <A href="https://cwiki.apache.org/confluence/pages/editpage.action?pageId=5964940"> + <IMG src="http://geronimo.apache.org/images/icons/notep_16.gif" height="16" width="16" border="0" align="absmiddle" title="Edit Page"></A> + <A href="https://cwiki.apache.org/confluence/pages/editpage.action?pageId=5964940">Edit Page</A> + + <A href="https://cwiki.apache.org/confluence/pages/listpages.action?key=TUSCANYxDOCx2x"> + <IMG src="http://geronimo.apache.org/images/icons/browse_space.gif" height="16" width="16" border="0" align="absmiddle" title="Browse Space"></A> + <A href="https://cwiki.apache.org/confluence/pages/listpages.action?key=TUSCANYxDOCx2x">Browse Space</A> + + <A href="https://cwiki.apache.org/confluence/pages/createpage.action?spaceKey=TUSCANYxDOCx2x&fromPageId=5964940"> + <IMG src="http://geronimo.apache.org/images/icons/add_page_16.gif" height="16" width="16" border="0" align="absmiddle" title="Add Page"></A> + <A href="https://cwiki.apache.org/confluence/pages/createpage.action?spaceKey=TUSCANYxDOCx2x&fromPageId=5964940">Add Page</A> + + <A href="https://cwiki.apache.org/confluence/pages/createblogpost.action?spaceKey=TUSCANYxDOCx2x&fromPageId=5964940"> + <IMG src="http://geronimo.apache.org/images/icons/add_blogentry_16.gif" height="16" width="16" border="0" align="absmiddle" title="Add News"></A> + <A href="https://cwiki.apache.org/confluence/pages/createblogpost.action?spaceKey=TUSCANYxDOCx2x&fromPageId=5964940">Add News</A> +<!-- --> + </DIV> + </DIV> + + <DIV class="pagecontent"> + <DIV class="wiki-content"> + +<H3><A name="SCAJavaimplementation.web-%3Cimplementation.web%3E"></A><implementation.web></H3> + +<P>The Tuscany Java SCA runtime supports components implemented as JEE web modules by using the <implementation.web> SCDL extension. Implementation.web is one of the SCA extensions being formalized in the OASIS Open Composite Services Architecture with a published <A href="http://www.oasis-open.org/committees/download.php/28798/SCA_JAVAEE_Integration_V100.pdf" class="external-link" rel="nofollow">specification </A> document.</P> + +<P>The web component implementation SCDL has the following format:</P> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> + <implementation.web web-uri=<SPAN class="code-quote">"<module name>"</SPAN> /> +</PRE> +</DIV></DIV> + +<P>Implementation.web can be used by components such as Servlets, JSPs, and Web 2.0 style html pages. How it works depends on the way the Tuscany runtime is being used.</P> + +<H4><A name="SCAJavaimplementation.web-Usingimplementation.webwithServlets%2CFilters%2CandEventlisteners"></A>Using implementation.web with Servlets, Filters, and Event listeners</H4> + +<P>JEE Servlets, Filters, and Event listeners may acquire references to the services wired to a component which use implementation.web as shown in the following code snippets.</P> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +<component name=<SPAN class="code-quote">"WebClient"</SPAN>> + <implementation.web web-uri=""/> + <reference name=<SPAN class="code-quote">"service"</SPAN> target=<SPAN class="code-quote">"HelloworldService"</SPAN>/> +</component> +</PRE> +</DIV></DIV> + +<P>Then when using a JEE container with SCA integration Servlets, Filters, and Event listeners can use annotations to acquire references to the services wired to the component as shown in the following Servlet code snippet (note the Servlet field name 'service' matches the reference name in the SCDL):</P> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +<SPAN class="code-keyword">public</SPAN> class HelloworldServlet <SPAN class="code-keyword">extends</SPAN> HttpServlet { + + @Reference + <SPAN class="code-keyword">protected</SPAN> HelloworldService service; + + . . . +} +</PRE> +</DIV></DIV> + +<P>When the container does not have SCA integration then injection via annotations does not work, so to work around this the services need to be manually got from the ComponentContext which may be obtained from the application context. This is shown in the following code snippet:</P> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +<SPAN class="code-keyword">public</SPAN> class HelloworldServlet <SPAN class="code-keyword">extends</SPAN> HttpServlet { + + <SPAN class="code-keyword">public</SPAN> void init(ServletConfig config) { + ComponentContext context = (ComponentContext)config.getServletContext().getAttribute(<SPAN class="code-quote">"org.osoa.sca.ComponentContext"</SPAN>); + HelloworldService service = context .getService(HelloworldService.class, <SPAN class="code-quote">"service"</SPAN>); + . . . + } + + . . . +} +</PRE> +</DIV></DIV> + +<P>See the <A href="https://svn.apache.org/repos/asf/tuscany/branches/sca-java-1.x/samples/helloworld-servlet/" class="external-link" rel="nofollow">helloworld-servlet</A> sample for the complete code of the above Servlet example.</P> + +<H4><A name="SCAJavaimplementation.web-Usingimplementation.webwithJSPs"></A>Using implementation.web with JSPs</H4> + +<P>A JSP tag library is available to expose SCA components in JSP pages. To use SCA references within a JSP use a taglib to include the SCA tags and define the reference field with the reference tag. </P> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +<component name=<SPAN class="code-quote">"WebClient"</SPAN>> + <implementation.web web-uri=""/> + <reference name=<SPAN class="code-quote">"service"</SPAN> target=<SPAN class="code-quote">"HelloworldService"</SPAN>/> +</component> +</PRE> +</DIV></DIV> + +<P>In the .jsp file:</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><sca:reference name=<SPAN class="code-quote">"service"</SPAN> type=<SPAN class="code-quote">"sample.HelloworldService"</SPAN> /> + +<html> + <body > + <%= service.sayHello(<SPAN class="code-quote">"world"</SPAN>) %> + </body> +</html> +</PRE> +</DIV></DIV> + +<P>See the <A href="https://svn.apache.org/repos/asf/tuscany/branches/sca-java-1.x/samples/helloworld-jsp/" class="external-link" rel="nofollow">helloworld-jsp</A> sample for the complete code of the above JSP example.</P> + +<H4><A name="SCAJavaimplementation.web-Usingimplementation.webwithWeb2.0stylebrowserclients"></A>Using implementation.web with Web 2.0 style browser clients</H4> + +<P>Web 2.0 style pages can invoke SCA services by making RPC calls from the remote browser client to the service-side SCA service. To do this the HTML page includes Javascript code to import the SCA ComponentContext and then gets service proxys from that ComponentContext. The org.osoa.sca.componentContext.js script is generated by Tuscany when a component uses implementation.web.</P> + +<P>In the SCDL the reference needs to specify one of the Tuscany Web2.0 bindings such as binding.jsonrpc or binding.dwr. <BR> +(TODO: could this be avoided - something like make binding.jsonrpc the default sca binding for web2.0 clients?) </P> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +<component name=<SPAN class="code-quote">"WebClient"</SPAN>> + <implementation.web web-uri=""/> + <reference name=<SPAN class="code-quote">"service"</SPAN> target=<SPAN class="code-quote">"HelloworldService"</SPAN>> + <tuscany:binding.jsonrpc /> + </reference> +</component> +</PRE> +</DIV></DIV> + +<P>In the html page:</P> +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +<html> + <head> + + <script type=<SPAN class="code-quote">"text/javascript"</SPAN> src=<SPAN class="code-quote">"org.osoa.sca.componentContext.js"</SPAN>></script> + + <script language=<SPAN class="code-quote">"JavaScript"</SPAN>> + + function callSayHello() { + componentContext.getService(<SPAN class="code-quote">"service"</SPAN>).sayHello( + document.getElementById('name').value, + function(reply) { + document.getElementById('result').innerHTML=reply; + }); + } + + </script> + + </head> + <body > + + . . . + + <input type=<SPAN class="code-quote">"text"</SPAN> id=<SPAN class="code-quote">"name"</SPAN> width=<SPAN class="code-quote">"10"</SPAN>> + + <button name=<SPAN class="code-quote">"submit"</SPAN> onclick=<SPAN class="code-quote">"callSayHello()"</SPAN>>Say hello</button> + + <div id='result'></div> + + . . . + + </body> +</html> +</PRE> +</DIV></DIV> + +<P>See the <A href="https://svn.apache.org/repos/asf/tuscany/branches/sca-java-1.x/samples/samples/helloworld-web/" class="external-link" rel="nofollow">helloworld-web</A> sample for the complete code of the above example.</P> + +<P><IMG class="emoticon" src="https://cwiki.apache.org/confluence/images/icons/emoticons/warning.gif" height="16" width="16" align="absmiddle" alt="" border="0"> The following on Web 2.0 callbacks is not yet fully implemented, describing here to encourage feedback </P> + +<P>Tuscany Web 2.0 clients using implementation.web support SCA asynchronous callbacks using what is known as <A href="http://en.wikipedia.org/wiki/Comet_(programming)" class="external-link" rel="nofollow">Comet or Reverse Ajax</A>. The only Tuscany binding that currently supports this in binding.dwr.</P> + +<P>The following shows the previous sample changed to use callbacks to receive the replies. A callback binding is added to the reference in the SCDL and the callback function is defined as a seperate Javascript function defined by the client and attached to the service proxy object. </P> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +<component name=<SPAN class="code-quote">"WebClient"</SPAN>> + <implementation.web web-uri=""/> + <reference name=<SPAN class="code-quote">"service"</SPAN> target=<SPAN class="code-quote">"HelloworldService"</SPAN>> + <tuscany:binding.dwr /> + <callback> + <tuscany:binding.dwr /> + </callback> + </reference> +</component> +</PRE> +</DIV></DIV> + +<P>In the html page:</P> +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +<html> + <head> + + <script type=<SPAN class="code-quote">"text/javascript"</SPAN> src=<SPAN class="code-quote">"org.osoa.sca.componentContext.js"</SPAN>></script> + + <script language=<SPAN class="code-quote">"JavaScript"</SPAN>> + + componentContext.getService(<SPAN class="code-quote">"service"</SPAN>).sayHelloCallback = + function(reply) { + document.getElementById('result').innerHTML=reply; + }; + + function callSayHello() { + componentContext.getService(<SPAN class="code-quote">"service"</SPAN>).sayHello(document.getElementById('name').value); + } + + </script> + + </head> + <body > + + . . . + + <input type=<SPAN class="code-quote">"text"</SPAN> id=<SPAN class="code-quote">"name"</SPAN> width=<SPAN class="code-quote">"10"</SPAN>> + + <button name=<SPAN class="code-quote">"submit"</SPAN> onclick=<SPAN class="code-quote">"callSayHello()"</SPAN>>Say hello</button> + + <div id='result'></div> + + . . . + + </body> +</html> +</PRE> +</DIV></DIV> + +<P>See the <A href="https://svn.apache.org/repos/asf/tuscany/java/sca/samples/helloworld-web-callback/" class="external-link" rel="nofollow">helloworld-web-callback</A> sample for the complete code of the above example.</P> + +<H4><A name="SCAJavaimplementation.web-Usingimplementation.webwiththeTuscanyruntimeembeddedwithinawebapp"></A>Using implementation.web with the Tuscany runtime embedded within a webapp</H4> + +<P>This is the style all the current Tuscany webapp samples use. When using implementation.web with the Tuscany runtime embedded within a webapp the implementation.web web-uri attribute is ignored.</P> + +<H4><A name="SCAJavaimplementation.web-Usingimplementation.webwiththeTuscanyruntimeintegratedintoaJEEserversuchasTomcatorGeronimo"></A>Using implementation.web with the Tuscany runtime integrated into a JEE server such as Tomcat or Geronimo</H4> + +<P>The only code that is currently working is some prototype code in the Tuscany runtime-tomcat module that supports injecting references into Servlets, Filters and Event listeners using the @Reference annotation.</P> + +<H4><A name="SCAJavaimplementation.web-Usingimplementation.webwiththeTuscanystandaloneruntime"></A>Using implementation.web with the Tuscany standalone runtime</H4> + +<P>Nothing implemented yet</P> + +<H4><A name="SCAJavaimplementation.web-Usingimplementation.webwiththeTuscanydistributeddomainruntime"></A>Using implementation.web with the Tuscany distributed domain runtime</H4> + +<P>Nothing implemented yet</P> + </DIV> + + </DIV> + </DIV> + </TD> + </TR> + </TABLE> + + <!-- footer --> + <TABLE border="0" cellpadding="2" cellspacing="0" width="100%"> + <TR> + <TD align="left" valign="middle" class="footer"> + + <IMG src="http://static.delicious.com/img/delicious.small.gif" height="10" width="10" alt="Delicious"> + <A href="http://delicious.com/save" onclick="window.open('http://delicious.com/save?v=5&noui&jump=close&url='+encodeURIComponent(location.href)+'&title='+encodeURIComponent(document.title),'delicious','toolbar=no,width=550,height=550'); return false;">Bookmark this on Delicious</A> + + <IMG src="http://digg.com/img/badges/16x16-digg-guy.gif" width="16" height="16" alt="Digg!"> + <A href="" onclick="window.open('http://digg.com/submit?url='+encodeURIComponent(location.href)+'&title='+encodeURIComponent(document.title)+'&topic=programming');">Digg this</A> + <!-- Slicker, but no text + <script type="text/javascript"> + digg_skin = 'icon'; + digg_window = 'new'; + digg_title = 'Apache Geronimo v2.2 Documentation : SCA Java implementation.web'; + digg_topic = 'programming'; + </script> + <script src="http://digg.com/tools/diggthis.js" type="text/javascript"></script> + --> + + </TD> + <TD align="right" valign="middle" class="footer"> + <A href="http://cwiki.apache.org/GMOxPMGT/geronimo-privacy-policy.html">Privacy Policy</A> - + Copyright © 2003-2010, The Apache Software Foundation, Licensed under <A href="http://www.apache.org/licenses/LICENSE-2.0">ASL 2.0.</A> + </TD> + </TR> + </TABLE> + + </BODY> +</HTML>
\ No newline at end of file |