Changes for page Endpoint Check

Last modified by Danniar Firdausy on 2024/09/04 10:26

From 37.1 to 37.2 From 47.1 to 48.1

From version 37.2

edited by Erik Bakker
on 2022/06/12 09:37

Change comment: Update document after refactoring.

To version 47.1

edited by Erik Bakker
on 2022/12/30 12:37

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (4 modified, 0 added, 0 removed)

Details

Page properties

Title

@@ -1,1 +1,1 @@
--novice-soap-webservice-connectivity-securing-your-soap-webservice
++Endpoint Check

Parent

@@ -1,1 +1,1 @@
--WebHome
++Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.WebHome

Default language

...	...	@@ -1,0 +1,1 @@
	1	+en

Content

@@ -1,62 +1,71 @@
  {{container}}{{container layoutStyle="columns"}}(((
--When communicating via SOAP web service calls it can happen that an exchange of data needs to happen between the message headers on your message and the SOAP headers. In this microlearning, we will learn about this exchange in both directions. SOAP Headers are headers within a SOAP Envelope that can be used to communicate metadata or authentication information between parties.
++When setting up a point at which your customers can talk to you eMagiz offers various methods of creating such a point. One of those options is by hosting a SOAP Webservice in eMagiz that handles XML messages asynchronously or synchronously. One last check to perform before you can communicate with the external parties that the endpoint is available to receive messages and up and running. In this microlearning, we will learn how you can perform such a check.
  Should you have any questions, please contact academy@emagiz.com.
--* Last update: June 10th, 2021
--* Required reading time: 5 minutes
--
  == 1. Prerequisites ==
  * Basic knowledge of the eMagiz platform
  == 2. Key concepts ==
--This microlearning centers around SOAP Headers.
++This microlearning centers around the endpoint check.
--By SOAP Headers, we mean: headers within a SOAP Envelope that can be used to communicate metadata or authentication information between parties
++By endpoint check, we mean: determine whether the WSDL is accessible on the correct endpoint so we can forward the URL to the WSDL + the URL to call to our external parties
--You can exchange data from:
--* SOAP Header to Message Header
--* Message Header to SOAP Header
++* The endpoint consists of the following elements:
++    ** Starts with https:// or http://
++    ** Second part is the host (i.e. where is the endpoint running)
++    ** Third part is the port on which the incoming traffic is accepted
++    ** These three things combined make up the first part of our endpoint that will vary per environment
++    ** Following that we have a static remainder of the endpoint that is build up as follows: /{soap WS name}/{Id}/
++    ** If you want to get to the WSDL simply add the name of the WSDL (which is defined by the Id given to the "Dynamic WSDL" support object) and the .wsdl extension to the endpoint when viewing it in the browser
--In both cases ensure that the correct information is exchanged.
--
--== 3. SOAP Headers ==
++== 3. Endpoint Check ==
--When communicating via SOAP web service calls it can happen that an exchange of data needs to happen between the message headers on your message and the SOAP headers. In this microlearning, we will learn about this exchange in both directions. SOAP Headers are headers within a SOAP Envelope that can be used to communicate metadata or authentication information between parties.
++When setting up a point at which your customers can talk to you eMagiz offers various methods of creating such a point. One of those options is by hosting a SOAP Webservice in eMagiz that handles XML messages asynchronously or synchronously. One last check to perform before you can communicate with the external parties that the endpoint is available to receive messages and up and running. In this microlearning, we will learn how you can perform such a check.
--You can exchange data from:
--* SOAP Header to Message Header
--* Message Header to SOAP Header
++* The endpoint consists of the following elements:
++    ** Starts with https:// or http://
++    ** Second part is the host (i.e. where is the endpoint running)
++    ** Third part is the port on which the incoming traffic is accepted
++    ** These three things combined make up the first part of our endpoint that will vary per environment
++    ** Following that we have a static remainder of the endpoint that is build up as follows: /{soap WS name}/{Id}/
++    ** If you want to get to the WSDL simply add the name of the WSDL (which is defined by the Id given to the "Dynamic WSDL" support object) and the .wsdl extension to the endpoint when viewing it in the browser
--In both cases ensure that the correct information is exchanged.
++As you can see the endpoint can be divided into two parts. One part is dynamic across environments and one part is static across environments. Let us first determine how we can find out the first part of our endpoint.
--In a previous microlearning, we already discussed one aspect of this. As you probably recall from our microlearning on [Securing your SOAP Webservice](novice-soap-web service-connectivity-securing-your-soap-webservice.md) we needed to exchange data between the SOAP header that our client was sending and a message header on the message so we could check whether or not the client was authorized to call the operation.
++=== 3.1 HTTPS or HTTP ===
--In that microlearning, we also discussed the component that we need for this. The 'complex SOAP header mapper'.
++We start at the top with the determination of HTTPS or HTTP. A simple rule of thumb is that when running in the eMagiz Cloud the endpoint starts with https:// and when the endpoint is running locally (i.e. on-premise) the endpoint starts with http:// (unless you secure it yourself, more on that later).
--[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-soap-headers--complex-soap-header-mapper.png]]
++=== 3.2 Host ===
--As you can see you can map from and to message headers with regards to the SOAP Headers. As we already discussed the first scenario in an earlier microlearning I will for now continue with the other scenario. This scenario is mainly needed when eMagiz calls a SOAP web service that is hosted by an external party. Since we would normally do this in an exit (gate/flow) let us open such an exit in eMagiz and enter "Start Editing" mode.
++The next part of the endpoint is the host. The host is effectively the (virtual) machine on which the endpoint is running. When hosting an endpoint in the eMagiz cloud the host part is the combination between the DNS left-most label on Route level and the cloudslot on which your environment is running. The first part of the equation can be found under Deploy -> Architecture. The second part can be found under Deploy -> Properties by looking for the {technicalnameproject}.amqp01.host. You need to combine the two elements via a dash -. An example of this would then be spwbsrv-test-cloud0001.emagizcloud.com. In case of an on-premise installation, you should ask your customer what the IP address or DNS name is to connect to the machine on which your runtime is running. If the runtime is running locally on your laptop the host equals localhost.
--The first step we need to take is to ensure that the information that we need to send to the SOAP web service in question (in this a unique reference number) is available in a message header. This can be done by verifying in all steps that preceded before the message entered the exit whether or not this piece of information was already added to a message header. In this case, we assume that this is the case since we want to focus on the 'complex SOAP header mapper' component and its relation to the web services outbound gateway. To correctly exchange data from a message header to a SOAP header we need to define a valid SpEL expression. See the help text of the component for a suggestion of what a valid SpEL expression is. The key part in this is knowing how the external party wants to receive the header(s) and how you (or one of your colleagues) has named the message header. When you have those two information elements you can write the correct expression. The result should be something as follows:
++=== 3.3 Port and Path ===
--[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-soap-headers--mapping-from-message-header.png]]
++Whether or not the port needs to be defined to get to the endpoint is once again determined by the location. If the endpoint is hosted in the eMagiz Cloud the port is *not* part of the endpoint. However, when you host your endpoint locally the endpoint becomes part of your endpoint. Note that to make this piece work in the eMagiz Cloud you should set up your Route properly. More on that in our Cloud Management courses. You can determine the port, for the endpoint or the route, by navigating to the infra flow of the runtime through which you host your SOAP web service. In the infra flow you can also find the remainder of the path to get to the WSDL location.
--Once you are satisfied you can press Save and link the support object to the web service outbound gateway.
++In the infra flow there is a support object of the type "Dynamic WSDL". In here you see the default location of the hosted SOAP endpoint, which is http://localhost:${entry.connector.ws.port}/ws/{soap WS name}/. Based on this, you can find the WSDL by adding {Id}.wsdl to the URI. In this example, when hosting the SOAP web service on-premise, a valid URI would be "http://localhost:8099/ws/soapgn3-connector/soapgn3-connector.wsdl".
--With this information, you can place SOAP Headers on message headers and vice versa every time you need it.
++{{info}}Note that when running your web service in the eMagiz cloud, the first part (the host part) will change depending on your configuration in Deploy Architecture and the cloud slot on which you are running. An example URI, in that case, would be "https://soap-test-cloud0000.emagizcloud.com/ws/soapgn3-connector/soapgn3-connector.wsdl"{{/info}}
++[[image:Main.Images.Microlearning.WebHome@novice-soap-webservice-connectivity-validate-incoming-messages-gen3--dynamic-wsdl-support-object-infra.png]]
++
  == 4. Assignment ==
--Call an external web service and send along some SOAP Headers.
++Determine the endpoint of your SOAP Webservice and retrieve the WSDL.
  This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
  == 5. Key takeaways ==
--* You can exchange data from:
--    ** SOAP Header to Message Header
--    ** Message Header to SOAP Header
--* You need the SOAP structure and the message header name to make it work
++* The endpoint consists of the following elements:
++    ** Starts with https:// or http://
++    ** Second part is the host (i.e. where is the endpoint running)
++    ** Third part is the port on which the incoming traffic is accepted
++    ** These three things combined make up the first part of our endpoint that will vary per environment
++    ** Following that we have a static remainder of the endpoint that is build up as follows: /{soap WS name}/{Id}/
++    ** If you want to get to the WSDL simply add the name of the WSDL (which is defined by the Id given to the "Dynamic WSDL" support object) and the .wsdl extension to the endpoint when viewing it in the browser
++* The relevant information can be derived from the "Dynamic WSDL" support object and by determining where the endpoint is hosted
  == 6. Suggested Additional Readings ==
@@ -64,6 +64,6 @@
  == 7. Silent demonstration video ==
--{{video attachment="novice-soap-webservice-connectivity-soap-headers.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
++{{video attachment="novice-soap-webservice-connectivity-endpoint-check-gen3.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
  )))((({{toc/}}))){{/container}}{{/container}}

Changes for page Endpoint Check

Summary

Details

Navigation