BAEL-3989: Calling a SOAP web service from Spring (#9174)

spring-soap/pom.xml

@@ -58,6 +58,28 @@
                 </configuration>
             </plugin>
             <!-- end::xsd[] -->
+            
+            <plugin>
+                <groupId>org.jvnet.jaxb2.maven2</groupId>
+                <artifactId>maven-jaxb2-plugin</artifactId>
+                <version>0.14.0</version>
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>generate</goal>
+                        </goals>
+                    </execution>
+                </executions>
+                <configuration>
+                    <schemaLanguage>WSDL</schemaLanguage>
+                    <generateDirectory>${project.basedir}/src/main/java</generateDirectory>
+                    <generatePackage>com.baeldung.springsoap.client.gen</generatePackage>
+                    <schemaDirectory>${project.basedir}/src/main/resources</schemaDirectory>
+                    <schemaIncludes>
+                        <include>countries.wsdl</include>
+                    </schemaIncludes>
+                </configuration>
+            </plugin>
         </plugins>
     </build>
 

spring-soap/src/main/java/com/baeldung/springsoap/client/CountryClient.java

@@ -0,0 +1,26 @@
+package com.baeldung.springsoap.client;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.ws.client.core.support.WebServiceGatewaySupport;
+
+import com.baeldung.springsoap.client.gen.GetCountryRequest;
+import com.baeldung.springsoap.client.gen.GetCountryResponse;
+
+public class CountryClient extends WebServiceGatewaySupport {
+
+    private static final Logger logger = LoggerFactory.getLogger(CountryClient.class);
+
+    public GetCountryResponse getCountry(String country) {
+
+        GetCountryRequest request = new GetCountryRequest();
+        request.setName(country);
+
+        logger.info("Requesting information for " + country);
+
+        GetCountryResponse response = (GetCountryResponse) getWebServiceTemplate().marshalSendAndReceive(request);
+
+        return response;
+    }
+
+}

spring-soap/src/main/java/com/baeldung/springsoap/client/CountryClientConfig.java

@@ -0,0 +1,25 @@
+package com.baeldung.springsoap.client;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.oxm.jaxb.Jaxb2Marshaller;
+
+@Configuration
+public class CountryClientConfig {
+
+    @Bean
+    public Jaxb2Marshaller marshaller() {
+            Jaxb2Marshaller marshaller = new Jaxb2Marshaller();
+            marshaller.setContextPath("com.baeldung.springsoap.client.gen");
+            return marshaller;
+    }
+
+    @Bean
+    public CountryClient countryClient(Jaxb2Marshaller marshaller) {
+            CountryClient client = new CountryClient();
+            client.setDefaultUri("http://localhost:8080/ws");
+            client.setMarshaller(marshaller);
+            client.setUnmarshaller(marshaller);
+            return client;
+    }
+}

spring-soap/src/main/java/com/baeldung/springsoap/client/gen/Country.java

@@ -0,0 +1,146 @@
+//
+// This file was generated by the JavaTM Architecture for XML Binding(JAXB) Reference Implementation, v2.3.0 
+// See <a href="https://javaee.github.io/jaxb-v2/">https://javaee.github.io/jaxb-v2/</a> 
+// Any modifications to this file will be lost upon recompilation of the source schema. 
+// Generated on: 2020.04.25 at 03:18:49 PM IST 
+//
+
+
+package com.baeldung.springsoap.client.gen;
+
+import javax.xml.bind.annotation.XmlAccessType;
+import javax.xml.bind.annotation.XmlAccessorType;
+import javax.xml.bind.annotation.XmlElement;
+import javax.xml.bind.annotation.XmlSchemaType;
+import javax.xml.bind.annotation.XmlType;
+
+
+/**
+ * <p>Java class for country complex type.
+ * 
+ * <p>The following schema fragment specifies the expected content contained within this class.
+ * 
+ * <pre>
+ * &lt;complexType name="country"&gt;
+ *   &lt;complexContent&gt;
+ *     &lt;restriction base="{http://www.w3.org/2001/XMLSchema}anyType"&gt;
+ *       &lt;sequence&gt;
+ *         &lt;element name="name" type="{http://www.w3.org/2001/XMLSchema}string"/&gt;
+ *         &lt;element name="population" type="{http://www.w3.org/2001/XMLSchema}int"/&gt;
+ *         &lt;element name="capital" type="{http://www.w3.org/2001/XMLSchema}string"/&gt;
+ *         &lt;element name="currency" type="{http://www.baeldung.com/springsoap/gen}currency"/&gt;
+ *       &lt;/sequence&gt;
+ *     &lt;/restriction&gt;
+ *   &lt;/complexContent&gt;
+ * &lt;/complexType&gt;
+ * </pre>
+ * 
+ * 
+ */
+@XmlAccessorType(XmlAccessType.FIELD)
+@XmlType(name = "country", propOrder = {
+    "name",
+    "population",
+    "capital",
+    "currency"
+})
+public class Country {
+
+    @XmlElement(required = true)
+    protected String name;
+    protected int population;
+    @XmlElement(required = true)
+    protected String capital;
+    @XmlElement(required = true)
+    @XmlSchemaType(name = "string")
+    protected Currency currency;
+
+    /**
+     * Gets the value of the name property.
+     * 
+     * @return
+     *     possible object is
+     *     {@link String }
+     *     
+     */
+    public String getName() {
+        return name;
+    }
+
+    /**
+     * Sets the value of the name property.
+     * 
+     * @param value
+     *     allowed object is
+     *     {@link String }
+     *     
+     */
+    public void setName(String value) {
+        this.name = value;
+    }
+
+    /**
+     * Gets the value of the population property.
+     * 
+     */
+    public int getPopulation() {
+        return population;
+    }
+
+    /**
+     * Sets the value of the population property.
+     * 
+     */
+    public void setPopulation(int value) {
+        this.population = value;
+    }
+
+    /**
+     * Gets the value of the capital property.
+     * 
+     * @return
+     *     possible object is
+     *     {@link String }
+     *     
+     */
+    public String getCapital() {
+        return capital;
+    }
+
+    /**
+     * Sets the value of the capital property.
+     * 
+     * @param value
+     *     allowed object is
+     *     {@link String }
+     *     
+     */
+    public void setCapital(String value) {
+        this.capital = value;
+    }
+
+    /**
+     * Gets the value of the currency property.
+     * 
+     * @return
+     *     possible object is
+     *     {@link Currency }
+     *     
+     */
+    public Currency getCurrency() {
+        return currency;
+    }
+
+    /**
+     * Sets the value of the currency property.
+     * 
+     * @param value
+     *     allowed object is
+     *     {@link Currency }
+     *     
+     */
+    public void setCurrency(Currency value) {
+        this.currency = value;
+    }
+
+}

spring-soap/src/main/java/com/baeldung/springsoap/client/gen/Currency.java

@@ -0,0 +1,47 @@
+//
+// This file was generated by the JavaTM Architecture for XML Binding(JAXB) Reference Implementation, v2.3.0 
+// See <a href="https://javaee.github.io/jaxb-v2/">https://javaee.github.io/jaxb-v2/</a> 
+// Any modifications to this file will be lost upon recompilation of the source schema. 
+// Generated on: 2020.04.25 at 03:18:49 PM IST 
+//
+
+
+package com.baeldung.springsoap.client.gen;
+
+import javax.xml.bind.annotation.XmlEnum;
+import javax.xml.bind.annotation.XmlType;
+
+
+/**
+ * <p>Java class for currency.
+ * 
+ * <p>The following schema fragment specifies the expected content contained within this class.
+ * <p>
+ * <pre>
+ * &lt;simpleType name="currency"&gt;
+ *   &lt;restriction base="{http://www.w3.org/2001/XMLSchema}string"&gt;
+ *     &lt;enumeration value="GBP"/&gt;
+ *     &lt;enumeration value="EUR"/&gt;
+ *     &lt;enumeration value="PLN"/&gt;
+ *   &lt;/restriction&gt;
+ * &lt;/simpleType&gt;
+ * </pre>
+ * 
+ */
+@XmlType(name = "currency")
+@XmlEnum
+public enum Currency {
+
+    GBP,
+    EUR,
+    PLN;
+
+    public String value() {
+        return name();
+    }
+
+    public static Currency fromValue(String v) {
+        return valueOf(v);
+    }
+
+}

spring-soap/src/main/java/com/baeldung/springsoap/client/gen/GetCountryRequest.java

@@ -0,0 +1,71 @@
+//
+// This file was generated by the JavaTM Architecture for XML Binding(JAXB) Reference Implementation, v2.3.0 
+// See <a href="https://javaee.github.io/jaxb-v2/">https://javaee.github.io/jaxb-v2/</a> 
+// Any modifications to this file will be lost upon recompilation of the source schema. 
+// Generated on: 2020.04.25 at 03:18:49 PM IST 
+//
+
+
+package com.baeldung.springsoap.client.gen;
+
+import javax.xml.bind.annotation.XmlAccessType;
+import javax.xml.bind.annotation.XmlAccessorType;
+import javax.xml.bind.annotation.XmlElement;
+import javax.xml.bind.annotation.XmlRootElement;
+import javax.xml.bind.annotation.XmlType;
+
+
+/**
+ * <p>Java class for anonymous complex type.
+ * 
+ * <p>The following schema fragment specifies the expected content contained within this class.
+ * 
+ * <pre>
+ * &lt;complexType&gt;
+ *   &lt;complexContent&gt;
+ *     &lt;restriction base="{http://www.w3.org/2001/XMLSchema}anyType"&gt;
+ *       &lt;sequence&gt;
+ *         &lt;element name="name" type="{http://www.w3.org/2001/XMLSchema}string"/&gt;
+ *       &lt;/sequence&gt;
+ *     &lt;/restriction&gt;
+ *   &lt;/complexContent&gt;
+ * &lt;/complexType&gt;
+ * </pre>
+ * 
+ * 
+ */
+@XmlAccessorType(XmlAccessType.FIELD)
+@XmlType(name = "", propOrder = {
+    "name"
+})
+@XmlRootElement(name = "getCountryRequest")
+public class GetCountryRequest {
+
+    @XmlElement(required = true)
+    protected String name;
+
+    /**
+     * Gets the value of the name property.
+     * 
+     * @return
+     *     possible object is
+     *     {@link String }
+     *     
+     */
+    public String getName() {
+        return name;
+    }
+
+    /**
+     * Sets the value of the name property.
+     * 
+     * @param value
+     *     allowed object is
+     *     {@link String }
+     *     
+     */
+    public void setName(String value) {
+        this.name = value;
+    }
+
+}

spring-soap/src/main/java/com/baeldung/springsoap/client/gen/GetCountryResponse.java

@@ -0,0 +1,71 @@
+//
+// This file was generated by the JavaTM Architecture for XML Binding(JAXB) Reference Implementation, v2.3.0 
+// See <a href="https://javaee.github.io/jaxb-v2/">https://javaee.github.io/jaxb-v2/</a> 
+// Any modifications to this file will be lost upon recompilation of the source schema. 
+// Generated on: 2020.04.25 at 03:18:49 PM IST 
+//
+
+
+package com.baeldung.springsoap.client.gen;
+
+import javax.xml.bind.annotation.XmlAccessType;
+import javax.xml.bind.annotation.XmlAccessorType;
+import javax.xml.bind.annotation.XmlElement;
+import javax.xml.bind.annotation.XmlRootElement;
+import javax.xml.bind.annotation.XmlType;
+
+
+/**
+ * <p>Java class for anonymous complex type.
+ * 
+ * <p>The following schema fragment specifies the expected content contained within this class.
+ * 
+ * <pre>
+ * &lt;complexType&gt;
+ *   &lt;complexContent&gt;
+ *     &lt;restriction base="{http://www.w3.org/2001/XMLSchema}anyType"&gt;
+ *       &lt;sequence&gt;
+ *         &lt;element name="country" type="{http://www.baeldung.com/springsoap/gen}country"/&gt;
+ *       &lt;/sequence&gt;
+ *     &lt;/restriction&gt;
+ *   &lt;/complexContent&gt;
+ * &lt;/complexType&gt;
+ * </pre>
+ * 
+ * 
+ */
+@XmlAccessorType(XmlAccessType.FIELD)
+@XmlType(name = "", propOrder = {
+    "country"
+})
+@XmlRootElement(name = "getCountryResponse")
+public class GetCountryResponse {
+
+    @XmlElement(required = true)
+    protected Country country;
+
+    /**
+     * Gets the value of the country property.
+     * 
+     * @return
+     *     possible object is
+     *     {@link Country }
+     *     
+     */
+    public Country getCountry() {
+        return country;
+    }
+
+    /**
+     * Sets the value of the country property.
+     * 
+     * @param value
+     *     allowed object is
+     *     {@link Country }
+     *     
+     */
+    public void setCountry(Country value) {
+        this.country = value;
+    }
+
+}

spring-soap/src/main/java/com/baeldung/springsoap/client/gen/ObjectFactory.java

@@ -0,0 +1,63 @@
+//
+// This file was generated by the JavaTM Architecture for XML Binding(JAXB) Reference Implementation, v2.3.0 
+// See <a href="https://javaee.github.io/jaxb-v2/">https://javaee.github.io/jaxb-v2/</a> 
+// Any modifications to this file will be lost upon recompilation of the source schema. 
+// Generated on: 2020.04.25 at 03:18:49 PM IST 
+//
+
+
+package com.baeldung.springsoap.client.gen;
+
+import javax.xml.bind.annotation.XmlRegistry;
+
+
+/**
+ * This object contains factory methods for each 
+ * Java content interface and Java element interface 
+ * generated in the com.baeldung.springsoap.client.gen package. 
+ * <p>An ObjectFactory allows you to programatically 
+ * construct new instances of the Java representation 
+ * for XML content. The Java representation of XML 
+ * content can consist of schema derived interfaces 
+ * and classes representing the binding of schema 
+ * type definitions, element declarations and model 
+ * groups.  Factory methods for each of these are 
+ * provided in this class.
+ * 
+ */
+@XmlRegistry
+public class ObjectFactory {
+
+
+    /**
+     * Create a new ObjectFactory that can be used to create new instances of schema derived classes for package: com.baeldung.springsoap.client.gen
+     * 
+     */
+    public ObjectFactory() {
+    }
+
+    /**
+     * Create an instance of {@link GetCountryRequest }
+     * 
+     */
+    public GetCountryRequest createGetCountryRequest() {
+        return new GetCountryRequest();
+    }
+
+    /**
+     * Create an instance of {@link GetCountryResponse }
+     * 
+     */
+    public GetCountryResponse createGetCountryResponse() {
+        return new GetCountryResponse();
+    }
+
+    /**
+     * Create an instance of {@link Country }
+     * 
+     */
+    public Country createCountry() {
+        return new Country();
+    }
+
+}

spring-soap/src/main/java/com/baeldung/springsoap/client/gen/package-info.java

@@ -0,0 +1,9 @@
+//
+// This file was generated by the JavaTM Architecture for XML Binding(JAXB) Reference Implementation, v2.3.0 
+// See <a href="https://javaee.github.io/jaxb-v2/">https://javaee.github.io/jaxb-v2/</a> 
+// Any modifications to this file will be lost upon recompilation of the source schema. 
+// Generated on: 2020.04.25 at 03:18:49 PM IST 
+//
+
+@javax.xml.bind.annotation.XmlSchema(namespace = "http://www.baeldung.com/springsoap/gen", elementFormDefault = javax.xml.bind.annotation.XmlNsForm.QUALIFIED)
+package com.baeldung.springsoap.client.gen;

spring-soap/src/main/resources/countries.wsdl

@@ -0,0 +1,74 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<wsdl:definitions xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:sch="http://www.baeldung.com/springsoap/gen"
+    xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:tns="http://www.baeldung.com/springsoap/gen" targetNamespace="http://www.baeldung.com/springsoap/gen">
+    <wsdl:types>
+        <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" targetNamespace="http://www.baeldung.com/springsoap/gen">
+
+            <xs:element name="getCountryRequest">
+                <xs:complexType>
+                    <xs:sequence>
+                        <xs:element name="name" type="xs:string" />
+                    </xs:sequence>
+                </xs:complexType>
+            </xs:element>
+
+            <xs:element name="getCountryResponse">
+                <xs:complexType>
+                    <xs:sequence>
+                        <xs:element name="country" type="tns:country" />
+                    </xs:sequence>
+                </xs:complexType>
+            </xs:element>
+
+            <xs:complexType name="country">
+                <xs:sequence>
+                    <xs:element name="name" type="xs:string" />
+                    <xs:element name="population" type="xs:int" />
+                    <xs:element name="capital" type="xs:string" />
+                    <xs:element name="currency" type="tns:currency" />
+                </xs:sequence>
+            </xs:complexType>
+
+            <xs:simpleType name="currency">
+                <xs:restriction base="xs:string">
+                    <xs:enumeration value="GBP" />
+                    <xs:enumeration value="EUR" />
+                    <xs:enumeration value="PLN" />
+                </xs:restriction>
+            </xs:simpleType>
+        </xs:schema>
+    </wsdl:types>
+    <wsdl:message name="getCountryResponse">
+        <wsdl:part element="tns:getCountryResponse" name="getCountryResponse">
+        </wsdl:part>
+    </wsdl:message>
+    <wsdl:message name="getCountryRequest">
+        <wsdl:part element="tns:getCountryRequest" name="getCountryRequest">
+        </wsdl:part>
+    </wsdl:message>
+    <wsdl:portType name="CountriesPort">
+        <wsdl:operation name="getCountry">
+            <wsdl:input message="tns:getCountryRequest" name="getCountryRequest">
+            </wsdl:input>
+            <wsdl:output message="tns:getCountryResponse" name="getCountryResponse">
+            </wsdl:output>
+        </wsdl:operation>
+    </wsdl:portType>
+    <wsdl:binding name="CountriesPortSoap11" type="tns:CountriesPort">
+        <soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http" />
+        <wsdl:operation name="getCountry">
+            <soap:operation soapAction="" />
+            <wsdl:input name="getCountryRequest">
+                <soap:body use="literal" />
+            </wsdl:input>
+            <wsdl:output name="getCountryResponse">
+                <soap:body use="literal" />
+            </wsdl:output>
+        </wsdl:operation>
+    </wsdl:binding>
+    <wsdl:service name="CountriesPortService">
+        <wsdl:port binding="tns:CountriesPortSoap11" name="CountriesPortSoap11">
+            <soap:address location="http://localhost:8080/ws" />
+        </wsdl:port>
+    </wsdl:service>
+</wsdl:definitions>

spring-soap/src/test/java/com/baeldung/springsoap/client/CountryClientLiveTest.java

@@ -0,0 +1,36 @@
+package com.baeldung.springsoap.client;
+
+import static org.junit.Assert.assertEquals;
+
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.test.context.ContextConfiguration;
+import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
+import org.springframework.test.context.support.AnnotationConfigContextLoader;
+
+import com.baeldung.springsoap.client.gen.Currency;
+import com.baeldung.springsoap.client.gen.GetCountryResponse;
+
+//Ensure that the server - com.baeldung.springsoap.Application - is running before executing this test
+@RunWith(SpringJUnit4ClassRunner.class)
+@ContextConfiguration(classes = CountryClientConfig.class, loader = AnnotationConfigContextLoader.class)
+public class CountryClientLiveTest {
+
+    @Autowired
+    CountryClient client;
+
+    @Test
+    public void givenCountryService_whenCountryPoland_thenCapitalIsWarsaw() {
+        GetCountryResponse response = client.getCountry("Poland");
+        assertEquals("Warsaw", response.getCountry()
+            .getCapital());
+    }
+
+    @Test
+    public void givenCountryService_whenCountrySpain_thenCurrencyEUR() {
+        GetCountryResponse response = client.getCountry("Spain");
+        assertEquals(Currency.EUR, response.getCountry()
+            .getCurrency());
+    }
+}