On this Page:
Tagged Values
<<URLAlias>>
Name | Description | Allowed Values | |
---|---|---|---|
protocol | Transport protocol. | one of: ldap, file, ftp, ftps, sftp, gopher, http (default), https, telnet | |
method | HTTP method of the URL adapter call. Default is "POST" if no value is specified. | one of: get, post (default), read, write, put, list | |
host | Host name. Default is "localhost" if no value is specified. | a valid hostname (default: localhost) | |
port | Machine port number the service is binding to. This port number can be given at service level only. | a valid port number (default: 80) | |
path | HTTP path for the SOAP request. | ||
Advanced | |||
followRedirects | The maximum number of redirects to follow. | any positive integer or 0 | |
options | Native cURL options as listed on Setting cURL Options on the URL Adapter . Use one of the following syntax rules:
| valid cURL options, e.g. CURLOPT_TIMEOUT=20 | |
Authentication | |||
user | Username/password. | ||
Proxy | |||
proxyType | Type of the proxy | one of: HTTP , SOCKS5 | |
proxyURL | URL of the proxy server. | ||
proxyUser | Proxy user. | ||
SSL | |||
sslCAInfo | Name of the file containing additional certificates for the connection verification (e.g. additional root CAs). | ||
sslCertificateFile | Name of the file that contains the client certificate. | ||
sslCertificateType | Type of the certificate. | one of: PEM (default), DER, P12 | |
sslPrivateKeyFile | Name of the file that contains the private key. | ||
sslPrivateKeyPassword | Password for the private key. | ||
sslPrivateKeyType | Type of the private key. | one of: PEM (default), DER, ENG | |
sslVerifyHost | Whether to verify the host information form the SSL connection. | On | Verification on. |
Off | Verification off. | ||
Existence | Limit verification to the mere existence of the host. | ||
sslVerifyPeer | Whether to verify the peer information from the SSL connection. | On | Verification on. |
Off | Verification off. |
<<URLAdapter>>
Tagged Value | Type | Description | Allowed Values | |
---|---|---|---|---|
alias | Specify the URL alias the adapter should connect to. | 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 in table URL Parameter Types below. | ||
streaming | Specify a streaming method for the usage of file streaming with the URL adapter. | none | No file streaming (default). | |
fromFile | Stream to a file. | |||
toFile | Stream from a file. |
URL Adapter Parameters
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. | |
response | Blob | out | get, post, put, list, read | Contains the response content in relation to the used method. | |
streamSource | String | in | ftp, ftps, sftp, http, https | post, put | If you want to use file streaming with streaming method fromFile, supply the streaming source here. Then, content 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. |
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. | |
httpStatus | Integer | out | http, https | Contains the HTTP status code of the response. | |
httpHeaderParameter | Array of HeaderField | out | http, https | Contains the HTTP headers of the response. |
URL Parameter Types
Class | Attribute | Type | CURL Option | Description | Values/Example | |
---|---|---|---|---|---|---|
Authentication | password | String | Password needed for authentication. | |||
username | String | Username needed for authentication. | ||||
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