Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space WBRIDGE and version 7.4.1

...

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
iconfalse

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
MultiExcerptNameurl_alias
NameDescriptionAllowed Values
protocol
Multiexcerpt
MultiExcerptNameprotocol

Transport protocol.



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

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
MultiExcerptNamehost

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

a valid hostname (default: localhost)
port
Multiexcerpt
MultiExcerptNameport

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
MultiExcerptNamepath

HTTP path for the SOAP request.




Advanced
followRedirects
Multiexcerpt
MultiExcerptNamefollowRedirects

The maximum number of redirects to follow.

any positive integer or 0
options
Multiexcerpt
MultiExcerptNameoptions

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
userUsername/password.
Proxy
proxyType
Multiexcerpt
MultiExcerptNameproxyType

Type of the proxy

one of: HTTP, SOCKS5

proxyURL
Multiexcerpt
MultiExcerptNameproxyURL

URL of the proxy server.





proxyUser
Multiexcerpt
MultiExcerptNameproxyUser

Proxy user.



SSL
sslCAInfo
Multiexcerpt
MultiExcerptNamesslCAInfo

Name of the file containing additional certificates for the connection verification (e.g. additional root CAs).



sslCertificateFile
Multiexcerpt
MultiExcerptNamesslCertificateFile

Name of the file that contains the client certificate.



sslCertificateType
Multiexcerpt
MultiExcerptNamesslCertificateType

Type of the certificate.

one of: PEM (default), DER, P12

sslPrivateKeyFile
Multiexcerpt
MultiExcerptNamesslPrivateKeyFile

Name of the file that contains the private key.



sslPrivateKeyPassword
Multiexcerpt
MultiExcerptNamesslPrivateKeyPassword

Password for the private key.



sslPrivateKeyType
Multiexcerpt
MultiExcerptNamesslPrivateKeyType

Type of the private key.


one of: PEM (default), DER, ENG
sslVerifyHost
Multiexcerpt
MultiExcerptNamesslVerifyHost

Whether to verify the host information form the SSL connection.

OnVerification on.
OffVerification off.
ExistenceLimit verification to the mere existence of the host.
sslVerifyPeer
Multiexcerpt
MultiExcerptNamesslVerifyPeer

Whether to verify the peer information from the SSL connection.

OnVerification on.
OffVerification off.

<<URLAdapter>>

Multiexcerpt
MultiExcerptNameurl_adapter
Tagged ValueTypeDescriptionAllowed Values

alias
Specify the URL alias the adapter should connect to.any valid URL alias
headerParametersArray 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
iconfalse

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
iconfalse

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.noneNo file streaming (default).
fromFileStream to a file.
toFileStream from a file.

URL Adapter Parameters

Multiexcerpt
MultiExcerptNameurl_parameters
NameTypeDirectionRestrictionsDescription
to listed protocol onlyto listed method only
urlstringin

This parameter contains the URL that will be accessed by the adapter. The URL contains protocol, port and path.
contentBlobin
post, put, writeUse this parameter to supply the content to be used by the listed methods.
headerParametersArray of HeaderFieldinhttp, https
Use this parameter to supply additional header information for the URL adapter call in the form of name and value pairs.
methodStringin

This parameter provides the method of the URL adapter call.
authenticationAuthenticationinldap, ftp, ftps, sftp, http, https
This parameter provides an object of type Authentication containing the user and the password.
proxyProxyinldap, ftp, ftps, sftp, http, https
Use this parameter to supply necessary proxy information.
followRedirectsIntegerinhttp, https
Specify here the maximum number of redirects to follow.
sslSSLinhttps, ftps
Use this parameter to supply SSL information.
commandsArray of Stringinftp, 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.

optionsArray of Optioninldap, ftp, ftps, sftp, http, https
Use this parameter to specify cURL options for the URL adapter call.
responseBlobout
get, post, put, list, readContains the response content in relation to the used method.
streamSourceStringinftp, ftps, sftp, http, httpspost, putIf you want to use file streaming with streaming method fromFile, supply the streaming source here. Then, content is not used.
streamTargetStringinftp, ftps, sftp, http, httpsget, post, put, listIf you want to use file streaming with streaming method toFile, supply the streaming target here. Then, response is not used.
ignoreHTTPErrorsBooleaninhttp, https
Version
SingleLinefalse
  • 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.

httpStatusIntegerouthttp, https
Contains the HTTP status code of the response.
httpHeaderParameterArray of HeaderFieldouthttp, https
Contains the HTTP header headers of the response.

URL Parameter Types

Multiexcerpt
MultiExcerptNameurl_parameter_types
CURL OptionClassAttributeTypeCURL OptionDescriptionValues/Example
AuthenticationpasswordString
Password needed for authentication.
usernameString
Username needed for authentication.
HeaderFieldnameString
Name of the header field.
valueString
Value of the header field.
OptionnameString
Native cURL option.CURLOPT_CONNECTTIMEOUT
valueString
Value of the cURL option.10
ProxyauthenticationAuthenticationCURLOPT_PROXYUSERPWDProxy user.
typeStringCURLOPT_PROXYTYPEType of the proxy.HTTP, SOCKS5
urlStringCURLOPT_PROXYURL of the proxy server.
SSLcaInfoStringCURLOPT_CAINFOFile name Name of the file containing additional certificates for the connection verification (e.g. additional root CAs).
certificateCertificate
Client certificate
keyKey
Private key of client certificate
verifyHostStringCURLOPT_SSL_VERIFYHOST

Whether to verify the host information form the SSL connection.

OnVerification on (default).
OffVerification off.
ExistenceLimit verification to the mere existence of the host.
verifyPeerStringCURLOPT_SSL_VERIFYPEERWhether to verify the peer information from the SSL connection.OnVerification on (default).
OffVerification off.
KeyfileStringCURLOPT_SSLKEYFile name Name of the file containing the private key.
passwordStringCURLOPT_KEYPASSWDPassword for the private key.
typeStringCURLOPT_SSLKEYTYPEType of the key.PEM, DER, ENG
CertificatefileStringCURLOPT_SSLCERTFile name Name of the file containing the client certificate.
typeStringCURLOPT_SSLCERTTYPEType of the certificate.PEM, DER, P12