SOAP Web Service with Mule ESB

In this tutorial I am going to show you how we can create SOAP web service in Mule ESB. We will use HTTP Connector as a request-response medium to interact with SOAP web service. The SOAP webservice here uses JAX-WS implementation.

You can see also REST Web Service with Mule ESB and Send data to remote REST web application using Mule ESB


Mule Studio 3.x(Anypoint Studio) (Download from
Maven 3.2.1 (Download from
JDK 1.7 (Download from
Configure JDK, Maven and Mule Studio

Step 1. First install JDK
Step 2. Add the Java_Home/bin directory to your system’s PATH.
Step 3. After downloading Maven, extract it to a drive
Step 4. Add the M2_Home/bin directory to your system’s PATH.
Step 5. Download and extract Mule Studio to a drive
Step 6. Now start Mule Studio by clicking on AnypointStudio exe icon in the folder <physical drive>/AnypointStudio
Step 7. Once started, close the startup page
Step 8. In Mule Studio, go to Window -> Preferences. Expand Java, then click on Installed JREs. Add JDK 1.7 and select it. In expanded Java, click on Compiler and select the compiler level as 1.7
Step 9. Now expand Anypoint Studio and click on Maven Settings. Then select appropriate Maven installation home directory using Browse button.
Step 10. If you want you can input Default groupId for new projects, it will save your time every time when you want to create a new project.

Create Mule project in Mule Studio
Now we will see how to create a new project in Mule Studio(Anypoint Studio).

Step 1. In Anypoint Studio, go to File -> New -> Mule Project
Step 2. Input Project Name: mule, Runtime is by default selected, tick on Use Maven; here the artifactId is automatically picked up from the Project Name:, the Group Id is picked up from the Default groupId for new projects and version is also a default value.
Step 3. Click Next and verify the JDK, mainly select Use default JRE(currently ‘jdk1.7.0_x’)
Step 4. Click on Next and click on Finish.


Step 1. Create the soap-with-mule.xml file under src/main/app directory and put the below file connector. While you create the xml file you will see on red mark on each file connector. Do not worry, red mark will be disappeared once you modify the xml file as given in Step 3.

soap with mule

Step 2. Open the soap-with-mule.xml file and click on Configuration XML view in the Editor
Step 3. Modify the soap-with-mule.xml file as shown below

<?xml version="1.0" encoding="UTF-8"?>
<mule xmlns:tracking=""
	xmlns:http="" xmlns:cxf=""
	xmlns="" xmlns:doc=""
	xmlns:spring="" version="EE-3.5.1"
	<flow name="soap-with-mule-flow" doc:name="soap-with-mule-flow">
		<http:inbound-endpoint exchange-pattern="request-response"
			host="localhost" port="8081" path="soap" doc:name="HTTP" />
		<cxf:jaxws-service serviceClass="com.roytuts.mule.soap.service.SoapService"
			doc:name="CXF" />
		<component class="com.roytuts.mule.soap.service.impl.SoapServiceImpl"
			doc:name="Java" />

In the above configuration we a Mule flow named as soap-with-mule-flow and inside this flow there is one http connector, which is acting as inboud-endpoint and handles request and response and there is another component called CXF SOAP, which is used to publish SOAP web service via using JAX-WS.

Step 4. Create a below service interface under directory src/main/java

package com.roytuts.mule.soap.service;
import javax.jws.WebService;
public interface SoapService {
	String sayHello(String name);

Step 5. Create a below service implementation class under src/main/java

package com.roytuts.mule.soap.service.impl;
import javax.jws.WebService;
import com.roytuts.mule.soap.service.SoapService;
@WebService(endpointInterface = "com.roytuts.mule.soap.service.SoapService")
public class SoapServiceImpl implements SoapService {
	public String sayHello(final String name) {
		return "Hello " + name + ", how are you?";

Step 6. Running the application

Now do a right-click on the rest-with-mule.xml file and click on Run As -> Mule Application. Then you will see something like below in Console when the application runs

INFO  2016-09-30 16:06:34,590 [main] org.mule.DefaultMuleContext:
* Application: mule                                                  *
* OS encoding: Cp1252, Mule encoding: UTF-8                          *
*                                                                    *
* Agents Running:                                                    *
*   DevKit Extension Information                                     *
*   Batch module default engine                                      *
*   Clustering Agent                                                 *
*   JMX Agent                                                        *
INFO  2016-09-30 16:06:34,590 [main] org.mule.module.launcher.MuleDeploymentService:
+ Started app 'mule'                                       +
INFO  2016-09-30 16:06:34,593 [main] org.mule.module.launcher.DeploymentDirectoryWatcher:
+ Mule is up and kicking (every 5000ms)                    +

Once the application is up and running, try to hit the URL http://localhost:8081/soap?wsdl in the browser, you will get the below attached wsdl file


Step 7. Create web service client class under src/main/java to test the service.

package com.roytuts.mule.service.test;
import javax.xml.namespace.QName;
import com.roytuts.mule.soap.service.SoapService;
public class SoapTest {
	 * @param args
	 * @throws MalformedURLException
	public static void main(String[] args) throws MalformedURLException {
		URL url = new URL("http://localhost:8081/soap?wsdl");
		QName qname = new QName("",
		Service service = Service.create(url, qname);
		SoapService soapService = service.getPort(SoapService.class);
		String response = soapService.sayHello("Soumitra");

Step 7. Run the above client class, you will see below output in the console.

Hello Soumitra, how are you?

Thanks for reading.

1 thought on “SOAP Web Service with Mule ESB

Leave a Reply

Your email address will not be published. Required fields are marked *