axistools:wsdl2java

Full name:

org.codehaus.mojo:axistools-maven-plugin:1.4:wsdl2java

Description:

A Plugin for generating stubs for WSDL files using Axis WSDL2Java.

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Requires dependency resolution of artifacts in scope: test.
  • Binds by default to the lifecycle phase: generate-sources.

Required Parameters

Name Type Since Description
outputDirectory File - Location to place generated java source files. Corresponds to the -o, --output option in the WSDL2Java command line tool.
Default value is: ${project.build.directory}/generated-sources/axistools/wsdl2java.
timestampDirectory File - Directory used when evaluating whether files are up to date or stale.
Default value is: ${project.build.directory}.

Optional Parameters

Name Type Since Description
allElements boolean - Generate code for all elements, even unreferenced ones. By default, WSDL2Java only generates code for those elements in the WSDL file that are referenced. A note about what it means to be referenced. We cannot simply say: start with the services, generate all bindings referenced by the service, generate all portTypes referenced by the referenced bindings, etc. What if we're generating code from a WSDL file that only contains portTypes, messages, and types? If WSDL2Java used service as an anchor, and there's no service in the file, then nothing will be generated. So the anchor is the lowest element that exists in the WSDL file in the order:
  1. types
  2. portTypes
  3. bindings
  4. services
For example, if a WSDL file only contained types, then all the listed types would be generated. But if a WSDL file contained types and a portType, then that portType will be generated and only those types that are referenced by that portType. Note that the anchor is searched for in the WSDL file appearing on the command line, not in imported WSDL files. This allows one WSDL file to import constructs defined in another WSDL file without the nuisance of having all the imported WSDL file's constructs generated. Corresponds to the -a, --all option in the WSDL2Java command line tool.
debug boolean - Print debug information, which currently is WSDL2Java's symbol table. Note that this is only printed after the symbol table is complete, ie., after the WSDL is parsed successfully. Corresponds to the -D, --Debug option in the WSDL2Java command line tool.
Default value is: false.
deployScope String - Add scope to deploy.xml: "Application", "Request", "Session". Corresponds to the -d, --deployScope option in the WSDL2Java command line tool.
factory String - Name of a custom class that implements GeneratorFactory interface (for extending Java generation functions). Corresponds to the -F, --factory option in the WSDL2Java command line tool.
fileNamespaceToPackage File - File containing namespace to package mappings. Corresponds to the -f, --fileNStoPkg option in the WSDL2Java command line tool.
helperGen boolean - Emits separate Helper classes for meta data. Corresponds to the -H, --helperGen option in the WSDL2Java command line tool.
Default value is: false.
implementationClassName String - Use this as the implementation class. Corresponds to the -c, --implementationClassName option in the WSDL2Java command line tool.
mappings ArrayList - Mappings of <namespace> to <targetPackage>.
namespaceToPackage String - Mapping of namespace to package. This is only used when useEmitter is set to true. If useEmitter is set to false you should use mappings instead. Corresponds to the -N, --NStoPkg option in the WSDL2Java command line tool.
noImports boolean - Only generate code for the immediate WSDL document. Corresponds to the -n, --noImports option in the WSDL2Java command line tool.
Default value is: false.
noWrapped boolean - Turn off support for "wrapped" document/literal. Corresponds to the -W, --noWrapped option in the WSDL2Java command line tool.
Default value is: false.
nsExcludes ArrayList - Namespace to specifically exclude from the generated code (defaults to none excluded until first namespace included with nsIncludes option). Corresponds to the -x, --nsExclude option in the WSDL2Java command line tool.
nsIncludes ArrayList - Namescape to specifically include in the generated code (defaults to all namespaces unless specifically excluded with the nsExcludes option). Corresponds to the -i, --nsInclude option in the WSDL2Java command line tool.
packageSpace String - Package to create the java files under, for example com.company.wsdl. Corresponds to the -p, --package option in the WSDL2Java command line tool.
password String - Password to access the WSDL-URI. Corresponds to the -P, --password option in the WSDL2Java command line tool.
runTestCasesAsUnitTests boolean - Copy the generated test cases to a generated-sources test directory to be compiled and run as normal Surefire unit tests.
Default value is: false.
serverSide boolean - Emit server-side bindings for web service. Corresponds to the -s, --server-side option in the WSDL2Java command line tool.
skeletonDeploy boolean - Deploy skeleton (true) or implementation (false) in deploy.wsdd. Corresponds to the -S, --skeletonDeploy option in the WSDL2Java command line tool.
Default value is: false.
sourceDependencies ArrayList - List of source dependencies in the format groupId:artifactId:version:file.
sourceDependencyDirectory File - Cache directory for WSDLs from sourceDependencies.
Default value is: ${project.build.directory}/axistools/wsdl2java/sourceDependencies.
sourceDirectory File - Source directory that contains .wsdl files.
Default value is: ${basedir}/src/main/wsdl.
staleMillis int - The granularity in milliseconds of the last modification date for testing whether a source needs recompilation.
Default value is: 0.
subPackageByFileName boolean - load.wsdl would further subpackage into load.*
testCases boolean - Generate the test cases. Corresponds to the -t, --testCase option in the WSDL2Java command line tool.
testSourceDirectory File - Location to place generated test source files.
Default value is: ${project.build.directory}/generated-test-sources/wsdl.
timeout Integer - Timeout in seconds (default is 45, specify -1 to disable). Corresponds to the -O, --timeout option in the WSDL2Java command line tool.
typeMappingVersion String - Indicate either 1.1 or 1.2, where 1.1 means SOAP 1.1 JAX-RPC compliant and 1.2 indicates SOAP 1.1 encoded. Corresponds to the -T, --typeMappingVersion option in the WSDL2Java command line tool.
Default value is: 1.1.
urlDownloadDirectory File - Cache directory for WSDLs from URLs.
Default value is: ${project.build.directory}/axistools/wsdl2java/urlDownloads.
urls ArrayList - List of URLs to process.
useEmitter boolean - Use the Emitter for generating the java files as opposed to the commandline wsdl2java tool.
Default value is: false.
username String - Username to access the WSDL-URI. Corresponds to the -U, --user option in the WSDL2Java command line tool.
verbose boolean - See what the tool is generating as it is generating it. Corresponds to the -v, --verbose option in the WSDL2Java command line tool.
wrapArrays boolean - Prefer generating JavaBean classes like "ArrayOfString" for certain schema array patterns. Corresponds to the -w, --wrapArrays option in the WSDL2Java command line tool.
Default value is: true.
wsdlFiles ArrayList - List of WSDL files from sourceDirectory to process. The files will be processed in the order they appear in your configuration.

