REST Client Service
Übersicht
Der RestClientService ermöglicht ausgehende REST-Aufrufe.
Technische Beschreibung
Klassenpfad org.b2bbp.eai.services.rs.RestClientService
| ServiceProperty / Eigenschaften | Beschreibung | Werte |
|---|---|---|
| URL | Endpoint URL | |
| METHOD | Endpoint Methode | z.B. GET, POST etc. |
| ENTITY_KEY_SOURCE | MessageContext-Key für die Request-Entity | |
| ENTITY_KEY_RESPONSE | MessageContext-Key für die Response-Entity | CURRENT_PAYLOAD(default) |
| RESPONSE_KEY | MessageContext-Key für das Response-Object | REST_RESPONSE(default) |
| LOAD_HEADERS_FROM_REQUEST | Falls es sich um einen Forwarding-Request handelt, verwende die Header-Daten des ursprünglichen Requests | true(default)/false |
| GENERATE_URL_FROM_REQUEST | Falls es sich um einen Forwarding-Request handelt, verwende den Hostnamen des ursprünglichen Requests als Basis-URI | true/false(default) |
| TARGET_BASE_URL | Nur in Kombination mit GENERATE_URL_FROM_REQUEST. Verwende die TARGET_BASE_URL als Basis-URI | true(default)/false |
| EXCLUDE_REQUEST_PATH_PART | Nur in Kombination mit TARGET_BASE_URL. Schließe den angegebenen Pfad-Teil bei der Erzeugung der Ziel-URL aus | true(default)/false |
| METHOD_FROM_REQUEST | Falls es sich um einen Forwarding-Request handelt, verwende die Methode des ursprünglichen Requests | true(default)/false |
| TCP_RECEIVE_TIMEOUT | Timeout des Aufrufs | 45000(default) oder beliebiger Wert |
| AUTH_METHOD | Authentifizierungs-Methode. Achtung: Wenn Authentifizierung OAUTH2_KEYCLOAK verwendet wird muss dazu eine keycloak.json Konfiguration im Klassenpfad hinterlegt werden, siehe Installation | NONE(default),BASIC_AUTHENTICATION/BASIC,OAUTH2_KEYCLOAK |
| USERNAME | Benutzername für Authentifizierung | |
| PASSWORD | Verschlüsseltes Passwort | |
| SECURITY_PROTOCOL | Protokoll | NONE(default), SSL, TLS |
| DISABLE_CN_CHECK | Keine Prüfung auf Common Name | true/false(default) |
| TRUST_ALL_CERTS | Allen Zertifikaten vertrauen | true/false(default) |
| KEYSTORE_PATH | Pfad zum KeyStore | |
| KEYSTORE_PASSWORD | Verschlüsseltes KeyStore-Passwort | |
| TRUSTSTORE_PATH | Pfad zum TrustStore | |
| TRUSTSTORE_PASSWORD | Verschlüsseltes TrustStore-Passwort | |
| RESPONSE_CODES_FOR_STOP | Komma-separierte Liste von Response-Codes, bei denen der Workflow gestoppt wird | 500,501,502,503,504,505,506,507,508,509,510,511 |
| HEADER_{HeaderParameterName} | Header-Parameter, die dem Request-Header hinzugefügt werden sollen. Sowohl als ServiceProperty oder MessageContextProperty definierbar. | |
| QUERYPARAM_{QueryParameterName} | Query-Parameter, die dem Request hinzugefügt werden sollen. Sowohl als ServiceProperty oder MessageContextProperty definierbar. | |
| FORMPARAM_{FormParameterName} | Form-Parameter, die dem Request hinzugefügt werden sollen. Sowohl als ServiceProperty oder MessageContextProperty definierbar. | |
| PROXY_SERVER | Proxy-Server, der für die Verbindung verwendet werden soll | |
| PROXY_PORT | Port des Proxy-Servers | |
| PROXY_USERNAME | Benutzername für Basic-Authentifzierung am Proxy-Server | |
| PROXY_PASSWORD | Verschlüsseltes Passwort für Basic-Authentifzierung am Proxy-Server | |
| MESSAGE_STATE_ON_SUCCESS | Beim erfolgreichen Rest-Call wird am Ende der Nachrichtenverarbeitung dieser VS-Status gesetzt. Nützlich, wenn eine asynchrone Antwort erwartet wird, z.B. beim AS4-Versand. | A4P |
| B3P_SET_CONTRL_STATE | Bei “true” wird der Bestätigungsstatus auf “CTW” (Warte auf CONTRL) gesetzt. Ausnahme: der Nachrichtentyp is “CONTRL”. | true/false(default) |