Skip to main content

SOAP service development using Spring boot and Apache CXF

In this tutorial we are going to learn how to develop a SOAP web service using Spring boot and Apache CXF. We will follow the contract first approach to develop our service where we will use jaxb2 maven plugin to generate the java classes which we will use for service implementation.

Why contract first

With contract first our primary focus stays with the contract of service to be implemented. Also it is useful to match the input/output with business requirement. We can share the contract with other business units/ customers or users, so it helps them to start early without waiting for the complete implementation. Once our contract is ready we can generate the Java classes using jaxb plugin which generates the java objects using the schema for SOAP contract and we need to focus only on service implementation.

SOAP service development (Hello service)

This service will have one operation where user can send their name and in response they will get a hello message with the passed name.
Here we will create a maven project. There are multiple ways to create a maven project like using IDE features, maven command or using spring initializer (http://start.spring.io/).
Below are the steps given in sequence which we will follow to develop our service.

Maven dependencies

I have used Spring boot version as 2.2.2.RELEASE using below parent tag declaration.
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.2.RELEASE</version>
        <relativePath/>
    </parent>
Add below dependencies for spring web and Apache CXF.
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.apache.cxf</groupId>
        <artifactId>cxf-spring-boot-starter-jaxws</artifactId>
        <version>3.3.4</version>
    </dependency>

Service contract using XML schema

Service contract is defined below using XML schema where we have defined request and response schema. Request contains one parameter for user name to pass in request and response has one parameter to send the response message.
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
           xmlns:tns="http://services.ttj.com/hello-service"
           targetNamespace="http://services.ttj.com/hello-service" elementFormDefault="qualified">

    <xs:element name="sayHelloRequest">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="userName" type="xs:string"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:element name="sayHelloResponse">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="message" type="xs:string"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>
</xs:schema>

Java classes generation from XSD contract

Add below plugin to pom.xml. Specify the schema location in schemDirectory tag and package location for new classes as given below. Please refer the link https://www.thetechnojournals.com/2019/10/jaxb2-maven-plugin-to-generate-java.html for more details on class generation from XML schema.
    <plugin>
        <groupId>org.codehaus.mojo</groupId>
        <artifactId>jaxb2-maven-plugin</artifactId>
        <version>1.6</version>
        <executions>
            <execution>
        <id>xjc</id>
        <goals>
            <goal>xjc</goal>
        </goals>
            </execution>
        </executions>
        <configuration>
            <schemaDirectory>${project.basedir}/src/main/resources/schema</schemaDirectory>
            <outputDirectory>${project.basedir}/src/main/java</outputDirectory>
            <clearOutputDir>false</clearOutputDir>
        </configuration>
    </plugin>
Now build the project using maven build. It will generate the new package and classes using the XML contract. Once these classes are generated, we can proceed with further steps

CXF servlet and bus configuration

We need to create a servlet dispatcher bean to map the services URL with CXF servlet. Also we will create a SpringBus bean, however you don't need to create the SpringBus bean but if you want to add some additional features like interceptors, security etc. then you should declare this bean and bind additional features to it.
@Configuration
public class CxfConfig {
    @Bean(name = Bus.DEFAULT_BUS_ID)
    public SpringBus springBus(){
        SpringBus bus = new SpringBus();
        return bus;
    }

    @Bean
    public ServletRegistrationBean<CXFServlet> messageDispatcherServlet(
            ApplicationContext applicationContext, SpringBus springBus){

        CXFServlet cxfServlet = new CXFServlet();
        cxfServlet.setBus(springBus);
        return new ServletRegistrationBean<>(cxfServlet, "/*");
    }
}

Service implementation

Now we will create the service class which will read the soap request and generate the response accordingly. It can be implemented by creating interface also but here I am creating only implementation class. If you create through interfaces please put all annotations to interface and then implement in your service class.
@WebService(serviceName = "hello-service")
public class HelloServiceEndpoint {
    @WebMethod(action="sayHello", operationName = "sayHelloRequest")
    @WebResult(name = "message")
    public String sayHello(SayHelloRequest request){
        return "Hello "+request.getUserName()+"!!!";
    }
}

Service endpoint configuration

Finally we need to create the endpoint for our web service which will be published using the specified endpoint.
@Configuration
public class SoapEndpointsConfig {

    @Bean
    public Endpoint endpoint(SpringBus bus) {
        EndpointImpl endpoint = new EndpointImpl(bus, new HelloServiceEndpoint());
        endpoint.publish("/helloService");
        return endpoint;
    }
}

Running and testing web service using SOAP UI

Now build the maven project and run it using below command.
Once your application is started, please enter below URL in browser.
http://localhost:8080/helloService?wsdl
If you are able to see the WSDL content then it means your service is up and ready for testing. You will see similar screen as given below.
wsdl
Now open the SoapUI and create a new Soap Project by giving the above WSDL URL. It will create a project with sample request also.
Open the request XML and verify that it has correct name space for service schema, if not then you can add it there. In my case it didn't add all namespace, so I added it manually. Now execute the request and you will see the response with hello message as given below.
soap request execution

Source code

You can download the complete source code form below github location.
https://github.com/thetechnojournals/spring-tutorials/tree/master/CxfSoapService

Other posts you may be interested in:

https://www.thetechnojournals.com/2019/10/soap-request-ssl-signature-validation.html

https://www.thetechnojournals.com/2020/02/xml-validation-using-xsd-schema.html

Comments

Popular Posts

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 "property.name" 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 all prop…

Asynchronous REST service implementation in Spring boot

In this tutorial we will see how to create an asynchronous REST service endpoint using Spring boot application.
Asynchronous service works in a way that it will not block the client request and do the processing in separate thread. When work is complete the response returned to the client so our service will be able to handle more client requests at the same time, compare to synchronous processing model.
Let's understand how it is working in synchronous mode. In such server/client application at server side it has a pool of threads which are serving the request. If a request received by a thread then it will be blocked until it send the response back to client. In this case if processing doesn't take much time it will be able to process it quickly and accept other client requests but there could be one situation when all threads are busy and not able to accept the new client requests.

To overcome of such problems, asynchronous processing model introduced for REST services. In…

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 our ent…

Web scraper using JSoup and Spring Boot

What is webscraping Webscraping is a technique to extract or pull the data from a website to gather required information by parsing the HTML source of their websites, such as articles from news or books site, products information from online shopping sites or course information from education sites. There are many organisations who uses web scraper to provide the best experience to their customers, for example extract the price for a smartphone from multiple online websites and show their customers the best and cheap product URL.
We will learn here how to code a web scraper by developing a simple new scraper service.
News scraper News scraper is used to extract the news articles or other related contents from a news site. Here we are going to create a web scraper application to pull the articles from news site.
Below are the operations provided by our news scraper service.
List all the authorsSearch articles by author nameSearch articles by article titleSearch articles by article desc…