Wiki source code of WS-Addressing
Last modified by Martijn Woudstra on 2022/06/10 16:13
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
31.1 | 1 | {{container}}{{container layoutStyle="columns"}}((( |
| 2 | 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: | ||
| 3 | |||
| 4 | * What is WS-Addressing | ||
| 5 | * Calling an external SOAP Webservice that requires WS-Addressing | ||
| 6 | |||
| 7 | Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]]. | ||
| 8 | |||
| 9 | * Last update: March 1st, 2021 | ||
| 10 | * Required reading time: 6 minutes | ||
| 11 | |||
| 12 | == 1. Prerequisites == | ||
| 13 | |||
| 14 | * Advanced knowledge of the eMagiz platform | ||
| 15 | |||
| 16 | == 2. Key concepts == | ||
| 17 | |||
| 18 | WS-Addressing is a standardized way of including message routing data within SOAP headers. | ||
| 19 | 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. | ||
| 20 | |||
| 21 | To correctly configure WS-addressing on an outbound call, you need: | ||
| 22 | * Message destination URI | ||
| 23 | * Source endpoint | ||
| 24 | * Reply endpoint | ||
| 25 | * Fault endpoint | ||
| 26 | * Action | ||
| 27 | |||
| 28 | == 3. WS-Addressing == | ||
| 29 | |||
| 30 | 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: | ||
| 31 | |||
| 32 | * What is WS-Addressing | ||
| 33 | * Calling an external SOAP Webservice that requires WS-Addressing | ||
| 34 | |||
| 35 | === 3.1 What is WS-Addressing === | ||
| 36 | |||
| 37 | WS-Addressing is a standardized way of including message routing data within SOAP headers. | ||
| 38 | 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. | ||
| 39 | |||
| 40 | This can be achieved by sending (a set of) WS-Addressing SOAP Headers along with the SOAP body. Examples of these headers are: | ||
| 41 | |||
| 42 | Relationship to previous messages (A pair of URIs) | ||
| 43 | * Message destination URI | ||
| 44 | * Source endpoint | ||
| 45 | * Reply endpoint | ||
| 46 | * Fault endpoint | ||
| 47 | * Action | ||
| 48 | |||
| 49 | What an external system exactly requires in terms of WS-Addressing headers depends on the requirements made by that system. | ||
| 50 | |||
| 51 | === 3.2 Calling an external SOAP Webservice that requires WS-Addressing === | ||
| 52 | |||
| 53 | 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). | ||
| 54 | This support object is: | ||
| 55 | |||
| 56 | - WS-Addressing action callback | ||
| 57 | |||
| 58 | Within this component, you can set the following headers as well as choose the version of WS-Addressing that is required: | ||
| 59 | |||
| 60 | - Action (required) | ||
| 61 | - To | ||
| 62 | - From | ||
| 63 | - Reply To | ||
| 64 | - Fault To | ||
| 65 | |||
| 66 | [[image:Main.Images.Microlearning.WebHome@expert-webservice-security-ws-addressing--ws-addressing-basic.png]] | ||
| 67 | |||
| 68 | [[image:Main.Images.Microlearning.WebHome@expert-webservice-security-ws-addressing--ws-addressing-advanced.png]] | ||
| 69 | |||
| 70 | When you are satisfied with your configuration, you can link this support object to the web service outbound gateway as follows: | ||
| 71 | |||
| 72 | [[image:Main.Images.Microlearning.WebHome@expert-webservice-security-ws-addressing--ws-addressing-callback.png]] | ||
| 73 | |||
| 74 | 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. | ||
| 75 | |||
| 76 | == 4. Assignment == | ||
| 77 | |||
| 78 | Define the correct configuration of calling an external web service from an exit flow in eMagiz that requires WS-addressing to be sent along with the call. You can execute this assignment on the model you have used for the previous lessons. | ||
| 79 | |||
| 80 | == 5. Key takeaways == | ||
| 81 | |||
| 82 | * WS-Addressing is a standardized way of including message routing data within SOAP headers | ||
| 83 | * These information elements can be added via a specific component in eMagiz | ||
| 84 | * Which information elements are needed is determined by the external party | ||
| 85 | |||
| 86 | == 6. Suggested Additional Readings == | ||
| 87 | |||
| 88 | If you are interested in this topic and want more information on it please read the help text provided by eMagiz. | ||
| 89 | |||
| 90 | == 7. Silent demonstration video == | ||
| 91 | |||
| 92 | This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned. | ||
| 93 | |||
| 94 | {{video attachment="expert-webservice-security-ws-addressing.mp4" reference="Main.Videos.Microlearning.WebHome"/}} | ||
| 95 | |||
| 96 | )))((({{toc/}}))){{/container}}{{/container}} |