URL Adapter Reference

Name

Specify a name for the alias.

any string

protocol

Transport protocol.

one of: ldap, ldaps, file, ftp, ftps, sftp, gopher, http (default), https, telnet

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.

host

Host name. Default is "localhost" if no value is specified.

a valid hostname (default: localhost)

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, patch, head, options, delete

Advanced

user

Username/password.

followRedirects

Specify here the maximum number of redirects to follow. Default value is 0 (no redirects).

any positive integer or 0

ignoreHttpErrors

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.

true

Ignore HTTP error codes > 300.

false

Do not ignore HTTP errors (default).

options

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

requestHttpHeaderRoles

In the context of HTTP based adapters (URL, REST), enable automatic header generation for the listed headers. These definitions overwrite the default behavior, and X-Transaction-Id, X-Request-Id, X-Sender-Host and/or X-Sender-Service will be substituted by this definition.

In the context of HTTP based adapters (URL, REST), enable automatic header generation for the listed headers. These definitions overwrite the default behavior, and X-Transaction-Id, X-Request-Id, X-Sender-Host and/or X-Sender-Service will be substituted by this definition.
Refer to HTTP Header Support for more details on header roles.

client_host

Provide the client host in a header <http header name> instead of X-Sender-Host.

client_service

Provide the client service in a header <http header name> instead of X-Sender-Service.

correlation_id

Provide the correlation ID in a header <http header name> instead of X-Request-Id.

transaction_id

Provide the transaction ID in a header <http header name> instead of X-Transaction-Id.

passthrough

Pass a present header <http header name> to the called service.

passthrough=<request header name>

Pass an incoming header <request header name> to the called service under the name of <http header name>.
This is equivalent to renaming a header.

digestAlgorithm

Generates a HTTP digest header using the specified algorithm. When applied, a digest header is generated using the specified algorithm, and sent with the request. The generated header conforms with RFC3230 and RFC5843.

Only one value is supported (no multi-value header).

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.

Proxy

proxyURL

URL of the proxy server.

proxyUser

Proxy user.

proxyType

Type of the proxy.

one of: HTTP, SOCKS5

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.

sslPrivateKeyFile

Name of the file that contains the private key.

sslPrivateKeyPassword

Password for the private key.

sslCertificateType

Type of the certificate.

one of: PEM (default), DER

sslVerifyHost

Whether to verify the host information form the SSL connection.

On

Verification on.

Off

Verification off (default).

Existence

Limit verification to the mere existence of the host.

sslVerifyPeer

Whether to verify the peer information from the SSL connection.

On

Verification on (default).

Off

Verification off.

sslPrivateKeyType

Type of the private key.

one of: PEM (default), DER

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 HeaderField below).

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.

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!

digestAlgorithm

Generates a HTTP digest header using the specified algorithm. When applied, a digest header is generated using the specified algorithm, and sent with the request. The generated header conforms with RFC3230 and RFC5843.

Only one value is supported (no multi-value header).

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.

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

Specify here the maximum number of redirects to follow. Default value is 0 (no redirects).

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

HTTP method of the URL adapter call. Default is "POST" if no value is specified.

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.

httpHeaderMap

Map of Entry

out

Header information as a map. The map contains arrays of header value strings whereas the header name is the key of the map.

• Header names are lowercase and treated case insensitive.

• Multiple headers with the same name are treated as arrays.

Refer to HTTP Header Support for more information on the standard xUML HTTP headers.

httpStatus

Integer

out

http, https

Contains the HTTP status code of the response.

response

Blob

out

get, post, put, list, read

Contains the response content in relation to the used method.

parseUrl()

urlString of type String

in

object of type URL

Parses an URL given in a String variable into a data structure.
For details see parseUrl() Function.

create aUrlobject;
set aUrlObject = aUrlString.parseUrl();

composeUrl()

urlStructure of type URL

in

String

Builds a String containing a URL from an object of type URL.
For details see composeUrl() Function.

aUrlString = composeUrl(aUrlObject);

password

String

Password needed for authentication.

username

String

Username needed for authentication.

file

String

CURLOPT_SSLCERT

Name of the file containing the client certificate.

type

String

CURLOPT_SSLCERTTYPE

Type of the certificate.

PEM, DER

key

String

The header name is the key of the map.

value

Any

Value of the header field.

name

String

Name of the header field.

value

String

Value of the header field.

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

String

Native cURL option.

CURLOPT_CONNECTTIMEOUT

value

String

Value of the cURL option.

10

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.

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.

scheme

String

URL scheme.

https:

user

String

User.

password

String

Password.

host

String

Name of the host.

acme.com

port

Integer

Machine port number the service is binding to. This port number can be given at service level only.

8080

path

String

HTTP path for the SOAP request.

resources/logo.png

query

String

Query parameters.

?download=true

fragment

String

URL fragment.

#anAnchor