Parameter Details

allElements:

Generate code for all elements, even unreferenced ones. By default, WSDL2Java only generates code for those elements in the WSDL file that are referenced. A note about what it means to be referenced. We cannot simply say: start with the services, generate all bindings referenced by the service, generate all portTypes referenced by the referenced bindings, etc. What if we're generating code from a WSDL file that only contains portTypes, messages, and types? If WSDL2Java used service as an anchor, and there's no service in the file, then nothing will be generated. So the anchor is the lowest element that exists in the WSDL file in the order:
  1. types
  2. portTypes
  3. bindings
  4. services
For example, if a WSDL file only contained types, then all the listed types would be generated. But if a WSDL file contained types and a portType, then that portType will be generated and only those types that are referenced by that portType. Note that the anchor is searched for in the WSDL file appearing on the command line, not in imported WSDL files. This allows one WSDL file to import constructs defined in another WSDL file without the nuisance of having all the imported WSDL file's constructs generated. Corresponds to the -a, --all option in the WSDL2Java command line tool.
  • Type: boolean
  • Required: No
  • Expression: ${allElements}

debug:

Print debug information, which currently is WSDL2Java's symbol table. Note that this is only printed after the symbol table is complete, ie., after the WSDL is parsed successfully. Corresponds to the -D, --Debug option in the WSDL2Java command line tool.
  • Type: boolean
  • Required: No
  • Default: false

deployScope:

Add scope to deploy.xml: "Application", "Request", "Session". Corresponds to the -d, --deployScope option in the WSDL2Java command line tool.
  • Type: java.lang.String
  • Required: No
  • Expression: ${deployScope}

factory:

Name of a custom class that implements GeneratorFactory interface (for extending Java generation functions). Corresponds to the -F, --factory option in the WSDL2Java command line tool.
  • Type: java.lang.String
  • Required: No
  • Expression: ${factory}

fileNamespaceToPackage:

File containing namespace to package mappings. Corresponds to the -f, --fileNStoPkg option in the WSDL2Java command line tool.
  • Type: java.io.File
  • Required: No
  • Expression: ${fileNamespaceToPackage}

helperGen:

Emits separate Helper classes for meta data. Corresponds to the -H, --helperGen option in the WSDL2Java command line tool.
  • Type: boolean
  • Required: No
  • Default: false

implementationClassName:

Use this as the implementation class. Corresponds to the -c, --implementationClassName option in the WSDL2Java command line tool.
  • Type: java.lang.String
  • Required: No
  • Expression: ${implementationClassName}

mappings:

Mappings of <namespace> to <targetPackage>.
  • Type: java.util.ArrayList
  • Required: No

namespaceToPackage:

Mapping of namespace to package. This is only used when useEmitter is set to true. If useEmitter is set to false you should use mappings instead. Corresponds to the -N, --NStoPkg option in the WSDL2Java command line tool.
  • Type: java.lang.String
  • Required: No
  • Expression: ${namespaceToPackage}

noImports:

Only generate code for the immediate WSDL document. Corresponds to the -n, --noImports option in the WSDL2Java command line tool.
  • Type: boolean
  • Required: No
  • Default: false

noWrapped:

Turn off support for "wrapped" document/literal. Corresponds to the -W, --noWrapped option in the WSDL2Java command line tool.
  • Type: boolean
  • Required: No
  • Default: false

