| <!DOCTYPE html> |
| |
| |
| <!-- |
| | Generated by Apache Maven Doxia Site Renderer 2.0.0 from src/site/markdown/docs/reference.md at 2025-03-05 |
| | Rendered using Apache Maven Fluido Skin 2.0.0-M11 |
| --> |
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1" /> |
| <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0" /> |
| <title>Axis2 Reference Guide – Apache Axis2</title> |
| <link rel="stylesheet" href="../css/apache-maven-fluido-2.0.0-M11.min.css" /> |
| <link rel="stylesheet" href="../css/site.css" /> |
| <link rel="stylesheet" href="../css/print.css" media="print" /> |
| <script src="../js/apache-maven-fluido-2.0.0-M11.min.js"></script> |
| </head> |
| <body> |
| <div class="container-fluid container-fluid-top"> |
| <header> |
| <div id="banner"> |
| <div class="pull-left"><div id="bannerLeft"><h1><a href="http://www.apache.org/"><img class="class java.lang.Object" src="http://www.apache.org/images/asf_logo_wide.png" /> Apache Axis2</a></h1></div></div> |
| <div class="pull-right"><div id="bannerRight"><h1><a href=".././"><img class="class java.lang.Object" src="../images/axis.jpg" /></a></h1></div></div> |
| <div class="clear"><hr/></div> |
| </div> |
| |
| <div id="breadcrumbs"> |
| <ul class="breadcrumb"> |
| <li id="publishDate">Last Published: 2025-03-04<span class="divider">|</span> |
| </li> |
| <li id="projectVersion">Version: 2.0.0<span class="divider">|</span></li> |
| <li><a href="http://www.apache.org" class="externalLink">Apache</a><span class="divider">/</span></li> |
| <li><a href="../index.html">Axis2/Java</a><span class="divider">/</span></li> |
| <li class="active">Axis2 Reference Guide</li> |
| </ul> |
| </div> |
| </header> |
| <div class="row-fluid"> |
| <header id="leftColumn" class="span2"> |
| <nav class="well sidebar-nav"> |
| <ul class="nav nav-list"> |
| <li class="nav-header">Axis2/Java</li> |
| <li><a href="../index.html">Home</a></li> |
| <li><a href="../download.html">Downloads</a></li> |
| <li><a href="javascript:void(0)"><span class="icon-chevron-down"></span>Release Notes</a> |
| <ul class="nav nav-list"> |
| <li><a href="../release-notes/1.6.1.html">1.6.1</a></li> |
| <li><a href="../release-notes/1.6.2.html">1.6.2</a></li> |
| <li><a href="../release-notes/1.6.3.html">1.6.3</a></li> |
| <li><a href="../release-notes/1.6.4.html">1.6.4</a></li> |
| <li><a href="../release-notes/1.7.0.html">1.7.0</a></li> |
| <li><a href="../release-notes/1.7.1.html">1.7.1</a></li> |
| <li><a href="../release-notes/1.7.2.html">1.7.2</a></li> |
| <li><a href="../release-notes/1.7.3.html">1.7.3</a></li> |
| <li><a href="../release-notes/1.7.4.html">1.7.4</a></li> |
| <li><a href="../release-notes/1.7.5.html">1.7.5</a></li> |
| <li><a href="../release-notes/1.7.6.html">1.7.6</a></li> |
| <li><a href="../release-notes/1.7.7.html">1.7.7</a></li> |
| <li><a href="../release-notes/1.7.8.html">1.7.8</a></li> |
| <li><a href="../release-notes/1.7.9.html">1.7.9</a></li> |
| <li><a href="../release-notes/1.8.0.html">1.8.0</a></li> |
| <li><a href="../release-notes/1.8.1.html">1.8.1</a></li> |
| <li><a href="../release-notes/1.8.2.html">1.8.2</a></li> |
| <li><a href="../release-notes/2.0.0.html">2.0.0</a></li> |
| </ul></li> |
| <li><a href="../modules/index.html">Modules</a></li> |
| <li><a href="../tools/index.html">Tools</a></li> |
| <li class="nav-header">Documentation</li> |
| <li><a href="../docs/toc.html">Table of Contents</a></li> |
| <li><a href="../docs/installationguide.html">Installation Guide</a></li> |
| <li><a href="../docs/quickstartguide.html">QuickStart Guide</a></li> |
| <li><a href="../docs/userguide.html">User Guide</a></li> |
| <li><a href="../docs/jaxws-guide.html">JAXWS Guide</a></li> |
| <li><a href="../docs/pojoguide.html">POJO Guide</a></li> |
| <li><a href="../docs/spring.html">Spring Guide</a></li> |
| <li><a href="../docs/webadminguide.html">Web Administrator's Guide</a></li> |
| <li><a href="../docs/migration.html">Migration Guide (from Axis1)</a></li> |
| <li class="nav-header">Resources</li> |
| <li><a href="../faq.html">FAQ</a></li> |
| <li><a href="../articles.html">Articles</a></li> |
| <li><a href="http://wiki.apache.org/ws/FrontPage/Axis2/" class="externalLink">Wiki</a></li> |
| <li><a href="../refLib.html">Reference Library</a></li> |
| <li><a href="../apidocs/index.html">Online Java Docs</a></li> |
| <li class="nav-header">Get Involved</li> |
| <li><a href="../overview.html">Overview</a></li> |
| <li><a href="../git.html">Checkout the Source</a></li> |
| <li><a href="../mail-lists.html">Mailing Lists</a></li> |
| <li><a href="../release-process.html">Release Process</a></li> |
| <li><a href="../guidelines.html">Developer Guidelines</a></li> |
| <li><a href="../siteHowTo.html">Build the Site</a></li> |
| <li class="nav-header">Project Information</li> |
| <li><a href="../team-list.html">Project Team</a></li> |
| <li><a href="../issue-tracking.html">Issue Tracking</a></li> |
| <li><a href="https://github.com/apache/axis-axis2-java-core" class="externalLink">Source Code</a></li> |
| <li><a href="../thanks.html">Acknowledgements</a></li> |
| <li class="nav-header">Apache</li> |
| <li><a href="http://www.apache.org/licenses/LICENSE-2.0.html" class="externalLink">License</a></li> |
| <li><a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink">Sponsorship</a></li> |
| <li><a href="http://www.apache.org/foundation/thanks.html" class="externalLink">Thanks</a></li> |
| <li><a href="http://www.apache.org/security/" class="externalLink">Security</a></li> |
| </ul> |
| </nav> |
| <div class="well sidebar-nav"> |
| <div id="poweredBy"> |
| <div class="clear"></div> |
| <div class="clear"></div> |
| <a href="https://maven.apache.org/" class="builtBy" target="_blank"><img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" /></a> |
| </div> |
| </div> |
| </header> |
| <main id="bodyColumn" class="span10"> |
| <!-- |
| ~ 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. |
| --> |
| <section><a id="Axis2_Reference_Guide"></a> |
| <h1>Axis2 Reference Guide</h1><section><a id="WSDL2Java_Reference"></a> |
| <h2>WSDL2Java Reference</h2> |
| |
| <pre class="prettyprint"><code class="nohighlight nocode">NAME |
| wsdl2java.sh or wsdl2java.bat - Generates java code according to a given WSDL file to handle Web service invocation. |
| These scripts can be found under the bin directory of the Axis2 distribution. |
| |
| SYNOPSIS |
| wsdl2java.sh [OPTION]... -uri <Location of WSDL> |
| |
| DESCRIPTION |
| Given a WSDL file, this generates java code to handle Web service invocations. |
| |
| -o <path> Specify a directory path for the generated code. |
| -a Generate async style code only (Default: off). |
| -s Generate sync style code only (Default: off). Takes precedence over -a. |
| -p <pkg1> Specify a custom package name for the generated code. |
| -l <language> Valid languages are java and c (Default: java). |
| -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). |
| -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. |
| -u Unpacks the databinding classes |
| -r <path> Specify a repository against which code is generated. |
| -ns2p ns1=pkg1,ns2=pkg2 Specify a custom package name for each namespace specified in the wsdls schema. |
| -ssi Generate an interface for the service implementation (Default: off). |
| -wv <version> WSDL Version. Valid Options : 2, 2.0, 1.1 |
| -S Specify a directory path for generated source |
| -R Specify a directory path for generated resources |
| -em Specify an external mapping file |
| -f Flattens the generated files |
| -uw Switch on un-wrapping. |
| -xsdconfig <file path> Use XMLBeans .xsdconfig file. Valid only with -d xmlbeans. |
| -ap Generate code for all ports |
| -or Overwrite the existing classes |
| -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 |
| -Eosv (for ADB) - turn off strict validation. |
| -Eiu (for ADB) - Ignore Unexpected elements instead of throwing ADBException |
| -Ewdc (for xmlbeans) - Generate code with a dummy schema. if someone use this option |
| they have to generate the xmlbeans code seperately with the scomp command comes with the |
| xmlbeans distribution and replace the Axis2 generated classes with correct classes |
| --noBuildXML Dont generate the build.xml in the output directory |
| --noWSDL Dont generate WSDLs in the resources directory |
| --noMessageReceiver Dont generate a MessageReceiver in the generated sources |
| --http-proxy-host Proxy host address if you are behind a firewall |
| --http-proxy-port Proxy prot address if you are behind a firewall |
| -ep Exclude packages - these packages are deleted after codegeneration |
| |
| EXAMPLES |
| wsdl2java.sh -uri ../samples/wsdl/Axis2SampleDocLit.wsdl |
| wsdl2java.sh -uri ../samples/wsdl/Axis2SampleDocLit.wsdl -ss -sd |
| wsdl2java.sh -uri ../samples/wsdl/Axis2SampleDocLit.wsdl -ss -sd -d xmlbeans -o ../samples -p org.apache.axis2.userguide |
| </code></pre></section><section><a id="Java2WSDL_Reference"></a> |
| <h2>Java2WSDL Reference</h2> |
| |
| <pre class="prettyprint"><code class="nohighlight nocode">NAME |
| Java2WSDL.sh or Java2WSDL.bat - Generates the appropriate WSDL file for a given java class. |
| These scripts can be found under the bin directory of the Axis2 distribution. |
| |
| SYNOPSIS |
| Java2WSDL.sh [OPTION]... -cn <fully qualified class name> |
| |
| DESCRIPTION |
| Given a java class generates a WSDL file for the given java class. |
| |
| -o <output location> output directory |
| -of <output file name> output file name for the WSDL |
| -sn <service name> service name |
| -l <one or more soap addresses> location URIs, comma-delimited |
| -cp <class path uri> list of classpath entries - (urls) |
| -tn <target namespace> target namespace for service |
| -tp <target namespace prefix> target namespace prefix for service |
| -stn <schema target namespace> target namespace for schema |
| -stp <schema target namespace prefix> target namespace prefix for schema |
| -st <binding style> style for the WSDL |
| -u <binding use> use for the WSDL |
| -nsg <class name> fully qualified name of a class that implements NamespaceGenerator |
| -sg <class name> fully qualified name of a class that implements SchemaGenerator |
| -p2n [<java package>,<namespace>] [<java package>,<namespace>] |
| java package to namespace mapping for argument and return types |
| -p2n [all, <namespace>] to assign all types to a single namespace |
| -efd <qualified/unqualified> setting for elementFormDefault (defaults to qualified) |
| -afd <qualified/unqualified> setting for attributeFormDefault (defaults to qualified) |
| -xc class1 -xc class2... extra class(es) for which schematype must be generated. |
| -wv <1.1/2.0> wsdl version - defaults to 1.1 if not specified |
| -dlb generate schemas conforming to doc/lit/bare style |
| -dne disallow nillable elements in the generated schema |
| -doe disallow optional elements in the generated schema |
| -disableSOAP11 disable binding generation for SOAP 1.1 |
| -disableSOAP12 disable binding generation for SOAP 1.2 |
| -disableREST disable binding generation for REST |
| |
| EXAMPLES |
| Java2WSDL.sh -cn ../samples/test/searchTool.Search |
| Java2WSDL.sh -cn ../samples/test/searchTool.Search -sn search |
| Java2WSDL.sh -cn ../samples/test/searchTool.Search -u -sn search |
| Java2WSDL.sh -cn ../samples/test/searchTool.Search -sn search -o ../samples/test/wsdl |
| </code></pre></section></section> </main> |
| </div> |
| </div> |
| <hr/> |
| <footer> |
| <div class="container-fluid"> |
| <div class="row-fluid"> |
| <p>© 2004–2025 |
| <a href="https://www.apache.org/">The Apache Software Foundation</a> |
| </p> |
| </div> |
| </div> |
| </footer> |
| </body> |
| </html> |
