3. Implementing Spring Web Services for SOAP - XML, XSD, and WSDL
Writing Our Contract-First XSD and WSDL
Spring Web Services enforce a contract-first approach to development, meaning you must define your XML schema before anything else.
Charity Registration XML Document Example
Here is an example of a Charity Registration XML document:
<CharityRegistration>
<id>1</id>
<userName>john_doe</userName>
<subject>Sample Subject</subject>
<body>This is a sample body text for the registration.</body>
<createdDate>2024-06-22T12:00:00Z</createdDate>
<fileAttachments>
<fileAttachment>
<name>sampleFile1.txt</name>
<mimeContentType>text/plain</mimeContentType>
<contents>U29tZSBmaWxlIGNvbnRlbnRzIGVuY29kZWQgaW4gYmFzZTY0</contents> <!-- Base64 encoded content -->
</fileAttachment>
<fileAttachment>
<name>sampleFile2.jpg</name>
<mimeContentType>image/jpeg</mimeContentType>
<contents>/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAkGBxISEhUSEhIVFRUVFRUVFRUVFRUVFRUVFRUWFhUVFRUYHSggGBolHRUVITEhJSkrLi4uFx8zODMsNygtLisBCgoKDg0OFQ8QFS0dFR0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLf/AABEIAKgBLAMBIgACEQEDEQH/xAAbAAEAAgMBAQAAAAAAAAAAAAAABQYBAwIBB//EADkQAAIBAwMBBQUEBAYDAAAAAAABAgMEERIhBRMxQVFhBhMicYGRMkKxwdHh8DJCUpLxFiQzgsH/xAAYAQEBAQEBAAAAAAAAAAAAAAAAAgEDBf/EACARAQEBAAMBAQEAAwEAAAAAAAABEQIhAxJBEyJx8P/aAAwDAQACEQMRAD8A+FNEVKV5QFpKyLHSYTSnqQUUzBhFjEKQhQEZHJBb0glXoeSSdBJ+gqnQnXtJNLQ20hoVFmuPC6qg4pPG0dBHDyXTzkIuD5uHdhkhZyZ2N6Kr2chbyvKTNytosQscZJAlhN3UAAbfiRU+YyFc7koV22a1dvBIR5GshN/DdmPd8KOYk+P8AsRUXW42kkayVEVVOgAHckfXeqSy5TQ26kmt/UG8ZGj8Iz1TnpDgbsQWy0AnRtsmSWsL9WUMyqAj3kR80Rj1kKe5KnXo06d8g5HlA2nUIFQnUpPMbivNQjbVoRQvYZkJOTptQtnRsZBWwLqSTQxzPDEQkQfx3NUuyqwvJUGkETLAg/v7+tQtTGo5SePOh7sRYA6xsf1iaSSDjwKnSa3FAlT8T6FZdFLVmNDGAeKnLZ4jR9mjltuoxTLCFSAPDndAE9J0NYiV0PxtiBOWHX/AFVRyt1hYRGzUkPloW2MbiPafIqXCG7Y0ylcwCWSdAkdqkD6ntQnDEmpSYGEPA+4ABndj/Tzqy0KiulX0VjMmUuN4YgB8wNv/AGgNPBzFxrIsELSKQg4uURvPl8ICaKeHa5KvYaTTK3HGe7zvh54NdANWnIctC2w8WcSe4t5Oue1XRIxj6na49WBJAII+YwF+kfY9E21eS4t0pt1HLiw4eqIOPVGxxRuoMkDbGcGn6Tk4VylDKjiJ9t3tT5QfRu+zSLQztDAhgIEHIGfmP7VrONeaVtJsp02MqgB+QpKkD1H23gNCcuMWtAqEjzDtA2PoDqOtKDRyccGS1EYLeRnCzHfA6j8nP0oP/2Q==</contents> <!-- Base64 encoded content -->
</fileAttachment>
</fileAttachments>
</CharityRegistration>
We also need to be able to add a charity registration, so we need a registrationRequest.
Registration Request XML Elements
<registrationRequest xmlns="http://www.nicordesigns.com/charityregistration">
<CharityRegistrationInfo>
<id>1</id>
<userName>john_doe</userName>
<subject>Sample Subject</subject>
<body>This is a sample body text for the registration.</body>
<createdDate>2024-06-22T12:00:00Z</createdDate>
<fileAttachments>
<attachment>
<name>sampleFile1.txt</name>
<content>U29tZSBmaWxlIGNvbnRlbnRzIGVuY29kZWQgaW4gYmFzZTY0</content> <!-- Base64 encoded content -->
</attachment>
<attachment>
<name>sampleFile2.jpg</name>
<content>/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAkGBxISEhUSEhIVFRUVFRUVFRUVFRUVFRUVFRUWFhUVFRUYHSggGBolHRUVITEhJSkrLi4uFx8zODMsNygtLisBCgoKDg0OFQ8QFS0dFR0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLf/AABEIAKgBLAMBIgACEQEDEQH/xAAbAAEAAgMBAQAAAAAAAAAAAAAABQYBAwIBB//EADkQAAIBAwMBBQUEBAYDAAAAAAABAgMEERIhBRMxQVFhBhMicYGRMkKxwdHh8DJCUpLxFiQzgsH/xAAYAQEBAQEBAAAAAAAAAAAAAAAAAgEDBf/EACARAQEBAAMBAQEAAwEAAAAAAAABEQIhAxJBEyJx8P/aAAwDAQACEQMRAD8A+FNEVKV5QFpKyLHSYTSnqQUUzBhFjEKQhQEZHJBb0glXoeSSdBJ+gqnQnXtJNLQ20hoVFmuPC6qg4pPG0dBHDyXTzkIuD5uHdhkhZyZ2N6Kr2chbyvKTNytosQscZJAlhN3UAAbfiRU+YyFc7koV22a1dvBIR5GshN/DdmPd8KOYk+P8AsRUXW42kkayVEVVOgAHckfXeqSy5TQ26kmt/UG8ZGj8Iz1TnpDgbsQWy0AnRtsmSWsL9WUMyqAj3kR80Rj1kKe5KnXo06d8g5HlA2nUIFQnUpPMbivNQjbVoRQvYZkJOTptQtnRsZBWwLqSTQxzPDEQkQfx3NUuyqwvJUGkETLAg/v7+tQtTGo5SePOh7sRYA6xsf1iaSSDjwKnSa3FAlT8T6FZdFLVmNDGAeKnLZ4jR9mjltuoxTLCFSAPDndAE9J0NYiV0PxtiBOWHX/AFVRyt1hYRGzUkPloW2MbiPafIqXCG7Y0ylcwCWSdAkdqkD6ntQnDEmpSYGEPA+4ABndj/Tzqy0KiulX0VjMmUuN4YgB8wNv/AGgNPBzFxrIsELSKQg4uURvPl8ICaKeHa5KvYaTTK3HGe7zvh54NdANWnIctC2w8WcSe4t5Oue1XRIxj6na49WBJAII+YwF+kfY9E21eS4t0pt1HLiw4eqIOPVGxxR
uoMkDbGcGn6Tk4VylDKjiJ9t3tT5QfRu+zSLQztDAhgIEHIGfmP7VrONeaVtJsp02MqgB+QpKkD1H23gNCcuMWtAqEjzDtA2PoDqOtKDRyccGS1EYLeRnCzHfA6j8nP0oP/2Q==</content> <!-- Base64 encoded content -->
</attachment>
</fileAttachments>
</CharityRegistrationInfo>
</registrationRequest>
We also need to be able to respond to a charity registration request, so we need a CharityRegistrationResponse.
Charity Registration Response XML Elements
<CharityRegistrationResponse xmlns="http://www.nicordesigns.com/charityregistration">
<responseMessage>Registration Successful</responseMessage>
<registrationId>1</registrationId>
<statusCode>200</statusCode>
<statusMessage>Success</statusMessage>
</CharityRegistrationResponse>
We will use an open-source tool to generate the XSD schema for us from these XML documents.
Generating XSD from XML Using FreeFormatter.com
FreeFormatter.com provides an easy-to-use, online tool for generating an XML Schema (XSD) from an XML document. Here’s how you can use it:
- Visit FreeFormatter.com:
- Open your web browser and go to FreeFormatter XML to XSD Generator.
- Input Your XML Content:
- Copy and paste your XML content into the text box provided on the website.
- Generate the XSD:
- Click the “Generate XSD” button. The tool will process your XML and produce an XSD schema.
- Download or Copy the XSD:
- You can either download the generated XSD file or copy the content directly from the website.
Example of Generated XSD
Here is an example of what the generated XSD might look like:
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" targetNamespace="http://www.nicordesigns.com/charityregistration" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<!-- SOAP IN -->
<xs:element name="CharityRegistrationRequest">
<xs:complexType>
<xs:sequence>
<xs:element name="CharityRegistrationInfo">
<xs:complexType>
<xs:sequence>
<xs:element type="xs:short" name="id"/>
<xs:element type="xs:string" name="userName"/>
<xs:element type="xs:string" name="subject"/>
<xs:element type="xs:string" name="body"/>
<xs:element type="xs:dateTime" name="createdDate"/>
<xs:element name="fileAttachments">
<xs:complexType>
<xs:sequence>
<xs:element name="attachment" maxOccurs="unbounded" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element type="xs:string" name="name"/>
<xs:element type="xs:string" name="content"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<!-- SOAP OUT -->
<xs:element name="CharityRegistrationResponse">
<xs:complexType>
<xs:sequence>
<xs:element type="xs:string" name="responseMessage"/>
<xs:element type="xs:short" name="registrationId"/>
<xs:element type="xs:short" name="statusCode"/>
<xs:element type="xs:string" name="statusMessage"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:schema>
With the XSD file generated, you can now proceed to create your WSDL and implement your SOAP endpoint in your Jakarta JEE8 Web App.