Webservice (SOAP) Connector: Sends a SOAP Request via HTTP(S) to the URL of a web service and issues the returned SOAP Response. It communicates with servers via HTTP (Hyper Text Transfer Protocol) or HTTPS (HTTP Secure).
If authentication is required, this must be SOAP-based via the SOAP header; its structure (certificate-based, token-based, etc.) must first be clarified with the remote peer. HTTP servers are also supported. For HTTP authentication, the HTTP(S) Connector must be used.
Properties
|
Operation |
Determines which operation the adapter executes Possible values:
|
Parameters
|
Repository |
Virtual repository of the adapter project |
|
protocol |
Used protocol (HTTP or HTTPS) Possible values:
|
|
host |
IP address or host name of the physical server Note: The Possible values: Any valid string without protocol handler (e. g. google.com) |
|
vHost |
Virtual host name, if it cannot be identified by the physical host within the parameter Note: The The ports can be specified, except for ports 80 (default for HTTP connections) and 443 (default for HTTPS connections). Possible values: Any valid string without protocol handler (z. B. google.com) |
|
port |
Port number of the HTTP(S) service Possible values:
|
|
path |
Path on the server, starting with a slash Possible values: Any valid path (e. g. |
|
authenticationEncoding |
Character encoding for the credentials Possible values: Specification of a character encoding, e.g. |
|
query |
Argument(s) of the HTTP(S) request Possible values: Any URL-encoded arguments without leading question marks (e. g. |
|
username |
User name for basic HTTP, digest, or NTLM authentication Possible values:
|
|
password |
Password for basic, digest, or NTLM authentication Possible values: Any valid string |
|
usePreemptiveBasicAuth |
Use preemptive authentication (using credentials from the parameters Possible values:
|
|
allowBasic |
Use HTTP(S) basic authentication Possible values:
|
|
useProxy |
Use a proxy server to connect Possible values:
|
|
proxyHost |
IP address or host name of a proxy server Possible values: Any valid string (e. g. |
|
proxyPort |
Port number of the proxy server Possible values:
|
|
proxyUsername |
User name for Basic HTTP, digest, or NTLM authentication on a proxy server Possible values:
|
|
proxyPassword |
Password of a proxy server Possible values: Any valid string |
|
proxyAllowDigest |
Use digest authentication for the proxy Possible values:
|
|
connectTimeout |
Timeout value for a socket connect in milliseconds Possible values:
|
|
socketTimeout |
Timeout value between two incoming data packages in milliseconds. This is not the maximal request time, only the maximal idle time of the connection. Possible values:
|
|
acceptAllCertificates |
Disable certificate checking Possible values:
|
|
acceptAllSslHostnames |
Disable hostname checking for certificates Possible values:
|
|
useClientCertificate |
Use client certificates to validate the request Possible values:
|
|
keystoreType |
Keystore type for storing client certificates (see http://docs.oracle.com/javase/6/docs/technotes/guides/security/StandardNames.html#KeyStore) Possible values:
|
|
keystoreURL |
Keystore URL to validate the request via client certificates Possible values: Any valid URL, e.g. |
|
keystorePassword |
Password for the keystore to validate the request via client certificates Possible values: Any valid string |
|
keyAlias |
Key alias to access a specific key within the keystore Possible values: Any valid string |
|
aliasPassword |
Corresponding password for a specific key within the keystore Possible values: Any valid string |
|
SoapAction |
HTTP header of the SOAP request. The value of this parameter is a URL that identifies the requested operation. |
|
toXml |
Output an XML document containing all headers as elements and the body content as Base64-encoded string Possible values:
|
Status values
|
|
The operation was executed successfully. |
|
|
The operation failed due to a technical error. |
SOAP Request
The SOAP Request is structured as in the following example:
<?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 Response
The SOAP Response includes the requested information in the body of the message:
<?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>