axistools:java2wsdl

Full name:

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

Description:

A Plugin for generating WSDL files using Axis Java2WSDL.

Attributes:

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

Required Parameters

Name Type Since Description
filename String - Indicates the name of the output WSDL file. Corresponds to the -o, --output option in the Java2WSDL command line tool, together with the outputDirectory parameter.

Optional Parameters

Name Type Since Description
all boolean - Look for allowed methods in inherited class. Corresponds to the -a, --all option in the Java2WSDL command line tool.
bindingName String - Indicates the name to use for the binding element. If not specified, the value of the servicePortName + "SoapBinding" is used. Corresponds to the -b, --bindingName option in the Java2WSDL command line tool.
classOfPortType String - The class-of-portType.
classesDirectory File - The directory the compile objects will be located for java2wsdl to source from.
Default value is: ${project.build.outputDirectory}.
excludes ArrayList - List of methods not to export. Corresponds to the -x, --exclude option in the Java2WSDL command line tool.
extraClasses ArrayList - Specify a list of class names which should be included in the types section of the WSDL document. This is useful in the case where your service interface references a base class and you would like your WSDL to contain XML Schema type definitions for these other classes. Corresponds to the -e, --extraClasses option in the Java2WSDL command line tool.
implClass String - Sometimes extra information is available in the implementation class file. Use this option to specify the implementation class. Corresponds to the -i, --implClass option in the Java2WSDL command line tool.
importSchema String - A file or URL to an XML Schema that should be physically imported into the generated WSDL. Corresponds to the -C, --importSchema option in the Java2WSDL command line tool.
input String - Optional parameter 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. Corresponds to the -I, --input option in the Java2WSDL command line tool.
location String - Indicates 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 servicePortName option). The service port address location attribute is assigned the specified value. Corresponds to the -l, --location option in the Java2WSDL command line tool.
locationImport String - Used to indicate the location of the interface WSDL when generating an implementation WSDL. Corresponds to the -L, --locationImport option in the Java2WSDL command line tool.
methods ArrayList - Methods to export. Corresponds to the -m, --methods option in the Java2WSDL command line tool.
namespace String - Indicates the name of the target namespace of the WSDL. Corresponds to the -n, --namespace option in the Java2WSDL command line tool.
namespaceImpl String - Namespace of the implementation WSDL. Corresponds to the -N, --namespaceImpl option in the Java2WSDL command line tool.
outputDirectory File - Directory for generated content. Corresponds to the -o, --output option in the Java2WSDL command line tool, together with the filename parameter.
Default value is: ${project.build.directory}/generated-sources/axistools/java2wsdl.
outputImpl String - Use this option to indicate the name of the output implementation WSDL file. If specified, Java2WSDL will produce interface and implementation WSDL files. If this option is used, the outputWSDLMode option is ignored. Corresponds to the -O, --outputImpl option in the Java2WSDL command line tool.
outputWSDLMode String - Indicates the kind of WSDL to generate. Accepted values are:
  • All --- (default) Generates wsdl containing both interface and implementation WSDL constructs.
  • Interface --- Generates a WSDL containing the interface constructs (no service element).
  • Implementation -- Generates a WSDL containing the implementation. The interface WSDL is imported via the locationImport option.
