Table of Contents<\/h3>\n\n- 1. Introduction<\/a><\/dt>\n
- 2. Application<\/a><\/dt>\n
- 3. Environment<\/a><\/dt>\n
- 4. Source Code<\/a><\/dt>\n
- 5. How to Run and Test<\/a><\/dt>\n
- 6. Summary<\/a><\/dt>\n
- 7. Useful Links<\/a><\/dt>\n
- 8. Download the Source Code<\/a><\/dt>\n<\/dl>\n<\/div>\n
<\/a>1. Introduction<\/h2>\nIn this article, we will show how to implement a SOAP web service with XML request and response in a Spring Boot application. Using Spring framework’s Dependency Injection and annotation based support in conjunction with the maven plugin jaxb2-maven-plugin,<\/code> the whole process of extracting XML from the SOAP input, mapping to Java objects and returning the SOAP response becomes very easy so that developers can focus on implementing business logic and unit testing the application.<\/p>\n<\/a>2. Application<\/h2>\nThe application we will develop is a web service for calculating the surcharge to be applied to an order. An order has the fields id, value, payment_method and a customer. The fields of customer are name (“first”, “last”) and an address, which in turn has the fields street (“line” which can take values 1 and 2), city, postal code and country.<\/p>\n
The surcharge is calculated as a percentage. If the customer’s country is “US”, surcharge is 10%, otherwise it is 15%. If payment method is credit card, indicated by CC, the surcharge will be increased by 3%. If the order value is greater than 1000, a discount of 1% will be given. A discount is a negative surcharge and since the calculation is very simple, it is kept in this service. In real world applications, discounting will be a service of its own. Since all surcharges for this application are in percentages, we will not consider the % symbol either in the input or output and will be returned as an int.<\/p>\n
<\/a>3. Environment<\/h2>\nI have used the following technologies for this application:<\/p>\n
\n- Java 1.8<\/li>\n
- Spring Boot 1.5.9<\/li>\n
- JAXB2 Maven plugin 1.6<\/li>\n
- Maven 3.3.9<\/li>\n
- Ubuntu 16.04 LTS<\/li>\n<\/ul>\n
<\/a>4. Source Code<\/h2>\nTypically you would get a sample XML file from your business analyst or client showing all the elements and data used to send as input to the web service. The following snippet shows a sample order in XML format.<\/p>\n
sample1.xml<\/em><\/span><\/p>\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<order>\n <id>S12345<\/id>\n <value>1250<\/value>\n <payment_method>CC<\/payment_method>\n <customer>\n <name part=\"first\">Nancy<\/name>\n <name part=\"last\">Smith<\/name>\n <address>\n <street line=\"1\">41 Earnest Road<\/street>\n <street line=\"2\">Rotamonte Park<\/street>\n <city>Koregon<\/city>\n <postalcode>12345<\/postalcode>\n <country>UK<\/country>\n <\/address>\n <\/customer>\n<\/order>\n<\/pre>\nThe first step in implementing the SOAP web service is to create an XML schema definition file. We will name it surcharge.xsd<\/code> and it can be either hand written or generated with a plugin. I have used the online tool xmlgrid.net\/xml2xsd.html<\/a>. The generated xsd shows a few errors in Eclipse, which had to be corrected. For example, the error for name<\/code> element is:<\/p>\nElement 'name' has both a 'type' attribute and a 'anonymous type' child. Only one of these is allowed for an element.<\/pre>\nThe generated XML is:<\/p>\n
<xs:element name=\"name\" maxOccurs=\"unbounded\" type=\"xs:string\">\n <xs:complexType>\n <xs:attribute name=\"part\" type=\"xs:string\"><\/xs:attribute>\n <\/xs:complexType>\n<\/xs:element><\/pre>\nIt has to be corrected to<\/p>\n
<xs:element maxOccurs=\"2\" name=\"name\">\n <xs:complexType>\n <xs:simpleContent>\n <xs:extension base=\"xs:string\">\n <xs:attribute name=\"part\" type=\"xs:string\" \/>\n <\/xs:extension>\n <\/xs:simpleContent>\n <\/xs:complexType>\n<\/xs:element>\n<\/pre>\nIn general, the xsd file has two patterns to be applied:
\n1) element – complexType – sequence – element – complexType – sequence – element \/ element
\n2) element – complexType – simpleContent – extension – attribute<\/p>\n
Your xsd file will be a combination of these two patterns to cater to any nested XML data. The final corrected xsd file including the response element is shown below:<\/p>\n
surcharge.xsd<\/em><\/span><\/p>\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<xs:schema xmlns:xs=\"http:\/\/www.w3.org\/2001\/XMLSchema\"\ntargetNamespace=\"http:\/\/www.javacodegeeks.org\/webservices\/soap\/surcharge\/generated\"\nxmlns:tns=\"http:\/\/www.javacodegeeks.org\/webservices\/soap\/surcharge\/generated\"\nelementFormDefault=\"qualified\">\n\n <xs:element name=\"SurchargeRequest\">\n <xs:complexType>\n <xs:sequence>\n <xs:element name=\"order\">\n <xs:complexType>\n <xs:sequence>\n <xs:element name=\"id\" type=\"xs:string\"><\/xs:element>\n <xs:element name=\"value\" type=\"xs:int\"><\/xs:element>\n <xs:element name=\"payment_method\" type=\"xs:string\"><\/xs:element>\n <xs:element name=\"customer\">\n <xs:complexType>\n <xs:sequence>\n <xs:element maxOccurs=\"2\" name=\"name\">\n <xs:complexType>\n <xs:simpleContent>\n <xs:extension base=\"xs:string\">\n <xs:attribute name=\"part\" type=\"xs:string\" \/>\n <\/xs:extension>\n <\/xs:simpleContent>\n <\/xs:complexType>\n <\/xs:element>\n <xs:element name=\"address\">\n <xs:complexType>\n <xs:sequence>\n <xs:element maxOccurs=\"2\" name=\"street\">\n <xs:complexType>\n <xs:simpleContent>\n <xs:extension base=\"xs:string\">\n <xs:attribute name=\"line\" type=\"xs:string\" \/>\n <\/xs:extension>\n <\/xs:simpleContent>\n <\/xs:complexType>\n <\/xs:element>\n <xs:element name=\"city\" type=\"xs:string\"><\/xs:element>\n <xs:element name=\"postalcode\" type=\"xs:int\"><\/xs:element>\n <xs:element name=\"country\" type=\"xs:string\"><\/xs:element>\n <\/xs:sequence>\n <\/xs:complexType>\n <\/xs:element>\n <\/xs:sequence>\n <\/xs:complexType>\n <\/xs:element>\n <\/xs:sequence>\n <\/xs:complexType>\n <\/xs:element>\n <\/xs:sequence>\n <\/xs:complexType>\n <\/xs:element>\n\n <xs:element name=\"SurchargeResponse\">\n <xs:complexType>\n <xs:sequence>\n <xs:element name=\"surcharge\" type=\"xs:int\" \/>\n <\/xs:sequence>\n <\/xs:complexType>\n <\/xs:element>\n\n<\/xs:schema>\n<\/pre>\nThe target namespace is specified as “http:\/\/www.javacodegeeks.org\/webservices\/soap\/surcharge\/generated”. With this, a package called org.javacodegeeks.webservices.soap.surcharge.generated<\/code> will be created during compile time and the classes generated from the xsd file will be placed there. <\/div> <\/div><\/p>\nSince this is a maven-based project, all the project-level settings and dependencies are given in pom.xml file.<\/p>\n
pom.xml<\/em><\/span><\/p>\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<project xmlns=\"http:\/\/maven.apache.org\/POM\/4.0.0\" xmlns:xsi=\"http:\/\/www.w3.org\/2001\/XMLSchema-instance\"\nxsi:schemaLocation=\"http:\/\/maven.apache.org\/POM\/4.0.0 http:\/\/maven.apache.org\/xsd\/maven-4.0.0.xsd\">\n <modelVersion>4.0.0<\/modelVersion>\n\n <groupId>org.javacodegeeks.webservices.soap<\/groupId>\n <artifactId>surcharge<\/artifactId>\n <version>0.0.1-SNAPSHOT<\/version>\n <packaging>jar<\/packaging>\n\n <name>surcharge<\/name>\n <description>Demo project for Spring Boot<\/description>\n\n <parent>\n <groupId>org.springframework.boot<\/groupId>\n <artifactId>spring-boot-starter-parent<\/artifactId>\n <version>1.5.9.RELEASE<\/version>\n <relativePath \/> <!-- lookup parent from repository -->\n <\/parent>\n\n <properties>\n <project.build.sourceEncoding>UTF-8<\/project.build.sourceEncoding>\n <project.reporting.outputEncoding>UTF-8<\/project.reporting.outputEncoding>\n <java.version>1.8<\/java.version>\n <\/properties>\n\n <dependencies>\n <dependency>\n <groupId>org.springframework.boot<\/groupId>\n <artifactId>spring-boot-starter-web-services<\/artifactId>\n <\/dependency>\n <dependency>\n <groupId>wsdl4j<\/groupId>\n <artifactId>wsdl4j<\/artifactId>\n <\/dependency>\n <dependency>\n <groupId>org.springframework.boot<\/groupId>\n <artifactId>spring-boot-starter-test<\/artifactId>\n <scope>test<\/scope>\n <\/dependency>\n <\/dependencies>\n\n <build>\n <plugins>\n <plugin>\n <groupId>org.springframework.boot<\/groupId>\n <artifactId>spring-boot-maven-plugin<\/artifactId>\n <\/plugin>\n <plugin>\n <groupId>org.codehaus.mojo<\/groupId>\n <artifactId>jaxb2-maven-plugin<\/artifactId>\n <version>1.6<\/version>\n <executions>\n <execution>\n <id>xjc<\/id>\n <goals>\n <goal>xjc<\/goal>\n <\/goals>\n <\/execution>\n <\/executions>\n <configuration>\n <clearOutputDir>false<\/clearOutputDir>\n <schemaDirectory>${project.basedir}\/src\/main\/resources<\/schemaDirectory>\n <outputDirectory>${project.basedir}\/src\/main\/java<\/outputDirectory>\n <\/configuration>\n <\/plugin>\n <\/plugins>\n <\/build>\n<\/project>\n<\/pre>\nThe configuration for jaxb2-maven-plugin<\/code> specifies that the output directory should not cleared when the classes are generated, the schema file is located in src\/main\/resources<\/code> directory and that the output directory where the package should be created is src\/main\/java<\/code>.<\/p>\nSurchargeApplication.java<\/em><\/span><\/p>\npackage org.javacodegeeks.webservices.soap.surcharge;\n\nimport org.springframework.boot.SpringApplication;\nimport org.springframework.boot.autoconfigure.SpringBootApplication;\n\n@SpringBootApplication\npublic class SurchargeApplication {\n\n\tpublic static void main(String[] args) {\n\t\tSpringApplication.run(SurchargeApplication.class, args);\n\t\t\n\t\tSystem.out.println(\"SurchargeApplication now running....\");\n\t}\n}\n<\/pre>\nThis is the main class of the application that runs on the default Tomcat container of Spring Boot at port 8080.[ulp id=’7POIYxRf1FUtPpmL’]<\/p>\n
SoapConfig.java<\/em><\/span><\/p>\npackage org.javacodegeeks.webservices.soap.surcharge.config;\n\nimport org.springframework.boot.web.servlet.ServletRegistrationBean;\nimport org.springframework.context.ApplicationContext;\nimport org.springframework.context.annotation.Bean;\nimport org.springframework.context.annotation.Configuration;\nimport org.springframework.core.io.ClassPathResource;\nimport org.springframework.ws.config.annotation.EnableWs;\nimport org.springframework.ws.transport.http.MessageDispatcherServlet;\nimport org.springframework.ws.wsdl.wsdl11.DefaultWsdl11Definition;\nimport org.springframework.xml.xsd.SimpleXsdSchema;\nimport org.springframework.xml.xsd.XsdSchema;\n\n@EnableWs\n@Configuration\npublic class SoapConfig {\n\t@Bean\n\tpublic XsdSchema surchargeSchema() {\n\t\treturn new SimpleXsdSchema(new ClassPathResource(\"surcharge.xsd\"));\n\t}\n\t\n\t@Bean(name = \"surcharge\")\n\tpublic DefaultWsdl11Definition defaultWsdl11Definition(XsdSchema surchargeSchema) {\n\t\tDefaultWsdl11Definition definition = new DefaultWsdl11Definition();\n\t\tdefinition.setPortTypeName(\"SurchargePort\");\n\t\tdefinition.setTargetNamespace(\"http:\/\/www.javacodegeeks.org\/webservices\/soap\/surcharge\/generated\");\n\t\tdefinition.setLocationUri(\"\/ws\");\n\t\tdefinition.setSchema(surchargeSchema);\n\t\treturn definition;\n\t}\n\t\n\t@Bean\n\tpublic ServletRegistrationBean messageDispatcherServlet(ApplicationContext context) {\n\t\tMessageDispatcherServlet messageDispatcherServlet = new MessageDispatcherServlet();\n\t\tmessageDispatcherServlet.setApplicationContext(context);\n\t\tmessageDispatcherServlet.setTransformWsdlLocations(true);\n\t\treturn new ServletRegistrationBean(messageDispatcherServlet, \"\/ws\/*\");\n\t}\n\n}\n<\/pre>\nThis class sets up the configures all the beans required as the application infrastructure. @EnableWS<\/code> enables all the Spring Java web services configuration defined in WsConfigurationSupport<\/code> class to be imported to our application configuration. It provides facilities for endpoint mapping to annotated controllers, adapters and exception handlers.<\/p>\nFirst, in the surchargeSchema<\/code> method, the surcharge.xsd<\/code> file is used to configure a SimpleXsdSchema<\/code> bean. Next, in the defaultWsdl11Definition<\/code> method, this bean set as the schema in a DefaultWsdl11Definition<\/code> with the name surcharge. Last, in the messageDispatcherServlet<\/code> method, a MessageDispatcherServlet<\/code> is created to take the ApplicationContext<\/code> and then used to create a ServletRegistrationBean<\/code> to handle the URI path \/ws<\/code>.<\/p>\nSurchargeEndpoint.java<\/em><\/span><\/p>\npackage org.javacodegeeks.webservices.soap.surcharge.endpoint;\n\nimport org.javacodegeeks.webservices.soap.surcharge.generated.SurchargeRequest;\nimport org.javacodegeeks.webservices.soap.surcharge.generated.SurchargeResponse;\nimport org.javacodegeeks.webservices.soap.surcharge.service.SurchargeService;\nimport org.springframework.beans.factory.annotation.Autowired;\nimport org.springframework.ws.server.endpoint.annotation.Endpoint;\nimport org.springframework.ws.server.endpoint.annotation.PayloadRoot;\nimport org.springframework.ws.server.endpoint.annotation.RequestPayload;\nimport org.springframework.ws.server.endpoint.annotation.ResponsePayload;\n\n@Endpoint\npublic class SurchargeEndpoint {\n\n\t@Autowired\n\tSurchargeService service;\n\n\t@PayloadRoot(namespace = \"http:\/\/www.javacodegeeks.org\/webservices\/soap\/surcharge\/generated\", localPart = \"SurchargeRequest\")\n\t@ResponsePayload\n\tpublic SurchargeResponse processCourseDetailsRequest(@RequestPayload SurchargeRequest request) {\n\n\t\tSurchargeResponse response = new SurchargeResponse();\n\n\t\tint surcharge = service.calculateSurcharge(request.getOrder());\n\t\tresponse.setSurcharge(surcharge);\n\n\t\treturn response;\n\t}\n\n}\n<\/pre>\nThis class has a SurchargeService<\/code> bean auto-wired. With the @PayloadRoot<\/code> annotation, we mark the method processCourseDetailsRequest<\/code> as the handler for the incoming request. The @ResponsePayload<\/code> annotation marks that the return value should be bound to the response payload.<\/p>\nIn the processCourseDetailsRequest<\/code> method, a SurchargeResponse<\/code> object is instantiated. The service bean’s calculateSurcharge<\/code> method is called passing in the Order<\/code> object from the SurchargeRequest<\/code> input. The calculated surcharge<\/code> returned from the call is set into the SurchargeResponse<\/code> object that is then returned.<\/p>\nSurchargeService.java<\/em><\/span><\/p>\npackage org.javacodegeeks.webservices.soap.surcharge.service;\n\nimport org.javacodegeeks.webservices.soap.surcharge.generated.SurchargeRequest.Order;\nimport org.springframework.stereotype.Component;\n\n@Component\npublic class SurchargeService {\n\t\n\tpublic int calculateSurcharge(Order order) {\n\t\t\n\t\tint surcharge = 15;\n\t\tif (order.getCustomer().getAddress().getCountry().equals(\"US\"))\n\t\t\tsurcharge = 10;\n\n\t\tif (order.getPaymentMethod().equals(\"CC\"))\n\t\t\tsurcharge += 3;\n\n\t\tif (order.getValue() > 1000)\n\t\t\tsurcharge -= 1;\n\n\t\treturn surcharge;\n\t}\n}\n<\/pre>\nThis class has a method calculateSurcharge<\/code> that implements the business logic of calculating the surcharge<\/code> for a given order<\/code>, as given in Section 2 above.<\/p>\n<\/a>5. How To Run and Test<\/h2>\nIn a terminal window go to the project root folder and enter<\/p>\n
mvn spring-boot:run<\/pre>\nThere are many client applications like SoapUI or Wizdler that you can use to invoke this service. I have used Postman app. The test request data is formed by just a few changes to the sample XML file we started with.<\/p>\n
test1.xml<\/em><\/span><\/p>\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<soapenv:Envelope xmlns:soapenv=\"http:\/\/schemas.xmlsoap.org\/soap\/envelope\/\"\n xmlns=\"http:\/\/schemas.xmlsoap.org\/soap\/envelope\/\">\n <soapenv:Body>\n <SurchargeRequest xmlns=\"http:\/\/www.javacodegeeks.org\/webservices\/soap\/surcharge\/generated\">\n <order>\n <id>S12345<\/id>\n <value>1250<\/value>\n <payment_method>CC<\/payment_method>\n <customer>\n <name part=\"first\">Nancy<\/name>\n <name part=\"last\">Smith<\/name>\n <address>\n <street line=\"1\">41 Earnest Road<\/street>\n <street line=\"2\">Rotamonte Park<\/street>\n <city>Koregon<\/city>\n <postalcode>12345<\/postalcode>\n <country>UK<\/country>\n <\/address>\n <\/customer>\n <\/order>\n <\/SurchargeRequest>\n <\/soapenv:Body>\n<\/soapenv:Envelope>\n<\/pre>\nGiven below is the screen shot of Postman showing the input soap XML and the response from the web service.<\/p>\n
![\"\"](\"http:\/\/examples.javacodegeeks.com\/wp-content\/uploads\/2018\/01\/output.jpg\")
<\/a>Output showing sample SOAP Request and Response of SurchargeService.<\/figcaption><\/figure><\/p>\nSince the order country is not “US”, payment method is “CC”, and the value is greater than 1000, the surcharge calculated is 15 + 3 -1 = 17, which is returned in the response.<\/p>\n
<\/a>6. Summary<\/h2>\nIn this article, we have seen how to use Spring framework in conjunction with maven plugin to implement a SOAP web service that take XML request and returns an XML response. We have also seen how to start from a sample XML to generate the XML schema definition and from there use the maven plugin and Spring annotations to transform the XML input to Java objects that are then used to execute the business logic.<\/p>\n
<\/a>7. Useful Links<\/h2>\nFollowing resources will be very useful to get additional information and insights on concepts discussed in this article:<\/p>\n
\n- https:\/\/blog.smartbear.com\/apis\/understanding-soap-and-rest-basics\/<\/a><\/li>\n
- http:\/\/mh-journal.blogspot.in\/2015\/08\/generating-xsds-for-xml-interfaces.html<\/a><\/li>\n
- https:\/\/www.getpostman.com\/docs\/postman\/sending_api_requests\/making_soap_requests<\/a><\/li>\n<\/ul>\n
<\/a>8. Download the Source Code<\/h2>\n
<\/a>1. Introduction<\/h2>\nIn this article, we will show how to implement a SOAP web service with XML request and response in a Spring Boot application. Using Spring framework’s Dependency Injection and annotation based support in conjunction with the maven plugin jaxb2-maven-plugin,<\/code> the whole process of extracting XML from the SOAP input, mapping to Java objects and returning the SOAP response becomes very easy so that developers can focus on implementing business logic and unit testing the application.<\/p>\n<\/a>2. Application<\/h2>\nThe application we will develop is a web service for calculating the surcharge to be applied to an order. An order has the fields id, value, payment_method and a customer. The fields of customer are name (“first”, “last”) and an address, which in turn has the fields street (“line” which can take values 1 and 2), city, postal code and country.<\/p>\n
The surcharge is calculated as a percentage. If the customer’s country is “US”, surcharge is 10%, otherwise it is 15%. If payment method is credit card, indicated by CC, the surcharge will be increased by 3%. If the order value is greater than 1000, a discount of 1% will be given. A discount is a negative surcharge and since the calculation is very simple, it is kept in this service. In real world applications, discounting will be a service of its own. Since all surcharges for this application are in percentages, we will not consider the % symbol either in the input or output and will be returned as an int.<\/p>\n
<\/a>3. Environment<\/h2>\nI have used the following technologies for this application:<\/p>\n
\n- Java 1.8<\/li>\n
- Spring Boot 1.5.9<\/li>\n
- JAXB2 Maven plugin 1.6<\/li>\n
- Maven 3.3.9<\/li>\n
- Ubuntu 16.04 LTS<\/li>\n<\/ul>\n
<\/a>4. Source Code<\/h2>\nTypically you would get a sample XML file from your business analyst or client showing all the elements and data used to send as input to the web service. The following snippet shows a sample order in XML format.<\/p>\n
sample1.xml<\/em><\/span><\/p>\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<order>\n <id>S12345<\/id>\n <value>1250<\/value>\n <payment_method>CC<\/payment_method>\n <customer>\n <name part=\"first\">Nancy<\/name>\n <name part=\"last\">Smith<\/name>\n <address>\n <street line=\"1\">41 Earnest Road<\/street>\n <street line=\"2\">Rotamonte Park<\/street>\n <city>Koregon<\/city>\n <postalcode>12345<\/postalcode>\n <country>UK<\/country>\n <\/address>\n <\/customer>\n<\/order>\n<\/pre>\nThe first step in implementing the SOAP web service is to create an XML schema definition file. We will name it surcharge.xsd<\/code> and it can be either hand written or generated with a plugin. I have used the online tool xmlgrid.net\/xml2xsd.html<\/a>. The generated xsd shows a few errors in Eclipse, which had to be corrected. For example, the error for name<\/code> element is:<\/p>\nElement 'name' has both a 'type' attribute and a 'anonymous type' child. Only one of these is allowed for an element.<\/pre>\nThe generated XML is:<\/p>\n
<xs:element name=\"name\" maxOccurs=\"unbounded\" type=\"xs:string\">\n <xs:complexType>\n <xs:attribute name=\"part\" type=\"xs:string\"><\/xs:attribute>\n <\/xs:complexType>\n<\/xs:element><\/pre>\nIt has to be corrected to<\/p>\n
<xs:element maxOccurs=\"2\" name=\"name\">\n <xs:complexType>\n <xs:simpleContent>\n <xs:extension base=\"xs:string\">\n <xs:attribute name=\"part\" type=\"xs:string\" \/>\n <\/xs:extension>\n <\/xs:simpleContent>\n <\/xs:complexType>\n<\/xs:element>\n<\/pre>\nIn general, the xsd file has two patterns to be applied:
\n1) element – complexType – sequence – element – complexType – sequence – element \/ element
\n2) element – complexType – simpleContent – extension – attribute<\/p>\n
Your xsd file will be a combination of these two patterns to cater to any nested XML data. The final corrected xsd file including the response element is shown below:<\/p>\n
surcharge.xsd<\/em><\/span><\/p>\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<xs:schema xmlns:xs=\"http:\/\/www.w3.org\/2001\/XMLSchema\"\ntargetNamespace=\"http:\/\/www.javacodegeeks.org\/webservices\/soap\/surcharge\/generated\"\nxmlns:tns=\"http:\/\/www.javacodegeeks.org\/webservices\/soap\/surcharge\/generated\"\nelementFormDefault=\"qualified\">\n\n <xs:element name=\"SurchargeRequest\">\n <xs:complexType>\n <xs:sequence>\n <xs:element name=\"order\">\n <xs:complexType>\n <xs:sequence>\n <xs:element name=\"id\" type=\"xs:string\"><\/xs:element>\n <xs:element name=\"value\" type=\"xs:int\"><\/xs:element>\n <xs:element name=\"payment_method\" type=\"xs:string\"><\/xs:element>\n <xs:element name=\"customer\">\n <xs:complexType>\n <xs:sequence>\n <xs:element maxOccurs=\"2\" name=\"name\">\n <xs:complexType>\n <xs:simpleContent>\n <xs:extension base=\"xs:string\">\n <xs:attribute name=\"part\" type=\"xs:string\" \/>\n <\/xs:extension>\n <\/xs:simpleContent>\n <\/xs:complexType>\n <\/xs:element>\n <xs:element name=\"address\">\n <xs:complexType>\n <xs:sequence>\n <xs:element maxOccurs=\"2\" name=\"street\">\n <xs:complexType>\n <xs:simpleContent>\n <xs:extension base=\"xs:string\">\n <xs:attribute name=\"line\" type=\"xs:string\" \/>\n <\/xs:extension>\n <\/xs:simpleContent>\n <\/xs:complexType>\n <\/xs:element>\n <xs:element name=\"city\" type=\"xs:string\"><\/xs:element>\n <xs:element name=\"postalcode\" type=\"xs:int\"><\/xs:element>\n <xs:element name=\"country\" type=\"xs:string\"><\/xs:element>\n <\/xs:sequence>\n <\/xs:complexType>\n <\/xs:element>\n <\/xs:sequence>\n <\/xs:complexType>\n <\/xs:element>\n <\/xs:sequence>\n <\/xs:complexType>\n <\/xs:element>\n <\/xs:sequence>\n <\/xs:complexType>\n <\/xs:element>\n\n <xs:element name=\"SurchargeResponse\">\n <xs:complexType>\n <xs:sequence>\n <xs:element name=\"surcharge\" type=\"xs:int\" \/>\n <\/xs:sequence>\n <\/xs:complexType>\n <\/xs:element>\n\n<\/xs:schema>\n<\/pre>\nThe target namespace is specified as “http:\/\/www.javacodegeeks.org\/webservices\/soap\/surcharge\/generated”. With this, a package called org.javacodegeeks.webservices.soap.surcharge.generated<\/code> will be created during compile time and the classes generated from the xsd file will be placed there. <\/div> <\/div><\/p>\nSince this is a maven-based project, all the project-level settings and dependencies are given in pom.xml file.<\/p>\n
pom.xml<\/em><\/span><\/p>\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<project xmlns=\"http:\/\/maven.apache.org\/POM\/4.0.0\" xmlns:xsi=\"http:\/\/www.w3.org\/2001\/XMLSchema-instance\"\nxsi:schemaLocation=\"http:\/\/maven.apache.org\/POM\/4.0.0 http:\/\/maven.apache.org\/xsd\/maven-4.0.0.xsd\">\n <modelVersion>4.0.0<\/modelVersion>\n\n <groupId>org.javacodegeeks.webservices.soap<\/groupId>\n <artifactId>surcharge<\/artifactId>\n <version>0.0.1-SNAPSHOT<\/version>\n <packaging>jar<\/packaging>\n\n <name>surcharge<\/name>\n <description>Demo project for Spring Boot<\/description>\n\n <parent>\n <groupId>org.springframework.boot<\/groupId>\n <artifactId>spring-boot-starter-parent<\/artifactId>\n <version>1.5.9.RELEASE<\/version>\n <relativePath \/> <!-- lookup parent from repository -->\n <\/parent>\n\n <properties>\n <project.build.sourceEncoding>UTF-8<\/project.build.sourceEncoding>\n <project.reporting.outputEncoding>UTF-8<\/project.reporting.outputEncoding>\n <java.version>1.8<\/java.version>\n <\/properties>\n\n <dependencies>\n <dependency>\n <groupId>org.springframework.boot<\/groupId>\n <artifactId>spring-boot-starter-web-services<\/artifactId>\n <\/dependency>\n <dependency>\n <groupId>wsdl4j<\/groupId>\n <artifactId>wsdl4j<\/artifactId>\n <\/dependency>\n <dependency>\n <groupId>org.springframework.boot<\/groupId>\n <artifactId>spring-boot-starter-test<\/artifactId>\n <scope>test<\/scope>\n <\/dependency>\n <\/dependencies>\n\n <build>\n <plugins>\n <plugin>\n <groupId>org.springframework.boot<\/groupId>\n <artifactId>spring-boot-maven-plugin<\/artifactId>\n <\/plugin>\n <plugin>\n <groupId>org.codehaus.mojo<\/groupId>\n <artifactId>jaxb2-maven-plugin<\/artifactId>\n <version>1.6<\/version>\n <executions>\n <execution>\n <id>xjc<\/id>\n <goals>\n <goal>xjc<\/goal>\n <\/goals>\n <\/execution>\n <\/executions>\n <configuration>\n <clearOutputDir>false<\/clearOutputDir>\n <schemaDirectory>${project.basedir}\/src\/main\/resources<\/schemaDirectory>\n <outputDirectory>${project.basedir}\/src\/main\/java<\/outputDirectory>\n <\/configuration>\n <\/plugin>\n <\/plugins>\n <\/build>\n<\/project>\n<\/pre>\nThe configuration for jaxb2-maven-plugin<\/code> specifies that the output directory should not cleared when the classes are generated, the schema file is located in src\/main\/resources<\/code> directory and that the output directory where the package should be created is src\/main\/java<\/code>.<\/p>\nSurchargeApplication.java<\/em><\/span><\/p>\npackage org.javacodegeeks.webservices.soap.surcharge;\n\nimport org.springframework.boot.SpringApplication;\nimport org.springframework.boot.autoconfigure.SpringBootApplication;\n\n@SpringBootApplication\npublic class SurchargeApplication {\n\n\tpublic static void main(String[] args) {\n\t\tSpringApplication.run(SurchargeApplication.class, args);\n\t\t\n\t\tSystem.out.println(\"SurchargeApplication now running....\");\n\t}\n}\n<\/pre>\nThis is the main class of the application that runs on the default Tomcat container of Spring Boot at port 8080.[ulp id=’7POIYxRf1FUtPpmL’]<\/p>\n
SoapConfig.java<\/em><\/span><\/p>\npackage org.javacodegeeks.webservices.soap.surcharge.config;\n\nimport org.springframework.boot.web.servlet.ServletRegistrationBean;\nimport org.springframework.context.ApplicationContext;\nimport org.springframework.context.annotation.Bean;\nimport org.springframework.context.annotation.Configuration;\nimport org.springframework.core.io.ClassPathResource;\nimport org.springframework.ws.config.annotation.EnableWs;\nimport org.springframework.ws.transport.http.MessageDispatcherServlet;\nimport org.springframework.ws.wsdl.wsdl11.DefaultWsdl11Definition;\nimport org.springframework.xml.xsd.SimpleXsdSchema;\nimport org.springframework.xml.xsd.XsdSchema;\n\n@EnableWs\n@Configuration\npublic class SoapConfig {\n\t@Bean\n\tpublic XsdSchema surchargeSchema() {\n\t\treturn new SimpleXsdSchema(new ClassPathResource(\"surcharge.xsd\"));\n\t}\n\t\n\t@Bean(name = \"surcharge\")\n\tpublic DefaultWsdl11Definition defaultWsdl11Definition(XsdSchema surchargeSchema) {\n\t\tDefaultWsdl11Definition definition = new DefaultWsdl11Definition();\n\t\tdefinition.setPortTypeName(\"SurchargePort\");\n\t\tdefinition.setTargetNamespace(\"http:\/\/www.javacodegeeks.org\/webservices\/soap\/surcharge\/generated\");\n\t\tdefinition.setLocationUri(\"\/ws\");\n\t\tdefinition.setSchema(surchargeSchema);\n\t\treturn definition;\n\t}\n\t\n\t@Bean\n\tpublic ServletRegistrationBean messageDispatcherServlet(ApplicationContext context) {\n\t\tMessageDispatcherServlet messageDispatcherServlet = new MessageDispatcherServlet();\n\t\tmessageDispatcherServlet.setApplicationContext(context);\n\t\tmessageDispatcherServlet.setTransformWsdlLocations(true);\n\t\treturn new ServletRegistrationBean(messageDispatcherServlet, \"\/ws\/*\");\n\t}\n\n}\n<\/pre>\nThis class sets up the configures all the beans required as the application infrastructure. @EnableWS<\/code> enables all the Spring Java web services configuration defined in WsConfigurationSupport<\/code> class to be imported to our application configuration. It provides facilities for endpoint mapping to annotated controllers, adapters and exception handlers.<\/p>\nFirst, in the surchargeSchema<\/code> method, the surcharge.xsd<\/code> file is used to configure a SimpleXsdSchema<\/code> bean. Next, in the defaultWsdl11Definition<\/code> method, this bean set as the schema in a DefaultWsdl11Definition<\/code> with the name surcharge. Last, in the messageDispatcherServlet<\/code> method, a MessageDispatcherServlet<\/code> is created to take the ApplicationContext<\/code> and then used to create a ServletRegistrationBean<\/code> to handle the URI path \/ws<\/code>.<\/p>\nSurchargeEndpoint.java<\/em><\/span><\/p>\npackage org.javacodegeeks.webservices.soap.surcharge.endpoint;\n\nimport org.javacodegeeks.webservices.soap.surcharge.generated.SurchargeRequest;\nimport org.javacodegeeks.webservices.soap.surcharge.generated.SurchargeResponse;\nimport org.javacodegeeks.webservices.soap.surcharge.service.SurchargeService;\nimport org.springframework.beans.factory.annotation.Autowired;\nimport org.springframework.ws.server.endpoint.annotation.Endpoint;\nimport org.springframework.ws.server.endpoint.annotation.PayloadRoot;\nimport org.springframework.ws.server.endpoint.annotation.RequestPayload;\nimport org.springframework.ws.server.endpoint.annotation.ResponsePayload;\n\n@Endpoint\npublic class SurchargeEndpoint {\n\n\t@Autowired\n\tSurchargeService service;\n\n\t@PayloadRoot(namespace = \"http:\/\/www.javacodegeeks.org\/webservices\/soap\/surcharge\/generated\", localPart = \"SurchargeRequest\")\n\t@ResponsePayload\n\tpublic SurchargeResponse processCourseDetailsRequest(@RequestPayload SurchargeRequest request) {\n\n\t\tSurchargeResponse response = new SurchargeResponse();\n\n\t\tint surcharge = service.calculateSurcharge(request.getOrder());\n\t\tresponse.setSurcharge(surcharge);\n\n\t\treturn response;\n\t}\n\n}\n<\/pre>\nThis class has a SurchargeService<\/code> bean auto-wired. With the @PayloadRoot<\/code> annotation, we mark the method processCourseDetailsRequest<\/code> as the handler for the incoming request. The @ResponsePayload<\/code> annotation marks that the return value should be bound to the response payload.<\/p>\nIn the processCourseDetailsRequest<\/code> method, a SurchargeResponse<\/code> object is instantiated. The service bean’s calculateSurcharge<\/code> method is called passing in the Order<\/code> object from the SurchargeRequest<\/code> input. The calculated surcharge<\/code> returned from the call is set into the SurchargeResponse<\/code> object that is then returned.<\/p>\nSurchargeService.java<\/em><\/span><\/p>\npackage org.javacodegeeks.webservices.soap.surcharge.service;\n\nimport org.javacodegeeks.webservices.soap.surcharge.generated.SurchargeRequest.Order;\nimport org.springframework.stereotype.Component;\n\n@Component\npublic class SurchargeService {\n\t\n\tpublic int calculateSurcharge(Order order) {\n\t\t\n\t\tint surcharge = 15;\n\t\tif (order.getCustomer().getAddress().getCountry().equals(\"US\"))\n\t\t\tsurcharge = 10;\n\n\t\tif (order.getPaymentMethod().equals(\"CC\"))\n\t\t\tsurcharge += 3;\n\n\t\tif (order.getValue() > 1000)\n\t\t\tsurcharge -= 1;\n\n\t\treturn surcharge;\n\t}\n}\n<\/pre>\nThis class has a method calculateSurcharge<\/code> that implements the business logic of calculating the surcharge<\/code> for a given order<\/code>, as given in Section 2 above.<\/p>\n<\/a>5. How To Run and Test<\/h2>\nIn a terminal window go to the project root folder and enter<\/p>\n
mvn spring-boot:run<\/pre>\nThere are many client applications like SoapUI or Wizdler that you can use to invoke this service. I have used Postman app. The test request data is formed by just a few changes to the sample XML file we started with.<\/p>\n
test1.xml<\/em><\/span><\/p>\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<soapenv:Envelope xmlns:soapenv=\"http:\/\/schemas.xmlsoap.org\/soap\/envelope\/\"\n xmlns=\"http:\/\/schemas.xmlsoap.org\/soap\/envelope\/\">\n <soapenv:Body>\n <SurchargeRequest xmlns=\"http:\/\/www.javacodegeeks.org\/webservices\/soap\/surcharge\/generated\">\n <order>\n <id>S12345<\/id>\n <value>1250<\/value>\n <payment_method>CC<\/payment_method>\n <customer>\n <name part=\"first\">Nancy<\/name>\n <name part=\"last\">Smith<\/name>\n <address>\n <street line=\"1\">41 Earnest Road<\/street>\n <street line=\"2\">Rotamonte Park<\/street>\n <city>Koregon<\/city>\n <postalcode>12345<\/postalcode>\n <country>UK<\/country>\n <\/address>\n <\/customer>\n <\/order>\n <\/SurchargeRequest>\n <\/soapenv:Body>\n<\/soapenv:Envelope>\n<\/pre>\nGiven below is the screen shot of Postman showing the input soap XML and the response from the web service.<\/p>\n
<\/a>Output showing sample SOAP Request and Response of SurchargeService.<\/figcaption><\/figure><\/p>\nSince the order country is not “US”, payment method is “CC”, and the value is greater than 1000, the surcharge calculated is 15 + 3 -1 = 17, which is returned in the response.<\/p>\n
<\/a>6. Summary<\/h2>\nIn this article, we have seen how to use Spring framework in conjunction with maven plugin to implement a SOAP web service that take XML request and returns an XML response. We have also seen how to start from a sample XML to generate the XML schema definition and from there use the maven plugin and Spring annotations to transform the XML input to Java objects that are then used to execute the business logic.<\/p>\n
<\/a>7. Useful Links<\/h2>\nFollowing resources will be very useful to get additional information and insights on concepts discussed in this article:<\/p>\n
\n- https:\/\/blog.smartbear.com\/apis\/understanding-soap-and-rest-basics\/<\/a><\/li>\n
- http:\/\/mh-journal.blogspot.in\/2015\/08\/generating-xsds-for-xml-interfaces.html<\/a><\/li>\n
- https:\/\/www.getpostman.com\/docs\/postman\/sending_api_requests\/making_soap_requests<\/a><\/li>\n<\/ul>\n
<\/a>8. Download the Source Code<\/h2>\n
jaxb2-maven-plugin,<\/code> the whole process of extracting XML from the SOAP input, mapping to Java objects and returning the SOAP response becomes very easy so that developers can focus on implementing business logic and unit testing the application.<\/p>\n<\/a>2. Application<\/h2>\nThe application we will develop is a web service for calculating the surcharge to be applied to an order. An order has the fields id, value, payment_method and a customer. The fields of customer are name (“first”, “last”) and an address, which in turn has the fields street (“line” which can take values 1 and 2), city, postal code and country.<\/p>\n
The surcharge is calculated as a percentage. If the customer’s country is “US”, surcharge is 10%, otherwise it is 15%. If payment method is credit card, indicated by CC, the surcharge will be increased by 3%. If the order value is greater than 1000, a discount of 1% will be given. A discount is a negative surcharge and since the calculation is very simple, it is kept in this service. In real world applications, discounting will be a service of its own. Since all surcharges for this application are in percentages, we will not consider the % symbol either in the input or output and will be returned as an int.<\/p>\n
<\/a>3. Environment<\/h2>\nI have used the following technologies for this application:<\/p>\n
\n- Java 1.8<\/li>\n
- Spring Boot 1.5.9<\/li>\n
- JAXB2 Maven plugin 1.6<\/li>\n
- Maven 3.3.9<\/li>\n
- Ubuntu 16.04 LTS<\/li>\n<\/ul>\n
<\/a>4. Source Code<\/h2>\nTypically you would get a sample XML file from your business analyst or client showing all the elements and data used to send as input to the web service. The following snippet shows a sample order in XML format.<\/p>\n
sample1.xml<\/em><\/span><\/p>\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<order>\n <id>S12345<\/id>\n <value>1250<\/value>\n <payment_method>CC<\/payment_method>\n <customer>\n <name part=\"first\">Nancy<\/name>\n <name part=\"last\">Smith<\/name>\n <address>\n <street line=\"1\">41 Earnest Road<\/street>\n <street line=\"2\">Rotamonte Park<\/street>\n <city>Koregon<\/city>\n <postalcode>12345<\/postalcode>\n <country>UK<\/country>\n <\/address>\n <\/customer>\n<\/order>\n<\/pre>\nThe first step in implementing the SOAP web service is to create an XML schema definition file. We will name it surcharge.xsd<\/code> and it can be either hand written or generated with a plugin. I have used the online tool xmlgrid.net\/xml2xsd.html<\/a>. The generated xsd shows a few errors in Eclipse, which had to be corrected. For example, the error for name<\/code> element is:<\/p>\nElement 'name' has both a 'type' attribute and a 'anonymous type' child. Only one of these is allowed for an element.<\/pre>\nThe generated XML is:<\/p>\n
<xs:element name=\"name\" maxOccurs=\"unbounded\" type=\"xs:string\">\n <xs:complexType>\n <xs:attribute name=\"part\" type=\"xs:string\"><\/xs:attribute>\n <\/xs:complexType>\n<\/xs:element><\/pre>\nIt has to be corrected to<\/p>\n
<xs:element maxOccurs=\"2\" name=\"name\">\n <xs:complexType>\n <xs:simpleContent>\n <xs:extension base=\"xs:string\">\n <xs:attribute name=\"part\" type=\"xs:string\" \/>\n <\/xs:extension>\n <\/xs:simpleContent>\n <\/xs:complexType>\n<\/xs:element>\n<\/pre>\nIn general, the xsd file has two patterns to be applied:
\n1) element – complexType – sequence – element – complexType – sequence – element \/ element
\n2) element – complexType – simpleContent – extension – attribute<\/p>\n
Your xsd file will be a combination of these two patterns to cater to any nested XML data. The final corrected xsd file including the response element is shown below:<\/p>\n
surcharge.xsd<\/em><\/span><\/p>\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<xs:schema xmlns:xs=\"http:\/\/www.w3.org\/2001\/XMLSchema\"\ntargetNamespace=\"http:\/\/www.javacodegeeks.org\/webservices\/soap\/surcharge\/generated\"\nxmlns:tns=\"http:\/\/www.javacodegeeks.org\/webservices\/soap\/surcharge\/generated\"\nelementFormDefault=\"qualified\">\n\n <xs:element name=\"SurchargeRequest\">\n <xs:complexType>\n <xs:sequence>\n <xs:element name=\"order\">\n <xs:complexType>\n <xs:sequence>\n <xs:element name=\"id\" type=\"xs:string\"><\/xs:element>\n <xs:element name=\"value\" type=\"xs:int\"><\/xs:element>\n <xs:element name=\"payment_method\" type=\"xs:string\"><\/xs:element>\n <xs:element name=\"customer\">\n <xs:complexType>\n <xs:sequence>\n <xs:element maxOccurs=\"2\" name=\"name\">\n <xs:complexType>\n <xs:simpleContent>\n <xs:extension base=\"xs:string\">\n <xs:attribute name=\"part\" type=\"xs:string\" \/>\n <\/xs:extension>\n <\/xs:simpleContent>\n <\/xs:complexType>\n <\/xs:element>\n <xs:element name=\"address\">\n <xs:complexType>\n <xs:sequence>\n <xs:element maxOccurs=\"2\" name=\"street\">\n <xs:complexType>\n <xs:simpleContent>\n <xs:extension base=\"xs:string\">\n <xs:attribute name=\"line\" type=\"xs:string\" \/>\n <\/xs:extension>\n <\/xs:simpleContent>\n <\/xs:complexType>\n <\/xs:element>\n <xs:element name=\"city\" type=\"xs:string\"><\/xs:element>\n <xs:element name=\"postalcode\" type=\"xs:int\"><\/xs:element>\n <xs:element name=\"country\" type=\"xs:string\"><\/xs:element>\n <\/xs:sequence>\n <\/xs:complexType>\n <\/xs:element>\n <\/xs:sequence>\n <\/xs:complexType>\n <\/xs:element>\n <\/xs:sequence>\n <\/xs:complexType>\n <\/xs:element>\n <\/xs:sequence>\n <\/xs:complexType>\n <\/xs:element>\n\n <xs:element name=\"SurchargeResponse\">\n <xs:complexType>\n <xs:sequence>\n <xs:element name=\"surcharge\" type=\"xs:int\" \/>\n <\/xs:sequence>\n <\/xs:complexType>\n <\/xs:element>\n\n<\/xs:schema>\n<\/pre>\nThe target namespace is specified as “http:\/\/www.javacodegeeks.org\/webservices\/soap\/surcharge\/generated”. With this, a package called org.javacodegeeks.webservices.soap.surcharge.generated<\/code> will be created during compile time and the classes generated from the xsd file will be placed there. <\/div> <\/div><\/p>\nSince this is a maven-based project, all the project-level settings and dependencies are given in pom.xml file.<\/p>\n
pom.xml<\/em><\/span><\/p>\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<project xmlns=\"http:\/\/maven.apache.org\/POM\/4.0.0\" xmlns:xsi=\"http:\/\/www.w3.org\/2001\/XMLSchema-instance\"\nxsi:schemaLocation=\"http:\/\/maven.apache.org\/POM\/4.0.0 http:\/\/maven.apache.org\/xsd\/maven-4.0.0.xsd\">\n <modelVersion>4.0.0<\/modelVersion>\n\n <groupId>org.javacodegeeks.webservices.soap<\/groupId>\n <artifactId>surcharge<\/artifactId>\n <version>0.0.1-SNAPSHOT<\/version>\n <packaging>jar<\/packaging>\n\n <name>surcharge<\/name>\n <description>Demo project for Spring Boot<\/description>\n\n <parent>\n <groupId>org.springframework.boot<\/groupId>\n <artifactId>spring-boot-starter-parent<\/artifactId>\n <version>1.5.9.RELEASE<\/version>\n <relativePath \/> <!-- lookup parent from repository -->\n <\/parent>\n\n <properties>\n <project.build.sourceEncoding>UTF-8<\/project.build.sourceEncoding>\n <project.reporting.outputEncoding>UTF-8<\/project.reporting.outputEncoding>\n <java.version>1.8<\/java.version>\n <\/properties>\n\n <dependencies>\n <dependency>\n <groupId>org.springframework.boot<\/groupId>\n <artifactId>spring-boot-starter-web-services<\/artifactId>\n <\/dependency>\n <dependency>\n <groupId>wsdl4j<\/groupId>\n <artifactId>wsdl4j<\/artifactId>\n <\/dependency>\n <dependency>\n <groupId>org.springframework.boot<\/groupId>\n <artifactId>spring-boot-starter-test<\/artifactId>\n <scope>test<\/scope>\n <\/dependency>\n <\/dependencies>\n\n <build>\n <plugins>\n <plugin>\n <groupId>org.springframework.boot<\/groupId>\n <artifactId>spring-boot-maven-plugin<\/artifactId>\n <\/plugin>\n <plugin>\n <groupId>org.codehaus.mojo<\/groupId>\n <artifactId>jaxb2-maven-plugin<\/artifactId>\n <version>1.6<\/version>\n <executions>\n <execution>\n <id>xjc<\/id>\n <goals>\n <goal>xjc<\/goal>\n <\/goals>\n <\/execution>\n <\/executions>\n <configuration>\n <clearOutputDir>false<\/clearOutputDir>\n <schemaDirectory>${project.basedir}\/src\/main\/resources<\/schemaDirectory>\n <outputDirectory>${project.basedir}\/src\/main\/java<\/outputDirectory>\n <\/configuration>\n <\/plugin>\n <\/plugins>\n <\/build>\n<\/project>\n<\/pre>\nThe configuration for jaxb2-maven-plugin<\/code> specifies that the output directory should not cleared when the classes are generated, the schema file is located in src\/main\/resources<\/code> directory and that the output directory where the package should be created is src\/main\/java<\/code>.<\/p>\nSurchargeApplication.java<\/em><\/span><\/p>\npackage org.javacodegeeks.webservices.soap.surcharge;\n\nimport org.springframework.boot.SpringApplication;\nimport org.springframework.boot.autoconfigure.SpringBootApplication;\n\n@SpringBootApplication\npublic class SurchargeApplication {\n\n\tpublic static void main(String[] args) {\n\t\tSpringApplication.run(SurchargeApplication.class, args);\n\t\t\n\t\tSystem.out.println(\"SurchargeApplication now running....\");\n\t}\n}\n<\/pre>\nThis is the main class of the application that runs on the default Tomcat container of Spring Boot at port 8080.[ulp id=’7POIYxRf1FUtPpmL’]<\/p>\n
SoapConfig.java<\/em><\/span><\/p>\npackage org.javacodegeeks.webservices.soap.surcharge.config;\n\nimport org.springframework.boot.web.servlet.ServletRegistrationBean;\nimport org.springframework.context.ApplicationContext;\nimport org.springframework.context.annotation.Bean;\nimport org.springframework.context.annotation.Configuration;\nimport org.springframework.core.io.ClassPathResource;\nimport org.springframework.ws.config.annotation.EnableWs;\nimport org.springframework.ws.transport.http.MessageDispatcherServlet;\nimport org.springframework.ws.wsdl.wsdl11.DefaultWsdl11Definition;\nimport org.springframework.xml.xsd.SimpleXsdSchema;\nimport org.springframework.xml.xsd.XsdSchema;\n\n@EnableWs\n@Configuration\npublic class SoapConfig {\n\t@Bean\n\tpublic XsdSchema surchargeSchema() {\n\t\treturn new SimpleXsdSchema(new ClassPathResource(\"surcharge.xsd\"));\n\t}\n\t\n\t@Bean(name = \"surcharge\")\n\tpublic DefaultWsdl11Definition defaultWsdl11Definition(XsdSchema surchargeSchema) {\n\t\tDefaultWsdl11Definition definition = new DefaultWsdl11Definition();\n\t\tdefinition.setPortTypeName(\"SurchargePort\");\n\t\tdefinition.setTargetNamespace(\"http:\/\/www.javacodegeeks.org\/webservices\/soap\/surcharge\/generated\");\n\t\tdefinition.setLocationUri(\"\/ws\");\n\t\tdefinition.setSchema(surchargeSchema);\n\t\treturn definition;\n\t}\n\t\n\t@Bean\n\tpublic ServletRegistrationBean messageDispatcherServlet(ApplicationContext context) {\n\t\tMessageDispatcherServlet messageDispatcherServlet = new MessageDispatcherServlet();\n\t\tmessageDispatcherServlet.setApplicationContext(context);\n\t\tmessageDispatcherServlet.setTransformWsdlLocations(true);\n\t\treturn new ServletRegistrationBean(messageDispatcherServlet, \"\/ws\/*\");\n\t}\n\n}\n<\/pre>\nThis class sets up the configures all the beans required as the application infrastructure. @EnableWS<\/code> enables all the Spring Java web services configuration defined in WsConfigurationSupport<\/code> class to be imported to our application configuration. It provides facilities for endpoint mapping to annotated controllers, adapters and exception handlers.<\/p>\nFirst, in the surchargeSchema<\/code> method, the surcharge.xsd<\/code> file is used to configure a SimpleXsdSchema<\/code> bean. Next, in the defaultWsdl11Definition<\/code> method, this bean set as the schema in a DefaultWsdl11Definition<\/code> with the name surcharge. Last, in the messageDispatcherServlet<\/code> method, a MessageDispatcherServlet<\/code> is created to take the ApplicationContext<\/code> and then used to create a ServletRegistrationBean<\/code> to handle the URI path \/ws<\/code>.<\/p>\nSurchargeEndpoint.java<\/em><\/span><\/p>\npackage org.javacodegeeks.webservices.soap.surcharge.endpoint;\n\nimport org.javacodegeeks.webservices.soap.surcharge.generated.SurchargeRequest;\nimport org.javacodegeeks.webservices.soap.surcharge.generated.SurchargeResponse;\nimport org.javacodegeeks.webservices.soap.surcharge.service.SurchargeService;\nimport org.springframework.beans.factory.annotation.Autowired;\nimport org.springframework.ws.server.endpoint.annotation.Endpoint;\nimport org.springframework.ws.server.endpoint.annotation.PayloadRoot;\nimport org.springframework.ws.server.endpoint.annotation.RequestPayload;\nimport org.springframework.ws.server.endpoint.annotation.ResponsePayload;\n\n@Endpoint\npublic class SurchargeEndpoint {\n\n\t@Autowired\n\tSurchargeService service;\n\n\t@PayloadRoot(namespace = \"http:\/\/www.javacodegeeks.org\/webservices\/soap\/surcharge\/generated\", localPart = \"SurchargeRequest\")\n\t@ResponsePayload\n\tpublic SurchargeResponse processCourseDetailsRequest(@RequestPayload SurchargeRequest request) {\n\n\t\tSurchargeResponse response = new SurchargeResponse();\n\n\t\tint surcharge = service.calculateSurcharge(request.getOrder());\n\t\tresponse.setSurcharge(surcharge);\n\n\t\treturn response;\n\t}\n\n}\n<\/pre>\nThis class has a SurchargeService<\/code> bean auto-wired. With the @PayloadRoot<\/code> annotation, we mark the method processCourseDetailsRequest<\/code> as the handler for the incoming request. The @ResponsePayload<\/code> annotation marks that the return value should be bound to the response payload.<\/p>\nIn the processCourseDetailsRequest<\/code> method, a SurchargeResponse<\/code> object is instantiated. The service bean’s calculateSurcharge<\/code> method is called passing in the Order<\/code> object from the SurchargeRequest<\/code> input. The calculated surcharge<\/code> returned from the call is set into the SurchargeResponse<\/code> object that is then returned.<\/p>\nSurchargeService.java<\/em><\/span><\/p>\npackage org.javacodegeeks.webservices.soap.surcharge.service;\n\nimport org.javacodegeeks.webservices.soap.surcharge.generated.SurchargeRequest.Order;\nimport org.springframework.stereotype.Component;\n\n@Component\npublic class SurchargeService {\n\t\n\tpublic int calculateSurcharge(Order order) {\n\t\t\n\t\tint surcharge = 15;\n\t\tif (order.getCustomer().getAddress().getCountry().equals(\"US\"))\n\t\t\tsurcharge = 10;\n\n\t\tif (order.getPaymentMethod().equals(\"CC\"))\n\t\t\tsurcharge += 3;\n\n\t\tif (order.getValue() > 1000)\n\t\t\tsurcharge -= 1;\n\n\t\treturn surcharge;\n\t}\n}\n<\/pre>\nThis class has a method calculateSurcharge<\/code> that implements the business logic of calculating the surcharge<\/code> for a given order<\/code>, as given in Section 2 above.<\/p>\n<\/a>5. How To Run and Test<\/h2>\nIn a terminal window go to the project root folder and enter<\/p>\n
mvn spring-boot:run<\/pre>\nThere are many client applications like SoapUI or Wizdler that you can use to invoke this service. I have used Postman app. The test request data is formed by just a few changes to the sample XML file we started with.<\/p>\n
test1.xml<\/em><\/span><\/p>\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<soapenv:Envelope xmlns:soapenv=\"http:\/\/schemas.xmlsoap.org\/soap\/envelope\/\"\n xmlns=\"http:\/\/schemas.xmlsoap.org\/soap\/envelope\/\">\n <soapenv:Body>\n <SurchargeRequest xmlns=\"http:\/\/www.javacodegeeks.org\/webservices\/soap\/surcharge\/generated\">\n <order>\n <id>S12345<\/id>\n <value>1250<\/value>\n <payment_method>CC<\/payment_method>\n <customer>\n <name part=\"first\">Nancy<\/name>\n <name part=\"last\">Smith<\/name>\n <address>\n <street line=\"1\">41 Earnest Road<\/street>\n <street line=\"2\">Rotamonte Park<\/street>\n <city>Koregon<\/city>\n <postalcode>12345<\/postalcode>\n <country>UK<\/country>\n <\/address>\n <\/customer>\n <\/order>\n <\/SurchargeRequest>\n <\/soapenv:Body>\n<\/soapenv:Envelope>\n<\/pre>\nGiven below is the screen shot of Postman showing the input soap XML and the response from the web service.<\/p>\n
<\/a>Output showing sample SOAP Request and Response of SurchargeService.<\/figcaption><\/figure><\/p>\nSince the order country is not “US”, payment method is “CC”, and the value is greater than 1000, the surcharge calculated is 15 + 3 -1 = 17, which is returned in the response.<\/p>\n
<\/a>6. Summary<\/h2>\nIn this article, we have seen how to use Spring framework in conjunction with maven plugin to implement a SOAP web service that take XML request and returns an XML response. We have also seen how to start from a sample XML to generate the XML schema definition and from there use the maven plugin and Spring annotations to transform the XML input to Java objects that are then used to execute the business logic.<\/p>\n
<\/a>7. Useful Links<\/h2>\nFollowing resources will be very useful to get additional information and insights on concepts discussed in this article:<\/p>\n
\n- https:\/\/blog.smartbear.com\/apis\/understanding-soap-and-rest-basics\/<\/a><\/li>\n
- http:\/\/mh-journal.blogspot.in\/2015\/08\/generating-xsds-for-xml-interfaces.html<\/a><\/li>\n
- https:\/\/www.getpostman.com\/docs\/postman\/sending_api_requests\/making_soap_requests<\/a><\/li>\n<\/ul>\n
<\/a>8. Download the Source Code<\/h2>\n