...
All URL adapter parameters, that are specified on the <<URLAlias>> in the component diagram, can also be supplied dynamically via action script. Find below a list of all relevant parameters of the URL adapter and their description.
| Noteinfo |
|---|
|
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. |
Tagged Values
<<URLAlias>>
| Multiexcerpt |
|---|
| MultiExcerptName | url_alias |
|---|
|
| Name | Description | Allowed Values |
|---|
| protocol | | Multiexcerpt |
|---|
| Transport protocol. |
| one of: ldap, file, ftp, ftps, sftp, gopher, http (default), https, telnet | | method | | Multiexcerpt |
|---|
| 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 | | Multiexcerpt |
|---|
| Host name. Default is "localhost" if no value is specified. |
| a valid hostname (default: localhost) | | port | | Multiexcerpt |
|---|
| 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 | | Multiexcerpt |
|---|
| HTTP path for the SOAP request. |
|
| | Advanced | | followRedirects | | Multiexcerpt |
|---|
| MultiExcerptName | followRedirects |
|---|
| The maximum number of redirects to follow. |
| any positive integer or 0 | | options | | Multiexcerpt |
|---|
| Native cURL options as listed on Setting cURL Options on the URL Adapter . Use one of the following syntax rules: - values separated by
',' in one line - values separated by
' ' in one line - list of tagged values
|
| valid cURL options, e.g. CURLOPT_TIMEOUT=20 | | Authentication | | user | Username/password. |
| | Proxy | | proxyType | | Multiexcerpt |
|---|
| MultiExcerptName | proxyType |
|---|
| Type of the proxy |
| one of: HTTP, SOCKS5
| | proxyURL | | Multiexcerpt |
|---|
| URL of the proxy server. |
|
| | proxyUser | | Multiexcerpt |
|---|
| MultiExcerptName | proxyUser |
|---|
| Proxy user. |
|
| | SSL | | sslCAInfo | | Multiexcerpt |
|---|
| MultiExcerptName | sslCAInfo |
|---|
| Name of the file containing additional certificates for the connection verification (e.g. additional root CAs). |
|
| | sslCertificateFile | | Multiexcerpt |
|---|
| MultiExcerptName | sslCertificateFile |
|---|
| Name of the file that contains the client certificate. |
|
| | sslCertificateType | | Multiexcerpt |
|---|
| MultiExcerptName | sslCertificateType |
|---|
| Type of the certificate. |
| one of: PEM (default), DER, P12
| | sslPrivateKeyFile | | Multiexcerpt |
|---|
| MultiExcerptName | sslPrivateKeyFile |
|---|
| Name of the file that contains the private key. |
|
| | sslPrivateKeyPassword | | Multiexcerpt |
|---|
| MultiExcerptName | sslPrivateKeyPassword |
|---|
| Password for the private key. |
|
| | sslPrivateKeyType | | Multiexcerpt |
|---|
| MultiExcerptName | sslPrivateKeyType |
|---|
| Type of the private key. |
|
one of: PEM (default), DER, ENG | | sslVerifyHost | | Multiexcerpt |
|---|
| MultiExcerptName | 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 | | Multiexcerpt |
|---|
| MultiExcerptName | sslVerifyPeer |
|---|
| Whether to verify the peer information from the SSL connection. |
| On | Verification on. | | Off | Verification off. | |
<<URLAdapter>>
| Multiexcerpt |
|---|
| MultiExcerptName | url_adapter |
|---|
|
| 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. | Info |
|---|
| The xUML Runtime assigns a correlation ID to each adapter call. This ID is stored in header field X-Bridge-CorrelationID. Adapter calls can be identified by this ID. Also, it is logged to the transaction log.
|
| Note |
|---|
| If you set this header manually, the new header will be send to the target URL. Nevertheless, the correlation ID logged to the transaction log will still be the one generated by the Runtime! |
|
| | 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
| Multiexcerpt |
|---|
| MultiExcerptName | url_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 |
| | Version |
|---|
| - Added in Builder 6.0.0.37
|
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 header headers of the response. | |
URL Parameter Types
| Multiexcerpt |
|---|
| MultiExcerptName | url_parameter_types |
|---|
|
| CURL OptionClass | 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 | File name 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 | File name 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 | File name Name of the file containing the client certificate. |
| | type | String | CURLOPT_SSLCERTTYPE | Type of the certificate. | PEM, DER, P12 | |