Skip to main content

jaxb2-maven-plugin to generate java code from XSD schema

In this tutorial I will show how to generate the Java source code from XSD schema. I will use jaxb2-maven-plugin to generate the code using XSD file which will be declared in pom.xml to make it part of build, so when maven build is executed it will generate the java code using XSD. Class generation can be controlled in plugin configuration.

Maven changes (pom.xml)

Include below plugin in your pom.xml. Here we have done some configuration under configuration section as given below.
schemaDirectory: This is the directory where I keep my schema (XSD file).
outputDirectory: This is the java source location where I want to generate the Java files. If it is not given then by default it will be generate inside target folder.
clearOutputDir: If this property is true then it will generate the classes on each build otherwise it will generate only if output directory is empty.

XSD Schema (employee.xsd)

Below is the XSD schema which will be used to generate the Java class.
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="" xmlns:tns=""
 <xs:complexType name="employee">
   <xs:element name="name" type="xs:string"/>
   <xs:element name="age" type="xs:int"/>
   <xs:element name="organization" type="xs:string"/>
   <xs:element name="salary" type="xs:decimal"/>
XSD location is as given below in my application.
xsd location

Generating Java classes

After setting up the above code and configuration, we can run the maven build by executing "men clean install". It will generate the Java classes using the XSD schema. Below is the generated code package structure after the build execution.
generated classes

Below is the snap of code from generated classes. Getters/Setters are also generated but not included in example.
  • @XmlAccessorType(XmlAccessType.FIELD)
     @XmlType(name = "employee", propOrder = {
     public class Employee {
         @XmlElement(required = true)
         protected String name;
         protected int age;
         @XmlElement(required = true)
         protected String organization;
         @XmlElement(required = true)
         protected BigDecimal salary;
  • @XmlRegistry
     public class ObjectFactory {
          * Create a new ObjectFactory that can be used to create new instances of schema derived classes for package: com.myexample.employee
         public ObjectFactory() {
          * Create an instance of {@link Employee }
         public Employee createEmployee() {
             return new Employee();
  • @javax.xml.bind.annotation.XmlSchema(namespace = "")
    package com.myexample.employee;
That's all. Usually you may have a need to generate the class this way when you are creating some SOAP service client or you can use it to just create the Java POJO classes also.

You may be interested in my other post on generating Java classes using annotation processor.


  1. Nice blog ! Thank you so much for compiling such a great article! Clearly, this is an excellent post. I appreciate the insightful and useful information you have offered here. custom erp software


Post a Comment

Popular Posts

Setting up kerberos in Mac OS X

Kerberos in MAC OS X Kerberos authentication allows the computers in same domain network to authenticate certain services with prompting the user for credentials. MAC OS X comes with Heimdal Kerberos which is an alternate implementation of the kerberos and uses LDAP as identity management database. Here we are going to learn how to setup a kerberos on MAC OS X which we will configure latter in our application. Installing Kerberos In MAC we can use Homebrew for installing any software package. Homebrew makes it very easy to install the kerberos by just executing a simple command as given below. brew install krb5 Once installation is complete, we need to set the below export commands in user's profile which will make the kerberos utility commands and compiler available to execute from anywhere. Open user's bash profile: vi ~/.bash_profile Add below lines: export PATH=/usr/local/opt/krb5/bin:$PATH export PATH=/usr/local/opt/krb5/sbin:$PATH export LDFLAGS=&

Multiple data source with Spring boot, batch and cloud task

Here we will see how we can configure different datasource for application and batch. By default, Spring batch stores the job details and execution details in database. If separate data source is not configured for spring batch then it will use the available data source in your application if configured and create batch related tables there. Which may be the unwanted burden on application database and we would like to configure separate database for spring batch. To overcome this situation we will configure the different datasource for spring batch using in-memory database, since we don't want to store batch job details permanently. Other thing is the configuration of  spring cloud task in case of multiple datasource and it must point to the same data source which is pointed by spring batch. In below sections, we will se how to configure application, batch and cloud task related data sources. Application Data Source Define the data source in application properties or yml con

SpringBoot - @ConditionalOnProperty example for conditional bean initialization

@ConditionalOnProperty annotation is used to check if specified property available in the environment or it matches some specific value so it can control the execution of some part of code like bean creation. It may be useful in many cases for example enable/disable service if specific property is available. Below are the attributes which can be used for property check. havingValue - Provide the value which need to check against specified property otherwise it will check that value should not be false. matchIfMissing - If true it will match the condition and execute the annotated code when property itself is not available in environment. name - Name of the property to be tested. If you want to test single property then you can directly put the property name as string like "" and if you have multiple properties to test then you can put the names like {"prop.name1","prop.name2"} prefix - It can be use when you want to apply some prefix to

Entity to DTO conversion in Java using Jackson

It's very common to have the DTO class for a given entity in any application. When persisting data, we use entity objects and when we need to provide the data to end user/application we use DTO class. Due to this we may need to have similar properties on DTO class as we have in our Entity class and to share the data we populate DTO objects using entity objects. To do this we may need to call getter on entity and then setter on DTO for the same data which increases number of code line. Also if number of DTOs are high then we need to write lot of code to just get and set the values or vice-versa. To overcome this problem we are going to use Jackson API and will see how to do it with minimal code only. Maven dependency <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-databind</artifactId> <version>2.9.9</version> </dependency> Entity class Below is