SOAP Connector 8.0.0

Webservice (SOAP) Connector:SOAP RequestSOAP ResponseIt 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:

Call SOAP: Execute adapter

Parameters

Adapter	Main adapter class (do not change!) Possible values: de.softproject.integration.nativeadapter.NativeAdapter: Main class (Default)
Repository	Virtual repository of the adapter project
protocol	Used protocol (HTTP or HTTPS) Possible values: `http`: Use HTTP (no encryption) (Default) `https`: Use HTTPS (SSL-encrypted)
host	IP address or host name of the physical server Note: The `host` parameter adds an `HTTP header` named `host`. 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 `host` Note: The `vHost` parameter overrides the value for the `HTTP header` named `host`, see `host` parameter. 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: Any integer number (e. g. `8080)` `-1`: Use port 80 for HTTP and port 443 for HTTPS (Default)
path	Path on the server, starting with a slash Possible values: Any valid path (e. g. `/intl/en_ALL/images/logo.gif`)
authenticationEncoding	Character encoding for the credentials Possible values: Specification of a character encoding, e.g. `UTF-8` oder `ISO-8859-1` With the help of this parameter, umlauts can also be used in the credentials.
query	Argument(s) of the HTTP(S) request Possible values: Any URL-encoded arguments without leading question marks (e. g. `Arg1=V1&Arg2=V2`)
username	User name for basic HTTP, digest, or NTLM authentication Possible values: For HTTP Basic authentication: the user name For HTTP Basic authentication on a Windows domain: a string following the pattern `<Domain>\<User name>` (e. g. `MyDomain\MyUserName`) For NTLM authentication on a Windows domain: only the user name (and specify the domain in parameter `ntlmDomain`) (e. g. `MyUsername`)
password	Password for basic, digest, or NTLM authentication Possible values: Any valid string
usePreemptiveBasicAuth	Use preemptive authentication (using credentials from the parameters `username` and `password`) for all HTTP(S) requests (only for basic authentication, see parameter `allowBasic`) Possible values: `true`: Send credentials directly (preemptively) with each HTTP(S) request `false`: No preemptive authentication (Default)
allowBasic	Use HTTP(S) basic authentication Possible values: `true`: Use basic authentication `false`: Do not use basic authentication (Default)
useProxy	Use a proxy server to connect Possible values: `true`: Connect via the proxy server, specified within the parameter `proxyHost` `false`: No proxy server (Default)
proxyHost	IP address or host name of a proxy server Possible values: Any valid string (e. g. `192.168.1.1`)
proxyPort	Port number of the proxy server Possible values: Any integer number `-1`: Use default port (Default)
proxyUsername	User name for Basic HTTP, digest, or NTLM authentication on a proxy server Possible values: For HTTP Basic authentication: the user name For HTTP Basic authentication on a Windows domain: a string following the pattern `<Domain>\<User name>` (e. g. `MyDomain\MyUserName`) For NTLM authentication on a Windows domain: only the user name (and specify the domain in parameter `ntlmDomain`) (e. g. `MyUsername`)
proxyPassword	Password of a proxy server Possible values: Any valid string
proxyAllowDigest	Use digest authentication for the proxy Possible values: `true`: Authenticate proxy with digest `false`: Do not authenticate proxy with digest (Default)
connectTimeout	Timeout value for a socket connect in milliseconds Possible values: `>0`: Timeout value in milliseconds `<=0`: No timeout (default)
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: `>0`: Timeout value in milliseconds `<=0`: No timeout (default)
acceptAllCertificates	Disable certificate checking Possible values: `any string`: Certificates are checked on confidence (default) `Yes, I want to disable security by accepting untrusted certificates.`: Certificate check is disabled Please note: The exact string must be entered here!
acceptAllSslHostnames	Disable hostname checking for certificates Possible values: `any string`: Hostname must correspond to the certificate (default) `Yes, I want to disable security by accepting non-matching hostnames.`: Hostname checking is disabled Please note: The exact string must be entered here!
useClientCertificate	Use client certificates to validate the request Possible values: `true`: Use client certificates to validate the request `false`: Do not use client certificates to validate the request (default)
keystoreType	Keystore type for storing client certificates (see http://docs.oracle.com/javase/6/docs/technotes/guides/security/StandardNames.html#KeyStore) Possible values: `jceks`: Use proprietary keystore implementation by SunJCE `jks`: Use proprietary keystore implementation by SUN `pkcs12`: Use keystore transfer format PKCS12
keystoreURL	Keystore URL to validate the request via client certificates Possible values: Any valid URL, e.g. `file:/C:/Folder/ExampleKeystore`
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: `true`: Output an XML document `false`: Output the unmodified response of the server (Default)

Status values

`1`	The operation was executed successfully.
`-1`	The operation failed due to a technical error.

SOAP Request

The SOAP Request is structured as in the following example:

HTML/XML

<?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:

HTML/XML

<?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>