With the URL adapter, it is possible to get and post messages via the protocols listed below. The input and output of this adapter is always of type Blob to support all possible data types (e.g. binary for images, text with HTML code, XML messages, etc.).
We differ between static and dynamic requests. Static means that the whole backend information (host, path, protocol, etc.) is defined in the component diagram and is not modified when called within an action state.
A dynamic call means that the definition is kept in the component diagram, but is modified before sending the request to the host. This is sometimes required, for example, when URL parameters must be calculated or are known at runtime only. Refer to URL Adapter Reference for more information on the URL adapter parameters.
Example File (Builder project Add-ons/URL):
 | <your example path>\Add-ons\URL\uml\urlUrl.xml |
The URL adapter supports the following protocols:
| Protocol | Description | Example | ||
|---|---|---|---|---|
| ldap | Via the URL adapter, it is possible to connect an LDAP server to retrieve user information. You can also access a Microsoft Active Directory Service (ADS) if it provides an LDAP interface. An E2E example model is provided with the documentation (see example reference). | Example File (Builder project Add-ons/URL):
| ||
| ftp | Example File (Builder project Add-ons/URL):
| |||
If large amounts of data have to be transferred, the URL adapter offers the possibility of streaming the data from or into a file so avoiding to utilize large memory chunks. The Streaming FTP section explains how to do this for the ftp protocol. Applying streaming to the other protocols works analogously.
Tagged Values
Find below a list of possible tagged values for the URL adapter and tagged values that are used in the component/deployment diagram.
Default values used when an option is not explicitly set are written in bold.
Some tagged values can only be used combined with a particular protocol. See the tagged values section of the documentation of this protocol for more information on that.
| Tagged Value | Description | Values | |
|---|---|---|---|
| protocol | Transport protocol. | ldap, file, ftp, ftps, sftp, gopher, http, https, telnet | |
| method | HTTP method. | get, post, read, write, put, list | |
| port | Machine port number the service is binding to. This port number can be given at service level only. | 80 | |
| path | HTTP path for the SOAP request. | ||
| Advanced | |||
| followRedirects | Maximum number of redirects to follow. | any integer | |
| options | Native cURL options. | cURL Options | |
| Authentication | |||
| user | Username/password. | ||
| Proxy | |||
| proxyType | Type of the proxy. | HTTP, SOCKS5 | |
| proxyURL | URL of the proxy server. | ||
| proxyUser | Proxy user. | ||
| SSL | |||
| sslCAInfo | File name containing additional certificates for the connection verification (e.g. additional root CAs). | ||
| sslCertificateFile | File name containing the client certificate. | ||
| sslCertificateType | Type of the certificate. | PEM, DER, P12 | |
| sslPrivateKeyFile | File name containing the private key. | ||
| sslPrivateKeyPassword | Password for the private key. | ||
| sslPrivateKeyType | Type of the key. | PEM, DER, ENG | |
| sslVerifyHost | Whether to verify the host information form the SSL connection. | On | Verification on. |
| Off | Verification off. | ||
| sslVerifyPeer | Whether to verify the peer information from the SSL connection. | On | Verification on. |
| Off | Verification off. | ||
Overview
Content Tools