OZG-Cloud
lib
xta-client-lib

Repository

%% Senden einer Nachricht
  sequenceDiagram
    participant A as Nutzer*in
    participant B as XTA-Client
    participant C as XTA-Server
    Note left of A: (1) XTA-Client erzeugen
    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
    C-->>B:
    deactivate C
    B->>C: lookupService
    activate C
    C-->>B:
    deactivate C
    B->>C: createMessageID
    activate C
    C-->>B:
    deactivate C
    B->>C: sendMessage
    activate C
    C-->>B:
    deactivate C
    B->>C: getTransportReport
    activate C
    C-->>B:
    deactivate C
    B-->>A:
    deactivate B
    deactivate A
    Note left of A: (4) Nachrichtenstatus prüfen
// (1) XTA-Client erzeugen
var client = XtaClient.from(config);
// (2) Nachricht erzeugen
var zipFileName = "d5be7468-e620-4126-a40e-61a7f9b46345_Geschaeftsgang.Geschaeftsgang.0201.zip";
var zipFileContentDataHandler = new DataHandler(new FileDataSource("/path/to/" + zipFileName));
var xdomeaXtaFile = XtaFile.builder()
        .name(zipFileName)
        .content(zipFileContentDataHandler)
        .contentType("application/zip")
        .build();

var message = XtaMessage.builder()
        .metaData(XtaMessageMetaData.builder()
                .service("urn:xoev-de:xdomea:schema:2.4.0/xdomea240Antrag.wsdl")
                .businessScenarioCode("XDOMEAGAD_DATA")
                .businessScenarioListUri("urn:de:dataport:codeliste:business.scenario")
                .businessScenarioListVersionId("1.0")
                .messageTypeCode("Geschaeftsgang.Geschaeftsgang.0201")
                .messageTypePayloadSchema("urn:xoev-de:xdomea:schema:2.4.0")
                .authorIdentifier(XtaIdentifier.builder()
                        .category("Generischer Antragsdienst")
                        .value("gad:010200100000")
                        .build())
                .readerIdentifier(XtaIdentifier.builder()
                        .category("Generischer Antragsempfänger")
                        .value("gae:test-environment@ozg-cloud.de")
                        .build())
                .build())
        .messageFile(xdomeaXtaFile)
        .attachmentFiles(emptyList())
        .build();
// (3) Nachricht senden
var transportReport = client.sendMessage(message);
// (4) Nachrichtenstatus prüfen
assert transportReport.status() == XtaMessageStatus.OPEN;
// ...
// (2) Nachricht erzeugen
// ...
var message = XdomeaXtaMessageCreator.createInstance().createMessage(xdomeaXtaFile);
// (3) Nachricht senden
var transportReport = client.sendMessage(message);
// ...
%% Empfangen von Nachrichten
  sequenceDiagram
    participant A as Nutzer*in
    participant B as XTA-Client
    participant C as XTA-Server
    Note left of A: (1) XTA-Client erzeugen
    Note left of A: (2) Nachrichten abholen
    A->>B: fetchMessages
    activate A
    activate B
    loop Für jede Leser-Kennung
        B->>C: checkAccountActive
        activate C
        C-->>B:
        deactivate C
        B->>C: getStatusList
        activate C
        C-->>B:
        deactivate C
        loop Für jede ungelesene Nachricht
            B->>C: getMessage
            activate C
            Note left of B: Nachricht abholen
            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
            C-->>B:
            deactivate C
            B->>C: getTransportReport
            activate C
            C-->>B:
            deactivate C
            B->>A:
        end
	end
	deactivate B
	deactivate A
    Note left of A: (4) Nachrichtenstatus prüfen
// (1) XTA-Client erzeugen
var client = XtaClient.from(config);
// (2) Nachrichten abholen
var transportReports = client.fetchMessages(xtaMessage -> {
    // (3) Nachricht verarbeiten
});
// (4) Nachrichtenstatus prüfen
for (var transportReport : transportReports) {
    assert transportReport.status() == XtaMessageStatus.GREEN;
}
var config = XtaClientConfig.builder()
        .managementServiceUrl("https://my-xta-server.de/MB_XTA-WS/XTA210managementPort.svc")
        .sendServiceUrl("https://my-xta-server.de/MB_XTA-WS/XTA210sendPort.svc")
        .msgBoxServiceUrl("https://my-xta-server.de/MB_XTA-WS/XTA210msgBoxPort.svc")
        .clientCertKeystore(XtaClientConfig.KeyStore.builder()
                .content(Files.toByteArray(new File("/path/to/client-cert.p12")))
                .type("PKCS12")
                .password("keystore-password")
                .bulid())
        .clientIdentifiers(List.of(
                XtaIdentifier.builder()
                        .category("Generischer Antragsempfänger")
                        .value("gae:test-environment@ozg-cloud.de")
                        .build(),
                XtaIdentifier.builder()
                        .category("Generischer Antragsempfänger")
                        .value("gae:dev-environment@ozg-cloud.de")
                        .build()
        ))
        .build();
var client = XtaClient.from(config);