| <!-- | |
| ~ Licensed to the Apache Software Foundation (ASF) under one | |
| ~ or more contributor license agreements. See the NOTICE file | |
| ~ distributed with this work for additional information | |
| ~ regarding copyright ownership. The ASF licenses this file | |
| ~ to you under the Apache License, Version 2.0 (the | |
| ~ "License"); you may not use this file except in compliance | |
| ~ with the License. You may obtain a copy of the License at | |
| ~ | |
| ~ http://www.apache.org/licenses/LICENSE-2.0 | |
| ~ | |
| ~ Unless required by applicable law or agreed to in writing, | |
| ~ software distributed under the License is distributed on an | |
| ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | |
| ~ KIND, either express or implied. See the License for the | |
| ~ specific language governing permissions and limitations | |
| ~ under the License. | |
| --> | |
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" | |
| "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> | |
| <html xmlns="http://www.w3.org/1999/xhtml"> | |
| <head> | |
| <meta name="generator" content= | |
| "HTML Tidy for Windows (vers 14 June 2007), see www.w3.org" /> | |
| <meta http-equiv="content-type" content="" /> | |
| <title>JiBX general document/literal</title> | |
| <link href="../../css/axis-docs.css" rel="stylesheet" type= | |
| "text/css" media="all" /> | |
| </head> | |
| <body> | |
| <h1>JiBX general document/literal</h1> | |
| <p>Code generation for JiBX data binding converts operations | |
| defined by a Web service to method calls. With general | |
| document/literal (doc/lit) Web services the generated methods each | |
| take a single parameter object and return a single result object. | |
| Here's a sample doc/lit WSDL (partial) by way of an example:</p> | |
| <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> | |
| <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. Here's the body of the client | |
| interface generated by the standard JiBX code generation:</p> | |
| <pre> | |
| public interface LibraryJibxUnwrapped { | |
| /** | |
| * Auto generated method signatures | |
| * @param addBook | |
| */ | |
| public com.sosnoski.ws.library.jibx.wrappers.AddBookResponse addBook( | |
| com.sosnoski.ws.library.jibx.wrappers.AddBookRequest addBook) throws java.rmi.RemoteException | |
| ; | |
| /** | |
| * Auto generated method signatures | |
| * @param getBook | |
| */ | |
| public com.sosnoski.ws.library.jibx.wrappers.GetBookResponse getBook( | |
| com.sosnoski.ws.library.jibx.wrappers.GetBookRequest getBook) throws java.rmi.RemoteException | |
| ; | |
| // | |
| } | |
| </pre> | |
| <p>You can see that the JiBX code generation converted the | |
| operations into simple method call interfaces using objects | |
| corresponding to the input and output elements of the operation | |
| (see <a href="./jibx-unwrapped-example.html">JiBX Unwrapped | |
| Example</a> for the interface generated when unwrapping is instead | |
| used). The server-side interface is the same.</p> | |
| <p>You need to supply an appropriate JiBX binding definition for | |
| use in code generation (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 concrete | |
| <i>mappings</i> for each element used as the input or output of an | |
| operation. The JiBX code generation extension matches the element | |
| names to the binding in order to determine the corresponding class | |
| to use in generated code.</p> | |
| <p>For example, here's a binding definition that matches the above | |
| WSDL:</p> | |
| <pre> | |
| <binding add-constructors="true"> | |
| <namespace uri="http://ws.sosnoski.com/library/types" default="elements"/> | |
| <mapping name="getBook" | |
| class="com.sosnoski.ws.library.jibx.wrappers.GetBookRequest"> | |
| <value name="isbn" field="m_isbn"/> | |
| </mapping> | |
| <mapping name="getBookResponse" | |
| class="com.sosnoski.ws.library.jibx.wrappers.GetBookResponse"> | |
| <structure name="book" field="m_book"/> | |
| </mapping> | |
| <mapping name="addBook" | |
| class="com.sosnoski.ws.library.jibx.wrappers.AddBookRequest"> | |
| <structure field="m_book"> | |
| <value name="type" field="m_type"/> | |
| <value name="isbn" field="m_isbn"/> | |
| <collection field="m_authors"> | |
| <value name="author" type="java.lang.String"/> | |
| </collection> | |
| <value name="title" field="m_title"/> | |
| </structure> | |
| </mapping> | |
| <mapping name="addBookResponse" | |
| class="com.sosnoski.ws.library.jibx.wrappers.AddBookResponse"/> | |
| <mapping abstract="true" class="com.sosnoski.ws.library.jibx.beans.Book"> | |
| <value name="type" style="attribute" field="m_type"/> | |
| <value name="isbn" style="attribute" field="m_isbn"/> | |
| <collection field="m_authors"> | |
| <value name="author" type="java.lang.String"/> | |
| </collection> | |
| <value name="title" field="m_title"/> | |
| </mapping> | |
| </binding> | |
| </pre> | |
| <p>And here are the actual data object classes:</p> | |
| <pre> | |
| package com.sosnoski.ws.library.jibx.wrappers; | |
| import com.sosnoski.ws.library.jibx.beans.Book; | |
| public class AddBookRequest | |
| { | |
| private Book m_book; | |
| public AddBookRequest(Book book) { | |
| m_book = book; | |
| } | |
| public Book getBook() { | |
| return m_book; | |
| } | |
| } | |
| public class AddBookResponse | |
| { | |
| } | |
| public class GetBookRequest | |
| { | |
| private String m_isbn; | |
| public GetBookRequest(String isbn) { | |
| m_isbn = isbn; | |
| } | |
| public String getIsbn() { | |
| return m_isbn; | |
| } | |
| } | |
| public class GetBookResponse | |
| { | |
| private Book m_book; | |
| public GetBookResponse(Book book) { | |
| m_book = book; | |
| } | |
| public Book getBook() { | |
| return m_book; | |
| } | |
| } | |
| 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> | |
| </body> | |
| </html> |