| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| |
| <meta charset="UTF-8"> |
| <title>@WebService OUT params via javax.xml.ws.Holder</title> |
| <meta name="description" content="Apache TomEE"> |
| <meta name="author" content="Apache TomEE"> |
| <meta name="google-translate-customization" content="f36a520c08f4c9-0a04e86a9c075ce9-g265f3196f697cf8f-10"> |
| <meta http-equiv="Pragma" content="no-cache"> |
| <meta http-equiv="Expires" content="0"> |
| <meta http-equiv="Cache-Control" content="no-store, no-cache, must-revalidate, max-age=0"> |
| |
| <!-- Le HTML5 shim, for IE6-8 support of HTML elements --> |
| <!--[if lt IE 9]> |
| <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> |
| <![endif]--> |
| |
| <!-- Le styles --> |
| <link href="./../../resources/css/bootstrap.css" rel="stylesheet"> |
| <link href="./../../resources/css/prettify.css" rel="stylesheet"> |
| <!--link href="./../../resources/css/bootstrap-mods.css" rel="stylesheet"--> |
| <link href="./../../resources/css/main.css" rel="stylesheet"> |
| <link href="./../../resources/font-awesome-4.6.3/css/font-awesome.min.css" rel="stylesheet"> |
| |
| <script type="text/javascript"> |
| var t = encodeURIComponent(document.title.replace(/^\s+|\s+$/g,"")); |
| var u = encodeURIComponent(""+document.URL); |
| |
| function fbshare () { |
| window.open( |
| "http://www.facebook.com/sharer/sharer.php?u="+u, |
| 'Share on Facebook', |
| 'width=640,height=426'); |
| }; |
| function gpshare () { |
| window.open( |
| "https://plus.google.com/share?url="+u, |
| 'Share on Google+', |
| 'width=584,height=385'); |
| }; |
| function twshare () { |
| window.open( |
| "https://twitter.com/intent/tweet?url="+u+"&text="+t, |
| 'Share on Twitter', |
| 'width=800,height=526'); |
| }; |
| function pinshare () { |
| window.open("//www.pinterest.com/pin/create/button/?url="+u+"&media=http%3A%2F%2Ftomee.apache.org%2Fresources%2Fimages%2Ffeather-logo.png&description="+t, |
| 'Share on Pinterest', |
| 'width=800,height=526'); |
| }; |
| </script> |
| |
| <!-- Le fav and touch icons --> |
| <link rel="shortcut icon" href="./../../favicon.ico"> |
| <link rel="apple-touch-icon" href="./../../resources/images/apple-touch-icon.png"> |
| <link rel="apple-touch-icon" sizes="72x72" href="./../../resources/images/apple-touch-icon-72x72.png"> |
| <link rel="apple-touch-icon" sizes="114x114" href="./../../resources/images/apple-touch-icon-114x114.png"> |
| |
| <script src="./../../resources/js/prettify.js" type="text/javascript"></script> |
| <script src="./../../resources/js/jquery-latest.js"></script> |
| <script src="http://platform.twitter.com/widgets.js" type="text/javascript"></script> |
| <script src="./../../resources/js/common.js"></script> |
| <script src="./../../resources/js/prettyprint.js"></script> |
| <!--script src="//assets.pinterest.com/js/pinit.js" type="text/javascript" async></script//--> |
| |
| <script type="text/javascript"> |
| |
| var _gaq = _gaq || []; |
| _gaq.push(['_setAccount', 'UA-2717626-1']); |
| _gaq.push(['_setDomainName', 'apache.org']); |
| _gaq.push(['_trackPageview']); |
| |
| (function() { |
| var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; |
| ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; |
| var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); |
| })(); |
| |
| </script> |
| </head> |
| |
| <body> |
| |
| <div class="topbar" data-dropdown="dropdown"> |
| <div class="fill"> |
| <div class="container"> |
| <a class="brand" href="./../../index.html">Apache TomEE</a> |
| <ul class="nav"> |
| <li class="dropdown"> |
| <a class="dropdown-toggle" data-toggle="dropdown" href="#"> |
| Apache |
| <b class="caret"></b> |
| </a> |
| <ul class="dropdown-menu"> |
| <!-- <li><a href="./../../misc/whoweare.html">Who we are?</a></li> --> |
| <!-- <li><a href="./../../misc/heritage.html">Heritage</a></li> --> |
| <li><a href="http://www.apache.org">Apache Home</a></li> |
| <!-- <li><a href="./../../misc/resources.html">Resources</a></li> --> |
| <li><a href="./../../misc/contact.html">Contact</a></li> |
| <li><a href="./../../misc/legal.html">Legal</a></li> |
| <li><a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li> |
| <li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li> |
| <li class="divider"/> |
| <li><a href="http://www.apache.org/security">Security</a></li> |
| </ul> |
| </li> |
| <li><a href="./../../index.html">Home</a></li> |
| <li><a href="./../../downloads.html">Downloads</a></li> |
| <li><a href="./../../documentation.html">Documentation</a></li> |
| <li><a href="./../../examples-trunk/index.html">Examples</a></li> |
| <li><a href="./../../support.html">Support</a></li> |
| <li><a href="./../../contribute.html">Contribute</a></li> |
| <li><a href="./../../security/index.html">Security</a></li> |
| </ul> |
| |
| <!-- Google CSE Search Box Begins --> |
| <FORM class="pull-right" id="searchbox_010475492895890475512:_t4iqjrgx90" action="http://www.google.com/cse"> |
| <INPUT type="hidden" name="cx" value="010475492895890475512:_t4iqjrgx90"> |
| <INPUT type="hidden" name="cof" value="FORID:0"> |
| <INPUT size="18" width="130" style="width:130px" name="q" type="text" placeholder="Search"> |
| </FORM> |
| <!--<SCRIPT type="text/javascript" src="http://www.google.com/coop/cse/brand?form=searchbox_010475492895890475512:_t4iqjrgx90"></SCRIPT>--> |
| <!-- Google CSE Search Box Ends --> |
| </div> |
| </div> |
| </div> |
| |
| <div class="container"> |
| |
| |
| <div class="row"> |
| <div class="span8"> |
| <small><a href="./../../index.html">Home</a> » <a href="./../../examples/">Examples</a> » <a href="./../../examples/webservice-holder/">Webservice Holder</a></small><br> |
| </div> |
| <div class="span8"> |
| </div> |
| </div> |
| |
| <div class="page-header"> |
| <h1>@WebService OUT params via javax.xml.ws.Holder |
| |
| <div style="float: right; position: relative; bottom: -10px; "> |
| <div id="google_translate_element"></div><script type="text/javascript"> |
| function googleTranslateElementInit() { |
| new google.translate.TranslateElement({pageLanguage: 'en', layout: google.translate.TranslateElement.InlineLayout.SIMPLE}, 'google_translate_element'); |
| } |
| </script><script type="text/javascript" src="//translate.google.com/translate_a/element.js?cb=googleTranslateElementInit"></script> |
| <a onclick="javascript:gpshare()" class="gp-share sprite" title="Share on Google+">share [gp]</a> |
| <a onclick="javascript:fbshare()" class="fb-share sprite" title="Share on Facebook">share [fb]</a> |
| <a onclick="javascript:twshare()" class="tw-share sprite" title="Share on Twitter">share [tw]</a> |
| <a onclick="javascript:pinshare()" class="pin-share sprite" title="Share on Pinterest">share [pin]</a> |
| <a data-toggle="modal" href="#edit" class="edit-page" title="Contribute to this Page">contribute</a> |
| </div> |
| </h1> |
| </div> |
| |
| <p>With SOAP it is possible to return multiple values in a single request. This is impossible in Java as a method can only return one object.</p> |
| |
| <p>JAX-WS solves this problem with the concept of Holders. A <code>javax.xml.ws.Holder</code> is a simple wrapper object that can be passed into the <code>@WebService</code> method as a parameter. The application sets the value of the holder during the request and the server will send the value back as an OUT parameter.</p> |
| |
| <h2>Using @WebParam and javax.xml.ws.Holder</h2> |
| |
| <p>The <code>@WebParam</code> annotation allows us to declare the <code>sum</code> and <code>multiply</code> Holders as <code>WebParam.Mode.OUT</code> parameters. As mentioned, these holders are simply empty buckets the application can fill in with data to have sent to the client. The server will pass them in uninitialized.</p> |
| |
| <pre><code>@Stateless |
| @WebService( |
| portName = "CalculatorPort", |
| serviceName = "CalculatorService", |
| targetNamespace = "http://superbiz.org/wsdl", |
| endpointInterface = "org.superbiz.ws.out.CalculatorWs") |
| public class Calculator implements CalculatorWs { |
| |
| public void sumAndMultiply(int a, int b, |
| @WebParam(name = "sum", mode = WebParam.Mode.OUT) Holder<Integer> sum, |
| @WebParam(name = "multiply", mode = WebParam.Mode.OUT) Holder<Integer> multiply) { |
| sum.value = a + b; |
| multiply.value = a * b; |
| } |
| } |
| </code></pre> |
| |
| <p>If the Holders were specified as <code>WebParam.Mode.INOUT</code> params, then the client could use them to send data and the application as well. The <code>Holder</code> instances would then be initialized with the data from the client request. The application could check the data before eventually overriting it with the response values.</p> |
| |
| <h2>The WSDL</h2> |
| |
| <p>The above JAX-WS <code>@WebService</code> component results in the folliwing WSDL that will be created automatically. Note the <code>sumAndMultiplyResponse</code> complext type returns two elements. These match the <code>@WebParam</code> declarations and our two <code>Holder<Integer></code> params.</p> |
| |
| <pre><code><?xml version="1.0" encoding="UTF-8"?> |
| <wsdl:definitions xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" |
| name="CalculatorService" |
| targetNamespace="http://superbiz.org/wsdl" |
| xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" |
| xmlns:tns="http://superbiz.org/wsdl" |
| xmlns:xsd="http://www.w3.org/2001/XMLSchema"> |
| <wsdl:types> |
| <xsd:schema attributeFormDefault="unqualified" elementFormDefault="unqualified" |
| targetNamespace="http://superbiz.org/wsdl" |
| xmlns:tns="http://superbiz.org/wsdl" |
| xmlns:xsd="http://www.w3.org/2001/XMLSchema"> |
| <xsd:element name="sumAndMultiply" type="tns:sumAndMultiply"/> |
| <xsd:complexType name="sumAndMultiply"> |
| <xsd:sequence> |
| <xsd:element name="arg0" type="xsd:int"/> |
| <xsd:element name="arg1" type="xsd:int"/> |
| </xsd:sequence> |
| </xsd:complexType> |
| <xsd:element name="sumAndMultiplyResponse" type="tns:sumAndMultiplyResponse"/> |
| <xsd:complexType name="sumAndMultiplyResponse"> |
| <xsd:sequence> |
| <xsd:element minOccurs="0" name="sum" type="xsd:int"/> |
| <xsd:element minOccurs="0" name="multiply" type="xsd:int"/> |
| </xsd:sequence> |
| </xsd:complexType> |
| </xsd:schema> |
| </wsdl:types> |
| <wsdl:message name="sumAndMultiplyResponse"> |
| <wsdl:part element="tns:sumAndMultiplyResponse" name="parameters"/> |
| </wsdl:message> |
| <wsdl:message name="sumAndMultiply"> |
| <wsdl:part element="tns:sumAndMultiply" name="parameters"/> |
| </wsdl:message> |
| <wsdl:portType name="CalculatorWs"> |
| <wsdl:operation name="sumAndMultiply"> |
| <wsdl:input message="tns:sumAndMultiply" name="sumAndMultiply"/> |
| <wsdl:output message="tns:sumAndMultiplyResponse" name="sumAndMultiplyResponse"/> |
| </wsdl:operation> |
| </wsdl:portType> |
| <wsdl:binding name="CalculatorServiceSoapBinding" type="tns:CalculatorWs"> |
| <soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/> |
| <wsdl:operation name="sumAndMultiply"> |
| <soap:operation soapAction="" style="document"/> |
| <wsdl:input name="sumAndMultiply"> |
| <soap:body use="literal"/> |
| </wsdl:input> |
| <wsdl:output name="sumAndMultiplyResponse"> |
| <soap:body use="literal"/> |
| </wsdl:output> |
| </wsdl:operation> |
| </wsdl:binding> |
| <wsdl:service name="CalculatorService"> |
| <wsdl:port binding="tns:CalculatorServiceSoapBinding" name="CalculatorPort"> |
| <soap:address location="http://127.0.0.1:4204/Calculator?wsdl"/> |
| </wsdl:port> |
| </wsdl:service> |
| </wsdl:definitions> |
| </code></pre> |
| |
| <h2>Testing the OUT params</h2> |
| |
| <p>Here we see a JAX-WS client executing the <code>sumAndMultiply</code> operation. Two empty <code>Holder</code> instances are created and passed in as parameters. The data from the <code>sumAndMultiplyResponse</code> is placed in the <code>Holder</code> instances and is then available to the client after the operation completes.</p> |
| |
| <p>The holders themselves are not actually sent in the request unless they are configured as INOUT params via WebParam.Mode.INOUT on <code>@WebParam</code></p> |
| |
| <pre><code>import org.junit.BeforeClass; |
| import org.junit.Test; |
| |
| import javax.ejb.embeddable.EJBContainer; |
| import javax.xml.namespace.QName; |
| import javax.xml.ws.Holder; |
| import javax.xml.ws.Service; |
| import java.net.URL; |
| import java.util.Properties; |
| |
| import static org.junit.Assert.assertEquals; |
| import static org.junit.Assert.assertNotNull; |
| |
| public class CalculatorTest { |
| |
| @BeforeClass |
| public static void setUp() throws Exception { |
| Properties properties = new Properties(); |
| properties.setProperty("openejb.embedded.remotable", "true"); |
| //properties.setProperty("httpejbd.print", "true"); |
| //properties.setProperty("httpejbd.indent.xml", "true"); |
| EJBContainer.createEJBContainer(properties); |
| } |
| |
| @Test |
| public void outParams() throws Exception { |
| final Service calculatorService = Service.create( |
| new URL("http://127.0.0.1:4204/Calculator?wsdl"), |
| new QName("http://superbiz.org/wsdl", "CalculatorService")); |
| |
| assertNotNull(calculatorService); |
| |
| final CalculatorWs calculator = calculatorService.getPort(CalculatorWs.class); |
| |
| final Holder<Integer> sum = new Holder<Integer>(); |
| final Holder<Integer> multiply = new Holder<Integer>(); |
| |
| calculator.sumAndMultiply(4, 6, sum, multiply); |
| |
| assertEquals(10, (int) sum.value); |
| assertEquals(24, (int) multiply.value); |
| } |
| } |
| </code></pre> |
| |
| <h2>Inspecting the messages</h2> |
| |
| <p>The above execution results in the following SOAP message.</p> |
| |
| <h3>SOAP sumAndMultiply <small>client request</small></h3> |
| |
| <pre><code><?xml version="1.0" encoding="UTF-8"?> |
| <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> |
| <soap:Body> |
| <ns1:sumAndMultiply xmlns:ns1="http://superbiz.org/wsdl"> |
| <arg0>4</arg0> |
| <arg1>6</arg1> |
| </ns1:sumAndMultiply> |
| </soap:Body> |
| </soap:Envelope> |
| </code></pre> |
| |
| <h3>SOAP sumAndMultiplyResponse <small>server response</small></h3> |
| |
| <pre><code><?xml version="1.0" encoding="UTF-8"?> |
| <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> |
| <soap:Body> |
| <ns1:sumAndMultiplyResponse xmlns:ns1="http://superbiz.org/wsdl"> |
| <sum>10</sum> |
| <multiply>24</multiply> |
| </ns1:sumAndMultiplyResponse> |
| </soap:Body> |
| </soap:Envelope> |
| </code></pre> |
| |
| |
| <div class="page-header"> </div> |
| <h4>APIs Used</h4> |
| <ul><li><a href="http://docs.oracle.com/javaee/6/api/javax/ejb/Stateless.html">javax.ejb.Stateless</a></li> |
| <li><a href="http://docs.oracle.com/javaee/6/api/javax/ejb/embeddable/EJBContainer.html">javax.ejb.embeddable.EJBContainer</a></li> |
| <li><a href="http://docs.oracle.com/javaee/6/api/javax/jws/WebParam.html">javax.jws.WebParam</a></li> |
| <li><a href="http://docs.oracle.com/javaee/6/api/javax/jws/WebService.html">javax.jws.WebService</a></li> |
| <li><a href="http://docs.oracle.com/javaee/6/api/javax/xml/namespace/QName.html">javax.xml.namespace.QName</a></li> |
| <li><a href="http://docs.oracle.com/javaee/6/api/javax/xml/ws/Holder.html">javax.xml.ws.Holder</a></li> |
| <li><a href="http://docs.oracle.com/javaee/6/api/javax/xml/ws/Service.html">javax.xml.ws.Service</a></li> |
| </ul> |
| |
| <h3>Source</h3> |
| <ul> |
| <li>Apache <a href="http://svn.apache.org/repos/asf/tomee/tomee//examples/webservice-holder">webservice-holder</a></li> |
| <li>Github <a href="https://github.com/apache/tomee/tree//examples/webservice-holder">webservice-holder</a></li> |
| </ul> |
| <pre> |
| svn co http://svn.apache.org/repos/asf/tomee/tomee//examples/webservice-holder |
| cd webservice-holder |
| mvn clean install |
| </pre> |
| |
| |
| <div id="edit" class="modal hide fade in" style="display: none; "> |
| <div class="modal-header"> |
| <a class="close" data-dismiss="modal">x</a> |
| |
| <h3>Thank you for contributing to the documentation!</h3> |
| </div> |
| <div class="modal-body"> |
| <h4>Any help with the documentation is greatly appreciated.</h4> |
| <p>All edits are reviewed before going live, so feel free to do much more than fix typos or links. If you see a page that could benefit from an entire rewrite, we'd be thrilled to review it. Don't be surprised if we like it so much we ask you for help with other pages :)</p> |
| <small>NOTICE: unless indicated otherwise on the pages in question, all editable content available from apache.org is presumed to be licensed under the Apache License (AL) version 2.0 and hence all submissions to apache.org treated as formal Contributions under the license terms.</small> |
| <!--[if gt IE 6]> |
| <h4>Internet Explorer Users</h4> |
| <p>If you are not an Apache committer, click the Yes link and enter a <i>anonymous</i> for the username and leave the password empty</p> |
| <![endif]--> |
| |
| </div> |
| <div class="modal-footer"> |
| Do you have an Apache ID? |
| <a href="javascript:void(location.href='https://cms.apache.org/redirect?uri='+escape(location.href))" class="btn">Yes</a> |
| <a href="javascript:void(location.href='https://anonymous:@cms.apache.org/redirect?uri='+escape(location.href))" class="btn">No</a> |
| </div> |
| </div> |
| <script src="./../../resources/js/bootstrap-modal.js"></script> |
| |
| <footer> |
| <p>Copyright © 1999-2016 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. |
| Apache TomEE, TomEE, Apache, the Apache feather logo, and the Apache TomEE project logo are trademarks of The Apache Software Foundation. |
| All other marks mentioned may be trademarks or registered trademarks of their respective owners.</p> |
| </footer> |
| |
| </div> <!-- /container --> |
| |
| <!-- Javascript |
| ================================================== --> |
| <!-- Placed at the end of the document so the pages load faster --> |
| <script src="./../../resources/js/bootstrap-dropdown.js"></script> |
| |
| </body> |
| </html> |
