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): SOAP.zip
<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 |
|
|---|---|---|---|---|---|
|
to listed protocol only |
to listed method only |
||||
|
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. |
|
|
|
username |
String |
|
Username needed for authentication. |
|
||
|
Entry |
key |
String |
|
Key of the map 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. |
|
|
|
value |
String |
|
Value of the header field. |
|
||
|
Option |
name |
String |
|
Native cURL option. |
|
|
|
value |
String |
|
Value of the cURL option. |
|
||
|
Proxy |
authentication |
Authentication |
Proxy user. |
|
||
|
type |
String |
Type of the proxy. |
HTTP, SOCKS5 |
|||
|
url |
String |
URL of the proxy server. |
|
|||
|
SSL |
caInfo |
String |
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 |
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 |
Whether to verify the peer information from the SSL connection. |
On |
Verification on (default). |
||
|
Off |
Verification off. |
|||||
|
Key |
file |
String |
Name of the file containing the private key. |
|
||
|
password |
String |
Password for the private key. |
|
|||
|
type |
String |
Type of the key. |
PEM, DER, ENG |
|||
|
Certificate |
file |
String |
Name of the file containing the client certificate. |
|
||
|
type |
String |
Type of the certificate. |
PEM, DER, P12 |
|||