nsExcludes:

Namespace to specifically exclude from the generated code (defaults to none excluded until first namespace included with nsIncludes option). Corresponds to the -x, --nsExclude option in the WSDL2Java command line tool.
  • Type: java.util.ArrayList
  • Required: No

nsIncludes:

Namescape to specifically include in the generated code (defaults to all namespaces unless specifically excluded with the nsExcludes option). Corresponds to the -i, --nsInclude option in the WSDL2Java command line tool.
  • Type: java.util.ArrayList
  • Required: No

outputDirectory:

Location to place generated java source files. Corresponds to the -o, --output option in the WSDL2Java command line tool.
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.build.directory}/generated-sources/axistools/wsdl2java

packageSpace:

Package to create the java files under, for example com.company.wsdl. Corresponds to the -p, --package option in the WSDL2Java command line tool.
  • Type: java.lang.String
  • Required: No
  • Expression: ${packageSpace}

password:

Password to access the WSDL-URI. Corresponds to the -P, --password option in the WSDL2Java command line tool.
  • Type: java.lang.String
  • Required: No
  • Expression: ${password}

runTestCasesAsUnitTests:

Copy the generated test cases to a generated-sources test directory to be compiled and run as normal Surefire unit tests.
  • Type: boolean
  • Required: No
  • Default: false

serverSide:

Emit server-side bindings for web service. Corresponds to the -s, --server-side option in the WSDL2Java command line tool.
  • Type: boolean
  • Required: No
  • Expression: ${serverSide}

skeletonDeploy:

Deploy skeleton (true) or implementation (false) in deploy.wsdd. Corresponds to the -S, --skeletonDeploy option in the WSDL2Java command line tool.
  • Type: boolean
  • Required: No
  • Default: false

sourceDependencies:

List of source dependencies in the format groupId:artifactId:version:file.
  • Type: java.util.ArrayList
  • Required: No

sourceDependencyDirectory:

Cache directory for WSDLs from sourceDependencies.
  • Type: java.io.File
  • Required: No
  • Default: ${project.build.directory}/axistools/wsdl2java/sourceDependencies

sourceDirectory:

Source directory that contains .wsdl files.
  • Type: java.io.File
  • Required: No
  • Default: ${basedir}/src/main/wsdl

staleMillis:

The granularity in milliseconds of the last modification date for testing whether a source needs recompilation.
  • Type: int
  • Required: No
  • Expression: ${lastModGranularityMs}
  • Default: 0

subPackageByFileName:

load.wsdl would further subpackage into load.*
  • Type: boolean
  • Required: No
  • Expression: ${subPackageByFileName}

testCases:

Generate the test cases. Corresponds to the -t, --testCase option in the WSDL2Java command line tool.
  • Type: boolean
  • Required: No
  • Expression: ${testCases}

testSourceDirectory:

Location to place generated test source files.
  • Type: java.io.File
  • Required: No
  • Default: ${project.build.directory}/generated-test-sources/wsdl

timeout:

Timeout in seconds (default is 45, specify -1 to disable). Corresponds to the -O, --timeout option in the WSDL2Java command line tool.
  • Type: java.lang.Integer
  • Required: No
  • Expression: ${timeout}

timestampDirectory:

Directory used when evaluating whether files are up to date or stale.
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.build.directory}

typeMappingVersion:

Indicate either 1.1 or 1.2, where 1.1 means SOAP 1.1 JAX-RPC compliant and 1.2 indicates SOAP 1.1 encoded. Corresponds to the -T, --typeMappingVersion option in the WSDL2Java command line tool.
  • Type: java.lang.String
  • Required: No
  • Expression: ${typeMappingVersion}
  • Default: 1.1

urlDownloadDirectory:

Cache directory for WSDLs from URLs.
  • Type: java.io.File
  • Required: No
  • Default: ${project.build.directory}/axistools/wsdl2java/urlDownloads

urls:

List of URLs to process.
  • Type: java.util.ArrayList
  • Required: No

useEmitter:

Use the Emitter for generating the java files as opposed to the commandline wsdl2java tool.
  • Type: boolean
  • Required: No
  • Default: false

username:

Username to access the WSDL-URI. Corresponds to the -U, --user option in the WSDL2Java command line tool.
  • Type: java.lang.String
  • Required: No
  • Expression: ${username}

verbose:

See what the tool is generating as it is generating it. Corresponds to the -v, --verbose option in the WSDL2Java command line tool.
  • Type: boolean
  • Required: No
  • Expression: ${verbose}

wrapArrays:

Prefer generating JavaBean classes like "ArrayOfString" for certain schema array patterns. Corresponds to the -w, --wrapArrays option in the WSDL2Java command line tool.
  • Type: boolean
  • Required: No
  • Default: true

wsdlFiles:

List of WSDL files from sourceDirectory to process. The files will be processed in the order they appear in your configuration.
  • Type: java.util.ArrayList
  • Required: No