On this Page:
Tagged Values
MultiExcerpt named soap_tagged_values was not found -- Please check the page name and MultiExcerpt name used in the MultiExcerpt-Include macro
Parameters
Name | Type | Direction | Description | Documentation |
---|---|---|---|---|
<any> | Array of SOAPHeaderElement | in | This parameter contains the URL that will be accessed by the adapter. The URL contains protocol, port and path. | Accessing the SOAP Headers |
urlParameter | URLMessage | in | Use this parameter to supply URL parameters to the SOAP call, e.g to set cURL options. | Providing the SOAP Adapter with URL Parameter |
<any> | HTTPTransport | out | Use this parameter to supply the content to be used by the listed methods. | Accessing HTTP Headers of a SOAP Call |
Parameter Types
SOAPHeaderElement
Class | Attribute | Type | SOAP Attribute | Description | Example XML Fragment |
---|---|---|---|---|---|
SOAPHeaderElement | encoding | String | encodingStyle | Specifies the encoding style used to construct the message. | env:encodingStyle="http://www.w3.org/2003/05/soap-encoding" |
header | Blob | - | The header holds the actual header data of base type Blob. | ||
mustunderstand | Boolean | mustUnderstand | This attribute says whether or not the recipient (indicated by the role attribute) is required to process a header entry. | env:mustUnderstand="true" | |
name | String | - | Holds the name of a header block. | ||
namespace | String | - | Defines the namespace to be assigned to the header element serialized with use="encoded". | ||
relay | Boolean | relay | If relay is set to true, it indicates that the SOAP header block must not be processed by any node that is targeted by the header block, but must only be passed on to the next targeted node. | env:relay="true" | |
role | String | role | The role is optional and defines the recipient of the header message. | env:role="http://example.com/Login" |
URLMessage
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. |
HTTPTransport
Class | Attribute | Type | Description |
---|---|---|---|
HTTPTransport | headers | Array of HeaderField | Header information as array of name/value pairs (see HeaderField below). |
statusCode | Integer | HTTP status code of the SOAP request. |
URLMessage and HTTPTransport 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. | CURLOPT_CONNECTTIMEOUT | ||
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). | |
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. | ||
type | String | CURLOPT_SSLCERTTYPE | Type of the certificate. | PEM, DER, P12 |
Overview
Content Tools