Versions Compared

Old Version 7

changes.mady.by.user Kirstin Seidel-Gebert

Saved on

compared with

New Version 8

changes.mady.by.user Kirstin Seidel-Gebert

Saved on

Key

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

...

port digestAlgorithm digestAlgorithmone of: HTTP, SOCKS5
proxyURLone of: PEM (default), DER, P12
sslPrivateKeyFile
Multiexcerpt
MultiExcerptNameurl_alias
NameDescriptionAllowed Values / Examples
Protocol
(protocol)
Multiexcerpt
MultiExcerptNameprotocol

Transport protocol.



one of: ldap, file, ftp, ftps, sftp, gopher, http (default), https, telnetmethod
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
(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
(path)
Multiexcerpt
MultiExcerptNamepath

HTTP path for the SOAP request.


Host
(host)
Multiexcerpt
MultiExcerptName
host

Builder 7.12.0 Runtime 2021.1 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.

Info

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

NoneNo header generated.

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-512Generate header using SHA-512 algorithm.
Advanced

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

a valid hostname (default: localhost)
Method
(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
Advanced
Follow Redirects
(followRedirects)followRedirects
Multiexcerpt
MultiExcerptNamefollowRedirects

The maximum number of redirects to follow.

any positive integer or 0
Ignore Http Errors
(ignoreHttpErrors)
Multiexcerpt
MultiExcerptNameignoreHttpErrors

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.

trueIgnore HTTP error codes > 300.
falseDo not ignore HTTP errors (default).
Options
(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
Request Http Header Roles
(requestHttpHeaderRoles)

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamerequest_http_header_roles
PageWithExcerptINTERNAL:_bridge_excerpts

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamerequest_http_header_roles_adapter
PageWithExcerptINTERNAL:_bridge_excerpts

client_hostProvide the client host in a header <http header name> instead of X-Sender-Host.
client_serviceProvide the client service in a header <http header name> instead of X-Sender-Service.
correlation_idProvide the correlation ID in a header <http header name> instead of X-Request-Id.
transaction_idProvide the transaction ID in a header <http header name> instead of X-Transaction-Id.
passthroughPass 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.
Digest Algorithm
(digestAlgorithm)





Multiexcerpt
MultiExcerptNamedigestAlgorithm

Builder 7.12.0 Runtime 2021.1 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.

Info

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






NoneNo header generated.

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-512Generate header using SHA-512 algorithm.
Authentication
User
(user)		Username/password.
ProxyproxyType
Multiexcerpt
MultiExcerptNameproxyType

Type of the proxy

Proxy URL
(proxyURL)
Multiexcerpt
MultiExcerptNameproxyURL

URL of the proxy server.


Proxy User
(proxyUser)
Multiexcerpt
MultiExcerptNameproxyUser

Proxy user.


Proxy Type
(proxyType)
Multiexcerpt
MultiExcerptNameproxyType

Type of the proxy

one of: HTTP, SOCKS5

SSL
Ssl CA Info
(sslCAInfo)
Multiexcerpt
MultiExcerptNamesslCAInfo

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



Ssl Certificate File
(sslCertificateFile)
Multiexcerpt
MultiExcerptNamesslCertificateFile

Name of the file that contains the client certificate.

sslCertificateType
Multiexcerpt
MultiExcerptNamesslCertificateType

Type of the certificate.



Ssl Private Key File
(sslPrivateKeyFile)
Multiexcerpt
MultiExcerptNamesslPrivateKeyFile

Name of the file that contains the private key.


Ssl Private Key Password
(sslPrivateKeyPassword)
Multiexcerpt
MultiExcerptNamesslPrivateKeyPassword

Password for the private key.


Ssl Certificate Type
(sslCertificateType)sslPrivateKeyType
Multiexcerpt
MultiExcerptNamesslPrivateKeyTypesslCertificateType

Type of the private keycertificate.

one of: PEM (default), DER, ENGP12

Ssl Verify Host
(sslVerifyHost)
Multiexcerpt
MultiExcerptNamesslVerifyHost

Whether to verify the host information form the SSL connection.

OnVerification on (default).
OffVerification off.
ExistenceLimit verification to the mere existence of the host.
Ssl Verify Peer
(sslVerifyPeer)
Multiexcerpt
MultiExcerptNamesslVerifyPeer

Whether to verify the peer information from the SSL connection.

OnVerification on (default).
OffVerification off.
Ssl Private Key Type
(sslPrivateKeyType)
Multiexcerpt
MultiExcerptNamesslPrivateKeyType

Type of the private key.

one of: PEM (default), DER, ENG

<<URLAdapter>>

Multiexcerpt
MultiExcerptNameurl_adapter
Tagged ValueTypeDescriptionAllowed Values

alias
Specify the URL alias the adapter should connect to.any valid URL alias
digestAlgorithm
Multiexcerpt
MultiExcerptNamedigestAlgorithm

Builder 7.12.0 Runtime 2021.1 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.

Info

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

NoneNo header generated.

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-512Generate header using SHA-512 algorithm.
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.

...

Multiexcerpt
MultiExcerptNameurl_parameters

Incoming Parameters

Multiexcerpt
MultiExcerptNameurl_parameters_incoming

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.
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

Multiexcerpt include

SingleLine

MultiExcerptName

false
  • Added in Builder 6.0.0.37
ignoreHttpErrors
PageWithExcerptURL
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.

Outgoing Parameters

Multiexcerpt
MultiExcerptNameurl_parameters_outgoing
NameTypeDirectionRestrictionsDescription
to listed protocol onlyto listed method only
responseBlobout
get, post, put, list, readContains the response content in relation to the used method.
httpStatusIntegerouthttp, https
Contains the HTTP status code of the response.
httpHeaderParameterArray of HeaderFieldouthttp, https
Noteinfo
iconfalse

DeprecatedThis attribute is deprecated as of Runtime 2020.11. Please use httpHeaderMap (see below) for new implementations as its implementation complies to the HTTP specification.

Contains the HTTP headers of the response.

httpHeaderMapMap of EntryoutMap of Entry
Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamehttpHeaderMap
PageWithExcerptINTERNAL:_bridge_excerpts

...