Providing the SOAP Adapter with URL Parameter

Using the SOAP adapter, it is possible to provide the URL parameter to e.g set cURL options for the SOAP call. In contrast to the URL adapter, where you need to provide every single parameter (see Setting cURL Options on the URL Adapter and URL Adapter Reference), you can use the parameter urlParameter of type URLMessage. URLMessage is a class containing all URL parameters.

Note, that the attributes content and commands of URLMessage are not implemented for the SOAP adapter, but only for the URL adapter. All other attributes have the same semantic as described for the URL adapter (see URL Adapter Reference).

Example File (Builder project Add-ons/SOAP):

<your example path>\Add-ons\SOAP\uml\soapUseUrlParameter.xml

Figure: Providing the URL Parameter to a SOAP Call

URLMessage Parameter

Name	Type	Direction	Restrictions		Description
Name	Type	Direction	to listed protocol only	to listed method only	Description
url	string	in			This parameter contains the URL that will be accessed by the adapter. The URL contains protocol, port and path.
content	Blob	in		post, put, write	Use this parameter to supply the content to be used by the listed methods.
headerParameters	Array of HeaderField	in	http, https		Use this parameter to supply additional header information for the URL adapter call in the form of name and value pairs.
method	String	in			This parameter provides the method of the URL adapter call.
authentication	Authentication	in	ldap, ftp, ftps, sftp, http, https		This parameter provides an object of type Authentication containing the user and the password.
proxy	Proxy	in	ldap, ftp, ftps, sftp, http, https		Use this parameter to supply necessary proxy information.
followRedirects	Integer	in	http, https		Specify here the maximum number of redirects to follow.
ssl	SSL	in	https, ftps		Use this parameter to supply SSL information.
commands	Array of String	in	ftp, ftps		Use this parameter to specify ftp commands. All commands are executed after executing the ftp method. For a list of available ftp commands see RFC 959.
options	Array of Option	in	ldap, ftp, ftps, sftp, http, https		Use this parameter to specify cURL options for the URL adapter call.

URL Parameter Types

Class	Attribute	Type	CURL Option	Description	Values/Example
Authentication	password	String		Password needed for authentication.
Authentication	username	String		Username needed for authentication.
Entry	key	String		Key of the map entry.
Entry	value	Array of Any		List of values of the map entry. The dynamic type for httpHeaderMap is String.
HeaderField	name	String		Name of the header field.
HeaderField	value	String		Value of the header field.
Option	name	String		Native cURL option.	`CURLOPT_CONNECTTIMEOUT`
Option	value	String		Value of the cURL option.	`10`
Proxy	authentication	Authentication	CURLOPT_PROXYUSERPWD	Proxy user.
	type	String	CURLOPT_PROXYTYPE	Type of the proxy.	HTTP, SOCKS5
	url	String	CURLOPT_PROXY	URL of the proxy server.
SSL	caInfo	String	CURLOPT_CAINFO	Name of the file containing additional certificates for the connection verification (e.g. additional root CAs).
	certificate	Certificate		Client certificate
	key	Key		Private key of client certificate
	verifyHost	String	CURLOPT_SSL_VERIFYHOST	Whether to verify the host information form the SSL connection.	On	Verification on (default).
					Off	Verification off.
					Existence	Limit verification to the mere existence of the host.
	verifyPeer	String	CURLOPT_SSL_VERIFYPEER	Whether to verify the peer information from the SSL connection.	On	Verification on (default).
	verifyPeer	String	CURLOPT_SSL_VERIFYPEER		Off	Verification off.
Key	file	String	CURLOPT_SSLKEY	Name of the file containing the private key.
	password	String	CURLOPT_KEYPASSWD	Password for the private key.
	type	String	CURLOPT_SSLKEYTYPE	Type of the key.	PEM, DER, ENG
Certificate	file	String	CURLOPT_SSLCERT	Name of the file containing the client certificate.
Certificate	type	String	CURLOPT_SSLCERTTYPE	Type of the certificate.	PEM, DER, P12