| <!DOCTYPE html> |
| <!-- |
| | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2017-11-22 |
| | Rendered using Apache Maven Fluido Skin 1.6 |
| --> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <meta name="Date-Revision-yyyymmdd" content="20171122" /> |
| <meta http-equiv="Content-Language" content="en" /> |
| <title>Apache Axis2 – JiBX unwrapped document/literal</title> |
| <link rel="stylesheet" href="../../css/apache-maven-fluido-1.6.min.css" /> |
| <link rel="stylesheet" href="../../css/site.css" /> |
| <link rel="stylesheet" href="../../css/print.css" media="print" /> |
| <script type="text/javascript" src="../../js/apache-maven-fluido-1.6.min.js"></script> |
| <meta name="generator" content="HTML Tidy for Windows (vers 14 June 2007), see www.w3.org" /><meta http-equiv="content-type" content="" /> </head> |
| <body class="topBarDisabled"> |
| <div class="container-fluid"> |
| <div id="banner"> |
| <div class="pull-left"><a href="http://www.apache.org/" id="bannerLeft"><img src="http://www.apache.org/images/asf_logo_wide.png" alt="Apache Axis2"/></a></div> |
| <div class="pull-right"><a href="../.././" id="bannerRight"><img src="../../images/axis.jpg" /></a></div> |
| <div class="clear"><hr/></div> |
| </div> |
| |
| <div id="breadcrumbs"> |
| <ul class="breadcrumb"> |
| <li id="publishDate">Last Published: 2017-11-22<span class="divider">|</span> |
| </li> |
| <li id="projectVersion">Version: 1.7.7<span class="divider">|</span></li> |
| <li class=""><a href="http://www.apache.org" class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> |
| <li class=""><a href="../../index.html" title="Axis2/Java">Axis2/Java</a><span class="divider">/</span></li> |
| <li class="active ">JiBX unwrapped document/literal</li> |
| </ul> |
| </div> |
| <div class="row-fluid"> |
| <div id="leftColumn" class="span2"> |
| <div class="well sidebar-nav"> |
| <ul class="nav nav-list"> |
| <li class="nav-header">Axis2/Java</li> |
| <li><a href="../../index.html" title="Home"><span class="none"></span>Home</a> </li> |
| <li><a href="../../download.html" title="Downloads"><span class="none"></span>Downloads</a> </li> |
| <li><a href="javascript:void(0)" title="Release Notes"><span class="icon-chevron-down"></span>Release Notes</a> |
| <ul class="nav nav-list"> |
| <li><a href="../../release-notes/1.6.1.html" title="1.6.1"><span class="none"></span>1.6.1</a> </li> |
| <li><a href="../../release-notes/1.6.2.html" title="1.6.2"><span class="none"></span>1.6.2</a> </li> |
| <li><a href="../../release-notes/1.6.3.html" title="1.6.3"><span class="none"></span>1.6.3</a> </li> |
| <li><a href="../../release-notes/1.6.4.html" title="1.6.4"><span class="none"></span>1.6.4</a> </li> |
| <li><a href="../../release-notes/1.7.0.html" title="1.7.0"><span class="none"></span>1.7.0</a> </li> |
| <li><a href="../../release-notes/1.7.1.html" title="1.7.1"><span class="none"></span>1.7.1</a> </li> |
| <li><a href="../../release-notes/1.7.2.html" title="1.7.2"><span class="none"></span>1.7.2</a> </li> |
| <li><a href="../../release-notes/1.7.3.html" title="1.7.3"><span class="none"></span>1.7.3</a> </li> |
| <li><a href="../../release-notes/1.7.4.html" title="1.7.4"><span class="none"></span>1.7.4</a> </li> |
| <li><a href="../../release-notes/1.7.5.html" title="1.7.5"><span class="none"></span>1.7.5</a> </li> |
| <li><a href="../../release-notes/1.7.6.html" title="1.7.6"><span class="none"></span>1.7.6</a> </li> |
| <li><a href="../../release-notes/1.7.7.html" title="1.7.7"><span class="none"></span>1.7.7</a> </li> |
| </ul> |
| </li> |
| <li><a href="../../modules/index.html" title="Modules"><span class="none"></span>Modules</a> </li> |
| <li><a href="../../tools/index.html" title="Tools"><span class="none"></span>Tools</a> </li> |
| <li class="nav-header">Documentation</li> |
| <li><a href="../../docs/toc.html" title="Table of Contents"><span class="none"></span>Table of Contents</a> </li> |
| <li><a href="../../docs/installationguide.html" title="Installation Guide"><span class="none"></span>Installation Guide</a> </li> |
| <li><a href="../../docs/quickstartguide.html" title="QuickStart Guide"><span class="none"></span>QuickStart Guide</a> </li> |
| <li><a href="../../docs/userguide.html" title="User Guide"><span class="none"></span>User Guide</a> </li> |
| <li><a href="../../docs/jaxws-guide.html" title="JAXWS Guide"><span class="none"></span>JAXWS Guide</a> </li> |
| <li><a href="../../docs/pojoguide.html" title="POJO Guide"><span class="none"></span>POJO Guide</a> </li> |
| <li><a href="../../docs/spring.html" title="Spring Guide"><span class="none"></span>Spring Guide</a> </li> |
| <li><a href="../../docs/webadminguide.html" title="Web Administrator's Guide"><span class="none"></span>Web Administrator's Guide</a> </li> |
| <li><a href="../../docs/migration.html" title="Migration Guide (from Axis1)"><span class="none"></span>Migration Guide (from Axis1)</a> </li> |
| <li class="nav-header">Resources</li> |
| <li><a href="../../faq.html" title="FAQ"><span class="none"></span>FAQ</a> </li> |
| <li><a href="../../articles.html" title="Articles"><span class="none"></span>Articles</a> </li> |
| <li><a href="http://wiki.apache.org/ws/FrontPage/Axis2/" class="externalLink" title="Wiki"><span class="none"></span>Wiki</a> </li> |
| <li><a href="../../refLib.html" title="Reference Library"><span class="none"></span>Reference Library</a> </li> |
| <li><a href="../../apidocs/index.html" title="Online Java Docs"><span class="none"></span>Online Java Docs</a> </li> |
| <li class="nav-header">Get Involved</li> |
| <li><a href="../../overview.html" title="Overview"><span class="none"></span>Overview</a> </li> |
| <li><a href="../../svn.html" title="Checkout the Source"><span class="none"></span>Checkout the Source</a> </li> |
| <li><a href="../../mail-lists.html" title="Mailing Lists"><span class="none"></span>Mailing Lists</a> </li> |
| <li><a href="../../release-process.html" title="Release Process"><span class="none"></span>Release Process</a> </li> |
| <li><a href="../../guidelines.html" title="Developer Guidelines"><span class="none"></span>Developer Guidelines</a> </li> |
| <li><a href="../../siteHowTo.html" title="Build the Site"><span class="none"></span>Build the Site</a> </li> |
| <li class="nav-header">Project Information</li> |
| <li><a href="../../team-list.html" title="Project Team"><span class="none"></span>Project Team</a> </li> |
| <li><a href="../../issue-tracking.html" title="Issue Tracking"><span class="none"></span>Issue Tracking</a> </li> |
| <li><a href="http://svn.apache.org/viewvc/axis/axis2/java/core/trunk/" class="externalLink" title="Source Code"><span class="none"></span>Source Code</a> </li> |
| <li><a href="../../thanks.html" title="Acknowledgements"><span class="none"></span>Acknowledgements</a> </li> |
| <li class="nav-header">Apache</li> |
| <li><a href="http://www.apache.org/licenses/LICENSE-2.0.html" class="externalLink" title="License"><span class="none"></span>License</a> </li> |
| <li><a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsorship"><span class="none"></span>Sponsorship</a> </li> |
| <li><a href="http://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks"><span class="none"></span>Thanks</a> </li> |
| <li><a href="http://www.apache.org/security/" class="externalLink" title="Security"><span class="none"></span>Security</a> </li> |
| </ul> |
| <hr /> |
| <div id="poweredBy"> |
| <div class="clear"></div> |
| <div class="clear"></div> |
| <div class="clear"></div> |
| <div class="clear"></div> |
| <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="../../images/logos/maven-feather.png" /></a> |
| </div> |
| </div> |
| </div> |
| <div id="bodyColumn" class="span10" > |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| |
| |
| <h1>JiBX Unwrapped document/literal</h1> |
| |
| <p>Code generation for JiBX data binding converts operations |
| defined by a Web service to method calls. In the most general case |
| of document/literal (doc/lit) Web services the generated methods |
| each take a single parameter object and return a single result |
| object. This type of interface can be painful for developers |
| because it adds both a layer of indirection and potentially a large |
| number of extra classes (one input and one output class for each |
| generated method).</p> |
| |
| <p>Fortunately, there's an alternative way of generating methods |
| that gives a much more usable API for many Web services. This |
| alternative is called <i>unwrapping</i>, and the service |
| definitions that it applies to are called <i>wrapped</i> |
| definitions. The key difference that qualifies a service definition |
| as wrapped is the structure of the input and output elements used |
| for operations.</p> |
| |
| <p>Here's a sample wrapped WSDL (partial) by way of an example:</p> |
| |
| <div> |
| <pre> |
| <wsdl:definitions targetNamespace="http://ws.sosnoski.com/library/wsdl" |
| xmlns:tns="http://ws.sosnoski.com/library/types" |
| xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" |
| xmlns:wsdlsoap="http://schemas.xmlsoap.org/wsdl/soap/"> |
| |
| <wsdl:types> |
| |
| <schema elementFormDefault="qualified" |
| targetNamespace="http://ws.sosnoski.com/library/types" |
| xmlns="http://www.w3.org/2001/XMLSchema"> |
| |
| <element name="getBook"> |
| <complexType> |
| <sequence> |
| <element name="isbn" type="string"/> |
| </sequence> |
| </complexType> |
| </element> |
| |
| <element name="getBookResponse"> |
| <complexType> |
| <sequence> |
| <element name="book" minOccurs="0" type="tns:BookInformation"/> |
| </sequence> |
| </complexType> |
| </element> |
| |
| <element name="addBook"> |
| <complexType> |
| <sequence> |
| <element name="type" type="string"/> |
| <element name="isbn" type="string"/> |
| <element name="author" minOccurs="0" maxOccurs="unbounded" type="string"/> |
| <element name="title" type="string"/> |
| </sequence> |
| </complexType> |
| </element> |
| |
| <element name="addBookResponse"> |
| <complexType> |
| <sequence> |
| <element name="success" type="boolean"/> |
| </sequence> |
| </complexType> |
| </element> |
| |
| <complexType name="BookInformation"> |
| <sequence> |
| <element name="author" minOccurs="0" maxOccurs="unbounded" type="string"/> |
| <element name="title" type="string"/> |
| </sequence> |
| <attribute name="type" use="required" type="string"/> |
| <attribute name="isbn" use="required" type="string"/> |
| </complexType> |
| |
| </schema> |
| |
| </wsdl:types> |
| |
| <wsdl:message name="getBookRequest"> |
| <wsdl:part element="wns:getBook" name="parameters"/> |
| </wsdl:message> |
| |
| <wsdl:message name="getBookResponse"> |
| <wsdl:part element="wns:getBookResponse" name="parameters"/> |
| </wsdl:message> |
| |
| <wsdl:message name="addBookRequest"> |
| <wsdl:part element="wns:addBook" name="parameters"/> |
| </wsdl:message> |
| |
| <wsdl:message name="addBookResponse"> |
| <wsdl:part element="wns:addBookResponse" name="parameters"/> |
| </wsdl:message> |
| |
| <wsdl:portType name="Library"> |
| |
| <wsdl:operation name="getBook"> |
| <wsdl:input message="wns:getBookRequest" name="getBookRequest"/> |
| <wsdl:output message="wns:getBookResponse" name="getBookResponse"/> |
| </wsdl:operation> |
| |
| <wsdl:operation name="addBook"> |
| <wsdl:input message="wns:addBookRequest" name="addBookRequest"/> |
| <wsdl:output message="wns:addBookResponse" name="addBookResponse"/> |
| </wsdl:operation> |
| |
| </wsdl:portType> |
| ... |
| </wsdl:definitions> |
| </pre></div> |
| |
| <p>This WSDL defines a service with just two operations: |
| <b>getBook</b> and <b>addBook</b>. The <b>getBook</b> operation |
| takes a <i>getBook</i> element as input, and returns a |
| <i>getBookResponse</i> element as output, while <b>addBook</b> |
| takes an <i>addBook</i> element as input and returns an |
| <i>addBookResponse</i> as output. Each of these input and output |
| elements in turn consists of a sequence of child elements, with |
| some of the child elements defined directly using standard schema |
| types and others referencing user-defined schema types.</p> |
| |
| <p>As I said up front, this WSDL qualifies for unwrapped handling |
| using JiBX. Here's the body of the client interface generated when |
| using unwrapping (the <i>-uw</i> option for WSDL2Java):</p> |
| |
| <div> |
| <pre> |
| public interface LibraryJibxUnwrapped { |
| |
| |
| /** |
| * Auto generated method signatures |
| * @param type* @param isbn* @param author* @param title |
| */ |
| public boolean addBook( |
| java.lang.String type,java.lang.String isbn,java.lang.String[] author,java.lang.String title) throws java.rmi.RemoteException |
| |
| |
| ; |
| |
| |
| /** |
| * Auto generated method signatures |
| * @param isbn |
| */ |
| public com.sosnoski.ws.library.jibx.beans.Book getBook( |
| java.lang.String isbn) throws java.rmi.RemoteException |
| |
| |
| ; |
| |
| |
| |
| // |
| } |
| </pre></div> |
| |
| <p>You can see that the JiBX code generation converted the |
| operations into simple method call interfaces without introducing |
| any extraneous objects (see <a href="./jibx-doclit-example.html">JiBX Document/Literal Example</a> for |
| the interface generated when unwrapping is not used). The |
| server-side interface is the same.</p> |
| |
| <p>The key points that allow unwrapped handling with JiBX are:</p> |
| |
| <ol style="list-style-type: decimal"> |
| |
| <li>Each operation either accepts no input, or the input consists |
| of a single element.</li> |
| |
| <li>Each input element is defined as a schema <i>complexType</i> |
| consisting of a <i>sequence</i> of any number of child |
| elements.</li> |
| |
| <li>Each operation either generates no output, or the output |
| consists of a single element.</li> |
| |
| <li>Each output element is defined as a schema <i>complexType</i> |
| consisting of a <i>sequence</i> that's either empty or contains a |
| single child element.</li> |
| |
| <li>The child elements of both inputs and outputs are defined using |
| <i>type</i> references, rather than an embedded type |
| definitions.</li> |
| </ol> |
| |
| <p>You also need to supply an appropriate JiBX binding definition |
| (using the <i>-Ebindingfile {file}</i> parameter for WSDL2Java - |
| see <a href="./jibx-codegen-integration.html#codegen">JiBX Codegen |
| Integration - WSDL2Java usage</a> for more details). This must |
| define abstract <i>mapping</i>s for the <i>complexType</i>s |
| referenced by child elements of the inputs and outputs, with a |
| <i>type-name</i> attribute matching the schema <i>complexType</i> |
| name. If the child elements reference schema <i>simpleType</i> |
| definitions the binding must also define a <i>format</i>s for each |
| <i>simpleType</i>, with a <i>label</i> attribute matching the |
| schema <i>simpleType</i> name. The binding definition must also |
| specify the <i>force-classes='true'</i> attribute on the |
| <i>binding</i> element.</p> |
| |
| <p>For example, here's a binding definition that matches the above |
| WSDL:</p> |
| |
| <div> |
| <pre> |
| <binding force-classes="true" xmlns:tns="http://ws.sosnoski.com/library/types"> |
| |
| <namespace uri="http://ws.sosnoski.com/library/types" default="elements"/> |
| |
| <mapping abstract="true" class="com.sosnoski.ws.library.jibx.beans.Book" |
| type-name="tns:BookInformation"> |
| <value name="type" style="attribute" field="m_type"/> |
| <value name="isbn" style="attribute" field="m_isbn"/> |
| <collection field="m_authors"> |
| <value name="author"/> |
| </collection> |
| <value name="title" field="m_title"/> |
| </mapping> |
| |
| </binding> |
| </pre></div> |
| |
| <p>And here's the actual |
| <tt>com.sosnoski.ws.library.jibx.beans.Book</tt> class:</p> |
| |
| <div> |
| <pre> |
| package com.sosnoski.ws.library.jibx.beans; |
| |
| public class Book |
| { |
| private String m_type; |
| private String m_isbn; |
| private String m_title; |
| private String[] m_authors; |
| |
| public Book() {} |
| |
| public String getType() { |
| return m_type; |
| } |
| |
| public String getIsbn() { |
| return m_isbn; |
| } |
| |
| public String getTitle() { |
| return m_title; |
| } |
| |
| public String[] getAuthors() { |
| return m_authors; |
| } |
| } |
| </pre></div> |
| |
| <p>The JiBX code generation for Axis2 currently requires that |
| classes coresponding to unwrapped child elements (such as |
| <tt>com.sosnoski.ws.library.jibx.beans.Book</tt>, in this case) |
| provide public default (no-argument) constructors.</p> |
| |
| <p>JiBX handling allows the child elements of both inputs and |
| outputs to be optional (with <i>nillable='true'</i>, |
| <i>minOccurs='0'</i>, or both), providing the binding converts |
| these child elements to object types rather than primitive types. |
| It also allows repeated child elements (with |
| <i>minOccurs='unbounded'</i>, or any value of <i>minOccurs</i> |
| greater than one), representing the repeated elements as arrays of |
| the corresponding object or primitive types.</p> |
| |
| </html> |
| </div> |
| </div> |
| </div> |
| <hr/> |
| <footer> |
| <div class="container-fluid"> |
| <div class="row-fluid"> |
| <p>Copyright ©2004–2017 |
| <a href="https://www.apache.org/">The Apache Software Foundation</a>. |
| All rights reserved.</p> |
| </div> |
| </div> |
| </footer> |
| </body> |
| </html> |