There are many ways to generate Java classes from WSDL files – one of them is using the cxf-codegen-plugin, which comes from the Apache Maven CXF. Note that this post will not work with the JDK version beyond 1.8. (See comments section). However, it may still be useful for legacy applications.
Contents
Software Requirements
We used the following items for this post.
- SOAP 1.2
- Java 8
- Windows 10
- Apache Maven
- IntelliJ IDEA 2021.1
- cxf-xjc-runtime from Apache CXF (See pom.xml)
WSDL File To Generate Java Classes
We will use a WSDL file downloaded from the following URL. Head to the URL and then save the content to a file.
http://www.webservicex.net/geoipservice.asmx?WSDL
The web service may change anytime without us knowing it unless we consume it. Therefore, we included the WSDL file in our Maven project. NOTE: the following URL is no longer available, but we can use other SOAP-based web services. They may be running on our local machine or hosted somewhere on the Internet.
Non-Standing SOAP 1.2 Binding
We may encounter an issue similar to the following problem with wsimport. It may still work with an older version of SOAP, but we haven’t tried it. If possible, please use wsdl2java directly or via the cxf-codegen-plugin.
We will only deal with SOAP 1.2 in this post.
Add the cxf-codegen-plugin Maven plugin.
Next, we update our pom.xml, as shown below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 | ... <build> <plugins> <plugin> <groupId>org.apache.cxf</groupId> <artifactId>cxf-codegen-plugin</artifactId> <version>3.2.1</version> <executions> <execution> <id>generate-sources</id> <phase>generate-sources</phase> <configuration> <wsdlOptions> <wsdlOption> <wsdl>${project.basedir}/src/main/resources/wsdl/geoipservice.wsdl</wsdl> <wsdlLocation>classpath:wsdl/geoipservice.wsdl</wsdlLocation> <extraargs> <extraarg>-p</extraarg> <extraarg>com.turreta.wsdl.webservicex.geoipservice</extraarg> <extraarg>-bareMethods</extraarg> </extraargs> <frontEnd>jaxws21</frontEnd> <faultSerialVersionUID>1</faultSerialVersionUID> <bindingFiles> <bindingFile>src/main/resources/binding.xml</bindingFile> </bindingFiles> </wsdlOption> </wsdlOptions> </configuration> <goals> <goal>wsdl2java</goal> </goals> </execution> </executions> </plugin> ... </plugins> </build> ... |
Then, we add the following dependency.
1 2 3 4 5 | <dependency> <groupId>org.apache.cxf.xjc-utils</groupId> <artifactId>cxf-xjc-runtime</artifactId> <version>2.7.0</version> </dependency> |
When we do a clean install, we get the following generated classes along with the jar file.
Check Java classes Created From WSDL via cxf-codegen-plugin in the jar file
There is another plugin (in the same pom.xml) responsible for moving the generated compiled classes to our jar file.
Lastly, update the pom.xml to include the following snippet. The plug-in adds all generated classes into the final application jar file.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 | ... <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>build-helper-maven-plugin</artifactId> <version>1.9</version> <executions> <execution> <id>add-source</id> <phase>generate-sources</phase> <goals> <goal>add-source</goal> </goals> <configuration> <sources> <source>${basedir}/target/generated/src/main/java</source> </sources> </configuration> </execution> </executions> </plugin> ... |
Download The cxf-codegen-plugin Sample Codes
The files are available at the following link.
https://github.com/Turreta/Generate-Java-classes-from-WSDL-files-using-cxf-codegen-plugin-in-Maven
Hi Karl,
Thanks for the informative post. I just have one question.
where do you get the binding.xml file from, that is included in the pom configuration.
src/main/resources/binding.xml ???
Thanks,
NOTE: This won’t compile with JDK 9, 11, and 14. Most probably, it won’t work with JDK 10, 12, 13, 15, and later.