jibx:jibx2wsdl

Full name:

org.jibx:maven-jibx-plugin:1.2.3-SNAPSHOT:jibx2wsdl

Description:

Generates WSDL from java code.

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
directory String - The directory which contains binding files.
Default value is: src/main/config.
interfaceClassNames ArrayList - The full class names of the service interface. Note: Classes should be in target/classes (which is where they should be after compiling).
load boolean - Control flag for test loading generated/modified classes.
Default value is: false.
multimodule boolean - Control flag multi-module mode.
Default value is: false.
outputDirectory String - Target directory path for generated output (default is current directory). Note: If you want the wsdl and schema included in your distribution, remember to include it in the <resources> section of your pom file.
Default value is: ${project.build.directory}/schema.
validate boolean - Control flag for test loading generated/modified classes.
Default value is: true.
verbose boolean - Control flag for verbose processing reports.
Default value is: false.
verify boolean - Control flag for verifying generated/modified classes with BCEL.
Default value is: false.

Optional Parameters

Name Type Since Description
customizations ArrayList - Include pattern for customization files.
excludes ArrayList - Exclude pattern for binding files.
includes ArrayList - Include pattern for binding files.
Note: Uses the standard filter format described in the plexus DirectoryScanner.
Defaults value is: binding.xml.
modules HashSet - A list of modules to search for binding files in the format: groupID:artifactID
options Map - Extra options to be given for customization via CLI.

Enter extra customizations or other command-line options.
The extra customizations are described on the JiBX2WSDL customizations page
The single character JiBX2WSDL commands may also be supplied here.
For example, to include Names of extra classes (-x) and Sets the base address used for the service endpoint address specified in the WSDL, supply the following options:
<options>
  <x>com.company.pacakge.ClassName</x>
  <service-base>http://localhost:8080/axis2/services</service-base>
</options>
sourceDirectories ArrayList - The source directories. Note: The source directory defaults to: <sourceDirectories>
  <sourceDirectory>${basedir}/src/main/java</sourceDirectory>
</sourceDirectories> If you are using the code-gen plugin, you may want to specify the generated sources directory: <sourceDirectories>
  <sourceDirectory>${basedir}/src/main/java</sourceDirectory>
  <sourceDirectory>${project.build.directory}/generated-source</sourceDirectory>
</sourceDirectories> If you don't want sources include, you will have to explicitly delare an empty list: <sourceDirectories>
  <sourceDirectory></sourceDirectory>
</sourceDirectories>

Parameter Details

customizations:

Include pattern for customization files.
  • Type: java.util.ArrayList
  • Required: No
  • Expression: ${customizations}

directory:

The directory which contains binding files.
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${directory}
  • Default: src/main/config

excludes:

Exclude pattern for binding files.
  • Type: java.util.ArrayList
  • Required: No
  • Expression: ${excludes}

includes:

Include pattern for binding files.
Note: Uses the standard filter format described in the plexus DirectoryScanner.
Defaults value is: binding.xml.
  • Type: java.util.ArrayList
  • Required: No
  • Expression: ${includes}

interfaceClassNames:

The full class names of the service interface. Note: Classes should be in target/classes (which is where they should be after compiling).
  • Type: java.util.ArrayList
  • Required: Yes
  • Expression: ${interfaceClassNames}

load:

Control flag for test loading generated/modified classes.
  • Type: boolean
  • Required: Yes
  • Expression: ${load}
  • Default: false

modules:

A list of modules to search for binding files in the format: groupID:artifactID
  • Type: java.util.HashSet
  • Required: No
  • Expression: ${modules}

multimodule:

Control flag multi-module mode.
  • Type: boolean
  • Required: Yes
  • Expression: ${multi-module}
  • Default: false

options:

Extra options to be given for customization via CLI.

Enter extra customizations or other command-line options.
The extra customizations are described on the JiBX2WSDL customizations page
The single character JiBX2WSDL commands may also be supplied here.
For example, to include Names of extra classes (-x) and Sets the base address used for the service endpoint address specified in the WSDL, supply the following options:
<options>
  <x>com.company.pacakge.ClassName</x>
  <service-base>http://localhost:8080/axis2/services</service-base>
</options>
  • Type: java.util.Map
  • Required: No

outputDirectory:

Target directory path for generated output (default is current directory). Note: If you want the wsdl and schema included in your distribution, remember to include it in the <resources> section of your pom file.
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${outputDirectory}
  • Default: ${project.build.directory}/schema

sourceDirectories:

The source directories. Note: The source directory defaults to: <sourceDirectories>
  <sourceDirectory>${basedir}/src/main/java</sourceDirectory>
</sourceDirectories> If you are using the code-gen plugin, you may want to specify the generated sources directory: <sourceDirectories>
  <sourceDirectory>${basedir}/src/main/java</sourceDirectory>
  <sourceDirectory>${project.build.directory}/generated-source</sourceDirectory>
</sourceDirectories> If you don't want sources include, you will have to explicitly delare an empty list: <sourceDirectories>
  <sourceDirectory></sourceDirectory>
</sourceDirectories>
  • Type: java.util.ArrayList
  • Required: No
  • Expression: ${sourceDirectories}

validate:

Control flag for test loading generated/modified classes.
  • Type: boolean
  • Required: Yes
  • Expression: ${validate}
  • Default: true

verbose:

Control flag for verbose processing reports.
  • Type: boolean
  • Required: Yes
  • Expression: ${verbose}
  • Default: false

verify:

Control flag for verifying generated/modified classes with BCEL.
  • Type: boolean
  • Required: Yes
  • Expression: ${verify}
  • Default: false