Saved searches
Use saved searches to filter your results more quickly
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session.
Gradle plugin for generating java source from wsdl files
License
nilsmagnus/wsdl2java
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Sign In Required
Please sign in to use Codespaces.
Launching GitHub Desktop
If nothing happens, download GitHub Desktop and try again.
Launching GitHub Desktop
If nothing happens, download GitHub Desktop and try again.
Launching Xcode
If nothing happens, download Xcode and try again.
Launching Visual Studio Code
Your codespace will open once ready.
There was a problem preparing your codespace, please try again.
Latest commit
Git stats
Files
Failed to load latest commit information.
README.md
This plugin is no longer maintained by its creator since I dont have any interest in using this plugin anymore and find no pleasure in maintaining it for free/fun. Please fork it and use it as you like. The plugin is not published to any relevant plugin-portals.
Gradle plugin for generating java from wsdl, using cxf under the hood and the same options as the maven wsdl-2-java plugin from apache-cxf.
The plugin binaries are downloadable from bintray: https://bintray.com/nilsmagnus/maven/wsdl2java/
If you have any issues with the plugin, please file an issue at github, https://github.com/nilsmagnus/wsdl2java/issues
Contributions are welcome as long as they are sane.
- Nils Larsgård , https://github.com/nilsmagnus
- Mats Faugli, https://github.com/fowlie
- Thorben Schiller, https://github.com/thorbolo
- Stefan Kloe, https://github.com/Pentadrago
- Mattias Rundgren, https://github.com/matrun
- Steffen Döring, https://github.com/s-doering
- Jesper Skov, https://github.com/jskovjyskebankdk
- Manuel Sanches Ortiz, https://github.com/manuelsanchezortiz
- Ruben Gees, https://github.com/rubengees
- Stefan Krause-Kjær, https://github.com/KrauseStefan
This plugin uses the apache-cxf tools to do the actual work.
| Name | Description | Dependecy |
|---|---|---|
| wsdl2java | Generate java source from wsdl-files | CompileJava/CompileKotlin depends on wsdl2java |
| xsd2java | Generate java source from xsd-files Removed in version 0.8 | CompileJava depends on xsd2java |
To use this plugin, you must
- modify your buildscript to have dependencies to the plugin
- apply the plugin
- set the properties of the plugin
buildscript < repositories< jcenter() mavenCentral() >dependencies < classpath 'no.nils:wsdl2java:0.12' > > apply plugin: 'no.nils.wsdl2java'
plugins < id("java") id("no.nils.wsdl2java") version "0.12" >
| Option | Default value | Description |
|---|---|---|
| wsdlDir | src/main/resources | Define the wsdl files directory to support incremental build. This means that the task will be up-to-date if nothing in this directory has changed. |
| wsdlsToGenerate | empty | This is the main input to the plugin that defines the wsdls to process. It is a list of arguments where each argument is a list of arguments to process a wsdl-file. The Wsdl-file with full path is the last argument. The array can be supplied with the same options as described for the maven-cxf plugin(http://cxf.apache.org/docs/wsdl-to-java.html). |
| locale | Locale.getDefault() | The locale for the generated sources – especially the JavaDoc. This might be necessary to prevent differing sources due to several development environments. |
| encoding | platform default encoding | Set the encoding name for generated sources, such as EUC-JP or UTF-8. |
| stabilizeAndMergeObjectFactory | false | If multiple WSDLs target the same package, merge their ObjectFactory classes. |
| cxfVersion | «+» | Controls the CXF version used to generate code. |
| cxfPluginVersion | «+» | Controls the CXF XJC-plugins version used to generate code. |
Example setting of options:
wsdl2java < wsdlDir = file("src/main/resources/myWsdlFiles") // define to support incremental build wsdlsToGenerate = [ // 2d-array of wsdls and cxf-parameters ['src/main/resources/wsdl/firstwsdl.wsdl'], ['-xjc','-b','bindingfile.xml','src/main/resources/wsdl/secondwsdl.wsdl'] ] locale = Locale.GERMANY cxfVersion = "2.5.1" cxfPluginVersion = "2.4.0" >
extra["cxfVersion"] = "3.3.2" extra["cxfPluginVersion"] = "3.2.2" wsdl2java < wsdlDir = file("$projectDir/src/main/wsdl") wsdlsToGenerate = listOf( listOf("$wsdlDir/firstwsdl.wsdl"), listOf("-xjc", "-b", "bindingfile.xml", "$wsdlDir/secondwsdl.wsdl") ) >
Options for xsd2java (deprecated, separate plugin coming soon)
This will not work for version 0.8+!
| Option | Default value | Description |
|---|---|---|
| generatedXsdDir | «generatedsources/src/main/java» | Destination directory for generated sources |
| xsdsToGenerate | null | 2-d array consisting of 2 or 3 values in each array: 1. xsd-file(input), 2. package for the generated sources, 3. (optional) a map containing additional options for the xjc task |
| encoding | platform default encoding | Set the encoding name for generated sources, such as EUC-JP or UTF-8. |
Example setting of options:
xsd2java < encoding = 'utf-8' xsdsToGenerate = [ ["src/main/resources/xsd/CustomersAndOrders.xsd", 'no.nils.xsd2java.sample', [header: false] /* optional map */] ] generatedXsdDir = file("generatedsources/xsd2java") >
This is a an example of a working build.gradle for a java project. You can also take a look at the test resources, which contain two working projects.
buildscript < repositories < jcenter() mavenCentral() >dependencies < classpath 'no.nils:wsdl2java:0.12' > > apply plugin: 'java' apply plugin: 'no.nils.wsdl2java' repositories < mavenCentral() >dependencies < testCompile 'junit:junit:+' > wsdl2java < wsdlsToGenerate = [ ['-p', 'com.acme.mypackage', '-autoNameResolution', "$projectDir/src/main/resources/wsdl/stockqoute.wsdl"] ] wsdlDir = file("$projectDir/src/main/resources/wsdl") locale = Locale.FRANCE cxfVersion = "2.5.1" cxfPluginVersion = "2.4.0" >
This plugin automatically adds the necessary dependencies to work on Java 9+ when detected.
As of now, these dependencies are added:
implementation "javax.xml.bind:jaxb-api:2.3.1", implementation "javax.xml.ws:jaxws-api:2.3.1", implementation "org.glassfish.jaxb:jaxb-runtime:2.3.2", implementation "org.glassfish.main.javaee-api:javax.jws:3.1.2.2", implementation "com.sun.xml.messaging.saaj:saaj-impl:1.5.1"
Enable basic extension support for xjc
Apache CXF supports extension for xjc, e.g. for creating a hashCode, equals and toString method in the classes generated by xjc.
To use those extensions some more dependencies are necessary.
dependencies() < compile 'org.jvnet.jaxb2_commons:jaxb2-basics-runtime:0.11.0' // enable extension support for wsdl2java wsdl2java 'org.jvnet.jaxb2_commons:jaxb2-basics-runtime:0.11.0' wsdl2java 'org.jvnet.jaxb2_commons:jaxb2-basics:0.11.0' > wsdl2java< wsdlsToGenerate = [ ['-xjc-Xequals', '-xjc-XhashCode', 'src/main/resources/com/example/api/interface.wsdl'] ] >
This example creates the hashCode and the equals method.
A notice on multi-module projects
Instead of referring to absolute paths in your build-file, try using $projectDir as a prefix to your files and directories. As shown in the «Complete example usage».
- set version to final in build.gradle & commit
- build artifact and upload export BINTRAY_USER= export BINTRAY_API_KEY= ./gradlew clean bintrayPublish bintrayUpload
- increment version and set to SNAPSHOT & commit
- git push
About
Gradle plugin for generating java source from wsdl files