WS-Addressing

Last modified by Erik Bakker on 2024/09/09 12:01

WS-Addressing is a standard that allows message routing data to be embedded within SOAP headers, ensuring consistent delivery and processing of messages. This section explains how to configure WS-Addressing within eMagiz, detailing the key components and settings required for successful integration with external SOAP web services.

Should you have any questions, please contact academy@emagiz.com.

1. Prerequisites

  • Advanced knowledge of the eMagiz platform

2. Key concepts

WS-Addressing is a standardized way of including message routing data within SOAP headers.
For example, a WS-Addressing message may contain its dispatch metadata in a standardized SOAP header instead of relying on network-level transport to convey routing information.

To correctly configure WS-addressing on an outbound call, you need:

  • Message destination URI
  • Source endpoint
  • Reply endpoint
  • Fault endpoint
  • Action

3. WS-Addressing

Within eMagiz, there are multiple ways of handling security concerning SOAP Webservices. One of these methods is WS-Addressing. In this microlearning, we will look at WS-Addressing from the following viewpoints:

  • What is WS-Addressing
  • Calling an external SOAP Webservice that requires WS-Addressing

3.1 What is WS-Addressing

WS-Addressing is a standardized way of including message routing data within SOAP headers.
For example, a WS-Addressing message may contain its dispatch metadata in a standardized SOAP header instead of relying on network-level transport to convey routing information.

This can be achieved by sending (a set of) WS-Addressing SOAP Headers along with the SOAP body. Examples of these headers are:

Relationship to previous messages (A pair of URIs)

  • Message destination URI
  • Source endpoint
  • Reply endpoint
  • Fault endpoint
  • Action

What an external system exactly requires in terms of WS-Addressing headers depends on the requirements made by that system.

3.2 Calling an external SOAP Webservice that requires WS-Addressing

To ensure that eMagiz creates the required SOAP headers on top of your SOAP message, you must add one support object to the flow where you want to call the external web service (predominantly the exit).
This support object is:

- WS-Addressing action callback

Within this component, you can set the following headers as well as choose the version of WS-Addressing that is required:

- Action (required)
- To
- From
- Reply To
- Fault To

expert-webservice-security-ws-addressing--ws-addressing-basic.png

expert-webservice-security-ws-addressing--ws-addressing-advanced.png

When you are satisfied with your configuration, you can link this support object to the web service outbound gateway as follows:

expert-webservice-security-ws-addressing--ws-addressing-callback.png

After doing all this, you can test the flow to verify that the WS-Addressing is correctly configured, allowing you to call the external web service.

4. Key takeaways

  • WS-Addressing is a standardized way of including message routing data within SOAP headers
  • These information elements can be added via a specific component in eMagiz
  • Which information elements are needed is determined by the external party

5. Suggested Additional Readings