From 9409b0550c53dc477b6a085f6188d906a623af32 Mon Sep 17 00:00:00 2001
From: Jan Zickermann <jan.zickermann@dataport.de>
Date: Thu, 24 Oct 2024 09:40:27 +0200
Subject: [PATCH] OZG-6891 Cleanup
---
README.md | 20 +++++++++----------
.../de/ozgcloud/xta/client/XtaClient.java | 2 +-
.../xta/client/config/XtaClientConfig.java | 2 +-
3 files changed, 11 insertions(+), 13 deletions(-)
diff --git a/README.md b/README.md
index 5d95161..55a8d0f 100644
--- a/README.md
+++ b/README.md
@@ -20,10 +20,10 @@ Wenn der zurückgegebene Transport-Report den Status `OPEN` meldet, steht die Na
participant B as XTA-Client
participant C as XTA-Server
Note left of A: (1) XTA-Client erzeugen
+ activate A
Note left of A: (2) Nachricht erzeugen
Note left of A: (3) Nachricht senden
A->>B: sendMessage
- activate A
activate B
B->>C: checkAccountActive
activate C
@@ -47,8 +47,8 @@ Wenn der zurückgegebene Transport-Report den Status `OPEN` meldet, steht die Na
deactivate C
B-->>A:
deactivate B
- deactivate A
Note left of A: (4) Nachrichtenstatus prüfen
+ deactivate A
```
<small>* Der XTA-Server wird oft als Nachrichtenbroker oder Nachrichtenvermittler bezeichnet.</small>
@@ -143,9 +143,10 @@ Hierbei signalisiert `RED` einen kritischen Fehler, `YELLOW` einen Warnhinweis u
participant B as XTA-Client
participant C as XTA-Server
Note left of A: (1) XTA-Client erzeugen
+ activate A
Note left of A: (2) Nachrichten abholen
A->>B: fetchMessages
- activate A
+
activate B
loop Für jede Leser-Kennung
B->>C: checkAccountActive
@@ -163,10 +164,8 @@ Hierbei signalisiert `RED` einen kritischen Fehler, `YELLOW` einen Warnhinweis u
C-->>B:
deactivate C
B->>A: processMessage
- deactivate B
Note left of A: (3) Nachricht verarbeiten
A-->>B:
- activate B
B->>C: close
activate C
Note left of B: Nachricht schließen
@@ -176,12 +175,12 @@ Hierbei signalisiert `RED` einen kritischen Fehler, `YELLOW` einen Warnhinweis u
activate C
C-->>B:
deactivate C
- B->>A:
end
end
- deactivate B
- deactivate A
+ B-->>A:
+ deactivate B
Note left of A: (4) Nachrichtenstatus prüfen
+ deactivate A
```
<small>* Sollte `processMessage` bei der Verarbeitung eine *RuntimeException* werfen, wird `Nachrichten schließen` übersprungen.</small>
@@ -243,8 +242,7 @@ Zum Beispiel kann auf diese Weise verhindert werden, dass nicht unterstützte Na
## Referenzen
-
-- Dieser XTA-Client basiert auf dem [XTA-Client-Beispielcode für XTA 2 Version 3 vom 21.07.2021](https://www.xoev.de/sixcms/media.php/13/XTA_Client_Version_3_20210721.zip) auffindbar unter [Hilfsmittel](https://www.xoev.de/osci-xta/standard-xta-2/xta-hilfsmittel-23081).
-- Die [XTA 2 Version 3.1 Spezifikation](file:///home/janz/Downloads/XTA_2_Version_3.1_Spezifikation_30112021-2.pdf) ist auffindbar unter [XTA 2 Version 3.1](https://www.xoev.de/osci-xta/standard-xta-2/xta-versionsuebersicht/xta-2-version-3-23038).
+- Dieser XTA-Client basiert auf dem [XTA-Client-Beispielcode für XTA 2 Version 3 vom 21.07.2021](https://www.xoev.de/sixcms/media.php/13/XTA_Client_Version_3_20210721.zip) auffindbar unter [Hilfsmittel](https://www.xoev.de/xta/hilfsmittel).
+- Die [XTA 2 Version 3.1 Spezifikation](https://www.xoev.de/sixcms/media.php/13/XTA_2_Version_3.1_Spezifikation_30112021.pdf) ist auffindbar unter [XTA 2 Version 3.1](https://www.xoev.de/xta/v3).
diff --git a/src/main/java/de/ozgcloud/xta/client/XtaClient.java b/src/main/java/de/ozgcloud/xta/client/XtaClient.java
index 8eaa3cc..0ec9459 100644
--- a/src/main/java/de/ozgcloud/xta/client/XtaClient.java
+++ b/src/main/java/de/ozgcloud/xta/client/XtaClient.java
@@ -28,7 +28,7 @@ import lombok.RequiredArgsConstructor;
import lombok.extern.log4j.Log4j2;
/**
- * A client for sending and receiving messages via the XTA protocol.
+ * A client for sending and receiving messages via the XTA 2 protocol (version 3).
*
* <p>
* The client may be initialized with an {@link XtaClientConfig} configuration by {@link #from(XtaClientConfig)}.
diff --git a/src/main/java/de/ozgcloud/xta/client/config/XtaClientConfig.java b/src/main/java/de/ozgcloud/xta/client/config/XtaClientConfig.java
index 48b4682..b51cb00 100644
--- a/src/main/java/de/ozgcloud/xta/client/config/XtaClientConfig.java
+++ b/src/main/java/de/ozgcloud/xta/client/config/XtaClientConfig.java
@@ -112,7 +112,7 @@ public class XtaClientConfig {
* Whether to validate the XTA SOAP schema of the messages. Default is true.
*
* <p>
- * This option is intended for testing purposes and turing it off is not recommended.
+ * This option is intended for testing purposes and turning it off is not recommended.
* </p>
*/
@Builder.Default
--
GitLab