blob: 2f574d2eba9dc0f0d8add188e43b56bcbf608690 [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>wsdl2java-maven-plugin &#x2013; wsdl2java:generate-sources</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>wsdl2java-maven-plugin</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="Maven plugins">
Maven plugins</a>
</li>
<li class="divider ">/</li>
<li class="">
<a href="./" title="wsdl2java-maven-plugin">
wsdl2java-maven-plugin</a>
</li>
<li class="divider ">/</li>
<li class="">wsdl2java:generate-sources</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="index.html" title="Introduction">
<i class="none"></i>
Introduction</a>
</li>
<li>
<a href="plugin-info.html" title="Goals">
<i class="none"></i>
Goals</a>
</li>
<li class="nav-header">Examples</li>
<li>
<a href="java-xml-type-mappings.html" title="Changing the Java class associated with an XML type">
<i class="none"></i>
Changing the Java class associated with an XML type</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" >
<div class="section">
<h2><a name="wsdl2java:generate-sources"></a>wsdl2java:generate-sources</h2>
<p><b>Full name</b>:</p>
<p>org.apache.axis:wsdl2java-maven-plugin:1.4.1-SNAPSHOT:generate-sources</p>
<p><b>Description</b>:</p>
<div>Create Java classes from local or remote WSDL.</div>
<p><b>Attributes</b>:</p>
<ul>
<li>Requires a Maven project to be executed.</li>
<li>Binds by default to the lifecycle phase: <tt>generate-sources</tt>.</li>
</ul>
<div class="section">
<h3><a name="Required_Parameters"></a>Required Parameters</h3>
<table class="table table-striped" border="0">
<tr class="a">
<th>Name</th>
<th>Type</th>
<th>Since</th>
<th>Description</th>
</tr>
<tr class="b">
<td><b><a href="#generate">generate</a></b></td>
<td><tt>String</tt></td>
<td><tt>-</tt></td>
<td>Specifies what artifacts should be generated. Valid values are:
<ul>
<li><tt>client</tt>: generate client stubs</li>
<li><tt>server</tt>: generate server side artifacts</li>
<li><tt>both</tt>: generate all artifacts</li>
</ul>
The <tt>server</tt> mode can also be used for clients that rely
on dynamic proxies created using the JAX-RPC
<tt>ServiceFactory</tt> API, because they don't need client
stubs. <br />
Also note that the <tt>both</tt> mode is only really meaningful
if <tt>skeleton</tt> is set to <tt>true</tt> or if
<tt>deployWsdd</tt> is specified. If none of these conditions
is satisfied, then <tt>client</tt> and <tt>both</tt> will
generate the same set of artifacts.<br /></td>
</tr>
</table>
</div>
<div class="section">
<h3><a name="Optional_Parameters"></a>Optional Parameters</h3>
<table class="table table-striped" border="0">
<tr class="a">
<th>Name</th>
<th>Type</th>
<th>Since</th>
<th>Description</th>
</tr>
<tr class="b">
<td><b><a href="#all">all</a></b></td>
<td><tt>boolean</tt></td>
<td><tt>-</tt></td>
<td>flag to generate code for all elements, even unreferenced ones<br /><b>Default value is</b>: <tt>false</tt>.</td>
</tr>
<tr class="a">
<td><b><a href="#allowInvalidURL">allowInvalidURL</a></b></td>
<td><tt>boolean</tt></td>
<td><tt>-</tt></td>
<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.</td>
</tr>
<tr class="b">
<td><b><a href="#catalog">catalog</a></b></td>
<td><tt>File</tt></td>
<td><tt>-</tt></td>
<td>The catalog file to resolve external entity references. This can be
any type of catalog supported by <a class="externalLink" href="http://xerces.apache.org/xml-commons/components/resolver/">xml-resolver</a>.<br /></td>
</tr>
<tr class="a">
<td><b><a href="#deployScope">deployScope</a></b></td>
<td><tt>String</tt></td>
<td><tt>-</tt></td>
<td>Determines the scope that will be specified for the service in the
deployment WSDD. Valid values are <tt>application</tt>,
<tt>request</tt> and <tt>session</tt>. This parameter has
no effect if <tt>generate</tt> is set to <tt>client</tt> or
if <tt>deployWsdd</tt> is not specified. If this parameter is
not specified, then no explicit scope will be configured in the
deployment WSDD, in which case the scope defaults to
<tt>request</tt>. <br />
Note that these semantics (in particular the default scope
<tt>request</tt>) are compatible with the
<tt>deployScope</tt> parameter of the wsdl2java Ant task. This
simplifies the migration of Ant builds to Maven. However, for most
services, <tt>application</tt> is a more reasonable setting.<br /></td>
</tr>
<tr class="b">
<td><b><a href="#deployWsdd">deployWsdd</a></b></td>
<td><tt>File</tt></td>
<td><tt>-</tt></td>
<td>The location of the deployment WSDD file to be generated. This
parameter is ignored if <tt>generate</tt> is set to
<tt>client</tt>. If this parameter is not specified, then no
deployment WSDD will be generated.<br /></td>
</tr>
<tr class="a">
<td><b><a href="#file">file</a></b></td>
<td><tt>File</tt></td>
<td><tt>-</tt></td>
<td>The WSDL file to process.<br /></td>
</tr>
<tr class="b">
<td><b><a href="#helperGen">helperGen</a></b></td>
<td><tt>boolean</tt></td>
<td><tt>-</tt></td>
<td>Turn on/off Helper class generation.<br /><b>Default value is</b>: <tt>false</tt>.</td>
</tr>
<tr class="a">
<td><b><a href="#implementationClassName">implementationClassName</a></b></td>
<td><tt>String</tt></td>
<td><tt>-</tt></td>
<td>Set the name of the class implementing the web service. This
parameter is ignored if <tt>generate</tt> is set to
<tt>client</tt>. If this parameter is not specified, then a
default class name will be chosen if necessary.<br /></td>
</tr>
<tr class="b">
<td><b><a href="#javaXmlTypeMappings">javaXmlTypeMappings</a></b></td>
<td><tt>JavaXmlTypeMapping[]</tt></td>
<td><tt>-</tt></td>
<td>A set of Java to XML type mappings that override the default
mappings. This can be used to <a href="java-xml-type-mappings.html">change the Java class associated
with an XML type</a>.<br /></td>
</tr>
<tr class="a">
<td><b><a href="#mappings">mappings</a></b></td>
<td><tt>Mapping[]</tt></td>
<td><tt>-</tt></td>
<td>Mappings of namespaces to packages.<br /></td>
</tr>
<tr class="b">
<td><b><a href="#noWrapped">noWrapped</a></b></td>
<td><tt>boolean</tt></td>
<td><tt>-</tt></td>
<td>Set the noWrapped flag.<br /><b>Default value is</b>: <tt>false</tt>.</td>
</tr>
<tr class="a">
<td><b><a href="#skeleton">skeleton</a></b></td>
<td><tt>boolean</tt></td>
<td><tt>-</tt></td>
<td>Specifies whether a skeleton should be generated. If this parameter
is set to <tt>false</tt>, a skeleton will not be generated.
Instead, the generated deployment WSDD will indicate that the
implementation class is deployed directly. In such cases, the WSDD
contains extra meta data describing the operations and parameters
of the implementation class. This parameter is ignored if
<tt>generate</tt> is set to <tt>client</tt>.<br /><b>Default value is</b>: <tt>false</tt>.</td>
</tr>
<tr class="b">
<td><b><a href="#sourceOutputDirectory">sourceOutputDirectory</a></b></td>
<td><tt>File</tt></td>
<td><tt>-</tt></td>
<td>Output directory for generated Java files.<br /><b>Default value is</b>: <tt>${project.build.directory}/generated-sources/wsdl2java</tt>.</td>
</tr>
<tr class="a">
<td><b><a href="#testSourceOutputDirectory">testSourceOutputDirectory</a></b></td>
<td><tt>File</tt></td>
<td><tt>-</tt></td>
<td>Output directory used for the stub and locator if
<tt>writeStubToTestSources</tt> is <tt>true</tt>.<br /><b>Default value is</b>: <tt>${project.build.directory}/generated-test-sources/wsdl2java</tt>.</td>
</tr>
<tr class="b">
<td><b><a href="#typeMappingVersion">typeMappingVersion</a></b></td>
<td><tt>String</tt></td>
<td><tt>-</tt></td>
<td>The default type mapping registry to use. Either 1.1 or 1.2.<br /><b>Default value is</b>: <tt>1.2</tt>.</td>
</tr>
<tr class="a">
<td><b><a href="#undeployWsdd">undeployWsdd</a></b></td>
<td><tt>File</tt></td>
<td><tt>-</tt></td>
<td>The location of the undeployment WSDD file to be generated. This
parameter is ignored if <tt>generate</tt> is set to
<tt>client</tt>. If this parameter is not specified, then no
undeployment WSDD will be generated. Note that (in contrast to
<tt>deployWsdd</tt>) this parameter is rarely used: in general,
no undeployment WSDD is required.<br /></td>
</tr>
<tr class="b">
<td><b><a href="#url">url</a></b></td>
<td><tt>String</tt></td>
<td><tt>-</tt></td>
<td>The URL of the WSDL to process. This should only be used for remote
WSDLs. For local files, use the <tt>file</tt> parameter.<br /></td>
</tr>
<tr class="a">
<td><b><a href="#wrapArrays">wrapArrays</a></b></td>
<td><tt>boolean</tt></td>
<td><tt>-</tt></td>
<td>Set the wrap arrays flag - if true this will make new classes like
&quot;ArrayOfString&quot; for literal &quot;wrapped&quot; arrays. Otherwise it will use
&quot;String []&quot; and generate appropriate metadata.<br /><b>Default value is</b>: <tt>false</tt>.</td>
</tr>
<tr class="b">
<td><b><a href="#writeStubToTestSources">writeStubToTestSources</a></b></td>
<td><tt>boolean</tt></td>
<td><tt>-</tt></td>
<td>Flag indicating whether the stub and locator should be written to
<tt>sourceOutputDirectory</tt> (<tt>false</tt>) or to
<tt>testSourceOutputDirectory</tt> (<tt>true</tt>). Set
this parameter to <tt>true</tt> if the main artifact of your
project should not contain client-side code, but you need it in
your test cases. Note that this parameter is only meaningful if
<tt>generate</tt> is set to <tt>both</tt>.<br /><b>Default value is</b>: <tt>false</tt>.</td>
</tr>
</table>
</div>
<div class="section">
<h3><a name="Parameter_Details"></a>Parameter Details</h3>
<p><b><a name="all">all</a>:</b></p>
<div>flag to generate code for all elements, even unreferenced ones</div>
<ul>
<li><b>Type</b>: <tt>boolean</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>Default</b>: <tt>false</tt></li>
</ul><hr />
<p><b><a name="allowInvalidURL">allowInvalidURL</a>:</b></p>
<div>(no description)</div>
<ul>
<li><b>Type</b>: <tt>boolean</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>Default</b>: <tt>false</tt></li>
</ul><hr />
<p><b><a name="catalog">catalog</a>:</b></p>
<div>The catalog file to resolve external entity references. This can be
any type of catalog supported by <a class="externalLink" href="http://xerces.apache.org/xml-commons/components/resolver/">xml-resolver</a>.</div>
<ul>
<li><b>Type</b>: <tt>java.io.File</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
</ul><hr />
<p><b><a name="deployScope">deployScope</a>:</b></p>
<div>Determines the scope that will be specified for the service in the
deployment WSDD. Valid values are <tt>application</tt>,
<tt>request</tt> and <tt>session</tt>. This parameter has
no effect if <tt>generate</tt> is set to <tt>client</tt> or
if <tt>deployWsdd</tt> is not specified. If this parameter is
not specified, then no explicit scope will be configured in the
deployment WSDD, in which case the scope defaults to
<tt>request</tt>. <br />
Note that these semantics (in particular the default scope
<tt>request</tt>) are compatible with the
<tt>deployScope</tt> parameter of the wsdl2java Ant task. This
simplifies the migration of Ant builds to Maven. However, for most
services, <tt>application</tt> is a more reasonable setting.</div>
<ul>
<li><b>Type</b>: <tt>java.lang.String</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
</ul><hr />
<p><b><a name="deployWsdd">deployWsdd</a>:</b></p>
<div>The location of the deployment WSDD file to be generated. This
parameter is ignored if <tt>generate</tt> is set to
<tt>client</tt>. If this parameter is not specified, then no
deployment WSDD will be generated.</div>
<ul>
<li><b>Type</b>: <tt>java.io.File</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
</ul><hr />
<p><b><a name="file">file</a>:</b></p>
<div>The WSDL file to process.</div>
<ul>
<li><b>Type</b>: <tt>java.io.File</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
</ul><hr />
<p><b><a name="generate">generate</a>:</b></p>
<div>Specifies what artifacts should be generated. Valid values are:
<ul>
<li><tt>client</tt>: generate client stubs</li>
<li><tt>server</tt>: generate server side artifacts</li>
<li><tt>both</tt>: generate all artifacts</li>
</ul>
The <tt>server</tt> mode can also be used for clients that rely
on dynamic proxies created using the JAX-RPC
<tt>ServiceFactory</tt> API, because they don't need client
stubs. <br />
Also note that the <tt>both</tt> mode is only really meaningful
if <tt>skeleton</tt> is set to <tt>true</tt> or if
<tt>deployWsdd</tt> is specified. If none of these conditions
is satisfied, then <tt>client</tt> and <tt>both</tt> will
generate the same set of artifacts.</div>
<ul>
<li><b>Type</b>: <tt>java.lang.String</tt></li>
<li><b>Required</b>: <tt>Yes</tt></li>
</ul><hr />
<p><b><a name="helperGen">helperGen</a>:</b></p>
<div>Turn on/off Helper class generation.</div>
<ul>
<li><b>Type</b>: <tt>boolean</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>Default</b>: <tt>false</tt></li>
</ul><hr />
<p><b><a name="implementationClassName">implementationClassName</a>:</b></p>
<div>Set the name of the class implementing the web service. This
parameter is ignored if <tt>generate</tt> is set to
<tt>client</tt>. If this parameter is not specified, then a
default class name will be chosen if necessary.</div>
<ul>
<li><b>Type</b>: <tt>java.lang.String</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
</ul><hr />
<p><b><a name="javaXmlTypeMappings">javaXmlTypeMappings</a>:</b></p>
<div>A set of Java to XML type mappings that override the default
mappings. This can be used to <a href="java-xml-type-mappings.html">change the Java class associated
with an XML type</a>.</div>
<ul>
<li><b>Type</b>: <tt>org.apache.axis.tools.maven.wsdl2java.JavaXmlTypeMapping[]</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
</ul><hr />
<p><b><a name="mappings">mappings</a>:</b></p>
<div>Mappings of namespaces to packages.</div>
<ul>
<li><b>Type</b>: <tt>org.apache.axis.tools.maven.shared.nsmap.Mapping[]</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
</ul><hr />
<p><b><a name="noWrapped">noWrapped</a>:</b></p>
<div>Set the noWrapped flag.</div>
<ul>
<li><b>Type</b>: <tt>boolean</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>Default</b>: <tt>false</tt></li>
</ul><hr />
<p><b><a name="skeleton">skeleton</a>:</b></p>
<div>Specifies whether a skeleton should be generated. If this parameter
is set to <tt>false</tt>, a skeleton will not be generated.
Instead, the generated deployment WSDD will indicate that the
implementation class is deployed directly. In such cases, the WSDD
contains extra meta data describing the operations and parameters
of the implementation class. This parameter is ignored if
<tt>generate</tt> is set to <tt>client</tt>.</div>
<ul>
<li><b>Type</b>: <tt>boolean</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>Default</b>: <tt>false</tt></li>
</ul><hr />
<p><b><a name="sourceOutputDirectory">sourceOutputDirectory</a>:</b></p>
<div>Output directory for generated Java files.</div>
<ul>
<li><b>Type</b>: <tt>java.io.File</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>Default</b>: <tt>${project.build.directory}/generated-sources/wsdl2java</tt></li>
</ul><hr />
<p><b><a name="testSourceOutputDirectory">testSourceOutputDirectory</a>:</b></p>
<div>Output directory used for the stub and locator if
<tt>writeStubToTestSources</tt> is <tt>true</tt>.</div>
<ul>
<li><b>Type</b>: <tt>java.io.File</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>Default</b>: <tt>${project.build.directory}/generated-test-sources/wsdl2java</tt></li>
</ul><hr />
<p><b><a name="typeMappingVersion">typeMappingVersion</a>:</b></p>
<div>The default type mapping registry to use. Either 1.1 or 1.2.</div>
<ul>
<li><b>Type</b>: <tt>java.lang.String</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>Default</b>: <tt>1.2</tt></li>
</ul><hr />
<p><b><a name="undeployWsdd">undeployWsdd</a>:</b></p>
<div>The location of the undeployment WSDD file to be generated. This
parameter is ignored if <tt>generate</tt> is set to
<tt>client</tt>. If this parameter is not specified, then no
undeployment WSDD will be generated. Note that (in contrast to
<tt>deployWsdd</tt>) this parameter is rarely used: in general,
no undeployment WSDD is required.</div>
<ul>
<li><b>Type</b>: <tt>java.io.File</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
</ul><hr />
<p><b><a name="url">url</a>:</b></p>
<div>The URL of the WSDL to process. This should only be used for remote
WSDLs. For local files, use the <tt>file</tt> parameter.</div>
<ul>
<li><b>Type</b>: <tt>java.lang.String</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
</ul><hr />
<p><b><a name="wrapArrays">wrapArrays</a>:</b></p>
<div>Set the wrap arrays flag - if true this will make new classes like
&quot;ArrayOfString&quot; for literal &quot;wrapped&quot; arrays. Otherwise it will use
&quot;String []&quot; and generate appropriate metadata.</div>
<ul>
<li><b>Type</b>: <tt>boolean</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>Default</b>: <tt>false</tt></li>
</ul><hr />
<p><b><a name="writeStubToTestSources">writeStubToTestSources</a>:</b></p>
<div>Flag indicating whether the stub and locator should be written to
<tt>sourceOutputDirectory</tt> (<tt>false</tt>) or to
<tt>testSourceOutputDirectory</tt> (<tt>true</tt>). Set
this parameter to <tt>true</tt> if the main artifact of your
project should not contain client-side code, but you need it in
your test cases. Note that this parameter is only meaningful if
<tt>generate</tt> is set to <tt>both</tt>.</div>
<ul>
<li><b>Type</b>: <tt>boolean</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>Default</b>: <tt>false</tt></li>
</ul>
</div>
</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>