Corresponds to the -w, --outputWsdlMode option in the Java2WSDL command line tool.
packageToNamespace String - Package=namespace, name value pair. The plugin currently only supports one name value pair. Corresponds to the -p, --PkgtoNS option in the Java2WSDL command line tool.
portTypeName String - Indicates the name to use for the portType element. If not specified, the classOfPortType name is used. Corresponds to the -P, --portTypeName option in the Java2WSDL command line tool.
serviceElementName String - Service element name (defaults to servicePortName value + "Service"). Corresponds to the -S, --serviceElementName option in the Java2WSDL command line tool.
servicePortName String - Indicates the name of the service port. If not specified, the service port name is derived from the location value. Corresponds to the -s, --servicePortName option in the Java2WSDL command line tool.
soapAction String - The value of the operations soapAction field. Values are DEFAULT, OPERATION or NONE. OPERATION forces soapAction to the name of the operation. DEFAULT causes the soapAction to be set according to the operation's meta data (usually ""). NONE forces the soapAction to "". The default is DEFAULT. Corresponds to the -A, --soapAction option in the Java2WSDL command line tool.
stopClasses ArrayList - List of classes which stop the Java2WSDL inheritance search. Corresponds to the -c, --stopClasses option in the Java2WSDL command line tool.
style String - The style of the WSDL document: RPC, DOCUMENT or WRAPPED. The default is RPC. If RPC is specified, an rpc wsdl is generated. If DOCUMENT is specified, a document wsdl is generated. If WRAPPED is specified, a document/literal wsdl is generated using the wrapped approach. Wrapped style forces the use attribute to be literal. Corresponds to the -y, --style option in the Java2WSDL command line tool.
typeMappingVersion String - Choose the default type mapping registry to use. Either 1.1 or 1.2. Corresponds to the -T, --typeMappingVersion option in the Java2WSDL command line tool.
use String - The use of the WSDL document: LITERAL or ENCODED. If LITERAL is specified, the XML Schema defines the representation of the XML for the request. If ENCODED is specified, SOAP encoding is specified in the generated WSDL. Corresponds to the -u, --use option in the Java2WSDL command line tool.

Parameter Details

all:

Look for allowed methods in inherited class. Corresponds to the -a, --all option in the Java2WSDL command line tool.
  • Type: boolean
  • Required: No
  • Expression: false

bindingName:

Indicates the name to use for the binding element. If not specified, the value of the servicePortName + "SoapBinding" is used. Corresponds to the -b, --bindingName option in the Java2WSDL command line tool.
  • Type: java.lang.String
  • Required: No
  • Expression: ${bindingName}

classOfPortType:

The class-of-portType.
  • Type: java.lang.String
  • Required: No
  • Expression: ${classOfPortType}

classesDirectory:

The directory the compile objects will be located for java2wsdl to source from.
  • Type: java.io.File
  • Required: No
  • Default: ${project.build.outputDirectory}

excludes:

List of methods not to export. Corresponds to the -x, --exclude option in the Java2WSDL command line tool.
  • Type: java.util.ArrayList
  • Required: No
  • Expression: ${exclude}

extraClasses:

Specify a list of class names which should be included in the types section of the WSDL document. This is useful in the case where your service interface references a base class and you would like your WSDL to contain XML Schema type definitions for these other classes. Corresponds to the -e, --extraClasses option in the Java2WSDL command line tool.
  • Type: java.util.ArrayList
  • Required: No
  • Expression: ${extraClasses}

filename:

Indicates the name of the output WSDL file. Corresponds to the -o, --output option in the Java2WSDL command line tool, together with the outputDirectory parameter.
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${fileName}

implClass:

Sometimes extra information is available in the implementation class file. Use this option to specify the implementation class. Corresponds to the -i, --implClass option in the Java2WSDL command line tool.
  • Type: java.lang.String
  • Required: No
  • Expression: ${implClass}

importSchema:

A file or URL to an XML Schema that should be physically imported into the generated WSDL. Corresponds to the -C, --importSchema option in the Java2WSDL command line tool.
  • Type: java.lang.String
  • Required: No
  • Expression: ${importSchema}

input:

Optional parameter 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. Corresponds to the -I, --input option in the Java2WSDL command line tool.
  • Type: java.lang.String
  • Required: No
  • Expression: ${input}

location:

Indicates 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 servicePortName option). The service port address location attribute is assigned the specified value. Corresponds to the -l, --location option in the Java2WSDL command line tool.
  • Type: java.lang.String
  • Required: No
  • Expression: ${location}

locationImport:

Used to indicate the location of the interface WSDL when generating an implementation WSDL. Corresponds to the -L, --locationImport option in the Java2WSDL command line tool.
  • Type: java.lang.String
  • Required: No
  • Expression: ${locationImport}

methods:

Methods to export. Corresponds to the -m, --methods option in the Java2WSDL command line tool.
  • Type: java.util.ArrayList
  • Required: No
  • Expression: ${methods}

namespace:

Indicates the name of the target namespace of the WSDL. Corresponds to the -n, --namespace option in the Java2WSDL command line tool.
  • Type: java.lang.String
  • Required: No
  • Expression: ${namespace}

