All URL adapter parameters, that are specified on the URL alias, can also be supplied dynamically via action script. Find below a list of all relevant parameters of the URL adapter and their description.
With the URL adapter, it is possible to get and put messages via file transfer protocols: FTP, FTPS and SFTP. These protocols often get confused and mixed up due to the similarity in function and names. Please refer to Using the URL Adapter with the FTP Protocol and Related Protocols for a distinction and more information on the usage with the URL adapter. |
|
The Runtime uses Transfer-encoding: chunked for POST requests. You can override this behavior by setting
|
Attribute | Type | Description | Allowed Values | |||
---|---|---|---|---|---|---|
alias | Specify the URL alias the adapter should use to establish the connection. | any valid URL alias | ||||
headerParameters | Array of HeaderField | Supply additional header information for the URL adapter call in form of name and value pairs (see type Header Field below).
| ||||
digestAlgorithm | None | No header generated (default). | ||||
MD5 | Generate header using MD5 algorithm. | |||||
SHA | Generate header using SHA algorithm. | |||||
SHA-1 | Generate header using SHA-1 algorithm. | |||||
SHA-256 | Generate header using SHA-256 algorithm. | |||||
SHA-512 | Generate header using SHA-512 algorithm. |
In general, three adapter operations can be used: request, streamFromFile and streamToFile. Exceptions are ldap and ldaps where streamToFile is not available. Depending on the protocol used, the parameters of the operation differ slightly.
Attribute | Type | Direction | Restrictions | Description | |
---|---|---|---|---|---|
to listed protocol only | to listed method only | ||||
authentication | Authentication | in | ldap, ftp, ftps, sftp, http, https | This parameter provides an object of type Authentication containing the user and the password. | |
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. | |
content | Blob | in | post, put, write | Use this parameter to supply the content to be used by the listed method. | |
followRedirects | Integer | in | http, https | Specifies the maximum number of redirects to follow. | |
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. | |
ignoreHTTPErrors | Boolean | in | http, https | If true, HTTP error codes > 300 will not cause an exception in the model. This implies, that the response body is accessible even if HTTP errors occur. The default value is false. | |
method | String | in | This parameter provides the method of the URL adapter call. | ||
options | Array of Option | in | ldap, ftp, ftps, sftp, http, https | Use this parameter to specify cURL options for the URL adapter call. | |
proxy | Proxy | in | ldap, ftp, ftps, sftp, http, https | Use this parameter to supply necessary proxy information. | |
ssl | SSL | in | https, ftps | Use this parameter to supply SSL information. | |
streamSource | String | in | ftp, ftps, sftp, http, https | post, put | If you want to use file streaming with streaming method toFile, supply the streaming target here. Then, response is not used. |
streamTarget | String | in | ftp, ftps, sftp, http, https | get, post, put, list | If you want to use file streaming with streaming method toFile, supply the streaming target here. Then, response is not used. |
url | String | in | This parameter contains the URL that will be accessed by the adapter. The URL contains protocol, port and path. |
|
Function | Parameter | Direction | Return Value | Description | Example |
---|---|---|---|---|---|
parseUrl() | urlString of type String | in | object of type URL | Parses an URL given in a String variable into a data structure. |
|
composeUrl() | urlStructure of type URL | in | String | Builds a String containing a URL from an object of type URL. For details see composeUrl. |
|
Name | Type | Description |
---|---|---|
password | String | Password needed for authentication. |
username | String | Username needed for authentication. |
Name | Type | CURL Option | Description | Allowed Values / Examples |
---|---|---|---|---|
file | String | CURLOPT_SSLCERT | Name of the file containing the client certificate. | |
type | String | CURLOPT_SSLCERTTYPE | Type of the certificate. | PEM, DER |
Name | Type | Description |
---|---|---|
key | String | The header name is the key of the map. |
value | Any | Value of the header field. |
Name | Type | Description |
---|---|---|
name | String | Name of the header field. |
value | String | Value of the header field. |
Name | Type | CURL Option | Description | Allowed Values / Examples |
---|---|---|---|---|
file | String | CURLOPT_SSLKEY | Name of the file containing the private key. | |
type | String | CURLOPT_SSLKEYTYPE | Type of the key. | PEM, DER |
password | String | CURLOPT_KEYPASSWD | Password for the private key. |
Name | Type | Description | Allowed Values / Examples |
---|---|---|---|
name | String | Native cURL option. | CURLOPT_CONNECTTIMEOUT |
value | String | Value of the cURL option. | 10 |
Name | Type | CURL Option | Description | Allowed Values / Examples |
---|---|---|---|---|
url | String | CURLOPT_PROXY | URL of the proxy server. | |
type | String | CURLOPT_PROXYTYPE | Type of the proxy. | HTTP, SOCKS5 |
authentication | Authentication | CURLOPT_PROXYUSERPWD | Proxy user. |
Name | Type | CURL Option | Description | Allowed Values / Examples | |
---|---|---|---|---|---|
verifyPeer | String | CURLOPT_SSL_VERIFYPEER | Whether to verify the peer information from the SSL connection. | On | Verification on (default). |
Off | Verification off. | ||||
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. | ||||
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. |
Name | Type | Description | Allowed Values / Examples |
---|---|---|---|
scheme | String | URL scheme. | https: |
user | String | User. | |
password | String | Password. | |
host | String | Name of the host. | acme.com |
port | Integer | Port number. | 8080 |
path | String | Path. | resources/logo.png |
query | String | Query parameters. |
|
fragment | String | URL fragment. | #anAnchor |