You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cxf.apache.org by dk...@apache.org on 2013/06/24 19:10:57 UTC
svn commit: r867253 [14/46] - in /websites/production/cxf/content: ./
2008/04/28/ 2008/06/20/ 2009/02/10/ 2009/08/04/ cache/ docs/
docs/cxf-architecture.thumbs/ docs/cxf-dependency-graphs.thumbs/
docs/logbrowser-configuration.thumbs/ docs/logbrowser-so...
Modified: websites/production/cxf/content/docs/developing-a-consumer.html
==============================================================================
--- websites/production/cxf/content/docs/developing-a-consumer.html (original)
+++ websites/production/cxf/content/docs/developing-a-consumer.html Mon Jun 24 17:10:51 2013
@@ -25,6 +25,17 @@
<meta http-equiv="Content-type" content="text/html;charset=UTF-8">
<meta name="keywords" content="business integration, EAI, SOA, Service Oriented Architecture, web services, SOAP, JBI, JMS, WSDL, XML, EDI, Electronic Data Interchange, standards support, integration standards, application integration, middleware, software, solutions, services, CXF, open source">
<meta name="description" content="Apache CXF, Services Framework - Developing a Consumer">
+
+ <link href='http://cxf.apache.org/resources/highlighter/styles/shCore.css' rel='stylesheet' type='text/css' />
+ <link href='http://cxf.apache.org/resources/highlighter/styles/shThemeCXF.css' rel='stylesheet' type='text/css' />
+ <script src='http://cxf.apache.org/resources/highlighter/scripts/shCore.js' type='text/javascript'></script>
+ <script src='http://cxf.apache.org/resources/highlighter/scripts/shBrushJava.js' type='text/javascript'></script>
+
+ <script type="text/javascript">
+ SyntaxHighlighter.defaults['toolbar'] = false;
+ SyntaxHighlighter.all();
+ </script>
+
<title>
Apache CXF -- Developing a Consumer
</title>
@@ -42,19 +53,15 @@ Apache CXF -- Developing a Consumer
<td id="cell-1-0"> </td>
<td id="cell-1-1"> </td>
<td id="cell-1-2">
- <div style="padding: 5px;">
- <div id="banner">
- <!-- Banner -->
-<div id="banner-content">
+ <!-- Banner -->
+<div class="banner" id="banner"><p>
<table border="0" cellpadding="0" cellspacing="0" width="100%"><tr><td align="left" colspan="1" nowrap>
<a shape="rect" href="http://cxf.apache.org/" title="Apache CXF"><span style="font-weight: bold; font-size: 170%; color: white">Apache CXF</span></a>
</td><td align="right" colspan="1" nowrap>
<a shape="rect" href="http://www.apache.org/" title="The Apache Sofware Foundation"><img border="0" alt="ASF Logo" src="http://cxf.apache.org/images/asf-logo.png"></a>
</td></tr></table>
-</div>
- <!-- Banner -->
- </div>
- </div>
+</p></div>
+ <!-- Banner -->
<div id="top-menu">
<table border="0" cellpadding="1" cellspacing="0" width="100%">
<tr>
@@ -94,7 +101,7 @@ Apache CXF -- Developing a Consumer
<hr>
-<ul class="alternate" type="square"><li>Search
+<ul class="alternate" type="square"><li>Search<br clear="none">
<form enctype="application/x-www-form-urlencoded" method="get" id="cse-search-box" action="http://www.google.com/cse">
<div>
@@ -132,175 +139,174 @@ For CXF clients, the wsdl2java utility c
<p>The below shows the HelloWorld WSDL contract. This contract defines a single port type, <tt>Greeter</tt>, with a SOAP binding, <tt>Greeter_SOAPBinding</tt>, and a service, <tt>SOAPService</tt>, which has a single port, <tt>SoapPort</tt>.</p>
-<p><a shape="rect" name="DevelopingaConsumer-Example1"></a></p>
-<div class="code panel" style="border-width: 1px;"><div class="codeHeader panelHeader" style="border-bottom-width: 1px;"><b>HelloWorld WSDL Contract</b></div><div class="codeContent panelContent">
-<pre class="code-java">
-<?xml version=<span class="code-quote">"1.0"</span> encoding=<span class="code-quote">"UTF-8"</span>?>
-<wsdl:definitions name=<span class="code-quote">"HelloWorld"</span> targetNamespace=<span class="code-quote">"http:<span class="code-comment">//apache.org/hello_world_soap_http"</span>
-</span> xmlns=<span class="code-quote">"http:<span class="code-comment">//schemas.xmlsoap.org/wsdl/"</span>
-</span> xmlns:soap=<span class="code-quote">"http:<span class="code-comment">//schemas.xmlsoap.org/wsdl/soap/"</span>
-</span> xmlns:tns=<span class="code-quote">"http:<span class="code-comment">//apache.org/hello_world_soap_http"</span>
-</span> xmlns:x1=<span class="code-quote">"http:<span class="code-comment">//apache.org/hello_world_soap_http/types"</span>
-</span> xmlns:wsdl=<span class="code-quote">"http:<span class="code-comment">//schemas.xmlsoap.org/wsdl/"</span>
-</span> xmlns:xsd=<span class="code-quote">"http:<span class="code-comment">//www.w3.org/2001/XMLSchema"</span>>
-</span> <wsdl:types>
- <schema targetNamespace=<span class="code-quote">"http:<span class="code-comment">//apache.org/hello_world_soap_http/types"</span>
-</span> xmlns=<span class="code-quote">"http:<span class="code-comment">//www.w3.org/2001/XMLSchema"</span>
-</span> xmlns:tns=<span class="code-quote">"http:<span class="code-comment">//apache.org/hello_world_soap_http/types"</span>
-</span> elementFormDefault=<span class="code-quote">"qualified"</span>>
- <simpleType name=<span class="code-quote">"MyStringType"</span>>
- <restriction base=<span class="code-quote">"string"</span>>
- <maxLength value=<span class="code-quote">"30"</span> />
+<p><a shape="rect" name="DevelopingaConsumer-Example1"></a></p><div class="code panel" style="border-width: 1px;"><div class="codeHeader panelHeader" style="border-bottom-width: 1px;"><b>HelloWorld WSDL Contract</b></div><div class="codeContent panelContent">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+<?xml version="1.0" encoding="UTF-8"?>
+<wsdl:definitions name="HelloWorld" targetNamespace="http://apache.org/hello_world_soap_http"
+ xmlns="http://schemas.xmlsoap.org/wsdl/"
+ xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
+ xmlns:tns="http://apache.org/hello_world_soap_http"
+ xmlns:x1="http://apache.org/hello_world_soap_http/types"
+ xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
+ xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+ <wsdl:types>
+ <schema targetNamespace="http://apache.org/hello_world_soap_http/types"
+ xmlns="http://www.w3.org/2001/XMLSchema"
+ xmlns:tns="http://apache.org/hello_world_soap_http/types"
+ elementFormDefault="qualified">
+ <simpleType name="MyStringType">
+ <restriction base="string">
+ <maxLength value="30" />
</restriction>
</simpleType>
- <element name=<span class="code-quote">"sayHi"</span>>
+ <element name="sayHi">
<complexType/>
</element>
- <element name=<span class="code-quote">"sayHiResponse"</span>>
+ <element name="sayHiResponse">
<complexType>
<sequence>
- <element name=<span class="code-quote">"responseType"</span> type=<span class="code-quote">"string"</span>/>
+ <element name="responseType" type="string"/>
</sequence>
</complexType>
</element>
- <element name=<span class="code-quote">"greetMe"</span>>
+ <element name="greetMe">
<complexType>
<sequence>
- <element name=<span class="code-quote">"requestType"</span> type=<span class="code-quote">"tns:MyStringType"</span>/>
+ <element name="requestType" type="tns:MyStringType"/>
</sequence>
</complexType>
</element>
- <element name=<span class="code-quote">"greetMeResponse"</span>>
+ <element name="greetMeResponse">
<complexType>
<sequence>
- <element name=<span class="code-quote">"responseType"</span> type=<span class="code-quote">"string"</span>/>
+ <element name="responseType" type="string"/>
</sequence>
</complexType>
</element>
- <element name=<span class="code-quote">"greetMeOneWay"</span>>
+ <element name="greetMeOneWay">
<complexType>
<sequence>
- <element name=<span class="code-quote">"requestType"</span> type=<span class="code-quote">"string"</span>/>
+ <element name="requestType" type="string"/>
</sequence>
</complexType>
</element>
- <element name=<span class="code-quote">"pingMe"</span>>
+ <element name="pingMe">
<complexType/>
</element>
- <element name=<span class="code-quote">"pingMeResponse"</span>>
+ <element name="pingMeResponse">
<complexType/>
</element>
- <element name=<span class="code-quote">"faultDetail"</span>>
+ <element name="faultDetail">
<complexType>
<sequence>
- <element name=<span class="code-quote">"minor"</span> type=<span class="code-quote">"<span class="code-object">short</span>"</span>/>
- <element name=<span class="code-quote">"major"</span> type=<span class="code-quote">"<span class="code-object">short</span>"</span>/>
+ <element name="minor" type="short"/>
+ <element name="major" type="short"/>
</sequence>
</complexType>
</element>
</schema>
</wsdl:types>
- <wsdl:message name=<span class="code-quote">"sayHiRequest"</span>>
- <wsdl:part element=<span class="code-quote">"x1:sayHi"</span> name=<span class="code-quote">"in"</span>/>
+ <wsdl:message name="sayHiRequest">
+ <wsdl:part element="x1:sayHi" name="in"/>
</wsdl:message>
- <wsdl:message name=<span class="code-quote">"sayHiResponse"</span>>
- <wsdl:part element=<span class="code-quote">"x1:sayHiResponse"</span> name=<span class="code-quote">"out"</span>/>
+ <wsdl:message name="sayHiResponse">
+ <wsdl:part element="x1:sayHiResponse" name="out"/>
</wsdl:message>
- <wsdl:message name=<span class="code-quote">"greetMeRequest"</span>>
- <wsdl:part element=<span class="code-quote">"x1:greetMe"</span> name=<span class="code-quote">"in"</span>/>
+ <wsdl:message name="greetMeRequest">
+ <wsdl:part element="x1:greetMe" name="in"/>
</wsdl:message>
- <wsdl:message name=<span class="code-quote">"greetMeResponse"</span>>
- <wsdl:part element=<span class="code-quote">"x1:greetMeResponse"</span> name=<span class="code-quote">"out"</span>/>
+ <wsdl:message name="greetMeResponse">
+ <wsdl:part element="x1:greetMeResponse" name="out"/>
</wsdl:message>
- <wsdl:message name=<span class="code-quote">"greetMeOneWayRequest"</span>>
- <wsdl:part element=<span class="code-quote">"x1:greetMeOneWay"</span> name=<span class="code-quote">"in"</span>/>
+ <wsdl:message name="greetMeOneWayRequest">
+ <wsdl:part element="x1:greetMeOneWay" name="in"/>
</wsdl:message>
- <wsdl:message name=<span class="code-quote">"pingMeRequest"</span>>
- <wsdl:part name=<span class="code-quote">"in"</span> element=<span class="code-quote">"x1:pingMe"</span>/>
+ <wsdl:message name="pingMeRequest">
+ <wsdl:part name="in" element="x1:pingMe"/>
</wsdl:message>
- <wsdl:message name=<span class="code-quote">"pingMeResponse"</span>>
- <wsdl:part name=<span class="code-quote">"out"</span> element=<span class="code-quote">"x1:pingMeResponse"</span>/>
+ <wsdl:message name="pingMeResponse">
+ <wsdl:part name="out" element="x1:pingMeResponse"/>
</wsdl:message>
- <wsdl:message name=<span class="code-quote">"pingMeFault"</span>>
- <wsdl:part name=<span class="code-quote">"faultDetail"</span> element=<span class="code-quote">"x1:faultDetail"</span>/>
+ <wsdl:message name="pingMeFault">
+ <wsdl:part name="faultDetail" element="x1:faultDetail"/>
</wsdl:message>
- <wsdl:portType name=<span class="code-quote">"Greeter"</span>>
- <wsdl:operation name=<span class="code-quote">"sayHi"</span>>
- <wsdl:input message=<span class="code-quote">"tns:sayHiRequest"</span> name=<span class="code-quote">"sayHiRequest"</span>/>
- <wsdl:output message=<span class="code-quote">"tns:sayHiResponse"</span> name=<span class="code-quote">"sayHiResponse"</span>/>
+ <wsdl:portType name="Greeter">
+ <wsdl:operation name="sayHi">
+ <wsdl:input message="tns:sayHiRequest" name="sayHiRequest"/>
+ <wsdl:output message="tns:sayHiResponse" name="sayHiResponse"/>
</wsdl:operation>
- <wsdl:operation name=<span class="code-quote">"greetMe"</span>>
- <wsdl:input message=<span class="code-quote">"tns:greetMeRequest"</span> name=<span class="code-quote">"greetMeRequest"</span>/>
- <wsdl:output message=<span class="code-quote">"tns:greetMeResponse"</span> name=<span class="code-quote">"greetMeResponse"</span>/>
+ <wsdl:operation name="greetMe">
+ <wsdl:input message="tns:greetMeRequest" name="greetMeRequest"/>
+ <wsdl:output message="tns:greetMeResponse" name="greetMeResponse"/>
</wsdl:operation>
- <wsdl:operation name=<span class="code-quote">"greetMeOneWay"</span>>
- <wsdl:input message=<span class="code-quote">"tns:greetMeOneWayRequest"</span>
- name=<span class="code-quote">"greetMeOneWayRequest"</span>/>
+ <wsdl:operation name="greetMeOneWay">
+ <wsdl:input message="tns:greetMeOneWayRequest"
+ name="greetMeOneWayRequest"/>
</wsdl:operation>
- <wsdl:operation name=<span class="code-quote">"pingMe"</span>>
- <wsdl:input name=<span class="code-quote">"pingMeRequest"</span> message=<span class="code-quote">"tns:pingMeRequest"</span>/>
- <wsdl:output name=<span class="code-quote">"pingMeResponse"</span> message=<span class="code-quote">"tns:pingMeResponse"</span>/>
- <wsdl:fault name=<span class="code-quote">"pingMeFault"</span> message=<span class="code-quote">"tns:pingMeFault"</span>/>
+ <wsdl:operation name="pingMe">
+ <wsdl:input name="pingMeRequest" message="tns:pingMeRequest"/>
+ <wsdl:output name="pingMeResponse" message="tns:pingMeResponse"/>
+ <wsdl:fault name="pingMeFault" message="tns:pingMeFault"/>
</wsdl:operation>
</wsdl:portType>
- <wsdl:binding name=<span class="code-quote">"Greeter_SOAPBinding"</span> type=<span class="code-quote">"tns:Greeter"</span>>
- <soap:binding style=<span class="code-quote">"document"</span>
- transport=<span class="code-quote">"http:<span class="code-comment">//schemas.xmlsoap.org/soap/http"</span>/>
-</span>
- <wsdl:operation name=<span class="code-quote">"sayHi"</span>>
- <soap:operation soapAction=<span class="code-quote">"" style="</span>document"/>
- <wsdl:input name=<span class="code-quote">"sayHiRequest"</span>>
- <soap:body use=<span class="code-quote">"literal"</span>/>
+ <wsdl:binding name="Greeter_SOAPBinding" type="tns:Greeter">
+ <soap:binding style="document"
+ transport="http://schemas.xmlsoap.org/soap/http"/>
+
+ <wsdl:operation name="sayHi">
+ <soap:operation soapAction="" style="document"/>
+ <wsdl:input name="sayHiRequest">
+ <soap:body use="literal"/>
</wsdl:input>
- <wsdl:output name=<span class="code-quote">"sayHiResponse"</span>>
- <soap:body use=<span class="code-quote">"literal"</span>/>
+ <wsdl:output name="sayHiResponse">
+ <soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
- <wsdl:operation name=<span class="code-quote">"greetMe"</span>>
- <soap:operation soapAction=<span class="code-quote">"" style="</span>document"/>
- <wsdl:input name=<span class="code-quote">"greetMeRequest"</span>>
- <soap:body use=<span class="code-quote">"literal"</span>/>
+ <wsdl:operation name="greetMe">
+ <soap:operation soapAction="" style="document"/>
+ <wsdl:input name="greetMeRequest">
+ <soap:body use="literal"/>
</wsdl:input>
- <wsdl:output name=<span class="code-quote">"greetMeResponse"</span>>
- <soap:body use=<span class="code-quote">"literal"</span>/>
+ <wsdl:output name="greetMeResponse">
+ <soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
- <wsdl:operation name=<span class="code-quote">"greetMeOneWay"</span>>
- <soap:operation soapAction=<span class="code-quote">"" style="</span>document"/>
- <wsdl:input name=<span class="code-quote">"greetMeOneWayRequest"</span>>
- <soap:body use=<span class="code-quote">"literal"</span>/>
+ <wsdl:operation name="greetMeOneWay">
+ <soap:operation soapAction="" style="document"/>
+ <wsdl:input name="greetMeOneWayRequest">
+ <soap:body use="literal"/>
</wsdl:input>
</wsdl:operation>
- <wsdl:operation name=<span class="code-quote">"pingMe"</span>>
- <soap:operation style=<span class="code-quote">"document"</span>/>
+ <wsdl:operation name="pingMe">
+ <soap:operation style="document"/>
<wsdl:input>
- <soap:body use=<span class="code-quote">"literal"</span>/>
+ <soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
- <soap:body use=<span class="code-quote">"literal"</span>/>
+ <soap:body use="literal"/>
</wsdl:output>
- <wsdl:fault name=<span class="code-quote">"pingMeFault"</span>>
- <soap:fault name=<span class="code-quote">"pingMeFault"</span> use=<span class="code-quote">"literal"</span>/>
+ <wsdl:fault name="pingMeFault">
+ <soap:fault name="pingMeFault" use="literal"/>
</wsdl:fault>
</wsdl:operation>
</wsdl:binding>
- <wsdl:service name=<span class="code-quote">"SOAPService"</span>>
- <wsdl:port binding=<span class="code-quote">"tns:Greeter_SOAPBinding"</span> name=<span class="code-quote">"SoapPort"</span>>
+ <wsdl:service name="SOAPService">
+ <wsdl:port binding="tns:Greeter_SOAPBinding" name="SoapPort">
<soap:address
- location=<span class="code-quote">"http:<span class="code-comment">//localhost:9000/SoapContext/SoapPort"</span>/>
-</span> </wsdl:port>
+ location="http://localhost:9000/SoapContext/SoapPort"/>
+ </wsdl:port>
</wsdl:service>
</wsdl:definitions>
-</pre>
+]]></script>
</div></div>
<p>The <tt>Greeter</tt> port type defines the following WSDL operations:</p>
@@ -347,22 +353,21 @@ asynchronous invocation model.</li></ul>
<p>The below shows the typical outline for a generated service class, <tt>ServiceName</tt>, which extends the <tt>javax.xml.ws.Service</tt> base class.</p>
-<p><a shape="rect" name="DevelopingaConsumer-Example2"></a></p>
-<div class="code panel" style="border-width: 1px;"><div class="codeHeader panelHeader" style="border-bottom-width: 1px;"><b>Outline of a Generated Service Class</b></div><div class="codeContent panelContent">
-<pre class="code-java">
-<span class="code-keyword">public</span> class ServiceName <span class="code-keyword">extends</span> javax.xml.ws.Service
+<p><a shape="rect" name="DevelopingaConsumer-Example2"></a></p><div class="code panel" style="border-width: 1px;"><div class="codeHeader panelHeader" style="border-bottom-width: 1px;"><b>Outline of a Generated Service Class</b></div><div class="codeContent panelContent">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+public class ServiceName extends javax.xml.ws.Service
{
...
- <span class="code-keyword">public</span> ServiceName(URL wsdlLocation, QName serviceName) { }
+ public ServiceName(URL wsdlLocation, QName serviceName) { }
- <span class="code-keyword">public</span> ServiceName() { }
+ public ServiceName() { }
- <span class="code-keyword">public</span> Greeter getPortName() { }
+ public Greeter getPortName() { }
.
.
.
}
-</pre>
+]]></script>
</div></div>
<p>The <tt>ServiceName</tt> class defines the following methods:</p>
@@ -379,107 +384,105 @@ asynchronous invocation model.</li></ul>
<p>For example, the below shows the Greeter service endpoint interface, which is generated from the Greeter port type defined in <a shape="rect" href="#DevelopingaConsumer-Example1">Example1</a>. For simplicity, <a shape="rect" href="#DevelopingaConsumer-Example3">Example3</a> omits the standard JAXB and JAX-WS annotations.</p>
-<p><a shape="rect" name="DevelopingaConsumer-Example3"></a></p>
-<div class="code panel" style="border-width: 1px;"><div class="codeHeader panelHeader" style="border-bottom-width: 1px;"><b>The Greeter Service Endpoint Interface</b></div><div class="codeContent panelContent">
-<pre class="code-java">
-/* Generated by WSDLToJava <span class="code-object">Compiler</span>. */
+<p><a shape="rect" name="DevelopingaConsumer-Example3"></a></p><div class="code panel" style="border-width: 1px;"><div class="codeHeader panelHeader" style="border-bottom-width: 1px;"><b>The Greeter Service Endpoint Interface</b></div><div class="codeContent panelContent">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+/* Generated by WSDLToJava Compiler. */
-<span class="code-keyword">package</span> org.objectweb.hello_world_soap_http;
+package org.objectweb.hello_world_soap_http;
...
-<span class="code-keyword">public</span> <span class="code-keyword">interface</span> Greeter
+public interface Greeter
{
- <span class="code-keyword">public</span> java.lang.<span class="code-object">String</span> sayHi();
+ public java.lang.String sayHi();
- <span class="code-keyword">public</span> java.lang.<span class="code-object">String</span> greetMe(java.lang.<span class="code-object">String</span> requestType);
+ public java.lang.String greetMe(java.lang.String requestType);
- <span class="code-keyword">public</span> void greetMeOneWay(java.lang.<span class="code-object">String</span> requestType);
+ public void greetMeOneWay(java.lang.String requestType);
- <span class="code-keyword">public</span> void pingMe() <span class="code-keyword">throws</span> PingMeFault;
+ public void pingMe() throws PingMeFault;
}
-</pre>
+]]></script>
</div></div>
<h4><a shape="rect" name="DevelopingaConsumer-Clientmainfunction"></a>Client main function</h4>
<p>Here is Java code that implements the HelloWorld client. In summary, the client connects to the <tt>SoapPort</tt> port on the <tt>SOAPService</tt> service and then proceeds to invoke each of the operations supported by the <tt>Greeter</tt> port type.</p>
-<p><a shape="rect" name="DevelopingaConsumer-Example4"></a></p>
-<div class="code panel" style="border-width: 1px;"><div class="codeHeader panelHeader" style="border-bottom-width: 1px;"><b>Client Implementation Code</b></div><div class="codeContent panelContent">
-<pre class="code-java">
-<span class="code-keyword">package</span> demo.hw.client;
-
-<span class="code-keyword">import</span> java.io.File;
-<span class="code-keyword">import</span> java.net.URL;
-<span class="code-keyword">import</span> javax.xml.namespace.QName;
-<span class="code-keyword">import</span> org.apache.hello_world_soap_http.Greeter;
-<span class="code-keyword">import</span> org.apache.hello_world_soap_http.PingMeFault;
-<span class="code-keyword">import</span> org.apche.hello_world_soap_http.SOAPService;
-
-<span class="code-keyword">public</span> <span class="code-keyword">final</span> class Client {
-
- <span class="code-keyword">private</span> <span class="code-keyword">static</span> <span class="code-keyword">final</span> QName SERVICE_NAME =
- <span class="code-keyword">new</span> QName(<span class="code-quote">"http:<span class="code-comment">//apache.org/hello_world_soap_http"</span>,
-</span> <span class="code-quote">"SOAPService"</span>);
+<p><a shape="rect" name="DevelopingaConsumer-Example4"></a></p><div class="code panel" style="border-width: 1px;"><div class="codeHeader panelHeader" style="border-bottom-width: 1px;"><b>Client Implementation Code</b></div><div class="codeContent panelContent">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+package demo.hw.client;
+
+import java.io.File;
+import java.net.URL;
+import javax.xml.namespace.QName;
+import org.apache.hello_world_soap_http.Greeter;
+import org.apache.hello_world_soap_http.PingMeFault;
+import org.apche.hello_world_soap_http.SOAPService;
+
+public final class Client {
+
+ private static final QName SERVICE_NAME =
+ new QName("http://apache.org/hello_world_soap_http",
+ "SOAPService");
- <span class="code-keyword">private</span> Client()
+ private Client()
{
}
- <span class="code-keyword">public</span> <span class="code-keyword">static</span> void main(<span class="code-object">String</span> args[]) <span class="code-keyword">throws</span> Exception
+ public static void main(String args[]) throws Exception
{
- <span class="code-keyword">if</span> (args.length == 0)
+ if (args.length == 0)
{
- <span class="code-object">System</span>.out.println(<span class="code-quote">"please specify wsdl"</span>);
- <span class="code-object">System</span>.exit(1);
+ System.out.println("please specify wsdl");
+ System.exit(1);
}
URL wsdlURL;
- File wsdlFile = <span class="code-keyword">new</span> File(args[0]);
- <span class="code-keyword">if</span> (wsdlFile.exists())
+ File wsdlFile = new File(args[0]);
+ if (wsdlFile.exists())
{
wsdlURL = wsdlFile.toURL();
}
- <span class="code-keyword">else</span>
+ else
{
- wsdlURL = <span class="code-keyword">new</span> URL(args[0]);
+ wsdlURL = new URL(args[0]);
}
- <span class="code-object">System</span>.out.println(wsdlURL);
- SOAPService ss = <span class="code-keyword">new</span> SOAPService(wsdlURL, SERVICE_NAME);
+ System.out.println(wsdlURL);
+ SOAPService ss = new SOAPService(wsdlURL, SERVICE_NAME);
Greeter port = ss.getSoapPort();
- <span class="code-object">String</span> resp;
+ String resp;
- <span class="code-object">System</span>.out.println(<span class="code-quote">"Invoking sayHi..."</span>);
+ System.out.println("Invoking sayHi...");
resp = port.sayHi();
- <span class="code-object">System</span>.out.println(<span class="code-quote">"Server responded with: "</span> + resp);
- <span class="code-object">System</span>.out.println();
+ System.out.println("Server responded with: " + resp);
+ System.out.println();
- <span class="code-object">System</span>.out.println(<span class="code-quote">"Invoking greetMe..."</span>);
- resp = port.greetMe(<span class="code-object">System</span>.getProperty(<span class="code-quote">"user.name"</span>));
- <span class="code-object">System</span>.out.println(<span class="code-quote">"Server responded with: "</span> + resp);
- <span class="code-object">System</span>.out.println();
-
- <span class="code-object">System</span>.out.println(<span class="code-quote">"Invoking greetMeOneWay..."</span>);
- port.greetMeOneWay(<span class="code-object">System</span>.getProperty(<span class="code-quote">"user.name"</span>));
- <span class="code-object">System</span>.out.println(<span class="code-quote">"No response from server as method is OneWay"</span>);
- <span class="code-object">System</span>.out.println();
+ System.out.println("Invoking greetMe...");
+ resp = port.greetMe(System.getProperty("user.name"));
+ System.out.println("Server responded with: " + resp);
+ System.out.println();
+
+ System.out.println("Invoking greetMeOneWay...");
+ port.greetMeOneWay(System.getProperty("user.name"));
+ System.out.println("No response from server as method is OneWay");
+ System.out.println();
- <span class="code-keyword">try</span> {
- <span class="code-object">System</span>.out.println(<span class="code-quote">"Invoking pingMe, expecting exception..."</span>);
+ try {
+ System.out.println("Invoking pingMe, expecting exception...");
port.pingMe();
- } <span class="code-keyword">catch</span> (PingMeFault ex) {
- <span class="code-object">System</span>.out.println(<span class="code-quote">"Expected exception: PingMeFault has occurred."</span>);
- <span class="code-object">System</span>.out.println(ex.toString());
+ } catch (PingMeFault ex) {
+ System.out.println("Expected exception: PingMeFault has occurred.");
+ System.out.println(ex.toString());
}
- <span class="code-object">System</span>.exit(0);
+ System.exit(0);
}
}
-</pre>
-</div></div>
-<p>The <tt>Client.main()</tt> function proceeds as follows:</p>
+]]></script>
+</div></div><br clear="none">
+The <tt>Client.main()</tt> function proceeds as follows:
<ol><li>The CXF runtime is implicitly initialized - that is, provided the CXF runtime classes are loaded. Hence, there is no need to call a special function in order to initialize CXF.</li><li>The client expects a single string argument that gives the location of the WSDL contract for HelloWorld. The WSDL location is stored in <tt>wsdlURL</tt>.</li><li>A new port object (which enables you to access the remote server endpoint) is created in two steps, as shown in the following code fragment:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">SOAPService ss = <span class="code-keyword">new</span> SOAPService(wsdlURL, SERVICE_NAME);
-Greeter port = ss.getSoapPort();</pre>
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[SOAPService ss = new SOAPService(wsdlURL, SERVICE_NAME);
+Greeter port = ss.getSoapPort();]]></script>
</div></div>
<p>To create a new port object, you first create a service object (passing in the WSDL location and service name) and then call the appropriate <tt>get <em>PortName</em> ()</tt> method to obtain an instance of the particular port you need. In this case, the <tt>SOAPService</tt> service supports only the <tt>SoapPort</tt> port, which is of <tt>Greeter</tt> type.</p></li><li>The client proceeds to call each of the methods supported by the <tt>Greeter</tt> service endpoint interface.</li><li>In the case of the <tt>pingMe()</tt> operation, the example code shows how to catch the <tt>PingMeFault</tt> fault exception.</li></ol>
@@ -495,17 +498,16 @@ Greeter port = ss.getSoapPort();</pre>
<p>To set a particular request context property, <em>ContextPropertyName</em>, to the value, <em>PropertyValue</em>, use the code shown here:</p>
-<p><a shape="rect" name="DevelopingaConsumer-Example4"></a></p>
-<div class="code panel" style="border-width: 1px;"><div class="codeHeader panelHeader" style="border-bottom-width: 1px;"><b>Setting a Request Context Property on the Client Side</b></div><div class="codeContent panelContent">
-<pre class="code-java">
-<span class="code-comment">// Set request context property.
-</span>java.util.Map<<span class="code-object">String</span>, <span class="code-object">Object</span>> requestContext =
+<p><a shape="rect" name="DevelopingaConsumer-Example4"></a></p><div class="code panel" style="border-width: 1px;"><div class="codeHeader panelHeader" style="border-bottom-width: 1px;"><b>Setting a Request Context Property on the Client Side</b></div><div class="codeContent panelContent">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+// Set request context property.
+java.util.Map<String, Object> requestContext =
((javax.xml.ws.BindingProvider)port).getRequestContext();
requestContext.put(ContextPropertyName, PropertyValue);
-<span class="code-comment">// Invoke an operation.
-</span>port.SomeOperation();
-</pre>
+// Invoke an operation.
+port.SomeOperation();
+]]></script>
</div></div>
<p>You have to cast the port object to <tt>javax.xml.ws.BindingProvider</tt> in order to access the request context. The request context itself is of type, <tt>java.util.Map<String, Object></tt>, which is a hash map that has keys of <tt>String</tt> and values of arbitrary type. Use <tt>java.util.Map.put()</tt> to create a new entry in the hash map.</p>
@@ -513,19 +515,18 @@ requestContext.put(ContextPropertyName,
<h4><a shape="rect" name="DevelopingaConsumer-Readingaresponsecontext"></a>Reading a response context</h4>
<p>To retrieve a particular response context property, <em>ContextPropertyName</em>, use the code shown here:</p>
-<p><a shape="rect" name="DevelopingaConsumer-Example5"></a></p>
-<div class="code panel" style="border-width: 1px;"><div class="codeHeader panelHeader" style="border-bottom-width: 1px;"><b>Reading a Response Context Property on the Client Side</b></div><div class="codeContent panelContent">
-<pre class="code-java">
-<span class="code-comment">// Invoke an operation.
-</span>port.SomeOperation();
+<p><a shape="rect" name="DevelopingaConsumer-Example5"></a></p><div class="code panel" style="border-width: 1px;"><div class="codeHeader panelHeader" style="border-bottom-width: 1px;"><b>Reading a Response Context Property on the Client Side</b></div><div class="codeContent panelContent">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+// Invoke an operation.
+port.SomeOperation();
-<span class="code-comment">// Read response context property.
-</span>java.util.Map<<span class="code-object">String</span>, <span class="code-object">Object</span>> responseContext =
+// Read response context property.
+java.util.Map<String, Object> responseContext =
((javax.xml.ws.BindingProvider)port).getResponseContext();
PropertyType propValue = (PropertyType) responseContext.get(ContextPropertyName);
-</pre>
-</div></div>
-<p>The response context is of type, <tt>java.util.Map<String, Object></tt>, which is a hash map that has keys of type <tt>String</tt> and values of an arbitrary type. Use <tt>java.util.Map.get()</tt> to access an entry in the hash map of response context properties.</p>
+]]></script>
+</div></div><br clear="none">
+The response context is of type, <tt>java.util.Map<String, Object></tt>, which is a hash map that has keys of type <tt>String</tt> and values of an arbitrary type. Use <tt>java.util.Map.get()</tt> to access an entry in the hash map of response context properties.
<h4><a shape="rect" name="DevelopingaConsumer-Supportedcontexts"></a>Supported contexts</h4>
<p>CXF supports the following context properties:</p>
@@ -546,72 +547,71 @@ PropertyType propValue = (PropertyType)
<p>The following example shows the WSDL contract that is used for the asynchronous example. The contract defines a single port type, <tt>GreeterAsync</tt>, which contains a single operation, <tt>greetMeSometime</tt>.</p>
-<p><a shape="rect" name="DevelopingaConsumer-Example6"></a></p>
-<div class="code panel" style="border-width: 1px;"><div class="codeHeader panelHeader" style="border-bottom-width: 1px;"><b>HelloWorld WSDL Contract for Asynchronous Example</b></div><div class="codeContent panelContent">
-<pre class="code-java">
-<wsdl:definitions xmlns=<span class="code-quote">"http:<span class="code-comment">//schemas.xmlsoap.org/wsdl/"</span>
-</span> xmlns:soap=<span class="code-quote">"http:<span class="code-comment">//schemas.xmlsoap.org/wsdl/soap/"</span>
-</span> xmlns:tns=<span class="code-quote">"http:<span class="code-comment">//apache.org/hello_world_async_soap_http"</span>
-</span> xmlns:x1=<span class="code-quote">"http:<span class="code-comment">//apache.org/hello_world_async_soap_http/types"</span>
-</span> xmlns:wsdl=<span class="code-quote">"http:<span class="code-comment">//schemas.xmlsoap.org/wsdl/"</span>
-</span> xmlns:xsd=<span class="code-quote">"http:<span class="code-comment">//www.w3.org/2001/XMLSchema"</span>
-</span> targetNamespace=<span class="code-quote">"http:<span class="code-comment">//apache.org/hello_world_async_soap_http"</span>
-</span> name=<span class="code-quote">"HelloWorld"</span>>
+<p><a shape="rect" name="DevelopingaConsumer-Example6"></a></p><div class="code panel" style="border-width: 1px;"><div class="codeHeader panelHeader" style="border-bottom-width: 1px;"><b>HelloWorld WSDL Contract for Asynchronous Example</b></div><div class="codeContent panelContent">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+<wsdl:definitions xmlns="http://schemas.xmlsoap.org/wsdl/"
+ xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
+ xmlns:tns="http://apache.org/hello_world_async_soap_http"
+ xmlns:x1="http://apache.org/hello_world_async_soap_http/types"
+ xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
+ xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+ targetNamespace="http://apache.org/hello_world_async_soap_http"
+ name="HelloWorld">
<wsdl:types>
- <schema targetNamespace=<span class="code-quote">"http:<span class="code-comment">//apache.org/hello_world_async_soap_http/types"</span>
-</span> xmlns=<span class="code-quote">"http:<span class="code-comment">//www.w3.org/2001/XMLSchema"</span>
-</span> xmlns:x1=<span class="code-quote">"http:<span class="code-comment">//apache.org/hello_world_async_soap_http/types"</span>
-</span> elementFormDefault=<span class="code-quote">"qualified"</span>>
- <element name=<span class="code-quote">"greetMeSometime"</span>>
+ <schema targetNamespace="http://apache.org/hello_world_async_soap_http/types"
+ xmlns="http://www.w3.org/2001/XMLSchema"
+ xmlns:x1="http://apache.org/hello_world_async_soap_http/types"
+ elementFormDefault="qualified">
+ <element name="greetMeSometime">
<complexType>
<sequence>
- <element name=<span class="code-quote">"requestType"</span> type=<span class="code-quote">"xsd:string"</span>/>
+ <element name="requestType" type="xsd:string"/>
</sequence>
</complexType>
</element>
- <element name=<span class="code-quote">"greetMeSometimeResponse"</span>>
+ <element name="greetMeSometimeResponse">
<complexType>
<sequence>
- <element name=<span class="code-quote">"responseType"</span> type=<span class="code-quote">"xsd:string"</span>/>
+ <element name="responseType" type="xsd:string"/>
</sequence>
</complexType>
</element>
</schema>
</wsdl:types>
- <wsdl:message name=<span class="code-quote">"greetMeSometimeRequest"</span>>
- <wsdl:part name=<span class="code-quote">"in"</span> element=<span class="code-quote">"x1:greetMeSometime"</span>/>
+ <wsdl:message name="greetMeSometimeRequest">
+ <wsdl:part name="in" element="x1:greetMeSometime"/>
</wsdl:message>
- <wsdl:message name=<span class="code-quote">"greetMeSometimeResponse"</span>>
- <wsdl:part name=<span class="code-quote">"out"</span> element=<span class="code-quote">"x1:greetMeSometimeResponse"</span>/>
+ <wsdl:message name="greetMeSometimeResponse">
+ <wsdl:part name="out" element="x1:greetMeSometimeResponse"/>
</wsdl:message>
- <wsdl:portType name=<span class="code-quote">"GreeterAsync"</span>>
- <wsdl:operation name=<span class="code-quote">"greetMeSometime"</span>>
- <wsdl:input name=<span class="code-quote">"greetMeSometimeRequest"</span>
- message=<span class="code-quote">"tns:greetMeSometimeRequest"</span>/>
- <wsdl:output name=<span class="code-quote">"greetMeSometimeResponse"</span>
- message=<span class="code-quote">"tns:greetMeSometimeResponse"</span>/>
+ <wsdl:portType name="GreeterAsync">
+ <wsdl:operation name="greetMeSometime">
+ <wsdl:input name="greetMeSometimeRequest"
+ message="tns:greetMeSometimeRequest"/>
+ <wsdl:output name="greetMeSometimeResponse"
+ message="tns:greetMeSometimeResponse"/>
</wsdl:operation>
</wsdl:portType>
- <wsdl:binding name=<span class="code-quote">"GreeterAsync_SOAPBinding"</span> type=<span class="code-quote">"tns:GreeterAsync"</span>>
- <soap:binding style=<span class="code-quote">"document"</span> transport=<span class="code-quote">"http:<span class="code-comment">//schemas.xmlsoap.org/soap/http"</span>/>
-</span> <wsdl:operation name=<span class="code-quote">"greetMeSometime"</span>>
- <soap:operation style=<span class="code-quote">"document"</span>/>
+ <wsdl:binding name="GreeterAsync_SOAPBinding" type="tns:GreeterAsync">
+ <soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>
+ <wsdl:operation name="greetMeSometime">
+ <soap:operation style="document"/>
<wsdl:input>
- <soap:body use=<span class="code-quote">"literal"</span>/>
+ <soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
- <soap:body use=<span class="code-quote">"literal"</span>/>
+ <soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
</wsdl:binding>
- <wsdl:service name=<span class="code-quote">"SOAPService"</span>>
- <wsdl:port name=<span class="code-quote">"SoapPort"</span> binding=<span class="code-quote">"tns:GreeterAsync_SOAPBinding"</span>>
+ <wsdl:service name="SOAPService">
+ <wsdl:port name="SoapPort" binding="tns:GreeterAsync_SOAPBinding">
<soap:address
- location=<span class="code-quote">"http:<span class="code-comment">//localhost:9000/SoapContext/SoapPort"</span>/>
-</span> </wsdl:port>
+ location="http://localhost:9000/SoapContext/SoapPort"/>
+ </wsdl:port>
</wsdl:service>
</wsdl:definitions>
-</pre>
+]]></script>
</div></div>
<h4><a shape="rect" name="DevelopingaConsumer-Generatingtheasynchronousstubcode"></a>Generating the asynchronous stub code</h4>
@@ -625,18 +625,17 @@ PropertyType propValue = (PropertyType)
<p>This section considers only the first approach, the external binding declaration. The template for a binding declaration file that switches on asynchronous invocations is shown next:</p>
-<p><a shape="rect" name="DevelopingaConsumer-Example7"></a></p>
-<div class="code panel" style="border-width: 1px;"><div class="codeHeader panelHeader" style="border-bottom-width: 1px;"><b>Template for an Asynchronous Binding Declaration</b></div><div class="codeContent panelContent">
-<pre class="code-java">
-<bindings xmlns:xsd=<span class="code-quote">"http:<span class="code-comment">//www.w3.org/2001/XMLSchema"</span>
-</span> xmlns:wsdl=<span class="code-quote">"http:<span class="code-comment">//schemas.xmlsoap.org/wsdl/"</span>
-</span> wsdlLocation=<span class="code-quote">"@WSDL_LOCATION@/hello_world_async.wsdl"</span>
- xmlns=<span class="code-quote">"http:<span class="code-comment">//java.sun.com/xml/ns/jaxws"</span>>
-</span> <bindings node=<span class="code-quote">"wsdl:definitions"</span>>
- <enableAsyncMapping><span class="code-keyword">true</span></enableAsyncMapping>
+<p><a shape="rect" name="DevelopingaConsumer-Example7"></a></p><div class="code panel" style="border-width: 1px;"><div class="codeHeader panelHeader" style="border-bottom-width: 1px;"><b>Template for an Asynchronous Binding Declaration</b></div><div class="codeContent panelContent">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+<bindings xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+ xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
+ wsdlLocation="@WSDL_LOCATION@/hello_world_async.wsdl"
+ xmlns="http://java.sun.com/xml/ns/jaxws">
+ <bindings node="wsdl:definitions">
+ <enableAsyncMapping>true</enableAsyncMapping>
</bindings>
</bindings>
-</pre>
+]]></script>
</div></div>
<p>Where <em>AffectedWSDLContract</em> specifies the URL of the WSDL contract that is affected by this binding declaration. The <em>AffectedNode</em> is an XPath value that specifies which node (or nodes) from the WSDL contract are affected by this binding declaration. You can set <em>AffectedNode</em> to <tt>wsdl:definitions</tt>, if you want the entire WSDL contract to be affected. The {jaxws:enableAsyncMapping}} element is set to <tt>true</tt> to enable the asynchronous invocation feature.</p>
@@ -651,31 +650,30 @@ PropertyType propValue = (PropertyType)
<p>When you run the wsdl2java command, you specify the location of the binding declaration file using the -b option. After generating the stub code in this way, the <tt>GreeterAsync</tt> service endpoint interface (in the file <tt>GreeterAsync.java</tt>) is defined as shown below:</p>
-<p><a shape="rect" name="DevelopingaConsumer-Example8"></a></p>
-<div class="code panel" style="border-width: 1px;"><div class="codeHeader panelHeader" style="border-bottom-width: 1px;"><b>Service Endpoint Interface with Methods for Asynchronous Invocations</b></div><div class="codeContent panelContent">
-<pre class="code-java">
-/* Generated by WSDLToJava <span class="code-object">Compiler</span>. */
-<span class="code-keyword">package</span> org.apache.hello_world_async_soap_http;
+<p><a shape="rect" name="DevelopingaConsumer-Example8"></a></p><div class="code panel" style="border-width: 1px;"><div class="codeHeader panelHeader" style="border-bottom-width: 1px;"><b>Service Endpoint Interface with Methods for Asynchronous Invocations</b></div><div class="codeContent panelContent">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+/* Generated by WSDLToJava Compiler. */
+package org.apache.hello_world_async_soap_http;
...
-<span class="code-keyword">import</span> java.util.concurrent.Future;
-<span class="code-keyword">import</span> javax.xml.ws.AsyncHandler;
-<span class="code-keyword">import</span> javax.xml.ws.Response;
+import java.util.concurrent.Future;
+import javax.xml.ws.AsyncHandler;
+import javax.xml.ws.Response;
...
-<span class="code-keyword">public</span> <span class="code-keyword">interface</span> GreeterAsync {
+public interface GreeterAsync {
- <span class="code-keyword">public</span> Future<?> greetMeSometimeAsync(
- <span class="code-object">String</span> requestType,
+ public Future<?> greetMeSometimeAsync(
+ String requestType,
AsyncHandler<org.myorg.types.GreetMeSometimeResponse> asyncHandler
);
- <span class="code-keyword">public</span> Response<org.myorg.types.GreetMeSometimeResponse> greetMeSometimeAsync(
- <span class="code-object">String</span> requestType);
+ public Response<org.myorg.types.GreetMeSometimeResponse> greetMeSometimeAsync(
+ String requestType);
- <span class="code-keyword">public</span> java.lang.<span class="code-object">String</span> greetMeSometime(
- <span class="code-object">String</span> requestType
+ public java.lang.String greetMeSometime(
+ String requestType
);
}
-</pre>
+]]></script>
</div></div>
<p>In addition to the usual synchronous method, <tt>greetMeSometime()</tt>, two asynchronous methods are also generated for the <tt>greetMeSometime</tt> operation, as follows:</p>
@@ -689,64 +687,63 @@ PropertyType propValue = (PropertyType)
<p>The below sample illustrates the polling approach to making an asynchronous operation call. Using this approach, the client invokes the<br clear="none">
operation by calling the special Java method, <tt>_OperationName_Async()</tt>, that returns a <tt>javax.xml.ws.Response<T></tt> object, where T is the type of the operation's response message. The <tt>Response<T></tt> object can be polled at a later stage to check whether the operation's response message has arrived.</p>
-<p><a shape="rect" name="DevelopingaConsumer-Example9"></a></p>
-<div class="code panel" style="border-width: 1px;"><div class="codeHeader panelHeader" style="border-bottom-width: 1px;"><b>Polling Approach for an Asynchronous Operation Call</b></div><div class="codeContent panelContent">
-<pre class="code-java">
-<span class="code-keyword">package</span> demo.hw.client;
+<p><a shape="rect" name="DevelopingaConsumer-Example9"></a></p><div class="code panel" style="border-width: 1px;"><div class="codeHeader panelHeader" style="border-bottom-width: 1px;"><b>Polling Approach for an Asynchronous Operation Call</b></div><div class="codeContent panelContent">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+package demo.hw.client;
-<span class="code-keyword">import</span> java.io.File;
-<span class="code-keyword">import</span> java.util.concurrent.Future;
+import java.io.File;
+import java.util.concurrent.Future;
-<span class="code-keyword">import</span> javax.xml.namespace.QName;
-<span class="code-keyword">import</span> javax.xml.ws.Response;
+import javax.xml.namespace.QName;
+import javax.xml.ws.Response;
-<span class="code-keyword">import</span> org.apache.hello_world_async_soap_http.GreeterAsync;
-<span class="code-keyword">import</span> org.apache.hello_world_async_soap_http.SOAPService;
-<span class="code-keyword">import</span> org.apche.hello_world_async_soap_http.types.GreetMeSometimeResponse;
+import org.apache.hello_world_async_soap_http.GreeterAsync;
+import org.apache.hello_world_async_soap_http.SOAPService;
+import org.apche.hello_world_async_soap_http.types.GreetMeSometimeResponse;
-<span class="code-keyword">public</span> <span class="code-keyword">final</span> class Client {
- <span class="code-keyword">private</span> <span class="code-keyword">static</span> <span class="code-keyword">final</span> QName SERVICE_NAME
- = <span class="code-keyword">new</span> QName(<span class="code-quote">"http:<span class="code-comment">//objectweb.org/hello_world_async_soap_http"</span>,
-</span> <span class="code-quote">"SOAPService"</span>);
+public final class Client {
+ private static final QName SERVICE_NAME
+ = new QName("http://objectweb.org/hello_world_async_soap_http",
+ "SOAPService");
- <span class="code-keyword">private</span> Client() {}
+ private Client() {}
- <span class="code-keyword">public</span> <span class="code-keyword">static</span> void main(<span class="code-object">String</span> args[]) <span class="code-keyword">throws</span> Exception {
+ public static void main(String args[]) throws Exception {
...
- <span class="code-comment">// Polling approach:
-</span> Response<GreetMeSometimeResponse> greetMeSomeTimeResp =
- port.greetMeSometimeAsync(<span class="code-object">System</span>.getProperty(<span class="code-quote">"user.name"</span>));
- <span class="code-keyword">while</span> (!greetMeSomeTimeResp.isDone()) {
- <span class="code-object">Thread</span>.sleep(100);
+ // Polling approach:
+ Response<GreetMeSometimeResponse> greetMeSomeTimeResp =
+ port.greetMeSometimeAsync(System.getProperty("user.name"));
+ while (!greetMeSomeTimeResp.isDone()) {
+ Thread.sleep(100);
}
GreetMeSometimeResponse reply = greetMeSomeTimeResp.get();
...
- <span class="code-object">System</span>.exit(0);
+ System.exit(0);
}
}
-</pre>
+]]></script>
</div></div>
<p>The <tt>greetMeSometimeAsync()</tt> method invokes the <tt>greetMeSometimes</tt> operation, transmitting the input parameters to the remote service and returning a reference to a <tt>javax.xml.ws.Response<GreetMeSometimeResponse></tt> object. The <tt>Response</tt> class is defined by extending the standard <tt>java.util.concurrency.Future<T></tt> interface, which is specifically designed for polling the outcome of work performed by a concurrent thread. There are essentially two basic approaches to polling using the <tt>Response</tt> object:</p>
<ul><li><b>Non-blocking polling</b> - before attempting to get the result, check whether the response has arrived by calling the non-blocking<br clear="none">
<tt>Response<T>.isDone()</tt> method. For example:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">Response<GreetMeSometimeResponse> greetMeSomeTimeResp = ...;
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[Response<GreetMeSometimeResponse> greetMeSomeTimeResp = ...;
-<span class="code-keyword">if</span> (greetMeSomeTimeResp.isDone()) {
+if (greetMeSomeTimeResp.isDone()) {
GreetMeSometimeResponse reply = greetMeSomeTimeResp.get();
}
-</pre>
+]]></script>
</div></div></li><li><b>Blocking polling</b> - call <tt>Response<T>.get()</tt> right away and block until the response arrives (optionally specifying a timeout). For example, to poll for a response, with a 60 second timeout:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
Response<GreetMeSometimeResponse> greetMeSomeTimeResp = ...;
GreetMeSometimeResponse reply = greetMeSomeTimeResp.get(
60L,
java.util.concurrent.TimeUnit.SECONDS
);
-</pre>
+]]></script>
</div></div></li></ul>
@@ -755,88 +752,85 @@ GreetMeSometimeResponse reply = greetMeS
<p>An alternative approach to making an asynchronous operation invocation is to implement a callback class, by deriving from the<br clear="none">
<tt>javax.xml.ws.AsyncHandler</tt> interface. This callback class must implement a <tt>handleResponse()</tt> method, which is called by the CXF runtime to notify the client that the response has arrived. The following shows an outline of the <tt>AsyncHandler</tt> interface that you need to implement.</p>
-<p><a shape="rect" name="DevelopingaConsumer-Example10"></a></p>
-<div class="code panel" style="border-width: 1px;"><div class="codeHeader panelHeader" style="border-bottom-width: 1px;"><b>The javax.xml.ws.AsyncHandler Interface</b></div><div class="codeContent panelContent">
-<pre class="code-java">
-<span class="code-keyword">package</span> javax.xml.ws;
+<p><a shape="rect" name="DevelopingaConsumer-Example10"></a></p><div class="code panel" style="border-width: 1px;"><div class="codeHeader panelHeader" style="border-bottom-width: 1px;"><b>The javax.xml.ws.AsyncHandler Interface</b></div><div class="codeContent panelContent">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+package javax.xml.ws;
-<span class="code-keyword">public</span> <span class="code-keyword">interface</span> AsyncHandler<T>
+public interface AsyncHandler<T>
{
void handleResponse(Response<T> res);
}
-</pre>
+]]></script>
</div></div>
<p>In this example, a callback class, <tt>TestAsyncHandler</tt>, is defined as shown below.</p>
-<p><a shape="rect" name="DevelopingaConsumer-Example11"></a></p>
-<div class="code panel" style="border-width: 1px;"><div class="codeHeader panelHeader" style="border-bottom-width: 1px;"><b>The TestAsyncHandler Callback Class</b></div><div class="codeContent panelContent">
-<pre class="code-java">
-<span class="code-keyword">package</span> demo.hw.client;
+<p><a shape="rect" name="DevelopingaConsumer-Example11"></a></p><div class="code panel" style="border-width: 1px;"><div class="codeHeader panelHeader" style="border-bottom-width: 1px;"><b>The TestAsyncHandler Callback Class</b></div><div class="codeContent panelContent">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+package demo.hw.client;
-<span class="code-keyword">import</span> javax.xml.ws.AsyncHandler;
-<span class="code-keyword">import</span> javax.xml.ws.Response;
+import javax.xml.ws.AsyncHandler;
+import javax.xml.ws.Response;
-<span class="code-keyword">import</span> org.apache.hello_world_async_soap_http.types.GreetMeSometimeResponse;
+import org.apache.hello_world_async_soap_http.types.GreetMeSometimeResponse;
-<span class="code-keyword">public</span> class TestAsyncHandler <span class="code-keyword">implements</span> AsyncHandler<GreetMeSometimeResponse> {
- <span class="code-keyword">private</span> GreetMeSometimeResponse reply;
+public class TestAsyncHandler implements AsyncHandler<GreetMeSometimeResponse> {
+ private GreetMeSometimeResponse reply;
- <span class="code-keyword">public</span> void handleResponse(Response<GreetMeSometimeResponse> response) {
- <span class="code-keyword">try</span> {
+ public void handleResponse(Response<GreetMeSometimeResponse> response) {
+ try {
reply = response.get();
- } <span class="code-keyword">catch</span> (Exception ex) {
+ } catch (Exception ex) {
ex.printStackTrace();
}
}
- <span class="code-keyword">public</span> <span class="code-object">String</span> getResponse() {
- <span class="code-keyword">return</span> reply.getResponseType();
+ public String getResponse() {
+ return reply.getResponseType();
}
}
-</pre>
+]]></script>
</div></div>
<p>The implementation of <tt>handleResponse()</tt> shown in <a shape="rect" href="#DevelopingaConsumer-Example11">Example11</a> simply gets the response data and stores it in a member variable, <tt>reply</tt>. The extra <tt>getResponse()</tt> method is just a convenience method that extracts the sole output parameter (that is, <tt>responseType</tt>) from the response.</p>
<p><a shape="rect" href="#DevelopingaConsumer-Example12">Example12</a> illustrates the callback approach to making an asynchronous operation call. Using this approach, the client invokes the operation by calling the special Java method, <tt>_OperationName_Async()</tt>, that returns a <tt>java.util.concurrency.Future<?></tt> object and takes an extra parameter of <tt>AsyncHandler<T></tt>.</p>
-<p><a shape="rect" name="DevelopingaConsumer-Example12"></a></p>
-<div class="code panel" style="border-width: 1px;"><div class="codeHeader panelHeader" style="border-bottom-width: 1px;"><b>Callback Approach for an Asynchronous Operation Call</b></div><div class="codeContent panelContent">
-<pre class="code-java">
-<span class="code-keyword">package</span> demo.hw.client;
-
-<span class="code-keyword">import</span> java.io.File;
-<span class="code-keyword">import</span> java.util.concurrent.Future;
-
-<span class="code-keyword">import</span> javax.xml.namespace.QName;
-<span class="code-keyword">import</span> javax.xml.ws.Response;
-
-<span class="code-keyword">import</span> org.apache.hello_world_async_soap_http.GreeterAsync;
-<span class="code-keyword">import</span> org.apache.hello_world_async_soap_http.SOAPService;
-<span class="code-keyword">import</span> org.apache.hello_world_async_soap_http.types.GreetMeSometimeResponse;
-
-<span class="code-keyword">public</span> <span class="code-keyword">final</span> class Client {
- <span class="code-keyword">private</span> <span class="code-keyword">static</span> <span class="code-keyword">final</span> QName SERVICE_NAME
- = <span class="code-keyword">new</span> QName(<span class="code-quote">"http:<span class="code-comment">//apache.org/hello_world_async_soap_http"</span>, <span class="code-quote">"SOAPService"</span>);
-</span>
- <span class="code-keyword">private</span> Client() {}
+<p><a shape="rect" name="DevelopingaConsumer-Example12"></a></p><div class="code panel" style="border-width: 1px;"><div class="codeHeader panelHeader" style="border-bottom-width: 1px;"><b>Callback Approach for an Asynchronous Operation Call</b></div><div class="codeContent panelContent">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+package demo.hw.client;
+
+import java.io.File;
+import java.util.concurrent.Future;
+
+import javax.xml.namespace.QName;
+import javax.xml.ws.Response;
+
+import org.apache.hello_world_async_soap_http.GreeterAsync;
+import org.apache.hello_world_async_soap_http.SOAPService;
+import org.apache.hello_world_async_soap_http.types.GreetMeSometimeResponse;
+
+public final class Client {
+ private static final QName SERVICE_NAME
+ = new QName("http://apache.org/hello_world_async_soap_http", "SOAPService");
+
+ private Client() {}
- <span class="code-keyword">public</span> <span class="code-keyword">static</span> void main(<span class="code-object">String</span> args[]) <span class="code-keyword">throws</span> Exception {
+ public static void main(String args[]) throws Exception {
...
- <span class="code-comment">// Callback approach
-</span> TestAsyncHandler testAsyncHandler = <span class="code-keyword">new</span> TestAsyncHandler();
- <span class="code-object">System</span>.out.println(<span class="code-quote">"Invoking greetMeSometimeAsync using callback object..."</span>);
- Future<?> response = port.greetMeSometimeAsync(<span class="code-object">System</span>.getProperty(<span class="code-quote">"user.name"</span>), testAsyncHandler);
- <span class="code-keyword">while</span> (!response.isDone()) {
- <span class="code-object">Thread</span>.sleep(100);
+ // Callback approach
+ TestAsyncHandler testAsyncHandler = new TestAsyncHandler();
+ System.out.println("Invoking greetMeSometimeAsync using callback object...");
+ Future<?> response = port.greetMeSometimeAsync(System.getProperty("user.name"), testAsyncHandler);
+ while (!response.isDone()) {
+ Thread.sleep(100);
}
resp = testAsyncHandler.getResponse();
...
- <span class="code-object">System</span>.exit(0);
+ System.exit(0);
}
}
-</pre>
+]]></script>
</div></div>
<p>The <tt>Future<?></tt> object returned by <tt>greetMeSometimeAsync()</tt> can be used only to test whether or not a response has arrived yet - for example, by calling <tt>response.isDone()</tt>. The value of the response is only made available to the callback object, <tt>testAsyncHandler</tt>.</p></div>
Modified: websites/production/cxf/content/docs/developing-a-service.html
==============================================================================
--- websites/production/cxf/content/docs/developing-a-service.html (original)
+++ websites/production/cxf/content/docs/developing-a-service.html Mon Jun 24 17:10:51 2013
@@ -25,6 +25,17 @@
<meta http-equiv="Content-type" content="text/html;charset=UTF-8">
<meta name="keywords" content="business integration, EAI, SOA, Service Oriented Architecture, web services, SOAP, JBI, JMS, WSDL, XML, EDI, Electronic Data Interchange, standards support, integration standards, application integration, middleware, software, solutions, services, CXF, open source">
<meta name="description" content="Apache CXF, Services Framework - Developing a Service">
+
+ <link href='http://cxf.apache.org/resources/highlighter/styles/shCore.css' rel='stylesheet' type='text/css' />
+ <link href='http://cxf.apache.org/resources/highlighter/styles/shThemeCXF.css' rel='stylesheet' type='text/css' />
+ <script src='http://cxf.apache.org/resources/highlighter/scripts/shCore.js' type='text/javascript'></script>
+ <script src='http://cxf.apache.org/resources/highlighter/scripts/shBrushJava.js' type='text/javascript'></script>
+
+ <script type="text/javascript">
+ SyntaxHighlighter.defaults['toolbar'] = false;
+ SyntaxHighlighter.all();
+ </script>
+
<title>
Apache CXF -- Developing a Service
</title>
@@ -42,19 +53,15 @@ Apache CXF -- Developing a Service
<td id="cell-1-0"> </td>
<td id="cell-1-1"> </td>
<td id="cell-1-2">
- <div style="padding: 5px;">
- <div id="banner">
- <!-- Banner -->
-<div id="banner-content">
+ <!-- Banner -->
+<div class="banner" id="banner"><p>
<table border="0" cellpadding="0" cellspacing="0" width="100%"><tr><td align="left" colspan="1" nowrap>
<a shape="rect" href="http://cxf.apache.org/" title="Apache CXF"><span style="font-weight: bold; font-size: 170%; color: white">Apache CXF</span></a>
</td><td align="right" colspan="1" nowrap>
<a shape="rect" href="http://www.apache.org/" title="The Apache Sofware Foundation"><img border="0" alt="ASF Logo" src="http://cxf.apache.org/images/asf-logo.png"></a>
</td></tr></table>
-</div>
- <!-- Banner -->
- </div>
- </div>
+</p></div>
+ <!-- Banner -->
<div id="top-menu">
<table border="0" cellpadding="1" cellspacing="0" width="100%">
<tr>
@@ -94,7 +101,7 @@ Apache CXF -- Developing a Service
<hr>
-<ul class="alternate" type="square"><li>Search
+<ul class="alternate" type="square"><li>Search<br clear="none">
<form enctype="application/x-www-form-urlencoded" method="get" id="cse-search-box" action="http://www.google.com/cse">
<div>
@@ -192,31 +199,31 @@ Apache CXF -- Developing a Service
<p><a shape="rect" name="DevelopingaService-Example1"></a></p>
<div class="code panel" style="border-width: 1px;"><div class="codeHeader panelHeader" style="border-bottom-width: 1px;"><b>Implementation of the Greeter Service</b></div><div class="codeContent panelContent">
-<pre class="code-java">
-<span class="code-keyword">package</span> demo.hw.server;
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+package demo.hw.server;
-<span class="code-keyword">import</span> org.apache.hello_world_soap_http.Greeter;
+import org.apache.hello_world_soap_http.Greeter;
-@javax.jws.WebService(portName = <span class="code-quote">"SoapPort"</span>, serviceName = <span class="code-quote">"SOAPService"</span>,
- targetNamespace = <span class="code-quote">"http:<span class="code-comment">//apache.org/hello_world_soap_http"</span>,
-</span> endpointInterface = <span class="code-quote">"org.apache.hello_world_soap_http.Greeter"</span>)
+@javax.jws.WebService(portName = "SoapPort", serviceName = "SOAPService",
+ targetNamespace = "http://apache.org/hello_world_soap_http",
+ endpointInterface = "org.apache.hello_world_soap_http.Greeter")
-<span class="code-keyword">public</span> class GreeterImpl <span class="code-keyword">implements</span> Greeter {
+public class GreeterImpl implements Greeter {
- <span class="code-keyword">public</span> <span class="code-object">String</span> greetMe(<span class="code-object">String</span> me)
+ public String greetMe(String me)
{
- <span class="code-object">System</span>.out.println(<span class="code-quote">"Executing operation greetMe"</span>);
- <span class="code-object">System</span>.out.println(<span class="code-quote">"Message received: "</span> + me + <span class="code-quote">"\n"</span>);
- <span class="code-keyword">return</span> <span class="code-quote">"Hello "</span> + me;
+ System.out.println("Executing operation greetMe");
+ System.out.println("Message received: " + me + "\n");
+ return "Hello " + me;
}
- <span class="code-keyword">public</span> <span class="code-object">String</span> sayHi()
+ public String sayHi()
{
- <span class="code-object">System</span>.out.println(<span class="code-quote">"Executing operation sayHi\n"</span>);
- <span class="code-keyword">return</span> <span class="code-quote">"Bonjour"</span>;
+ System.out.println("Executing operation sayHi\n");
+ return "Bonjour";
}
}
-</pre>
+]]></script>
</div></div>
<h2><a shape="rect" name="DevelopingaService-JavaFirstDevelopment"></a>Java First Development</h2>
@@ -253,14 +260,14 @@ In this pattern, you typically have an e
<p><a shape="rect" name="DevelopingaService-Example2"></a></p>
<div class="code panel" style="border-width: 1px;"><div class="codeHeader panelHeader" style="border-bottom-width: 1px;"><b>Simple SEI</b></div><div class="codeContent panelContent">
-<pre class="code-java">
-<span class="code-keyword">package</span> org.apache.cxf;
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+package org.apache.cxf;
-<span class="code-keyword">public</span> <span class="code-keyword">interface</span> QuoteReporter
+public interface QuoteReporter
{
- <span class="code-keyword">public</span> Quote getQuote(<span class="code-object">String</span> ticker);
+ public Quote getQuote(String ticker);
}
-</pre>
+]]></script>
</div></div>
<h4><a shape="rect" name="DevelopingaService-Implementingtheinterface"></a>Implementing the interface</h4>
@@ -271,25 +278,25 @@ In this pattern, you typically have an e
<p><a shape="rect" name="DevelopingaService-Example3"></a></p>
<div class="code panel" style="border-width: 1px;"><div class="codeHeader panelHeader" style="border-bottom-width: 1px;"><b>Implementation for SEI</b></div><div class="codeContent panelContent">
-<pre class="code-java">
-<span class="code-keyword">package</span> org.apache.cxf;
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+package org.apache.cxf;
-<span class="code-keyword">import</span> java.util.*;
+import java.util.*;
-<span class="code-keyword">public</span> class StockQuoteReporter <span class="code-keyword">implements</span> QuoteReporter
+public class StockQuoteReporter implements QuoteReporter
{
...
- <span class="code-keyword">public</span> Quote getQuote(<span class="code-object">String</span> ticker)
+ public Quote getQuote(String ticker)
{
- Quote retVal = <span class="code-keyword">new</span> Quote();
+ Quote retVal = new Quote();
retVal.setID(ticker);
retVal.setVal(Board.check(ticker));[1]
- Date retDate = <span class="code-keyword">new</span> Date();
+ Date retDate = new Date();
retVal.setTime(retDate.toString());
- <span class="code-keyword">return</span>(retVal);
+ return(retVal);
}
}
-</pre>
+]]></script>
</div></div>
<h3><a shape="rect" name="DevelopingaService-AnnotatingtheCode"></a>Annotating the Code</h3>
@@ -320,19 +327,19 @@ In this pattern, you typically have an e
<p><a shape="rect" name="DevelopingaService-Example4"></a></p>
<div class="code panel" style="border-width: 1px;"><div class="codeHeader panelHeader" style="border-bottom-width: 1px;"><b>Interface with the @WebService Annotation</b></div><div class="codeContent panelContent">
-<pre class="code-java">
-<span class="code-keyword">package</span> com.mycompany.demo;
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+package com.mycompany.demo;
-<span class="code-keyword">import</span> javax.jws.*;
+import javax.jws.*;
-@WebService(name=<span class="code-quote">"quoteUpdater"</span>,
- targetNamespace=<span class="code-quote">"http:<span class="code-comment">//cxf.apache.org"</span>,
-</span> wsdlLocation=<span class="code-quote">"http:<span class="code-comment">//somewhere.com/quoteExampleService?wsdl"</span>)
-</span><span class="code-keyword">public</span> <span class="code-keyword">interface</span> QuoteReporter
+@WebService(name="quoteUpdater",
+ targetNamespace="http://cxf.apache.org",
+ wsdlLocation="http://somewhere.com/quoteExampleService?wsdl")
+public interface QuoteReporter
{
- <span class="code-keyword">public</span> Quote getQuote(@WebParam(name=<span class="code-quote">"ticker"</span>) <span class="code-object">String</span> ticker);
+ public Quote getQuote(@WebParam(name="ticker") String ticker);
}
-</pre>
+]]></script>
</div></div>
<p>The <tt>@WebService</tt> annotation <a shape="rect" href="#DevelopingaService-Example4">above</a> does the following:</p>
<ol><li>Specifies that the value of the name attribute of the <tt>wsdl:portType</tt> element defining the service interface is <tt>quoteUpdater</tt>.</li><li>Specifies that the target namespace of the service is <tt><a shape="rect" href="http://cxf.apache.org">http://cxf.apache.org</a></tt>.</li><li>Specifies that the service will use the pre-defined WSDL contract which is published at <tt><a shape="rect" class="external-link" href="http://somewhere.com/quoteExampleService?wsdl" rel="nofollow">http://somewhere.com/quoteExampleService?wsdl</a></tt>.</li></ol>
@@ -346,24 +353,24 @@ In this pattern, you typically have an e
<p><a shape="rect" name="DevelopingaService-Example5"></a></p>
<div class="code panel" style="border-width: 1px;"><div class="codeHeader panelHeader" style="border-bottom-width: 1px;"><b>Annotated Service Implementation Class</b></div><div class="codeContent panelContent">
-<pre class="code-java">
-<span class="code-keyword">package</span> org.apache.cxf;
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+package org.apache.cxf;
-<span class="code-keyword">import</span> javax.jws.*;
+import javax.jws.*;
-@WebService(endpointInterface=<span class="code-quote">"org.apache.cxf.quoteReporter"</span>,
- targetNamespace=<span class="code-quote">"http:<span class="code-comment">//cxf.apache.org"</span>,
-</span> portName=<span class="code-quote">"StockQuotePort"</span>,
- serviceName=<span class="code-quote">"StockQuoteReporter"</span>,
+@WebService(endpointInterface="org.apache.cxf.quoteReporter",
+ targetNamespace="http://cxf.apache.org",
+ portName="StockQuotePort",
+ serviceName="StockQuoteReporter",
)
-<span class="code-keyword">public</span> class StockQuoteReporter <span class="code-keyword">implements</span> QuoteReporter
+public class StockQuoteReporter implements QuoteReporter
{
- <span class="code-keyword">public</span> Quote getQuote(<span class="code-object">String</span> ticker)
+ public Quote getQuote(String ticker)
{
...
}
}
-</pre>
+]]></script>
</div></div>
<h4><a shape="rect" name="DevelopingaService-OptionalAnnotations"></a>Optional Annotations</h4>
@@ -390,20 +397,20 @@ In this pattern, you typically have an e
<p><a shape="rect" name="DevelopingaService-Example6"></a></p>
<div class="code panel" style="border-width: 1px;"><div class="codeHeader panelHeader" style="border-bottom-width: 1px;"><b>Specifying an RPC/LITERAL SOAP Binding</b></div><div class="codeContent panelContent">
-<pre class="code-java">
-<span class="code-keyword">package</span> org.eric.demo;
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+package org.eric.demo;
-<span class="code-keyword">import</span> javax.jws.*;
-<span class="code-keyword">import</span> javax.jws.soap.*;
-<span class="code-keyword">import</span> javax.jws.soap.SOAPBinding.*;
+import javax.jws.*;
+import javax.jws.soap.*;
+import javax.jws.soap.SOAPBinding.*;
-@WebService(name=<span class="code-quote">"quoteReporter"</span>)
+@WebService(name="quoteReporter")
@SOAPBinding(style=Style.RPC, use=Use.LITERAL)
-<span class="code-keyword">public</span> <span class="code-keyword">interface</span> QuoteReporter
+public interface QuoteReporter
{
...
}
-</pre>
+]]></script>
</div></div>
<h5><a shape="rect" name="DevelopingaService-DefiningOperationPropertieswithAnnotations"></a>Defining Operation Properties with Annotations</h5>
@@ -466,23 +473,23 @@ FixMe: <tt>faultName</tt> is defined as
<p><a shape="rect" name="DevelopingaService-Example7"></a></p>
<div class="code panel" style="border-width: 1px;"><div class="codeHeader panelHeader" style="border-bottom-width: 1px;"><b>SEI with Annotated Methods</b></div><div class="codeContent panelContent">
-<pre class="code-java">
-<span class="code-keyword">package</span> org.apache.cxf;
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+package org.apache.cxf;
-<span class="code-keyword">import</span> javax.jws.*;
-<span class="code-keyword">import</span> javax.xml.ws.*;
+import javax.jws.*;
+import javax.xml.ws.*;
-@WebService(name=<span class="code-quote">"quoteReporter"</span>)
-<span class="code-keyword">public</span> <span class="code-keyword">interface</span> QuoteReporter
+@WebService(name="quoteReporter")
+public interface QuoteReporter
{
- @WebMethod(operationName=<span class="code-quote">"getStockQuote"</span>)
- @RequestWrapper(targetNamespace=<span class="code-quote">"http:<span class="code-comment">//demo.mycompany.com/types"</span>,
-</span> className=<span class="code-quote">"java.lang.<span class="code-object">String</span>"</span>)
- @ResponseWrapper(targetNamespace=<span class="code-quote">"http:<span class="code-comment">//demo.mycompany.com/types"</span>,
-</span> className=<span class="code-quote">"org.eric.demo.Quote"</span>)
- <span class="code-keyword">public</span> Quote getQuote(<span class="code-object">String</span> ticker);
+ @WebMethod(operationName="getStockQuote")
+ @RequestWrapper(targetNamespace="http://demo.mycompany.com/types",
+ className="java.lang.String")
+ @ResponseWrapper(targetNamespace="http://demo.mycompany.com/types",
+ className="org.eric.demo.Quote")
+ public Quote getQuote(String ticker);
}
-</pre>
+]]></script>
</div></div>
<h5><a shape="rect" name="DevelopingaService-DefiningParameterPropertieswithAnnotations"></a>Defining Parameter Properties with Annotations</h5>
@@ -515,34 +522,34 @@ FixMe: <tt>faultName</tt> is defined as
<p><a shape="rect" name="DevelopingaService-Example8"></a></p>
<div class="code panel" style="border-width: 1px;"><div class="codeHeader panelHeader" style="border-bottom-width: 1px;"><b>Fully Annotated SEI</b></div><div class="codeContent panelContent">
-<pre class="code-java">
-<span class="code-keyword">package</span> org.apache.cxf;
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+package org.apache.cxf;
-<span class="code-keyword">import</span> javax.jws.*;
-<span class="code-keyword">import</span> javax.xml.ws.*;
-<span class="code-keyword">import</span> javax.jws.soap.*;
-<span class="code-keyword">import</span> javax.jws.soap.SOAPBinding.*;
-<span class="code-keyword">import</span> javax.jws.WebParam.*;
+import javax.jws.*;
+import javax.xml.ws.*;
+import javax.jws.soap.*;
+import javax.jws.soap.SOAPBinding.*;
+import javax.jws.WebParam.*;
-@WebService(name=<span class="code-quote">"quoteReporter"</span>)
+@WebService(name="quoteReporter")
@SOAPBinding(style=Style.RPC, use=Use.LITERAL)
-<span class="code-keyword">public</span> <span class="code-keyword">interface</span> QuoteReporter
+public interface QuoteReporter
{
- @WebMethod(operationName=<span class="code-quote">"getStockQuote"</span>)
- @RequestWrapper(targetNamespace=<span class="code-quote">"http:<span class="code-comment">//demo.mycompany.com/types"</span>,
-</span> className=<span class="code-quote">"java.lang.<span class="code-object">String</span>"</span>)
- @ResponseWrapper(targetNamespace=<span class="code-quote">"http:<span class="code-comment">//demo.mycompany.com/types"</span>,
-</span> className=<span class="code-quote">"org.eric.demo.Quote"</span>)
- @WebResult(targetNamespace=<span class="code-quote">"http:<span class="code-comment">//demo.mycompany.com/types"</span>,
-</span> name=<span class="code-quote">"updatedQuote"</span>)
- <span class="code-keyword">public</span> Quote getQuote(
- @WebParam(targetNamespace=<span class="code-quote">"http:<span class="code-comment">//demo.mycompany.com/types"</span>,
-</span> name=<span class="code-quote">"stockTicker"</span>,
+ @WebMethod(operationName="getStockQuote")
+ @RequestWrapper(targetNamespace="http://demo.mycompany.com/types",
+ className="java.lang.String")
+ @ResponseWrapper(targetNamespace="http://demo.mycompany.com/types",
+ className="org.eric.demo.Quote")
+ @WebResult(targetNamespace="http://demo.mycompany.com/types",
+ name="updatedQuote")
+ public Quote getQuote(
+ @WebParam(targetNamespace="http://demo.mycompany.com/types",
+ name="stockTicker",
mode=Mode.IN)
- <span class="code-object">String</span> ticker
+ String ticker
);
}
-</pre>
+]]></script>
</div></div>
<h3><a shape="rect" name="DevelopingaService-GeneratingWSDL"></a>Generating WSDL</h3>
@@ -555,61 +562,61 @@ FixMe: <tt>faultName</tt> is defined as
<p><a shape="rect" name="DevelopingaService-Example9"></a></p>
<div class="code panel" style="border-width: 1px;"><div class="codeHeader panelHeader" style="border-bottom-width: 1px;"><b>Generated WSDL from an SEI</b></div><div class="codeContent panelContent">
-<pre class="code-java">
-<?xml version=<span class="code-quote">"1.0"</span> encoding=<span class="code-quote">"UTF-8"</span>?>
-<wsdl:definitions targetNamespace=<span class="code-quote">"http:<span class="code-comment">//demo.eric.org/"</span>
-</span> xmlns:tns=<span class="code-quote">"http:<span class="code-comment">//demo.eric.org/"</span>
-</span> xmlns:ns1=""
- xmlns:xsd=<span class="code-quote">"http:<span class="code-comment">//www.w3.org/2001/XMLSchema"</span>
-</span> xmlns:ns2=<span class="code-quote">"http:<span class="code-comment">//demo.eric.org/types"</span>
-</span> xmlns:soap=<span class="code-quote">"http:<span class="code-comment">//schemas.xmlsoap.org/wsdl/soap/"</span>
-</span> xmlns:wsdl=<span class="code-quote">"http:<span class="code-comment">//schemas.xmlsoap.org/wsdl/"</span>>
-</span> <wsdl:types>
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+<?xml version="1.0" encoding="UTF-8"?>
+<wsdl:definitions targetNamespace="http://demo.eric.org/"
+ xmlns:tns="http://demo.eric.org/"
+ xmlns:ns1=""
+ xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+ xmlns:ns2="http://demo.eric.org/types"
+ xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
+ xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">
+ <wsdl:types>
<xsd:schema>
- <xs:complexType name=<span class="code-quote">"quote"</span>>
+ <xs:complexType name="quote">
<xs:sequence>
- <xs:element name=<span class="code-quote">"ID"</span> type=<span class="code-quote">"xs:string"</span> minOccurs=<span class="code-quote">"0"</span>/>
- <xs:element name=<span class="code-quote">"time"</span> type=<span class="code-quote">"xs:string"</span> minOccurs=<span class="code-quote">"0"</span>/>
- <xs:element name=<span class="code-quote">"val"</span> type=<span class="code-quote">"xs:<span class="code-object">float</span>"</span>/>
+ <xs:element name="ID" type="xs:string" minOccurs="0"/>
+ <xs:element name="time" type="xs:string" minOccurs="0"/>
+ <xs:element name="val" type="xs:float"/>
</xs:sequence>
</xs:complexType>
</xsd:schema>
</wsdl:types>
- <wsdl:message name=<span class="code-quote">"getStockQuote"</span>>
- <wsdl:part name=<span class="code-quote">"stockTicker"</span> type=<span class="code-quote">"xsd:string"</span>>
+ <wsdl:message name="getStockQuote">
+ <wsdl:part name="stockTicker" type="xsd:string">
</wsdl:part>
</wsdl:message>
- <wsdl:message name=<span class="code-quote">"getStockQuoteResponse"</span>>
- <wsdl:part name=<span class="code-quote">"updatedQuote"</span> type=<span class="code-quote">"tns:quote"</span>>
+ <wsdl:message name="getStockQuoteResponse">
+ <wsdl:part name="updatedQuote" type="tns:quote">
</wsdl:part>
</wsdl:message>
- <wsdl:portType name=<span class="code-quote">"quoteReporter"</span>>
- <wsdl:operation name=<span class="code-quote">"getStockQuote"</span>>
- <wsdl:input name=<span class="code-quote">"getQuote"</span> message=<span class="code-quote">"tns:getStockQuote"</span>>
+ <wsdl:portType name="quoteReporter">
+ <wsdl:operation name="getStockQuote">
+ <wsdl:input name="getQuote" message="tns:getStockQuote">
</wsdl:input>
- <wsdl:output name=<span class="code-quote">"getQuoteResponse"</span> message=<span class="code-quote">"tns:getStockQuoteResponse"</span>>
+ <wsdl:output name="getQuoteResponse" message="tns:getStockQuoteResponse">
</wsdl:output>
</wsdl:operation>
</wsdl:portType>
- <wsdl:binding name=<span class="code-quote">"quoteReporterBinding"</span> type=<span class="code-quote">"tns:quoteReporter"</span>>
- <soap:binding style=<span class="code-quote">"rpc"</span> transport=<span class="code-quote">"http:<span class="code-comment">//schemas.xmlsoap.org/soap/http"</span>/>
-</span> <wsdl:operation name=<span class="code-quote">"getStockQuote"</span>>
- <soap:operation style=<span class="code-quote">"rpc"</span>/>
- <wsdl:input name=<span class="code-quote">"getQuote"</span>>
- <soap:body use=<span class="code-quote">"literal"</span>/>
+ <wsdl:binding name="quoteReporterBinding" type="tns:quoteReporter">
+ <soap:binding style="rpc" transport="http://schemas.xmlsoap.org/soap/http"/>
+ <wsdl:operation name="getStockQuote">
+ <soap:operation style="rpc"/>
+ <wsdl:input name="getQuote">
+ <soap:body use="literal"/>
</wsdl:input>
- <wsdl:output name=<span class="code-quote">"getQuoteResponse"</span>>
- <soap:body use=<span class="code-quote">"literal"</span>/>
+ <wsdl:output name="getQuoteResponse">
+ <soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
</wsdl:binding>
- <wsdl:service name=<span class="code-quote">"quoteReporterService"</span>>
- <wsdl:port name=<span class="code-quote">"quoteReporterPort"</span> binding=<span class="code-quote">"tns:quoteReporterBinding"</span>>
- <soap:address location=<span class="code-quote">"http:<span class="code-comment">//localhost:9000/quoteReporterService"</span>/>
-</span> </wsdl:port>
+ <wsdl:service name="quoteReporterService">
+ <wsdl:port name="quoteReporterPort" binding="tns:quoteReporterBinding">
+ <soap:address location="http://localhost:9000/quoteReporterService"/>
+ </wsdl:port>
</wsdl:service>
</wsdl:definitions>
-</pre>
+]]></script>
</div></div></div>
</div>
<!-- Content -->