diff options
Diffstat (limited to 'site/trunk/site-publish/sca-java-interfacewsdl.html')
| -rw-r--r-- | site/trunk/site-publish/sca-java-interfacewsdl.html | 328 |
1 files changed, 328 insertions, 0 deletions
diff --git a/site/trunk/site-publish/sca-java-interfacewsdl.html b/site/trunk/site-publish/sca-java-interfacewsdl.html new file mode 100644 index 0000000000..58f4c60e26 --- /dev/null +++ b/site/trunk/site-publish/sca-java-interfacewsdl.html @@ -0,0 +1,328 @@ + +<!-- + + 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 interface.wsdl</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=108128"> + <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="sca-java-user-reference.html" title="SCA Java User Reference">SCA Java User Reference</A> > <A href="" title="SCA Java interface.wsdl">SCA Java interface.wsdl</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="SCAJavainterface.wsdl-%3Cinterface.wsdl%3E"></A><interface.wsdl></H3> + +<P>The Tuscany Java SCA runtime supports interfaces that are described by Web Services Description Lanuage (WSDL) files. The files contain a description of the service interface, services, references, method requests and responses, and the data types. The implementation of this WSDL interface can be generated with the Java SDK tool <B>wsimport</B>. The <B>wsimport</B> tool generates a skeleton of the service interface, along with all associated request and response classes, and any complex data types passed on the interface. The user can augment the skeleton by putting implementation code in the approproate spot.</P> + +<P>The following snippet shows how the WSDL interface and the Java implementation are used in an SCA composite file and publicised as a component.</P> +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> + <component name=<SPAN class="code-quote">"OrderServiceComponent"</SPAN>> + <implementation.java class=<SPAN class="code-quote">"org.example.orderservice.OrderServiceImpl"</SPAN> /> + <service name=<SPAN class="code-quote">"OrderService"</SPAN>> + <<SPAN class="code-keyword">interface</SPAN>.wsdl <SPAN class="code-keyword">interface</SPAN>=<SPAN class="code-quote">"http:<SPAN class="code-comment">//www.example.org/OrderService/#wsdl.<SPAN class="code-keyword">interface</SPAN>(OrderService)"</SPAN> /> +</SPAN> <binding.ws uri=<SPAN class="code-quote">"http:<SPAN class="code-comment">//localhost:8085/OrderService"</SPAN>/> +</SPAN> </service> + </component> +</PRE> +</DIV></DIV> + +<H3><A name="SCAJavainterface.wsdl-Examples"></A>Examples</H3> + +<P>This example shows a component with its interface described via WSDL. The web service binding defaults are used so the endpoint of the Web service will be <A href="http://localhost:8085/OrderService" class="external-link" rel="nofollow">http://localhost:8085/OrderService</A>. (Note that this full sample is available in Tuscany 1.x branch under the samples/holder-ws-service sample).</P> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +<composite xmlns=<SPAN class="code-quote">"http:<SPAN class="code-comment">//www.osoa.org/xmlns/sca/1.0"</SPAN> +</SPAN> targetNamespace=<SPAN class="code-quote">"http:<SPAN class="code-comment">//orderservice"</SPAN> +</SPAN> xmlns:hw=<SPAN class="code-quote">"http:<SPAN class="code-comment">//orderservice"</SPAN> +</SPAN> name=<SPAN class="code-quote">"orderws"</SPAN>> + + <component name=<SPAN class="code-quote">"OrderServiceComponent"</SPAN>> + <implementation.java class=<SPAN class="code-quote">"org.example.orderservice.OrderServiceImpl"</SPAN> /> + <service name=<SPAN class="code-quote">"OrderService"</SPAN>> + <<SPAN class="code-keyword">interface</SPAN>.wsdl <SPAN class="code-keyword">interface</SPAN>=<SPAN class="code-quote">"http:<SPAN class="code-comment">//www.example.org/OrderService/#wsdl.<SPAN class="code-keyword">interface</SPAN>(OrderService)"</SPAN> /> +</SPAN> <binding.ws uri=<SPAN class="code-quote">"http:<SPAN class="code-comment">//localhost:8085/OrderService"</SPAN>/> +</SPAN> </service> + </component> + +</composite> +</PRE> +</DIV></DIV> + +<P>WSDL files can be generated with many tools and development environment plugins. This snippet shows a portion of the WSDL file that describes the business service data types and the assoicated method calls and responses:</P> +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> + <wsdl:portType name=<SPAN class="code-quote">"OrderService"</SPAN>> + <wsdl:operation name=<SPAN class="code-quote">"reviewOrder"</SPAN>> + <wsdl:input message=<SPAN class="code-quote">"tns:reviewOrderRequest"</SPAN>/> + <wsdl:output message=<SPAN class="code-quote">"tns:reviewOrderResponse"</SPAN>/> + </wsdl:operation> + </wsdl:portType> + <wsdl:message name=<SPAN class="code-quote">"reviewOrderRequest"</SPAN>> + <wsdl:part element=<SPAN class="code-quote">"tns:reviewOrder"</SPAN> name=<SPAN class="code-quote">"myParameters"</SPAN>/> + </wsdl:message> + <wsdl:message name=<SPAN class="code-quote">"reviewOrderResponse"</SPAN>> + <wsdl:part element=<SPAN class="code-quote">"tns:reviewOrderResponse"</SPAN> name=<SPAN class="code-quote">"myResult"</SPAN>/> + </wsdl:message> + <wsdl:types> + <xsd:schema targetNamespace=<SPAN class="code-quote">"http:<SPAN class="code-comment">//www.example.org/OrderService/"</SPAN>> +</SPAN> <xsd:complexType name=<SPAN class="code-quote">"order"</SPAN>> + <xsd:sequence> + <xsd:element name=<SPAN class="code-quote">"customerId"</SPAN> type=<SPAN class="code-quote">"xsd:string"</SPAN> minOccurs=<SPAN class="code-quote">"0"</SPAN> /> + <xsd:element name=<SPAN class="code-quote">"status"</SPAN> type=<SPAN class="code-quote">"tns:status"</SPAN> minOccurs=<SPAN class="code-quote">"0"</SPAN> /> + <xsd:element name=<SPAN class="code-quote">"total"</SPAN> type=<SPAN class="code-quote">"xsd:<SPAN class="code-object">double</SPAN>"</SPAN> /> + <xsd:element name=<SPAN class="code-quote">"orderId"</SPAN> type=<SPAN class="code-quote">"xsd:<SPAN class="code-object">int</SPAN>"</SPAN> /> + </xsd:sequence> + </xsd:complexType> + + <xsd:simpleType name=<SPAN class="code-quote">"status"</SPAN>> + <xsd:restriction base=<SPAN class="code-quote">"xsd:string"</SPAN>> + <xsd:enumeration value=<SPAN class="code-quote">"Created"</SPAN> /> + <xsd:enumeration value=<SPAN class="code-quote">"Submitted"</SPAN> /> + <xsd:enumeration value=<SPAN class="code-quote">"Approved"</SPAN> /> + <xsd:enumeration value=<SPAN class="code-quote">"Rejected"</SPAN> /> + </xsd:restriction> + </xsd:simpleType> + + <xsd:element name=<SPAN class="code-quote">"reviewOrder"</SPAN>> + <xsd:complexType> + <xsd:sequence> + <xsd:element name=<SPAN class="code-quote">"myData"</SPAN> type=<SPAN class="code-quote">"tns:order"</SPAN> + minOccurs=<SPAN class="code-quote">"1"</SPAN> maxOccurs=<SPAN class="code-quote">"1"</SPAN> /> + </xsd:sequence> + </xsd:complexType> + </xsd:element> + <xsd:element name=<SPAN class="code-quote">"reviewOrderResponse"</SPAN>> + <xsd:complexType> + <xsd:sequence> + <xsd:element name=<SPAN class="code-quote">"myData"</SPAN> type=<SPAN class="code-quote">"tns:order"</SPAN> + minOccurs=<SPAN class="code-quote">"1"</SPAN> maxOccurs=<SPAN class="code-quote">"1"</SPAN> /> + </xsd:sequence> + </xsd:complexType> + </xsd:element> + + </xsd:schema> + </wsdl:types> +</PRE> +</DIV></DIV> + +<P>The Java implementation for this web service can be generated with the Java SDK tool <B>wsimport</B>. Full documentation is in the Java SDK JavaDocs, but basically one specifies the source WSDL and the output directory for generated files.</P> +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> + wsimport -d orderservice -keep orderservice.wsdl +</PRE> +</DIV></DIV> + +<P>The generated implementation files can be augmented with code that operates on provided business objects.</P> + +<H3><A name="SCAJavainterface.wsdl-WebServicesHolderPattern"></A>Web Services Holder Pattern</H3> + +<P>A pattern known as the Web Services Holder Pattern is supported by Tuscany in the 1.5 and later releases. WSDL files support a parameter mode known as INOUT. The INOUT mode is used for service interface parameters that are passed into a business interface and returned<BR> +on the same interface.</P> + +<P>The advantages of the INOUT mode are:</P> +<UL> + <LI>supports a well known pattern of parameter pass by reference. Normally SCA parameters are always passed by value.</LI> + <LI>saves instantiation and initialization for large or complex objects.</LI> + <LI>simplifies the signature of business interfaces</LI> + <LI>saves the user the cost of boxing and returning multiple return objects.</LI> +</UL> + + +<P>The Holder pattern is created by the Java SDK wsimport tool whenever data type is both input and output to a given operation></P> +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> + <xsd:element name=<SPAN class="code-quote">"myOperation"</SPAN>> + <xsd:complexType> + <xsd:sequence> + <xsd:element name=<SPAN class="code-quote">"myData"</SPAN> type=<SPAN class="code-quote">"tns:myDataType"</SPAN> minOccurs=<SPAN class="code-quote">"1"</SPAN> maxOccurs=<SPAN class="code-quote">"1"</SPAN>/> + </xsd:sequence> + </xsd:complexType> + </xsd:element> + <xsd:element name=<SPAN class="code-quote">"myOperationResponse"</SPAN>> + <xsd:complexType> + <xsd:sequence> + <xsd:element name=<SPAN class="code-quote">"myData"</SPAN> type=<SPAN class="code-quote">"tns:myDataType"</SPAN> minOccurs=<SPAN class="code-quote">"1"</SPAN> maxOccurs=<SPAN class="code-quote">"1"</SPAN>/> + </xsd:sequence> + </xsd:complexType> + </xsd:element> +</PRE> +</DIV></DIV> + +<P>The generated implemenation code contains annotations that mark the parameter data as an input output parameter. Also notice that the business object Order is passed in as a data type javax.xml.ws.Holder<Order>. This Holder class allows the input object to be returned as an output object, i.e. pass by reference.</P> +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> + @WebMethod(action = <SPAN class="code-quote">"http:<SPAN class="code-comment">//www.example.org/OrderService/reviewOrder"</SPAN>) +</SPAN> @RequestWrapper(localName = <SPAN class="code-quote">"reviewOrder"</SPAN>, targetNamespace = <SPAN class="code-quote">"http:<SPAN class="code-comment">//www.example.org/OrderService/"</SPAN>, className = <SPAN class="code-quote">"org.example.orderservice.ReviewOrder"</SPAN>) +</SPAN> @ResponseWrapper(localName = <SPAN class="code-quote">"reviewOrderResponse"</SPAN>, targetNamespace = <SPAN class="code-quote">"http:<SPAN class="code-comment">//www.example.org/OrderService/"</SPAN>, className = <SPAN class="code-quote">"org.example.orderservice.ReviewOrderResponse"</SPAN>) +</SPAN> <SPAN class="code-keyword">public</SPAN> void reviewOrder( + @WebParam(name = <SPAN class="code-quote">"myData"</SPAN>, targetNamespace = "", mode = WebParam.Mode.INOUT) + javax.xml.ws.Holder<Order> myData); +</PRE> +</DIV></DIV> + +<P>The Java implemenation code can access the wrapped Holder object, perform updates on the object, and leave it in place to return the object as shown here with the Java object Order :</P> +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> + @WebMethod(action = <SPAN class="code-quote">"http:<SPAN class="code-comment">//www.example.org/OrderService/reviewOrder"</SPAN>) +</SPAN> @RequestWrapper(localName = <SPAN class="code-quote">"reviewOrder"</SPAN>, targetNamespace = <SPAN class="code-quote">"http:<SPAN class="code-comment">//www.example.org/OrderService/"</SPAN>, className = <SPAN class="code-quote">"org.example.orderservice.ReviewOrder"</SPAN>) +</SPAN> @ResponseWrapper(localName = <SPAN class="code-quote">"reviewOrderResponse"</SPAN>, targetNamespace = <SPAN class="code-quote">"http:<SPAN class="code-comment">//www.example.org/OrderService/"</SPAN>, className = <SPAN class="code-quote">"org.example.orderservice.ReviewOrderResponse"</SPAN>) +</SPAN> <SPAN class="code-keyword">public</SPAN> void reviewOrder( + @WebParam(name = <SPAN class="code-quote">"myData"</SPAN>, targetNamespace = "", mode = WebParam.Mode.INOUT) + Holder<Order> myData) { + Order order = myData.value; + <SPAN class="code-object">double</SPAN> total = order.getTotal(); + <SPAN class="code-keyword">if</SPAN> ( total < 100.0 ) { + order.setStatus( Status.APPROVED ); + } + } +</PRE> +</DIV></DIV> + +<P>Tuscany, as of version 1.5 supports this input/output Holder pattern. At this point there is a limitation of only one in/out parameter, and this is only supported on methods with void return types.</P> +</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> |