This is an automated email from the ASF dual-hosted git repository. robertlazarski pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/axis-axis2-java-core.git
commit 1c19806ff30e9242910394c76ddd38fa409463ce Author: Robert Lazarski <[email protected]> AuthorDate: Sun Sep 6 12:55:14 2026 -1000 Stop documenting modules removed in 2.0.1 JiBX and the SOAP Monitor went in AXIS2-6105, but the site still carried a full JiBX client how-to, two JiBX sections in the quickstart guide, and links to pages that no longer exist. wsdl2java also still offered jibx as a -d value in its own help while codegen.databinding.frameworks lists only adb, xmlbeans, jaxbri and none, so the option could not work. Migration-guide references stay: they describe Axis 1.x, not this release. Note that printUsage loops over wsdl2code.arg2..arg53 by number, so arg30 is kept empty rather than deleted -- a gap throws MissingResourceException and breaks -help. Co-Authored-By: Claude Opus 5 (1M context) <[email protected]> --- .../org/apache/axis2/wsdl/i18n/resource.properties | 8 +- src/site/markdown/docs/reference.md | 3 +- src/site/xdoc/docs/Axis2ArchitectureGuide.xml | 3 - src/site/xdoc/docs/adv-userguide.xml | 4 - src/site/xdoc/docs/quickstartguide.xml | 166 +------ .../xdoc/docs/userguide-creatingclients-jibx.xml | 506 --------------------- src/site/xdoc/docs/userguide-creatingclients.xml | 19 +- src/site/xdoc/docs/userguide-forfurtherstudy.xml | 1 - src/site/xdoc/docs/userguide.xml | 1 - src/site/xdoc/tools/CodegenToolReference.xml | 4 +- 10 files changed, 19 insertions(+), 696 deletions(-) diff --git a/modules/codegen/src/org/apache/axis2/wsdl/i18n/resource.properties b/modules/codegen/src/org/apache/axis2/wsdl/i18n/resource.properties index 0956e23414..240980a638 100644 --- a/modules/codegen/src/org/apache/axis2/wsdl/i18n/resource.properties +++ b/modules/codegen/src/org/apache/axis2/wsdl/i18n/resource.properties @@ -44,7 +44,7 @@ wsdl2code.arg6= -l <language> Valid languages are java and c (Defaul wsdl2code.arg7= -t Generate a test case for the generated code. wsdl2code.arg8= -ss Generate server side code (i.e. skeletons) (Default: off). wsdl2code.arg9= -sd Generate service descriptor (i.e. services.xml). (Default: off). Valid with -ss. -wsdl2code.arg10= -d <databinding> Valid databinding(s) are adb, xmlbeans, jibx and jaxbri (Default: adb). +wsdl2code.arg10= -d <databinding> Valid databinding(s) are adb, xmlbeans, jaxbri and none (Default: adb). wsdl2code.arg11= -g Generates all the classes. It generates clases for both client side and server side including derived classes of the schema. wsdl2code.arg12= -pn <port_name> Choose a specific port when there are multiple ports in the wsdl. wsdl2code.arg13= -sn <service_name> Choose a specific service when there are multiple services in the wsdl. @@ -64,7 +64,11 @@ wsdl2code.arg26= -or Overwrite the existing classes wsdl2code.arg27= -b Generate Axis 1.x backward compatible code. wsdl2code.arg28= -sp Suppress namespace prefixes (Optimzation that reduces size of soap request/response) wsdl2code.arg29= -E<key> <value> Extra configuration options specific to certain databindings. Examples: -wsdl2code.arg30= \t\t\t -Ebindingfile <path> (for jibx) - specify the file path for the binding file +# WSDL2Code.printUsage() loops over wsdl2code.arg2..arg53 by number, so these keys +# are positional: a gap throws MissingResourceException and breaks -help. arg30 held +# the JiBX -Ebindingfile example; JiBX was removed in 2.0.1 (AXIS2-6105) and the key +# is kept empty rather than deleted. +wsdl2code.arg30= wsdl2code.arg31= \t\t\t -Etypesystemname <my_type_system_name> (for xmlbeans) - override the randomly generated type system name wsdl2code.arg32= \t\t\t -Ejavaversion 1.5 (for xmlbeans) - generates Java 1.5 code (typed lists instead of arrays) wsdl2code.arg33= \t\t\t -Emp <package name> (for ADB) - extension mapper package name diff --git a/src/site/markdown/docs/reference.md b/src/site/markdown/docs/reference.md index 7fbe7f35db..eb88b934d7 100644 --- a/src/site/markdown/docs/reference.md +++ b/src/site/markdown/docs/reference.md @@ -41,7 +41,7 @@ WSDL2Java Reference -t Generate a test case for the generated code. -ss Generate server side code (i.e. skeletons) (Default: off). -sd Generate service descriptor (i.e. services.xml). (Default: off). Valid with -ss. - -d <databinding> Valid databinding(s) are adb, xmlbeans, jibx and jaxbri (Default: adb). + -d <databinding> Valid databinding(s) are adb, xmlbeans, jaxbri and none (Default: adb). -g Generates all the classes. Valid only with -ss. -pn <port_name> Choose a specific port when there are multiple ports in the wsdl. -sn <service_name> Choose a specific service when there are multiple services in the wsdl. @@ -61,7 +61,6 @@ WSDL2Java Reference -b Generate Axis 1.x backword compatible code. -sp Suppress namespace prefixes (Optimzation that reduces size of soap request/response) -E<key> <value> Extra configuration options specific to certain databindings. Examples: - -Ebindingfile <path> (for jibx) - specify the file path for the binding file -Etypesystemname <my_type_system_name> (for xmlbeans) - override the randomly generated type system name -Ejavaversion 1.5 (for xmlbeans) - generates Java 1.5 code (typed lists instead of arrays) -Emp <package name> (for ADB) - extension mapper package name diff --git a/src/site/xdoc/docs/Axis2ArchitectureGuide.xml b/src/site/xdoc/docs/Axis2ArchitectureGuide.xml index 949f5e11f1..16f63f3e16 100644 --- a/src/site/xdoc/docs/Axis2ArchitectureGuide.xml +++ b/src/site/xdoc/docs/Axis2ArchitectureGuide.xml @@ -979,9 +979,6 @@ schema support is needed!</li> <li><strong>JAXB-RI</strong> - JAXB2 support has been added in a similar manner to XMLbeans and serves as another option for the user</li> -<li><strong>JibX</strong> - This is the most recent addition to the -family of databinding extensions, and it is also another option -users have for data binding.</li> </ol> <a name="serial" id="serial"></a> <h3>Serialization and De-Serialization of Data bound classes</h3> diff --git a/src/site/xdoc/docs/adv-userguide.xml b/src/site/xdoc/docs/adv-userguide.xml index 24d46420b8..f2b457e3c2 100644 --- a/src/site/xdoc/docs/adv-userguide.xml +++ b/src/site/xdoc/docs/adv-userguide.xml @@ -496,9 +496,6 @@ to the following documents for more information.</p> <li><a href="adb/adb-tweaking.html">ADB Tweaking Guide</a></li> </ol> -<h4>JiBX</h4> -<a href="jibx/jibx-codegen-integration.html">JiBX Integration With Axis2</a> - <h3>Other Topics</h3> <ol> <li><a href="spring.html">Axis2 Integration With The Spring @@ -511,7 +508,6 @@ to the following documents for more information.</p> <li><a href="migration.html">Migrating from Apache Axis 1.x to Axis 2</a></li> <li><a href="modules.html">Writing your Own Axis2 Module</a></li> - <li><a href="soapmonitor-module.html">Using the SOAP Monitor</a></li> <li><a href="xmlbased-server.html">Writing Web Services Using Axis2's Primary APIs</a></li> <li><a href="dii.html">Writing Web Service Clients Using Axis2's Primary diff --git a/src/site/xdoc/docs/quickstartguide.xml b/src/site/xdoc/docs/quickstartguide.xml index 63da021fae..6178b07cd3 100644 --- a/src/site/xdoc/docs/quickstartguide.xml +++ b/src/site/xdoc/docs/quickstartguide.xml @@ -49,7 +49,6 @@ creating clients to access those services.</p> <li><a href="#adb">Generating the service using ADB</a></li> <li><a href="#xmlbeans">Generating the service using XMLBeans</a></li> -<li><a href="#jibx">Generating the service using JiBX</a></li> </ul> </li> <li><a href="#clients">Generating Clients</a> @@ -58,7 +57,6 @@ XMLBeans</a></li> <li><a href="#clientadb">Generating a client using ADB</a></li> <li><a href="#clientxmlbeans">Generating a client using XML Beans</a></li> -<li><a href="#clientjibx">Generating a client using JiBX</a></li> </ul> </li> <li><a href="#summary">Summary</a></li> @@ -68,8 +66,8 @@ Beans</a></li> <p>The code for the document can be found in the extracted <a href= "../download.cgi">Standard Binary Distribution</a>, more specifically at Axis2_HOME/samples/ -inside the directories- quickstart, quickstartadb, quickstartaxiom, -quickstartjibx and quickstartxmlbeans. (Consider getting it now as +inside the directories- quickstart, quickstartadb, quickstartaxiom +and quickstartxmlbeans. (Consider getting it now as it will help you to follow along.) It includes Ant buildfiles (build.xml) that we'll refer to throughout the examples to make compilation easier.</p> @@ -171,7 +169,6 @@ WEB-INF modules.list addressing.mar ... - soapmonitor.mar services services.list aservice.aar @@ -263,8 +260,7 @@ services.</p> based on the StockQuoteService class: deploying Plain Old Java Objects (POJO), building the service using AXIOM's OMElement, generating the service using Axis2 Databinding Framework (ADB), -generating the service using XMLBeans, and generating the service -using JiBX.</p> +and generating the service using XMLBeans.</p> <a name="deploy" id="deploy"></a> <h3>Deploying POJOs</h3> <p>To deploy the service using POJOs (Plain Old Java Objects), @@ -636,90 +632,12 @@ http://localhost:8080/axis2/services/StockQuoteService?wsdl <pre> http://localhost:8080/axis2/services/StockQuoteService?xsd </pre> -<a name="jibx" id="jibx"></a> -<h3>Generating the Service using JiBX</h3> -<p>To generate and deploy the service using <a href= -"http://www.jibx.org";>JiBX data binding</a>, execute the following -steps.</p> -<p>Generate the skeleton using the WSDL2Java utility by typing the -following at a console in the Axis2_HOME/samples/quickstartjibx -directory:</p> -<pre> -%AXIS2_HOME%\bin\wsdl2java.bat -uri resources\META-INF\StockQuoteService.wsdl -p samples.quickstart.service.jibx -d jibx -s -ss -sd -ssi -uw -o build\service -</pre> -<p>Else, simply type "ant generate.service" in the -Axis2_HOME/samples/quickstartjibx directory.</p> -<p>The option -d jibx specifies JiBX data binding. The -s switch -specifies synchronous or blocking calls only. The -ss switch -creates the server side code (skeleton and related files). The -sd -switch creates a service descriptor (services.xml file). The -ssi -switch creates an interface for the service skeleton. The -uw -switch unwraps the parameters passed to and from the service -operations in order to create a more natural programming -interface.</p> -<p>After running WSDL2Java, the service files should be located at -build/service. If you generated the code by using WSDL2Java -directly, you need to modify the generated skeleton to implement -the service (if you used "ant generate.service" a completed -skeleton will be copied over the generated one automatically). Open -the -build/service/src/samples/quickstart/service/jibx/StockQuoteServiceSkeleton.java -file and modify it to add the functionality of your service to the -generated methods, as shown in Code Listing 8.</p> -<p><b>Code Listing 8: Defining the Service Skeleton File</b></p> -<pre> -package samples.quickstart.service.jibx; - -import java.util.HashMap; - -public class StockQuoteServiceSkeleton implements StockQuoteServiceSkeletonInterface { - private HashMap map = new HashMap(); - - public void update(String symbol, Double price) { - map.put(symbol, price); - } - - public Double getPrice(String symbol) { - Double ret = (Double) map.get(symbol); - if (ret == null) { - ret = new Double(42.0); - } - return ret; - } -} -</pre> -<p>Now you can build the project by typing the following command in -the build/service directory:</p> -<pre> -ant jar.server -</pre> -<p>If all goes well, you should see the BUILD SUCCESSFUL message in -your window, and the StockQuoteService.aar file in the -build/service/build/lib directory. Copy this file to the -webapps/axis2/WEB-INF/services directory of the servlet engine.</p> -<p>You can check to make sure that the service has been properly -deployed by viewing the list of services at,</p> -<pre> -http://localhost:8080/axis2/services/listServices -</pre> -<p>You can also check the custom WSDL at,</p> -<pre> -http://localhost:8080/axis2/services/StockQuoteService?wsdl -</pre> -<p>and the schema at,</p> -<pre> -http://localhost:8080/axis2/services/StockQuoteService?xsd -</pre> -<p>For more information on using JiBX with Axis2, see the <a href= -"jibx/jibx-codegen-integration.html">JiBX code generation -integration</a> details.</p> <a name="clients" id="clients"></a> <h2>Creating Clients</h2> -<p>In this section, we'll look at four ways to create clients based +<p>In this section, we'll look at three ways to create clients based on the StockQuoteService class: building an AXIOM based client, generating a client using Axis2 Databinding Framework (ADB), -generating a client using XMLBeans, and generating a client using -JiBX.</p> +and generating a client using XMLBeans.</p> <a name="clientaxiom" id="clientaxiom"></a> <h3>Creating a Client with AXIOM</h3> <p>To build a client using AXIOM, execute the following steps.</p> @@ -1010,80 +928,6 @@ the Axis2_HOME/samples/quickstartxmlbeans directory.</p> price updated 42.32 </pre> -<a name="clientjibx" id="clientjibx"></a> -<h3>Generating a Client using JiBX</h3> -<p>To build a client using JiBX, execute the following steps.</p> -<p>Generate the client stub by typing the following at a console in -the Axis2_HOME/samples/quickstartjibx directory.</p> -<pre> -%AXIS2_HOME%\bin\wsdl2java.bat -uri resources\META-INF\StockQuoteService.wsdl -p samples.quickstart.clients -d jibx -s -uw -o build\client -</pre> -<p>Else, simply type "ant generate.client".</p> -<p>Next take a look at -quickstartjibx/src/samples/quickstart/clients/JiBXClient.java, -shown below in Code Listing 12.</p> -<p><b>Code Listing 12: The JiBXClient class</b></p> -<pre> -package samples.quickstart.clients; - -import samples.quickstart.service.jibx.StockQuoteServiceStub; - -public class JiBXClient{ - public static void main(java.lang.String args[]){ - try{ - StockQuoteServiceStub stub = - new StockQuoteServiceStub - ("http://localhost:8080/axis2/services/StockQuoteService";); - - getPrice(stub); - update(stub); - getPrice(stub); - - } catch(Exception e){ - e.printStackTrace(); - System.err.println("\n\n\n"); - } - } - - /* fire and forget */ - public static void update(StockQuoteServiceStub stub){ - try{ - stub.update("CDE", new Double(42.35)); - System.err.println("price updated"); - } catch(Exception e){ - e.printStackTrace(); - System.err.println("\n\n\n"); - } - } - - /* two way call/receive */ - public static void getPrice(StockQuoteServiceStub stub){ - try{ - System.err.println(stub.getPrice("CDE")); - } catch(Exception e){ - e.printStackTrace(); - System.err.println("\n\n\n"); - } - } - -} -</pre> -<p>This class uses the created JiBX client stub to access the -getPrice and the update operations on the Web service. The getPrice -method sends a request for the stock "ABC" and displays the current -price. The update method setsnex the price for stock "ABC" to -42.35.</p> -<p>Now build and run the client by typing "ant run.client" at a -console in the Axis2_HOME/samples/quickstartjibx directory.</p> -<p>You should get the following as output:</p> -<pre> -42 -price updated -42.35 -</pre> -<p>For more information on using JiBX with Axis2, see the <a href= -"jibx/jibx-codegen-integration.html">JiBX code generation -integration</a> details.</p> <a name="summary" id="summary"></a> <h2>Summary</h2> <p>Axis2 provides a slick and robust way to get web services up and diff --git a/src/site/xdoc/docs/userguide-creatingclients-jibx.xml b/src/site/xdoc/docs/userguide-creatingclients-jibx.xml deleted file mode 100644 index d45c860909..0000000000 --- a/src/site/xdoc/docs/userguide-creatingclients-jibx.xml +++ /dev/null @@ -1,506 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> - -<!-- - ~ 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 Transitional//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> -<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> -<head> -<meta name="generator" content= -"HTML Tidy for Windows (vers 14 June 2007), see www.w3.org" /> -<meta http-equiv="content-type" content="" /> -<title>Generating a Web Service Client using Axis2 and JiBX</title> -</head> -<body> -<h1 class="title">Generating a Web Service Client using Axis2 and -JiBX</h1> -<p>This document explains how to generate a Web service client -using Axis2 and JiBX data binding. The service has the following -WSDL:</p> -<p><b>Code Listing 1: The WSDL file</b></p> -<pre> -<?xml version="1.0" encoding="UTF-8"?> -<wsdl:definitions - xmlns:apachesoap="http://xml.apache.org/xml-soap"; - xmlns:impl="http://apache.org/axis2/Axis2UserGuide"; - xmlns:intf="http://apache.org/axis2/Axis2UserGuide"; - xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"; - xmlns:wsdlsoap="http://schemas.xmlsoap.org/wsdl/soap/"; - xmlns:xsd="http://www.w3.org/2001/XMLSchema"; - targetNamespace="http://apache.org/axis2/Axis2UserGuide"> - - <wsdl:types> - <schema - elementFormDefault="qualified" - targetNamespace="http://apache.org/axis2/Axis2UserGuide"; - xmlns="http://www.w3.org/2001/XMLSchema"> - - <!-- ELEMENTS --> - - <element name="DoInOnlyRequest"> - <complexType> - <sequence> - <element name="messageString" type="xsd:string"/> - </sequence> - </complexType> - </element> - - <element name="TwoWayOneParameterEchoRequest"> - <complexType> - <sequence> - <element name="echoString" type="xsd:string"/> - </sequence> - </complexType> - </element> - <element name="TwoWayOneParameterEchoResponse"> - <complexType> - <sequence> - <element name="echoString" type="xsd:string"/> - </sequence> - </complexType> - </element> - - <element name="NoParametersRequest"> - <complexType/> - </element> - <element name="NoParametersResponse"> - <complexType/> - </element> - - <element name="MultipleParametersAddItemRequest"> - <complexType> - <sequence> - <element name="itemId" type="xsd:int"/> - <element name="itemName" type="xsd:string"/> - <element name="price" type="xsd:float"/> - <element name="description" type="xsd:string"/> - </sequence> - </complexType> - </element> - - <element name="MultipleParametersAddItemResponse"> - <complexType> - <sequence> - <element name="itemId" type="xsd:int"/> - <element name="successfulAdd" type="xsd:boolean"/> - </sequence> - </complexType> - </element> - - </schema> - </wsdl:types> - - - <!-- MESSAGES --> - - <wsdl:message name="DoInOnlyRequestMessage"> - <wsdl:part name="input" element="impl:DoInOnlyRequest"/> - </wsdl:message> - - <wsdl:message name="TwoWayOneParameterEchoRequestMessage"> - <wsdl:part name="input" element="impl:TwoWayOneParameterEchoRequest"/> - </wsdl:message> - <wsdl:message name="TwoWayOneParameterEchoResponseMessage"> - <wsdl:part name="output" element="impl:TwoWayOneParameterEchoResponse"/> - </wsdl:message> - - <wsdl:message name="NoParametersRequestMessage"> - <wsdl:part name="input" element="impl:NoParametersRequest"/> - </wsdl:message> - <wsdl:message name="NoParametersResponseMessage"> - <wsdl:part name="output" element="impl:NoParametersResponse"/> - </wsdl:message> - - <wsdl:message name="MultipleParametersAddItemRequestMessage"> - <wsdl:part name="input" element="impl:MultipleParametersAddItemRequest"/> - </wsdl:message> - <wsdl:message name="MultipleParametersAddItemResponseMessage"> - <wsdl:part name="output" element="impl:MultipleParametersAddItemResponse"/> - </wsdl:message> - - - <!-- Port type (operations) --> - - <wsdl:portType name="Axis2UserGuidePortType"> - - <wsdl:operation name="DoInOnly" parameterOrder="input"> - <wsdl:input name="DoInOnlyRequestMessage" - message="impl:DoInOnlyRequestMessage"/> - </wsdl:operation> - - <wsdl:operation name="TwoWayOneParameterEcho" parameterOrder="input"> - <wsdl:input name="TwoWayOneParameterEchoRequestMessage" - message="impl:TwoWayOneParameterEchoRequestMessage"/> - <wsdl:output name="TwoWayOneParameterEchoResponseMessage" - message="impl:TwoWayOneParameterEchoResponseMessage"/> - </wsdl:operation> - - <wsdl:operation name="NoParameters" parameterOrder="input"> - <wsdl:input name="NoParametersRequestMessage" - message="impl:NoParametersRequestMessage"/> - <wsdl:output name="NoParametersResponseMessage" - message="impl:NoParametersResponseMessage"/> - </wsdl:operation> - - <wsdl:operation name="MultipleParametersAddItem" parameterOrder="input"> - <wsdl:input name="MultipleParametersAddItemRequestMessage" - message="impl:MultipleParametersAddItemRequestMessage"/> - <wsdl:output name="MultipleParametersAddItemResponseMessage" - message="impl:MultipleParametersAddItemResponseMessage"/> - </wsdl:operation> - - </wsdl:portType> - - - <!-- BINDING (bind operations) --> - <wsdl:binding - name="Axis2UserGuideSoapBinding" - type="impl:Axis2UserGuidePortType"> - <wsdlsoap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/> - - <wsdl:operation name="DoInOnly"> - <wsdlsoap:operation soapAction="DoInOnly"/> - <wsdl:input> - <wsdlsoap:body use="literal"/> - </wsdl:input> - </wsdl:operation> - - <wsdl:operation name="TwoWayOneParameterEcho"> - <wsdlsoap:operation soapAction="TwoWayOneParameterEcho"/> - <wsdl:input> - <wsdlsoap:body use="literal"/> - </wsdl:input> - <wsdl:output> - <wsdlsoap:body use="literal"/> - </wsdl:output> - </wsdl:operation> - - <wsdl:operation name="NoParameters"> - <wsdlsoap:operation soapAction="NoParameters"/> - <wsdl:input> - <wsdlsoap:body use="literal"/> - </wsdl:input> - <wsdl:output> - <wsdlsoap:body use="literal"/> - </wsdl:output> - </wsdl:operation> - - <wsdl:operation name="MultipleParametersAddItem"> - <wsdlsoap:operation soapAction="MultipleParametersAddItem"/> - <wsdl:input> - <wsdlsoap:body use="literal"/> - </wsdl:input> - <wsdl:output> - <wsdlsoap:body use="literal"/> - </wsdl:output> - </wsdl:operation> - </wsdl:binding> - - - <!-- SERVICE --> - - <wsdl:service name="Axis2UserGuideService"> - <wsdl:port binding="impl:Axis2UserGuideSoapBinding" - name="Axis2UserGuide"> - <wsdlsoap:address location="http://localhost:8080/axis2/services/Axis2UserGuide"/> - </wsdl:port> - </wsdl:service> -</wsdl:definitions> -</pre> -<p>Note that the document defines four operations, DoInOnly, -NoParameters, TwoWayOneParameterEcho, and -MultipleParametersAddItem. Each client will include methods for -calling each of these operations.</p> -<p>(You can get more information on WSDL at <a href= -"http://www.w3.org/2002/ws/desc/";>http://www.w3.org/2002/ws/desc/</a> -.)</p> -<a name="jibx" id="jibx"></a> -<h2>JiBX</h2> -<p>JiBX is not part of the Apache project, so in order to use it to -generate your clients, you will need to do some setting up to start -with. To generate your client, execute the following steps:</p> -<p><b>The short story</b>:</p> -<ol> -<li>Download the latest JiBX package (tested with JiBX v1.1) from -<a href= -"https://sourceforge.net/projects/jibx/";>https://sourceforge.net/projects/jibx/</a> -. Extract the zip file, and copy the JARs in the lib directory to -the AXIS2_HOME/lib directory. (Delete the stax-api.jar file; it's -superseded by the version that comes with Axis2.)</li> -<li>Download <s><a href= -"http://sourceforge.net/project/showfiles.php?group_id=69358&package_id=122897";> -xsd2jibx version beta2a</a></s> <em>(Old SourceForge URL format - see <a href="https://sourceforge.net/projects/jibx/files/";>JiBX files</a>)</em> from SourceForge. Create a directory -called xsd2jibx in your working directory and extract the files -into it. This utility does not work with the latest release (v1.1) -of JiBX, so download <s><a href= -"http://sourceforge.net/project/showfiles.php?group_id=69358&package_id=68290";> -jibx-1.0RC1</a></s> <em>(Old SourceForge URL format - see <a href="https://sourceforge.net/projects/jibx/files/";>JiBX files</a>)</em> from SourceForge. Extract the files from this -archive and copy the *.jar files in the lib directory into the -xsd2jibx/lib directory.</li> -<li>Create a schema based on the data structures of your WSDL file -and save it in your working directory.</li> -<li>Make sure that only the xsd2jibx jar files are in the classpath -and execute the following command to create the basic binding file: -java -jar xsd2jibx\lib\xsd2jibx.jar Axis2UserGuide.xsd</li> -<li>Copy the org directory to the src directory to place the -generated classes into the project so that the compiler will see -them.</li> -<li>Remove the xsd2jibx-related *.jar files from your CLASSPATH and -add the Axis2 .jar files back into it. Execute the following -command to generate the stubs: -<pre> -%AXIS2_HOME%\bin\WSDL2Java -uri Axis2UserGuide.wsdl -p org.apache.axis2.axis2userguide -d jibx -Ebindingfile org\apache\axis2\axis2userguide\binding.xml -s -</pre></li> -<li>Create the client file in the org/apache/axis2/axis2userguide -directory.</li> -<li>Copy the org directory and all its contents to the src -directory.</li> -<li>Compile the first set of classes by typing:<code>ant -jar.client</code></li> -<li>Go to the build/classes directory and run the JiBX compiler: -<pre> -java -jar C:\apps\axis2\lib\jibx-bind.jar -..\..\org\apache\axis2\axis2userguide\binding.xml -</pre></li> -<li>Run Ant again to package the new auto-generated JiBX classes -into the client jar by typing: <code>ant jar.client</code></li> -<li>Add the build/lib/Axis2UserGuideService-test-client.jar file to -the CLASSPATH and run the client by typing: -<pre> -java org.apache.axis2.axis2userguide.Client -</pre></li> -</ol> -<p><b>The long story:</b></p> -<p>To use JiBX to generate your client, you first need to use it in -two different functions. You have to generate a binding file that -maps objects to the XML elements, and then use JiBX to generate the -stubs that your client will use. To generate a binding file, you'll -need the xsd2jibx utility, which creates a binding file from an XML -Schema document. Once you have the binding file, you can run JiBX -to create the actual object. In order to do all that you'll need to -have the appropriate versions of the JiBX software.</p> -<p>Download the latest JiBX package (tested with JiBX v1.1) from -<a href= -"https://sourceforge.net/projects/jibx/";>https://sourceforge.net/projects/jibx/</a>. -Extract the zip file, and copy the JARs in the lib directory to the -AXIS2_HOME/lib directory. (Delete the stax-api.jar file; it's -superseded by the version that comes with Axis2.) These files -pertain to the main JiBX application.</p> -<p>Download <s><a href= -"http://sourceforge.net/project/showfiles.php?group_id=69358&package_id=122897";> -xsd2jibx version beta2a</a></s> <em>(Old SourceForge URL format - see <a href="https://sourceforge.net/projects/jibx/files/";>JiBX files</a>)</em> from Sourceforge. Create a directory -called xsd2jibx in your working directory and extract the files -into it. Unfortunately, this utility does not work with the latest -release of JiBX, so you will need to download <s><a href= -"http://sourceforge.net/project/showfiles.php?group_id=69358&package_id=68290";> -jibx-1.0RC1</a></s> <em>(Old SourceForge URL format - see <a href="https://sourceforge.net/projects/jibx/files/";>JiBX files</a>)</em> from Sourceforge. Extract the files from this -archive and place the *.jar files in the lib directory into the -xsd2jibx/lib directory. This way, you can use them exclusively with -the xsd2jibx utility.</p> -<p>You'll need an XML schema from which to generate the binding -file, which links XML elements to the Java classes. As defined in -the sample WSDL file, its content should be as shown in Code -Listing 2.</p> -<p><b>Code Listing 2: XML Schema</b></p> -<pre> -<?xml version="1.0" encoding="UTF-8"?> -<xsd:schema - elementFormDefault="qualified" - targetNamespace="http://apache.org/axis2/Axis2UserGuide"; - xmlns="http://www.w3.org/2001/XMLSchema"; - xmlns:xsd="http://www.w3.org/2001/XMLSchema"> - - <!-- ELEMENTS --> - <xsd:element name="DoInOnlyRequest"> - <xsd:complexType> - <xsd:sequence> - <xsd:element name="messageString" type="xsd:string"/> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - - <xsd:element name="TwoWayOneParameterEchoRequest"> - <xsd:complexType> - <xsd:sequence> - <xsd:element name="echoString" type="xsd:string"/> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - <xsd:element name="TwoWayOneParameterEchoResponse"> - <xsd:complexType> - <xsd:sequence> - <xsd:element name="echoString" type="xsd:string"/> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - - <xsd:element name="NoParametersRequest"> - <xsd:complexType/> - </xsd:element> - <xsd:element name="NoParametersResponse"> - <xsd:complexType/> - </xsd:element> - - <xsd:element name="MultipleParametersAddItemRequest"> - <xsd:complexType> - <xsd:sequence> - <xsd:element name="itemId" type="xsd:int"/> - <xsd:element name="itemName" type="xsd:string"/> - <xsd:element name="price" type="xsd:float"/> - <xsd:element name="description" type="xsd:string"/> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - - <xsd:element name="MultipleParametersAddItemResponse"> - <xsd:complexType> - <xsd:sequence> - <xsd:element name="itemId" type="xsd:int"/> - <xsd:element name="successfulAdd" type="xsd:boolean"/> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - -</xsd:schema> -</pre> -<p>Save the above XML schema file as Axis2UserGuide.xsd.</p> -<p>In order to map this schema into a JiBX binding file, you'll -need to use the xsd2jibx utility. Clear your CLASSPATH and add only -the .jar files in the xsd2jibx/lib directory. Execute the following -command to create the basic binding file:</p> -<pre> -java -jar xsd2jibx\lib\xsd2jibx.jar Axis2UserGuide.xsd -</pre> -<p>This operation creates the basic class files, as well as the -mapping file, called binding.xml. You'll use this file to do the -actual WSDL-to-Java conversion.</p> -<p>Remove the xsd2jibx .jar files from your CLASSPATH and add the -Axis2 .jar files back into it. Execute the command in Code Listing -3 to generate the stubs.</p> -<p><b>Code Listing 3: Generating the stubs</b></p> -<pre> -%AXIS2_HOME%\bin\WSDL2Java -uri Axis2UserGuide.wsdl -p org.apache.axis2.axis2userguide -d jibx -Ebindingfile org\apache\axis2\axis2userguide\binding.xml -s -</pre> -<p>Create the client file, Client.java, in the -org/apache/axis2/axis2userguide directory. Add the following code -in Code Listing 4.</p> -<p><b>Code Listing 4: Creating Client.java</b></p> -<pre> -package org.apache.axis2.axis2userguide; - -public class Client{ - public static void main(java.lang.String args[]){ - try{ - Axis2UserGuideServiceStub stub = - new Axis2UserGuideServiceStub - ("http://localhost:8080/axis2/services/Axis2UserGuideService";); - - doInOnly(stub); - twoWayOneParameterEcho(stub); - noParameters(stub); - multipleParameters(stub); - } catch(Exception e){ - e.printStackTrace(); - System.out.println("\n\n\n"); - } - } - - public static void doInOnly(Axis2UserGuideServiceStub stub){ - try{ - DoInOnlyRequest req = - new DoInOnlyRequest(); - - req.setMessageString("fire and forget it!"); - - stub.DoInOnly(req); - } catch(Exception e){ - e.printStackTrace(); - System.out.println("\n\n\n"); - } - } - - public static void twoWayOneParameterEcho(Axis2UserGuideServiceStub stub){ - try{ - TwoWayOneParameterEchoRequest req = - new TwoWayOneParameterEchoRequest(); - - req.setEchoString("echo! ... echo!"); - System.out.println(stub.TwoWayOneParameterEcho(req).getEchoString()); - } catch(Exception e){ - e.printStackTrace(); - System.out.println("\n\n\n"); - } - } - - public static void noParameters(Axis2UserGuideServiceStub stub){ - try{ - NoParametersRequest req = - new NoParametersRequest(); - - System.out.println(stub.NoParameters(req)); - } catch(Exception e){ - e.printStackTrace(); - System.out.println("\n\n\n"); - } - } - - public static void multipleParameters(Axis2UserGuideServiceStub stub){ - try{ - MultipleParametersAddItemRequest req = - new MultipleParametersAddItemRequest(); - - req.setPrice((float)1.99); - req.setItemId((int)23872983); - req.setDescription("Must have for cooking"); - req.setItemName("flour"); - - MultipleParametersAddItemResponse res = - stub.MultipleParametersAddItem(req); - - System.out.println(res.getItemId()); - System.out.println(res.getSuccessfulAdd()); - } catch(Exception e){ - e.printStackTrace(); - System.out.println("\n\n\n"); - } - } -} -</pre> -<p>Now it's time to compile the client. For the generated files to -be found, they need to be in the source directory, so copy the org -file to the src directory.</p> -<p>Compile the first set of classes by typing: <code>ant -jar.client</code></p> -<p>This action compiles most of the available classes, but not -everything. Fortunately, it does compile the classes needed by the -JiBX compiler, so you can now generate the actual JiBX resources. -Change to the build/classes directory and run the JiBX -compiler:</p> -<pre> -java -jar C:\apps\axis2\lib\jibx-bind.jar ..\..\org\apache\axis2\axis2userguide\binding.xml -</pre> -<p>Now that you have the new files in place, re-run the Ant task to -generate the client: <code>ant jar.client</code></p> -<p>This action adds all the appropriate files to the -build/lib/Axis2UserGuideService-test-client.jar file, so add that -.jar file to your CLASSPATH and run the client by typing: java -org.apache.axis2.axis2userguide.Client</p> -</body> -</html> diff --git a/src/site/xdoc/docs/userguide-creatingclients.xml b/src/site/xdoc/docs/userguide-creatingclients.xml index c476ca5ec0..d1e47c3398 100644 --- a/src/site/xdoc/docs/userguide-creatingclients.xml +++ b/src/site/xdoc/docs/userguide-creatingclients.xml @@ -104,8 +104,8 @@ Study</a></li> <a name="choosingclient" id="choosingclient"></a> <h2>Choosing a Client Generation Method</h2> <p>Axis2 gives you several options when it comes to mapping WSDL to -objects when generating clients. Three of these options are Axis2 -DataBinding Framework, XMLBeans, and JiBX databinding. All of these +objects when generating clients. Two of these options are the Axis2 +DataBinding Framework and XMLBeans. Both of these methods involve using databinding to create Java objects out of the XML structures used by the service, and each has its pros and cons. You can also generate XML in-out stubs that are not based on @@ -122,18 +122,10 @@ compiler, so it doesn't carry the same limitations as ADB. It is, however, a bit more complicated to use than ADB. It generates a huge number of files, and the programming model, while being certainly usable, is not as straightforward as ADB.</p> -<p>JiBX: JiBX is a complete databinding framework that actually -provides not only WSDL-to-Java conversion, as covered in this -document, but also Java-to-XML conversion. In some ways, JiBX -provides the best of both worlds. JiBX is extremely flexible, -enabling you to choose the classes that represent your entities, -but it can be complicated to set up. On the other hand, once it is -set up, actually using the generated code is as easy as using -ADB.</p> <p>In the end, for simple structures, ADB will likely be enough for you. If, on the other hand you need more power or flexibility, -whether you choose XMLBeans or JiBX depends on how much power or -flexibility you need and your tolerance for complexity.</p> +XMLBeans gives you a full schema compiler at the cost of some +complexity.</p> <a name="generating" id="generating"></a> <h2>Generating Clients</h2> <p>The process for generating and using a client varies slightly @@ -234,8 +226,7 @@ servlet container. It should look something like this:</p> "images/fig03.jpg" /><br clear="all" /></p> <p>ADB is not your only option for generating Web service clients. Other options include <a href= -"userguide-creatingclients-xmlbeans.html">XmlBeans</a>, <a href= -"userguide-creatingclients-jibx.html">JiBX</a> and +"userguide-creatingclients-xmlbeans.html">XmlBeans</a> and JAXBRI.</p> <p><strong>See the Next Section</strong> -<a href= "userguide-buildingservices.html#buildservices">Building diff --git a/src/site/xdoc/docs/userguide-forfurtherstudy.xml b/src/site/xdoc/docs/userguide-forfurtherstudy.xml index 566ebdf278..bb892dc505 100644 --- a/src/site/xdoc/docs/userguide-forfurtherstudy.xml +++ b/src/site/xdoc/docs/userguide-forfurtherstudy.xml @@ -102,7 +102,6 @@ Study</strong></a></li> <p><a href="http-transport.html">HTTP Transports</a></p> <p><a href="mtom-guide.html">MTOM with Axis2</a></p> <p><a href="https://axis.apache.org/axis2/java/rampart/";>Securing SOAP Messages with Apache Rampart</a></p> -<p><a href="soapmonitor-module.html">SOAPMonitor</a></p> <p><a href="adv-userguide.html">Apache Axis2 Advance User's Guide</a></p> </body> </html> diff --git a/src/site/xdoc/docs/userguide.xml b/src/site/xdoc/docs/userguide.xml index c2c49bfd9f..0ca6a84d48 100644 --- a/src/site/xdoc/docs/userguide.xml +++ b/src/site/xdoc/docs/userguide.xml @@ -308,7 +308,6 @@ WEB-INF modules.list addressing.mar ... - soapmonitor.mar services services.list aservice.aar diff --git a/src/site/xdoc/tools/CodegenToolReference.xml b/src/site/xdoc/tools/CodegenToolReference.xml index 9ea18fe56c..64d7713f4a 100644 --- a/src/site/xdoc/tools/CodegenToolReference.xml +++ b/src/site/xdoc/tools/CodegenToolReference.xml @@ -156,7 +156,7 @@ generation option.</td> <td width="20%">-d <databinding></td> <td width="20%">--databinding-method <databinding></td> <td width="60%">Specifies the Databinding framework. Valid values -are xmlbeans, adb, jibx, and none. Default is adb.</td> +are adb, xmlbeans, jaxbri, and none. Default is adb.</td> <td></td> </tr> <tr> @@ -335,7 +335,7 @@ using the target namespace of the WSDL) will be used. Maps to the <td>databindingName</td> <td>Data binding framework name. Maps to the -d option of the command line tool. Possible values include "adb", "xmlbeans", -"jibx","jaxbri".</td> +"jaxbri" and "none".</td> </tr> <tr> <td>serviceName</td>
