SOAP Connector 8.0.0 | X4Documentation

Webservice (SOAP) Connector: Sendet eine SOAP-Anfrage (SOAP Request) via HTTP(S) zu der URL eines WebServices und gibt die zurückgelieferte SOAP-Antwort (SOAP Response) aus. Er kommuniziert mit Servern über HTTP (Hyper Text Transfer Protocol) oder HTTPS (HTTP Secure).

Falls eine Authentifizierung erforderlich ist, muss diese SOAP-basiert über den SOAP Header erfolgen. Der Aufbau (zertifikats-, token-basiert etc.) muss zunächst mit der Gegenstelle geklärt werden. Es werden HTTP-Server unterstützt. Für die HTTP-Authentifizierung muss der HTTP(S) Connector verwendet werden.

Eigenschaften (Properties)

Operation

Bestimmt, welche Operation der Adapter durchführt

Mögliche Werte:

Call SOAP: Adapter ausführen

Parameter

Repository	Virtuelles Repository des Adapterprojekts
protocol	Verwendetes Protokoll (HTTP oder HTTPS) Mögliche Werte: `http`: HTTP (unverschlüsselt) verwenden (Standard) `https`: HTTPS (SSL-verschlüsselt) verwenden
host	IP-Adresse oder Host-Name des physikalischen Servers Hinweis: Der Parameter `host` fügt einen `HTTP-Header` namens `host` hinzu. Mögliche Werte: Beliebige gültige Zeichenkette ohne Protokollangabe (z. B. google.com)
vHost	Host-Name eines logischen Servers (virtual host), falls dieser durch die physikalische Angabe in Parameter host nicht eindeutig identifiziert werden kann Hinweis: Der Parameter `vHost` überschreibt den Wert für den `HTTP-Header` namens `host`, siehe Parameter `host`. Hier können die Ports angegeben werden, ausgenommen der Ports 80 (Standard für HTTP-Verbindungen) und 443 (Standard für HTTPS-Verbindungen). Mögliche Werte: Beliebige gültige Zeichenkette ohne Protokollangabe (z. B. google.com)
port	Portnummer des HTTP(S)-Dienstes Mögliche Werte: Beliebige ganze Zahl (z. B. `8080`) `-1`: Für HTTP-Verbindungen Port 80 verwenden; bei HTTPS-Verbindungen Port 443 verwenden (Standard)
path	Ordnerpfad auf dem Server, beginnend mit einem Schrägstrich Mögliche Werte: Beliebige Pfadangabe (z. B. `/intl/en_ALL/images/logo.gif`)
authenticationEncoding	Zeichenkodierung für die Anmeldedaten Mögliche Werte: Angabe einer Zeichenkodierung, z. B. `UTF-8` oder `ISO-8859-1` Mithilfe dieses Parameters können auch Umlaute in den Anmeldedaten verwendet werden.
query	Argument(e) für die HTTP(S)-Anfrage Mögliche Werte: Beliebige URL-kodierte Argumente ohne führendes Fragezeichen (z. B. `Arg1=V1&Arg2=V2`)
username	Benutzername für eine Basic-, Digest- oder NTLM-Authentifizierung Mögliche Werte: Bei HTTP-Basic-Authentifizierung: der Benutzername Bei HTTP-Basic-Authentifizierung an einer Windows-Domäne: Zeichenkette nach dem Muster `<Domäne>\<Benutzername>` (z. B. `MyDomain\MyUserName`) Bei NTLM-Authentifizierung an einer Windows-Domäne: nur der Benutzername (und in Parameter ntlmDomain die Domäne angeben) (z. B. `MyUsername`)
password	Passwort für eine Basic-, Digest- oder NTLM-Authentifizierung Mögliche Werte: Beliebige Zeichenkette
usePreemptiveBasicAuth	Präemptive Authentifizierung (mit den Zugangsdaten aus Parameter username und password) für HTTP(S)-Aufrufe aktivieren (nur für Basic-Authentifizierung, siehe Parameter allowBasic) Mögliche Werte: `ja`: Zugangsdaten direkt (präemptiv) bei jedem HTTP(S)-Aufruf mitschicken `nein`: Keine präemptive Authentifizierung (Standard)
allowBasic	HTTP(S)-Basic-Authentifizierung verwenden Mögliche Werte: `ja`: Basic-Authentifizierung verwenden `nein`: Keine Basic-Authentifizierung verwenden (Standard)
useProxy	Proxy-Server für den Verbindungsaufbau verwenden Mögliche Werte: `ja`: Verbindung über den in Parameter proxyHost angegeben Proxy-Server aufbauen `nein`: Kein Proxy-Server (Standard)
proxyHost	IP-Adresse oder Host-Name eines Proxy-Servers Mögliche Werte: Beliebige gültige Zeichenkette (z. B. `192.168.1.1`)
proxyPort	Portnummer des Proxy-Servers Mögliche Werte: Beliebige ganze Zahl -`1`: Standard-Port verwenden (Standard)
proxyUsername	Benutzername für eine Basic-, Digest- oder NTLM-Authentifizierung am Proxy-Server Mögliche Werte: Bei HTTP-Basic-Authentifizierung: der Benutzername Bei HTTP-Basic-Authentifizierung an einer Windows-Domäne: Zeichenkette nach dem Muster `<Domäne>\<Benutzername>` (z. B. `MyDomain\MyUserName`) Bei NTLM-Authentifizierung an einer Windows-Domäne: nur der Benutzername (und in Parameter `ntlmDomain` die Domäne angeben) (z. B. `MyUsername`)
proxyPassword	Passwort für den Proxy-Server Mögliche Werte: Beliebige Zeichenkette
proxyAllowBasic	Basic-Authentifizierung für den Proxy verwenden Mögliche Werte: `ja`: Basic-Authentifizierung für den Proxy verwenden `nein`: Keine Basic-Authentifizierung für den Proxy verwenden (Standard)
connectTimeout	Timeout-Wert für den Verbindungsaufbau in Millisekunden Mögliche Werte: `>0`: Timeout-Wert in Millisekunden `<=0`: Kein Timeout (Standard)
socketTimeout	Timeout-Wert zwischen zwei eingehenden Datenpaketen in Millisekunden; Dieser sagt nichts über die Gesamt-Anfragezeit aus. Mögliche Werte: `>0`: Timeout-Wert in Millisekunden `<=0`: Kein Timeout (Standard)
acceptAllCertificates	Zertifikatsprüfung abschalten Mögliche Werte: `beliebiger String`: Zertifikate werden auf Vertrauen geprüft (Standard) `Yes, I want to disable security by accepting untrusted certificates.`: Zertifikatsprüfung wird abgeschaltet Bitte beachten: Hier muss die genaue Zeichenfolge eingegeben werden!
acceptAllSslHostnames	Hostname-Überprüfung für Zertifikate abschalten Mögliche Werte: `beliebiger String`: Hostname muss zum Zertifikat passen (Standard) `Yes, I want to disable security by accepting non-matching hostnames.`: Hostname-Überprüfung wird abgeschaltet Bitte beachten: Hier muss die genaue Zeichenfolge eingegeben werden!
useClientCertificate	Client-Zertifikate zur Validierung des Requests verwenden Mögliche Werte: `ja`: Client-Zertifikate zur Validierung des Requests verwenden `nein`: Kein Client-Zertifikat zur Validierung des Requests verwenden (Standard)
keystoreType	Keystore-Typ für die Speicherung von Client-Zertifikaten (gemäß http://docs.oracle.com/javase/6/docs/technotes/guides/security/StandardNames.html#KeyStore) Mögliche Werte: `jceks`: Proprietäre Keystore-Implementierung von SunJCE verwenden `jks`: Proprietäre Keystore-Implementierung von SUN verwenden `pkcs12`: Keystore-Transferformat PKCS12 verwenden
keystoreURL	URL zum Keystore für die Validierung des Requests über Client-Zertifikate Mögliche Werte: Beliebige gültige URL, z.B. `file:/C:/Folder/ExampleKeystore`
keystorePassword	Passwort für den Keystore zur Validierung des Requests über Client-Zertifikate Mögliche Werte: Beliebige gültige Zeichenkette
keyAlias	Schlüssel-Alias zur Zugriff auf einen bestimmten Schlüssel innerhalb des Keystores Mögliche Werte: Beliebige gültige Zeichenkette
aliasPassword	Zugehöriges Passwort für einen bestimmten Schlüssel innerhalb des Keystores Mögliche Werte: Beliebige gültige Zeichenkette
SoapAction	HTTP-Header des SOAP-Requests. Der Wert dieses Parameters ist eine URL, die die abgefragte Operation identifiziert.
toXml	Alle Header als Elemente und den Inhalt des Bodys als Base64-kodierten Text in einem XML-Dokument ausgeben Mögliche Werte: `ja`: XML-Dokument ausgeben `nein`: Server-Antwort unverändert ausgeben (Standard)

Statuswerte

`1`	Die Operation wurde erfolgreich ausgeführt.
`-1`	Die Operation ist aufgrund eines technischen Fehlers fehlgeschlagen.

SOAP-Anfrage

Die SOAP-Anfrage ist wie im folgenden Beispiel aufgebaut:

<?xml version = "1.0"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://www.w3.org/2001/12/soap-envelope"
                   SOAP-ENV:encodingStyle="http://www.w3.org/2001/12/soap-encoding">
	<SOAP-ENV:Body xmlns:m="http://www.xyz.org/quotations">
		<m:GetQuotation>
			<m:QuotationsName>MicroSoft</m:QuotationsName>
		</m:GetQuotation>
	</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

SOAP-Antwort

Die SOAP-Antwort enthält die angeforderten Information im Body der Nachricht:

<?xml version = "1.0"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://www.w3.org/2001/12/soap-envelope"
                   SOAP-ENV:encodingStyle="http://www.w3.org/2001/12/soap-encoding">
	<SOAP-ENV:Body xmlns:m="http://www.xyz.org/quotation">
		<m:GetQuotationResponse>
			<m:Quotation>Here is the quotation</m:Quotation>
		</m:GetQuotationResponse>
	</SOAP-ENV:Body>
</SOAP-ENV:Envelope>