namespaceImpl:

Namespace of the implementation WSDL. Corresponds to the -N, --namespaceImpl option in the Java2WSDL command line tool.
  • Type: java.lang.String
  • Required: No
  • Expression: ${namespaceImpl}

outputDirectory:

Directory for generated content. Corresponds to the -o, --output option in the Java2WSDL command line tool, together with the filename parameter.
  • Type: java.io.File
  • Required: No
  • Default: ${project.build.directory}/generated-sources/axistools/java2wsdl

outputImpl:

Use this option to indicate the name of the output implementation WSDL file. If specified, Java2WSDL will produce interface and implementation WSDL files. If this option is used, the outputWSDLMode option is ignored. Corresponds to the -O, --outputImpl option in the Java2WSDL command line tool.
  • Type: java.lang.String
  • Required: No
  • Expression: ${outputImpl}

outputWSDLMode:

Indicates the kind of WSDL to generate. Accepted values are:
  • All --- (default) Generates wsdl containing both interface and implementation WSDL constructs.
  • Interface --- Generates a WSDL containing the interface constructs (no service element).
  • Implementation -- Generates a WSDL containing the implementation. The interface WSDL is imported via the locationImport option.
Corresponds to the -w, --outputWsdlMode option in the Java2WSDL command line tool.
  • Type: java.lang.String
  • Required: No
  • Expression: ${outputWSDLMode}

packageToNamespace:

Package=namespace, name value pair. The plugin currently only supports one name value pair. Corresponds to the -p, --PkgtoNS option in the Java2WSDL command line tool.
  • Type: java.lang.String
  • Required: No
  • Expression: ${packageToNamespace}

portTypeName:

Indicates the name to use for the portType element. If not specified, the classOfPortType name is used. Corresponds to the -P, --portTypeName option in the Java2WSDL command line tool.
  • Type: java.lang.String
  • Required: No
  • Expression: ${portTypeName}

serviceElementName:

Service element name (defaults to servicePortName value + "Service"). Corresponds to the -S, --serviceElementName option in the Java2WSDL command line tool.
  • Type: java.lang.String
  • Required: No
  • Expression: ${serviceElementName}

servicePortName:

Indicates the name of the service port. If not specified, the service port name is derived from the location value. Corresponds to the -s, --servicePortName option in the Java2WSDL command line tool.
  • Type: java.lang.String
  • Required: No
  • Expression: ${servicePortName}

soapAction:

The value of the operations soapAction field. Values are DEFAULT, OPERATION or NONE. OPERATION forces soapAction to the name of the operation. DEFAULT causes the soapAction to be set according to the operation's meta data (usually ""). NONE forces the soapAction to "". The default is DEFAULT. Corresponds to the -A, --soapAction option in the Java2WSDL command line tool.
  • Type: java.lang.String
  • Required: No
  • Expression: ${soapAction}

stopClasses:

List of classes which stop the Java2WSDL inheritance search. Corresponds to the -c, --stopClasses option in the Java2WSDL command line tool.
  • Type: java.util.ArrayList
  • Required: No
  • Expression: ${stopClasses}

style:

The style of the WSDL document: RPC, DOCUMENT or WRAPPED. The default is RPC. If RPC is specified, an rpc wsdl is generated. If DOCUMENT is specified, a document wsdl is generated. If WRAPPED is specified, a document/literal wsdl is generated using the wrapped approach. Wrapped style forces the use attribute to be literal. Corresponds to the -y, --style option in the Java2WSDL command line tool.
  • Type: java.lang.String
  • Required: No
  • Expression: ${style}

typeMappingVersion:

Choose the default type mapping registry to use. Either 1.1 or 1.2. Corresponds to the -T, --typeMappingVersion option in the Java2WSDL command line tool.
  • Type: java.lang.String
  • Required: No
  • Expression: ${typeMappingVersion}

use:

The use of the WSDL document: LITERAL or ENCODED. If LITERAL is specified, the XML Schema defines the representation of the XML for the request. If ENCODED is specified, SOAP encoding is specified in the generated WSDL. Corresponds to the -u, --use option in the Java2WSDL command line tool.
  • Type: java.lang.String
  • Required: No
  • Expression: ${use}