From 848fd7c71af720175272e164367ab1d94b0922ff Mon Sep 17 00:00:00 2001 From: Sander Verbruggen Date: Thu, 23 Nov 2023 11:17:30 +0100 Subject: [PATCH] FDP-94: Added README Signed-off-by: Sander Verbruggen --- README.md | 39 +++ .../src/main/resources/application-dev.yml | 3 - docs/proxy.svg | 250 ++++++++++++++++++ 3 files changed, 289 insertions(+), 3 deletions(-) create mode 100644 README.md create mode 100644 docs/proxy.svg diff --git a/README.md b/README.md new file mode 100644 index 0000000..ce192a8 --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +# GXF Soap bridge + +This component can be used to bridge gaps between environments. +The GXF platform doesn't have to reside on a single location/namespace/network zone. +To make this bridge seamless it acts like a proxy. It will accept your SOAP call, send it over Kafka to the other end +and re-issue the SOAP request over there. + +# Kafka communication - Example + +![](docs/proxy.svg) + +- `Servce X` will try to call Service Y. You've configured X to make the request to the proxy instead +- `Proxy A` will + - store the HTTP connection used to receive the request and keep it open + - receive the SOAP body and some meta data + - make a message object of it + - sign this message + - and send it over the `web_requests` Kafka topic +- `Proxy B` will + - receive the message from the Kafka topic `web_requests` + - check the signature + - unwrap the message + - use the SOAP body to do the SOAP request to `Service Y` and receive a SOAP result body + - make a message object of that result body + - sign this message + - and send it over the `web_responses` Kafka topic +- `Proxy A` will then + - receive the message from the Kafka topic `web_responses` + - check the signature + - unwrap the message + - find the stored HTTP connection that was used to initiate this request + - write the SOAP result body to the HTTP response +- `Service X` will receive a SOAP response not even knowing it talked to a proxy + +## Notifications ("The other way around") + +You can also configure this to work the other way around; `Service Y` calling `Service X`. +In GXF terms, this is called a notification. +Each proxy instance can act as both proxy start and end point as seen in the image above. diff --git a/application/src/main/resources/application-dev.yml b/application/src/main/resources/application-dev.yml index 59112eb..1c0b25b 100644 --- a/application/src/main/resources/application-dev.yml +++ b/application/src/main/resources/application-dev.yml @@ -49,9 +49,6 @@ soap: management: server: port: 8888 - # ssl: - # enabled: false - # client-auth: none endpoints: web: exposure: diff --git a/docs/proxy.svg b/docs/proxy.svg new file mode 100644 index 0000000..092c451 --- /dev/null +++ b/docs/proxy.svg @@ -0,0 +1,250 @@ + + + + + + + + + + + + + + +
+
+
+ Proxy A +
+
+
+ + + Proxy A + + + + + + + + + +
+
+
+ Proxy B +
+
+
+ + + Proxy B + + + + + + + + + + +
+
+
+ web_requests +
+
+
+ + + web_requests + + + + + + + + + + +
+
+
+ web_responses +
+
+
+ + + web_responses + + + + + + + + + + +
+
+
+ backend_requests +
+
+
+ + + backend_requests + + + + + + + + + + +
+
+
+ backend_responses +
+
+
+ + + backend_responses + + + + + + + + + + + + + + + + + +
+
+
+ Service X +
+
+
+ + + Service X + + + + + + + +
+
+
+ Service Y +
+
+
+ + Service Y + + + + + + + + Text is not SVG - cannot display + + +