blob: 125e4380d4b518147bebe1cfcf9edda1105a97f9 [file] [log] [blame]
<!DOCTYPE html>
<!--
| Generated by Apache Maven Doxia at 2015-07-03
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<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="20150703" />
<meta http-equiv="Content-Language" content="en" />
<title>Ant Tasks &#x2013; Axis-java2wsdl Task</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.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.3.0.min.js"></script>
</head>
<body class="topBarDisabled">
<div class="container-fluid">
<div id="banner">
<div class="pull-left">
<div id="bannerLeft">
<h2>Ant Tasks</h2>
</div>
</div>
<div class="pull-right"> <a href=".." id="bannerRight">
<img src="../images/axis-small.png" alt="Apache Axis"/>
</a>
</div>
<div class="clear"><hr/></div>
</div>
<div id="breadcrumbs">
<ul class="breadcrumb">
<li class="">
<a href="http://www.apache.org/" class="externalLink" title="Apache">
Apache</a>
</li>
<li class="divider ">/</li>
<li class="">
<a href="../../../" title="Axis">
Axis</a>
</li>
<li class="divider ">/</li>
<li class="">
<a href="../../" title="Axis 1.x">
Axis 1.x</a>
</li>
<li class="divider ">/</li>
<li class="">
<a href="../" title="Java">
Java</a>
</li>
<li class="divider ">/</li>
<li class="">
<a href="./" title="Ant Tasks">
Ant Tasks</a>
</li>
<li class="divider ">/</li>
<li class="">Axis-java2wsdl Task</li>
<li id="publishDate" class="pull-right">Last Published: 2015-07-03</li> <li class="divider pull-right">|</li>
<li id="projectVersion" class="pull-right">Version: 1.4.1-SNAPSHOT</li>
</ul>
</div>
<div class="row-fluid">
<div id="leftColumn" class="span3">
<div class="well sidebar-nav">
<ul class="nav nav-list">
<li class="nav-header">Overview</li>
<li>
<a href="ant.html" title="Introduction">
<i class="none"></i>
Introduction</a>
</li>
<li>
<a href="dependencies.html" title="Dependencies">
<i class="none"></i>
Dependencies</a>
</li>
<li class="nav-header">Tasks</li>
<li>
<a href="axis-admin.html" title="axis-admin">
<i class="none"></i>
axis-admin</a>
</li>
<li class="active">
<a href="#"><i class="none"></i>axis-java2wsdl</a>
</li>
<li>
<a href="axis-wsdl2java.html" title="axis-wsdl2java">
<i class="none"></i>
axis-wsdl2java</a>
</li>
<li>
<a href="foreach.html" title="foreach">
<i class="none"></i>
foreach</a>
</li>
<li>
<a href="runaxisfunctionaltests.html" title="runaxisfunctionaltests">
<i class="none"></i>
runaxisfunctionaltests</a>
</li>
<li class="nav-header">Apache</li>
<li>
<a href="http://www.apache.org/licenses/LICENSE-2.0.html" class="externalLink" title="License">
<i class="none"></i>
License</a>
</li>
<li>
<a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsorship">
<i class="none"></i>
Sponsorship</a>
</li>
<li>
<a href="http://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks">
<i class="none"></i>
Thanks</a>
</li>
<li>
<a href="http://www.apache.org/security/" class="externalLink" title="Security">
<i class="none"></i>
Security</a>
</li>
</ul>
<form id="search-form" action="http://www.google.com/search" method="get" >
<input value="ws.apache.org/axis/java" name="sitesearch" type="hidden"/>
<input class="search-query" name="q" id="query" type="text" />
</form>
<script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=search-form"></script>
<hr class="divider" />
<div id="poweredBy">
<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="span9" >
<!-- ~ 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. -->
<div class="section">
<h2><a name="Description"></a>Description</h2>
<p>Generates a WSDL description from a Java class.</p>
</div>
<div class="section">
<h2><a name="Parameters"></a>Parameters</h2>
<table border="0" class="table table-striped">
<tr class="a">
<th>Attribute</th>
<th>Description</th>
<th>Type</th>
</tr>
<tr class="b">
<td>bindingname</td>
<td>The name to use use for the binding element. If not specified, the value of the <tt>servicePortName</tt> + &quot;SoapBinding&quot; is used.</td>
<td>String</td>
</tr>
<tr class="a">
<td>classname</td>
<td>the class name to import, eg. org.example.Foo. Required. The class must be on the classpath.</td>
<td>String</td>
</tr>
<tr class="b">
<td>exclude</td>
<td>Comma separated list of methods to exclude from the wsdl file.</td>
<td>String</td>
</tr>
<tr class="a">
<td>extraclasses</td>
<td>The setter for the &quot;extraClasses&quot; attribute</td>
<td>String</td>
</tr>
<tr class="b">
<td>implclass</td>
<td>Sometimes extra information is available in the implementation class file. Use this option to specify the implementation class.</td>
<td>String</td>
</tr>
<tr class="a">
<td>importschema</td>
<td>Option attribute that indicates the name of an XML Schema file that should be physically imported into the generated WSDL.</td>
<td>File</td>
</tr>
<tr class="b">
<td>input</td>
<td>Optional attribute that indicates the name of the input wsdl file. The output wsdl file will contain everything from the input wsdl file plus the new constructs. If a new construct is already present in the input wsdl file, it is not added. This option is useful for constructing a wsdl file with multiple ports, bindings, or portTypes.</td>
<td>File</td>
</tr>
<tr class="a">
<td>location</td>
<td>The url of the location of the service. The name after the last slash or backslash is the name of the service port (unless overridden by the -s option). The service port address location attribute is assigned the specified value.</td>
<td>String</td>
</tr>
<tr class="b">
<td>locationimport</td>
<td>the location of the interface WSDL when generating an implementation WSDL Required when <tt>outputImpl</tt> is set</td>
<td>String</td>
</tr>
<tr class="a">
<td>methods</td>
<td>If this option is specified, only the indicated methods in your interface class will be exported into the WSDL file. The methods list must be comma separated. If not specified, all methods declared in the interface class will be exported into the WSDL file</td>
<td>String</td>
</tr>
<tr class="b">
<td>namespace</td>
<td>the target namespace. Required.</td>
<td>String</td>
</tr>
<tr class="a">
<td>namespaceimpl</td>
<td>Namespace of the implementation WSDL.</td>
<td>String</td>
</tr>
<tr class="b">
<td>output</td>
<td>The name of the output WSDL file. If not specified, a suitable default WSDL file is written into the current directory.</td>
<td>java.io.File</td>
</tr>
<tr class="a">
<td>outputimpl</td>
<td>Use this option to indicate the name of the output implementation WSDL file. If specified, Java2WSDL will produce separate interface and implementation WSDL files. If not, a single WSDL file is generated</td>
<td>File</td>
</tr>
<tr class="b">
<td>porttypename</td>
<td>Indicates the name to use use for the portType element. If not specified, the class-of-portType name is used.</td>
<td>String</td>
</tr>
<tr class="a">
<td>serviceelementname</td>
<td>the name of the service element. If not specified, the service element is the <tt>portTypeName</tt>Service.</td>
<td>String</td>
</tr>
<tr class="b">
<td>serviceportname</td>
<td>service port name (obtained from location if not specified)</td>
<td>String</td>
</tr>
<tr class="a">
<td>soapaction</td>
<td>The setter for the &quot;soapAction&quot; attribute</td>
<td>String</td>
</tr>
<tr class="b">
<td>stopclasses</td>
<td>Comma separated list of classes which stop the Java2WSDL inheritance search.</td>
<td>String</td>
</tr>
<tr class="a">
<td>style</td>
<td>The style of the WSDL document: RPC, DOCUMENT or WRAPPED. If RPC, a rpc/encoded wsdl is generated. If DOCUMENT, a document/literal wsdl is generated. If WRAPPED, a document/literal wsdl is generated using the wrapped approach.</td>
<td>String</td>
</tr>
<tr class="b">
<td>typemappingversion</td>
<td>the default type mapping registry to use. Either 1.1 or 1.2. Default is 1.1</td>
<td>&quot;1.1&quot;, &quot;1.2&quot;</td>
</tr>
<tr class="a">
<td>use</td>
<td>Set the use option</td>
<td>String</td>
</tr>
<tr class="b">
<td>useinheritedmethods</td>
<td>should inherited methods be exported too? Default=false</td>
<td>boolean</td>
</tr>
</table>
</div>
<div class="section">
<h2><a name="Parameters_as_nested_elements"></a>Parameters as nested elements</h2>
<dl>
<dt>complextype (org.apache.axis.tools.ant.wsdl.ComplexType)</dt>
<dd>Nested element for Complex Types. Each Complex Type uses the following fields:</dd>
<dt>mapping (org.apache.axis.tools.ant.wsdl.NamespaceMapping)</dt>
<dd>add a mapping of namespaces to packages</dd>
<dt>mappingset (org.apache.axis.tools.ant.wsdl.MappingSet)</dt>
<dd>add a mapping of namespaces to packages</dd>
<dt>classpath (org.apache.tools.ant.types.Path)</dt>
<dd>add a classpath containing the java classes.</dd>
</dl>
</div>
</div>
</div>
</div>
<hr/>
<footer>
<div class="container-fluid">
<div class="row span12">Copyright &copy; 2000-2015
<a href="http://www.apache.org/">The Apache Software Foundation</a>.
All Rights Reserved.
</div>
</div>
</footer>
</body>
</html>