Webservice (SOAP) Connector

Hinweis

Der Webservice (SOAP) Connector wird mit Version 8.0 der X4 BPMS abgekündigt und in zukünftigen Versionen der X4 BPMS nicht mehr unterstützt.

Dieser Adapter 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; Dessen Aufbau (zertifikats-, token-basiert etc.) muss zunächst mit der Gegenstelle geklärt werden. Zudem werden HTTP- und NTLM-Authentifizierung sowie Proxy-Server unterstützt. Für die HTTP-Authentifizierung muss der HTTP(S) Connector verwendet werden.

Hinweis:

Der Adapter unterstützt SOAP MTOM (Message Transmission Optimization Mechanism), mit dem sich große Dokumente bzw. Binärdaten in MTOM-basierenden WebServices über XOP (XML-binary Optimized Packaging) performant übertragen lassen.

Die MTOM-Verarbeitung für Anfragen wird nur aktiviert, wenn das Input-Dokument des Adapters den MIME-Typ text/xml oder application/xml besitzt.

Gesteuert wird die MTOM-Funktion über Processing Instructions, die dem SOAP-Request-Dokument zum Aktivieren von MTOM auf Eingangsseite hinzugefügt werden:

<?useMTOM?>: MTOM-Funktion für diesen SOAP-Request aktivieren
<?MTOM-xpath 0–n XPath-Ausdrücke ?>: Beliebig viele XPath-Ausdrücke, um die Elemente zu definieren, die Binärdaten enthalten
<?MTOM-size Größe in KB ?>: Größe der Daten in Kilobyte, ab der die Komprimierung aktiviert wird (Standard: 1 KB)

Außerdem wandelt der Adapter MTOM-basierende SOAP-Responses, die ein Webservice liefert, automatisch in Standard-SOAP-Responses um.

Eigenschaften (Properties)

Operation

Bestimmt, welche Operation der Adapter durchführt

Mögliche Werte: Call: Adapter ausführen

Parameter

wsURL	URL, an die der SOAP-Request gesendet wird, mit dem Standard-Port `80` Mögliche Werte: Beliebige Webservice-URL Abweichende Ports müssen in der URL angegeben werden.
soapAction	HTTP-Header des SOAP-Requests. Der Wert dieses Parameters ist eine URL, die die abgefragte Operation identifiziert.
login	Benutzername für eine einfache HTTP-Authentifizierung Mögliche Werte: Beliebige Zeichenkette
pwd	Passwort für eine einfache HTTP-Authentifizierung Mögliche Werte: Beliebige Zeichenkette
preemptiveAuth	Präemptive Authentifizierung (mit den Zugangsdaten aus Parameter `login` und `pwd`) für alle HTTP(S)-Aufrufe aktivieren Mögliche Werte: `Ja`: Zugangsdaten direkt (präemptiv) bei jedem HTTP(S)-Aufruf mitschicken `Nein`: Keine präemptive Authentifizierung (Standard)
pxHost	IP-Adresse oder Host-Name eines Proxy-Servers Mögliche Werte: Beliebige gültige Zeichenkette (z.B. `192.168.1.1`)
pxPort	Portnummer des Proxy-Servers Mögliche Werte: Beliebige ganze Zahl
pxLogin	Benutzername für den Proxy-Server Mögliche Werte: Beliebige Zeichenkette
pxPwd	Passwort für den Proxy-Server Mögliche Werte: Beliebige Zeichenkette
pxNTLMDomain	Windows-Domäne für eine NTLM-Authentifizierung via NTLM-Proxy Mögliche Werte: Beliebiger Domänenname
pxNTLMhost	Host (Computer-Name), von dem die Authentifizierungsanfrage ausgeht (für eine NTLM-Authentifizierung via NTLM-Proxy) Mögliche Werte: Beliebiger Hostname
pxUseNTLM	Proprietäre NTLM-Authentifizierung von Microsoft für den Proxy verwenden Mögliche Werte: `ja`: Per NTLM authentifizieren `nein`: Nicht per NTLM authentifizieren (Standard)
nTLMDomain	Windows-Domäne für eine NTLM-Server-Authentifizierung Mögliche Werte: Beliebiger Domänenname
nTLMhost	Host (Computer-Name), von dem die NTLM-Server-Authentifizierungsanfrage ausgeht Mögliche Werte: Beliebiger Hostname
useNTLM	Proprietäre NTLM-Server-Authentifizierung von Microsoft verwenden Mögliche Werte: `ja`: Per NTLM authentifizieren `nein`: Nicht per NTLM authentifizieren (Standard)
timeout	Zeitbeschränkung für den Verbindungsaufbau in Millisekunden Mögliche Werte: Beliebige ganze Zahl `0`: Keine Zeitbeschränkung
keystorePath	Kompletter Pfad zur Keystore-Datei; wenn ein Keystore angegeben wird, werden nur Zertifikate dieses Keystores akzeptiert Mögliche Werte: Beliebiger Pfad zur Keystore-Datei (nur Zertifikate dieses Keystores verwenden) `(kein Pfad)`: Alle Zertifikate akzeptieren
keystorePassword	Passwort für die Keystore-Datei Mögliche Werte: Beliebige Zeichenkette

Statuswerte

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

Input

Um einen Webservice mit MTOM aufzurufen, muss der SOAP-Request die o.g. Processing Instructions enthalten, beispielsweise:

<?useMTOM?>
<?MTOM-xpath soapenv:Envelope/soapenv:Body/ws:signVerifyRequest/ws:Service
  RequestData/ws:Document?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
 xmlns:ws="http://authentidate.de/ws">
  <soapenv:Header />
  <soapenv:Body>
    <ws:signVerifyRequest>
      <ws:ServiceRequestData>
        <ws:Document>JVBiRi0xLjMKMyAwIG9iago8PC9UeXBlIC9QYWdlCi9QYXJlbnQgM
          SAwIFIKL1Jlc291cmNlcyAyIDAgUgovQ29udGVudHMgNCAwIFI+PgplbmRvYmoKNC
          AwIG9iago8PC9GaWx0ZXIgL0ZsYXRlRGVjb2RlIC9MZW5ndGggMjEzNT4+CnN0cmV
        </ws:Document>
        <ws:DocumentName>R_1639_37480.pdf</ws:DocumentName>
        <ws:ServiceRequest>SIGN</ws:ServiceRequest>
      </ws:ServiceRequestData>
    </ws:signVerifyRequest>
  </soapenv:Body>
</soapenv:Envelope>

Hinweis:

Mehrere Processing Instructions werden immer als einzelne Elemente nacheinander aufgeführt.