Fork me on GitHub
Built by Maven

jaxws:wsgen

Full name:

org.codehaus.mojo:jaxws-maven-plugin:2.6:wsgen

Description:

Reads a JAX-WS service endpoint implementation class and generates all of the portable artifacts for a JAX-WS web service.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: runtime.
  • Binds by default to the lifecycle phase: process-classes.

Optional Parameters

Name Type Since Description
<args> List - Specify optional command-line options.

Multiple elements can be specified, and each token must be placed in its own list.
<destDir> File - Specify where to place output generated classes. Use xnocompile to turn this off.
Default value is: ${project.build.outputDirectory}.
<encoding> String - Specify character encoding used by source files.
Default value is: ${project.build.sourceEncoding}.
<executable> File 2.2.1 Path to the executable. Should be either wsgen or wsimport but basically any script which will understand passed in arguments will work.
<extension> boolean - Allow to use the JAXWS Vendor Extensions.
Default value is: false.
<genWsdl> boolean - Specify that a WSDL file should be generated in ${resourceDestDir}.
Default value is: false.
<inlineSchemas> boolean - Inline schemas in the generated WSDL. Used in conjunction with the genWsdl option.
Default value is: false.
<keep> boolean - Keep generated files.
Default value is: true.
<metadata> File 2.3 Metadata file for wsgen. See the JAX-WS Guide for the description of this feature. Unmatched files will be ignored.
<portname> String - Specify the Port name to use in the generated WSDL. Used in conjunction with the genWsdl option.
<protocol> String - Used in conjunction with genWsdl to specify the protocol to use in the wsdl:binding. Valid values are "soap1.1" or "Xsoap1.2", default is "soap1.1". "Xsoap1.2" is not standard and can only be used in conjunction with the extension option.
<resourceDestDir> File - Directory containing the generated wsdl files.
Default value is: ${project.build.directory}/generated-sources/wsdl.
<sei> String - Service endpoint implementation class name.
<servicename> String - Specify the Service name to use in the generated WSDL. Used in conjunction with the genWsdl option.
<sourceDestDir> File - Specify where to place generated source files, keep is turned on with this option.
Default value is: ${project.build.directory}/generated-sources/wsgen.
<useJdkToolchainExecutable> boolean 2.4 If a JDK toolchain is found, by default, it is used to get java executable with its tools.jar. But if set to true, it is used it to find wsgen and wsimport executables.
Default value is: false.
<verbose> boolean - Output messages about what the tool is doing.
Default value is: false.
<vmArgs> List - Specify optional JVM options.

Multiple elements can be specified, and each token must be placed in its own list.
<xdonotoverwrite> boolean - (no description)
Default value is: false.
<xnocompile> boolean - Turn off compilation after code generation and let generated sources be compiled by maven during compilation phase; keep is turned on with this option.
Default value is: false.

Parameter Details

<args>

Specify optional command-line options.

Multiple elements can be specified, and each token must be placed in its own list.

  • Type: java.util.List
  • Required: No

<destDir>

Specify where to place output generated classes. Use xnocompile to turn this off.
  • Type: java.io.File
  • Required: No
  • Default: ${project.build.outputDirectory}

<encoding>

Specify character encoding used by source files.
  • Type: java.lang.String
  • Required: No
  • Default: ${project.build.sourceEncoding}

<executable>

Path to the executable. Should be either wsgen or wsimport but basically any script which will understand passed in arguments will work.
  • Type: java.io.File
  • Since: 2.2.1
  • Required: No

<extension>

Allow to use the JAXWS Vendor Extensions.
  • Type: boolean
  • Required: No
  • Default: false

<genWsdl>

Specify that a WSDL file should be generated in ${resourceDestDir}.
  • Type: boolean
  • Required: No
  • Default: false

<inlineSchemas>

Inline schemas in the generated WSDL. Used in conjunction with the genWsdl option.
  • Type: boolean
  • Required: No
  • Default: false

<keep>

Keep generated files.
  • Type: boolean
  • Required: No
  • Default: true

<metadata>

Metadata file for wsgen. See the JAX-WS Guide for the description of this feature. Unmatched files will be ignored.
  • Type: java.io.File
  • Since: 2.3
  • Required: No

<portname>

Specify the Port name to use in the generated WSDL. Used in conjunction with the genWsdl option.
  • Type: java.lang.String
  • Required: No

<protocol>

Used in conjunction with genWsdl to specify the protocol to use in the wsdl:binding. Valid values are "soap1.1" or "Xsoap1.2", default is "soap1.1". "Xsoap1.2" is not standard and can only be used in conjunction with the extension option.
  • Type: java.lang.String
  • Required: No

<resourceDestDir>

Directory containing the generated wsdl files.
  • Type: java.io.File
  • Required: No
  • Default: ${project.build.directory}/generated-sources/wsdl

<sei>

Service endpoint implementation class name.
  • Type: java.lang.String
  • Required: No

<servicename>

Specify the Service name to use in the generated WSDL. Used in conjunction with the genWsdl option.
  • Type: java.lang.String
  • Required: No

<sourceDestDir>

Specify where to place generated source files, keep is turned on with this option.
  • Type: java.io.File
  • Required: No
  • Default: ${project.build.directory}/generated-sources/wsgen

<useJdkToolchainExecutable>

If a JDK toolchain is found, by default, it is used to get java executable with its tools.jar. But if set to true, it is used it to find wsgen and wsimport executables.
  • Type: boolean
  • Since: 2.4
  • Required: No
  • Default: false

<verbose>

Output messages about what the tool is doing.
  • Type: boolean
  • Required: No
  • Default: false

<vmArgs>

Specify optional JVM options.

Multiple elements can be specified, and each token must be placed in its own list.

  • Type: java.util.List
  • Required: No

<xdonotoverwrite>

(no description)
  • Type: boolean
  • Required: No
  • Default: false

<xnocompile>

Turn off compilation after code generation and let generated sources be compiled by maven during compilation phase; keep is turned on with this option.
  • Type: boolean
  • Required: No
  • Default: false