| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
| <!-- Generated by Apache Maven Doxia Site Renderer 1.3 at Jun 28, 2015 -->
|
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
| <head>
|
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
| <title>Apache Axis2 - |
| |
| |
| JiBX unwrapped document/literal</title>
|
| <style type="text/css" media="all">
|
| @import url("../../css/maven-base.css");
|
| @import url("../../css/maven-theme.css");
|
| @import url("../../css/site.css");
|
| </style>
|
| <link rel="stylesheet" href="../../css/print.css" type="text/css" media="print" />
|
| <meta name="Date-Revision-yyyymmdd" content="20150628" />
|
| <meta http-equiv="Content-Language" content="en" />
|
| <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="composite">
|
| <div id="banner">
|
| <a href="http://www.apache.org/" id="bannerLeft">
|
| <img src="http://www.apache.org/images/asf_logo_wide.png" alt="Apache Axis2" />
|
| </a>
|
| <a href="../.././" id="bannerRight">
|
| <img src="../../images/axis.jpg" alt="Apache Axis2" />
|
| </a>
|
| <div class="clear">
|
| <hr/>
|
| </div>
|
| </div>
|
| <div id="breadcrumbs">
|
|
|
|
|
| <div class="xleft">
|
| <span id="publishDate">Last Published: 2015-06-28</span>
|
| | <span id="projectVersion">Version: 1.6.3</span>
|
| </div>
|
| <div class="xright"> <a href="../../index.html" title="Axis2/Java">Axis2/Java</a>
|
| |
|
| <a href="http://www.apache.org" class="externalLink" title="Apache">Apache</a>
|
|
|
|
|
| </div>
|
| <div class="clear">
|
| <hr/>
|
| </div>
|
| </div>
|
| <div id="leftColumn">
|
| <div id="navcolumn">
|
|
|
|
|
| <h5>Axis2/Java</h5>
|
| <ul>
|
| <li class="none">
|
| <a href="../../index.html" title="Home">Home</a>
|
| </li>
|
| </ul>
|
| <h5>Downloads</h5>
|
| <ul>
|
| <li class="none">
|
| <a href="../../download.cgi" title="Releases">Releases</a>
|
| </li>
|
| <li class="none">
|
| <a href="../../modules/index.html" title="Modules">Modules</a>
|
| </li>
|
| <li class="none">
|
| <a href="../../tools/index.html" title="Tools">Tools</a>
|
| </li>
|
| </ul>
|
| <h5>Documentation</h5>
|
| <ul>
|
| <li class="none">
|
| <a href="../../docs/toc.html" title="Table of Contents">Table of Contents</a>
|
| </li>
|
| <li class="none">
|
| <a href="../../docs/installationguide.html" title="Installation Guide">Installation Guide</a>
|
| </li>
|
| <li class="none">
|
| <a href="../../docs/quickstartguide.html" title="QuickStart Guide">QuickStart Guide</a>
|
| </li>
|
| <li class="none">
|
| <a href="../../docs/userguide.html" title="User Guide">User Guide</a>
|
| </li>
|
| <li class="none">
|
| <a href="../../docs/jaxws-guide.html" title="JAXWS Guide">JAXWS Guide</a>
|
| </li>
|
| <li class="none">
|
| <a href="../../docs/pojoguide.html" title="POJO Guide">POJO Guide</a>
|
| </li>
|
| <li class="none">
|
| <a href="../../docs/spring.html" title="Spring Guide">Spring Guide</a>
|
| </li>
|
| <li class="none">
|
| <a href="../../docs/webadminguide.html" title="Web Administrator's Guide">Web Administrator's Guide</a>
|
| </li>
|
| <li class="none">
|
| <a href="../../docs/migration.html" title="Migration Guide (from Axis1)">Migration Guide (from Axis1)</a>
|
| </li>
|
| </ul>
|
| <h5>Resources</h5>
|
| <ul>
|
| <li class="none">
|
| <a href="../../faq.html" title="FAQ">FAQ</a>
|
| </li>
|
| <li class="none">
|
| <a href="../../articles.html" title="Articles">Articles</a>
|
| </li>
|
| <li class="none">
|
| <a href="http://wiki.apache.org/ws/FrontPage/Axis2/" class="externalLink" title="Wiki">Wiki</a>
|
| </li>
|
| <li class="none">
|
| <a href="../../refLib.html" title="Reference Library">Reference Library</a>
|
| </li>
|
| <li class="none">
|
| <a href="../../api/index.html" title="Online Java Docs">Online Java Docs</a>
|
| </li>
|
| </ul>
|
| <h5>Get Involved</h5>
|
| <ul>
|
| <li class="none">
|
| <a href="../../overview.html" title="Overview">Overview</a>
|
| </li>
|
| <li class="none">
|
| <a href="../../svn.html" title="Checkout the Source">Checkout the Source</a>
|
| </li>
|
| <li class="none">
|
| <a href="../../mail-lists.html" title="Mailing Lists">Mailing Lists</a>
|
| </li>
|
| <li class="none">
|
| <a href="../../release-process.html" title="Release Process">Release Process</a>
|
| </li>
|
| <li class="none">
|
| <a href="../../guidelines.html" title="Developer Guidelines">Developer Guidelines</a>
|
| </li>
|
| <li class="none">
|
| <a href="../../siteHowTo.html" title="Build the Site">Build the Site</a>
|
| </li>
|
| </ul>
|
| <h5>Project Information</h5>
|
| <ul>
|
| <li class="none">
|
| <a href="../../team-list.html" title="Project Team">Project Team</a>
|
| </li>
|
| <li class="none">
|
| <a href="../../issue-tracking.html" title="Issue Tracking">Issue Tracking</a>
|
| </li>
|
| <li class="none">
|
| <a href="http://svn.apache.org/viewvc/axis/axis2/java/core/trunk/" class="externalLink" title="Source Code">Source Code</a>
|
| </li>
|
| <li class="none">
|
| <a href="../../thanks.html" title="Acknowledgements">Acknowledgements</a>
|
| </li>
|
| <li class="none">
|
| <a href="http://www.apache.org/licenses/LICENSE-2.0.html" class="externalLink" title="License">License</a>
|
| </li>
|
| <li class="none">
|
| <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsorship">Sponsorship</a>
|
| </li>
|
| <li class="none">
|
| <a href="http://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks">Thanks</a>
|
| </li>
|
| <li class="none">
|
| <a href="http://www.apache.org/security/" class="externalLink" title="Security">Security</a>
|
| </li>
|
| </ul>
|
| <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
|
| <img class="poweredBy" alt="Built by Maven" src="../../images/logos/maven-feather.png" />
|
| </a>
|
|
|
|
|
| </div>
|
| </div>
|
| <div id="bodyColumn">
|
| <div id="contentBox">
|
| <!-- ~ Licensed to the Apache Software Foundation (ASF) under one |
| ~ or more contributor license agreements. See the NOTICE file |
| ~ distributed with this work for additional information |
| ~ regarding copyright ownership. The ASF licenses this file |
| ~ to you under the Apache License, Version 2.0 (the |
| ~ "License"); you may not use this file except in compliance |
| ~ with the License. You may obtain a copy of the License at |
| ~ |
| ~ http://www.apache.org/licenses/LICENSE-2.0 |
| ~ |
| ~ Unless required by applicable law or agreed to in writing, |
| ~ software distributed under the License is distributed on an |
| ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| ~ KIND, either express or implied. See the License for the |
| ~ specific language governing permissions and limitations |
| ~ under the License. --><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 class="clear">
|
| <hr/>
|
| </div>
|
| <div id="footer">
|
| <div class="xright">
|
| Copyright © 2004-2015
|
| <a href="http://www.apache.org/">The Apache Software Foundation</a>.
|
| All Rights Reserved.
|
|
|
| </div>
|
| <div class="clear">
|
| <hr/>
|
| </div>
|
| </div>
|
| </body>
|
| </html>
|
