The URL adapter uses cURL. In some cases you might want to set cURL options on an URL adapter request, e.g. to specify a timeout. You can do that by adding these cURL options on the URL alias to the options attribute. To specify multiple cURL options, list them separated by ',' (comma) or ' ' (blank). If an option allows for multiple values, you can concatenate them by using the '|' (pipe) operator.
Examples:
CURLOPT_CONNECTTIMEOUT=60(see note below for a hint regarding this option)CURLOPT_CONNECTTIMEOUT=60, E2E_FORBID_REUSE=trueCURLOPT_CONNECTTIMEOUT=60 E2E_FORBID_REUSE=trueCURLOPT_HTTPAUTH=CURLAUTH_NTLM|CURLAUTH_NEGOTIATE, E2E_FORBID_REUSE=true
Setting cURL Options dynamically
Alternatively, it is possible to provide the cURL options dynamically.
The options parameter is an array of Base Components.Add Ons.Option, describing a name/value pair. Set the cURL option you want to provide to attribute name and the value to attribute value.
Then, provide the options array to parameter options of the URL adapter as shown below.
Persisted variable curlOptions is an array of Option. It contains the cURL options as name/value pairs. The execution diagram provides this variable to the parameter option of the URL adapter call (request).
The contents of curlOptions need to be prepared before in a dedicated operation, e.g. a mapping diagram.
The following options - listed in alphabetical order - are currently supported (see the cURL documentation for more details). All cURL data types can be set by using xUML Base Type String : In seconds (see cURL documentation). CURLOPT_SERVER_RESPONSE_TIMEOUTScheer PAS cURL Options
Option Data Type Remarks E2E_FORBID_REUSEBoolean If E2E_FORBID_REUSE is true for a URL adapter call, then all curl connections are closed after the request.Native cURL Options
Legend: 
Option is recognized and forwarded to cURL 
Option is recognized and forwarded to cURL, but may overwrite built-in URL adapter functionality 
Option is not supported and not forwarded to cURLcURL Data Types
cURL Data Type xUML Base Type Comment Array(String) Array of Strings You must use a cast() to use this type, because the URL option value is of type String. Bitmask String It is a string containing a string of cURL options separated by the pipe character ("|"). Blob n/a Is not supported. Boolean String You can use false or 0 for false and true or 1 for true.Callback n/a Is not supported. Constant String Use the defined strings from cURL. For example, for the option CURLOPT_FTP_FILEMETHOD you can use CURLFTPMETHOD_MULTICWD, CURLFTPMETHOD_NOCWD or CURLFTPMETHOD_SINGLECWD. The xUML Runtime will convert the strings to numbers.FileHandle n/a Is not supported. Integer String String will be converted to a number. String String List of Supported Options
Option Data Type Supported Supported cURL Constants / Remarks CURLOPT_ACCEPT_ENCODINGString CURLOPT_ACCEPTTIMEOUT_MSInteger CURLOPT_APPENDString CURLOPT_AUTOREFERERBoolean CURLOPT_AWS_SIGV4String CURLOPT_BUFFERSIZEInteger CURLOPT_CAINFOString CURLOPT_CAPATHString CURLOPT_CA_CACHE_TIMEOUTInteger In seconds (see cURL documentation). CURLOPT_CONNECTTIMEOUTInteger CURLOPT_CONNECT_ONLYBoolean CURLOPT_CRLFBoolean CURLOPT_CRLFILEString CURLOPT_CONV_FROM_NETWORK_FUNCTION Callback CURLOPT_CONV_FROM_UTF8_FUNCTIONCallback CURLOPT_CONV_TO_NETWORK_FUNCTIONCallback CURLOPT_COOKIEString CURLOPT_COOKIEFILEString CURLOPT_COOKIEJARString CURLOPT_COOKIELISTString CURLOPT_COOKIESESSIONBoolean CURLOPT_CUSTOMREQUESTString CURLOPT_DEBUGDATABlob CURLOPT_DEBUGFUNCTIONCallback CURLOPT_DIRLISTONLYString CURLOPT_DNS_CACHE_TIMEOUTInteger In seconds (see cURL documentation). CURLOPT_DNS_USE_GLOBAL_CACHEBoolean CURLOPT_DOH_SSL_VERIFYHOSTBoolean CURLOPT_DOH_SSL_VERIFYPEERBoolean CURLOPT_DOH_SSL_VERIFYSTATUSInteger CURLOPT_DOH_URLString CURLOPT_EGDSOCKETString CURLOPT_ENCODINGString CURLOPT_ERRORBUFFERBlob CURLOPT_EXPECT_100_TIMEOUT_MSInteger CURLOPT_FAILONERRORBoolean CURLOPT_FILETIMEBoolean CURLOPT_FORBID_REUSEBoolean CURLOPT_FRESH_CONNECTBoolean CURLOPT_FTP_ACCOUNTString CURLOPT_FTP_ALTERNATIVE_TO_USERString CURLOPT_FTPAPPENDBoolean CURLOPT_FTP_CREATE_MISSING_DIRSBoolean CURLOPT_FTP_FILEMETHODConstant CURLFTPMETHOD_DEFAULT
Same behavior as if no method is specified. CURLFTPMETHOD_MULTICWD
cURL does a single CWD operation for each path part in the given URL. CURLFTPMETHOD_NOCWD
cURL does no CWD at all. CURLFTPMETHOD_SINGLECWD
libccURL does one CWD with the full target directory and then operates on the file "normally". CURLOPT_FTPLISTONLYBoolean CURLOPT_FTP_RESPONSE_TIMEOUTInteger In seconds (see cURL documentation). CURLOPT_FTPPORTString CURLOPT_FTP_SKIP_PASV_IPBoolean CURLOPT_FTP_SSLConstant Deprecated. Use CURLOPT_USE_SSL instead. CURLOPT_FTP_SSL_CCCBoolean false represents CURLFTPSSL_CCC_NONE, true is for
CURLFTPSSL_CCC_PASSIVE
. CURLOPT_FTPSSLAUTHConstant CURLFTPAUTH_DEFAULT
Allow cURL to decide. CURLFTPAUTH_SSL
Try SSL first, and only if that fails try TLS. CURLFTPAUTH_TLS
Try TLS first, and only if that fails try SSL. CURLOPT_FTP_USE_EPRTBoolean CURLOPT_FTP_USE_EPSVBoolean CURLOPT_FTP_USE_PRETString CURLOPT_FOLLOWLOCATIONBoolean CURLOPT_HAPPY_EYEBALLS_TIMEOUT_MSInteger CURLOPT_HAPROXYPROTOCOLString CURLOPT_HEADERBoolean CURLOPT_HEADERDATABlob CURLOPT_HEADERFUNCTIONCallback CURLOPT_HTTPAUTHConstant C URLAUTH_ANY cURL will automatically select the one it finds most secure. CURLAUTH_ANYSAFE All except basic authentication. cURL will automatically select the one it finds most secure.
CURLAUTH_AWS_SIGV4
AWS V4 signature (see CURLOPT_AWS_SIGV4). CURLAUTH_BASIC basic authentication CURLAUTH_DIGEST
digest authentication CURLAUTH_GSSNEGOTIATE deprecated, use CURLAUTH_NEGOTIATE insteadCURLAUTH_NEGOTIATE
negotiate (SPNEGO) authentication CURLAUTH_NTLM
NTLM authentication CURLOPT_HTTPGETBoolean CURLOPT_HTTPHEADERArray(String) CURLOPT_HTTPPOSTOther CURLOPT_HTTPPROXYTUNNELBoolean CURLOPT_HTTP_VERSIONConstant CURL_HTTP_VERSION_NONE
cURL will use whatever HTTP version it thinks fit. CURL_HTTP_VERSION_1_0
Enforce HTTP 1.0 requests. CURL_HTTP_VERSION_1_1
Enforce HTTP 1.1 requests. CURLOPT_HTTP200ALIASESArray(String) CURLOPT_IGNORE_CONTENT_LENGTHBoolean CURLOPT_INFILESIZEInteger CURLOPT_INFILESIZE_LARGEInteger CURLOPT_INTERFACEString CURLOPT_IOCTLDATABlob CURLOPT_IOCTLFUNCTIONCallback CURLOPT_IPRESOLVEConstant CURL_IPRESOLVE_WHATEVER
Resolves addresses to all IP versions that your system allows. CURL_IPRESOLVE_V4
Resolve to IPv4 addresses. CURL_IPRESOLVE_V6
Resolve to IPv6 addresses. CURLOPT_ISSUERCERTString CURLOPT_KEYPASSWDString CURLOPT_KRB4LEVELString CURLOPT_LOCALPORTInteger CURLOPT_LOCALPORTRANGEInteger CURLOPT_LOW_SPEED_LIMITInteger CURLOPT_LOW_SPEED_TIMEInteger In seconds (see cURL documentation). CURLOPT_MAXAGE_CONNInteger CURLOPT_MAXCONNECTSInteger CURLOPT_MAXFILESIZEInteger CURLOPT_MAXFILESIZE_LARGEInteger CURLOPT_MAXLIFETIME_CONNInteger CURLOPT_MAX_RECV_SPEED_LARGEInteger CURLOPT_MAXREDIRSInteger CURLOPT_MAX_SEND_SPEED_LARGEInteger CURLOPT_MIME_OPTIONSConstant CURLMIMEOPT_FORMESCAPE
Tells libcurl to escape multipart form field and file names using the backslash-escaping algorithm rather than percent-encoding (HTTP only). See cURL documentation for more. CURLOPT_NETRCConstant
CURL_NETRC_OPTIONAL
The use of your
~/.netrc
file is optional, and information in the URL is to be preferred.CURL_NETRC_IGNORED
cURL will ignore the file and use only the information in the URL. CURL_NETRC_REQUIRED
The use of the file is required, the information in the URL is ignored. CURLOPT_NETRC_FILEString CURLOPT_NEW_DIRECTORY_PERMSInteger CURLOPT_NEW_FILE_PERMSInteger CURLOPT_NOBODYBoolean CURLOPT_NOPROGRESSBoolean CURLPOT_NOPROXYString See cURL documentation. CURLOPT_NOSIGNALBoolean CURLOPT_QUOTEArray(String) CURLOPT_PATH_AS_ISString CURLOPT_PINNEDPUBLICKEYString CURLOPT_PORTInteger CURLOPT_POSTBoolean CURLOPT_POSTFIELDSBlob CURLOPT_POSTFIELDSIZEInteger CURLOPT_POSTFIELDSIZE_LARGEInteger CURLOPT_POSTQUOTEArray(String) CURLOPT_POSTREDIRString CURLOPT_PREQUOTEArray(String) CURLOPT_PREREQDATABlob CURLOPT_PREREQFUNCTIONCallback CURLOPT_PRIVATEBlob CURLOPT_PROGRESSDATABlob CURLOPT_PROGRESSFUNCTIONCallback CURLOPT_PROTOCOLS_STRString CURLOPT_PROXYString CURLOPT_PROXYAUTHConstant CURLAUTH_BASIC
basic authentication CURLAUTH_DIGEST
digest authentication CURLAUTH_NEGOTIATE
negotiate (SPNEGO) authentication CURLAUTH_GSSNEGOTIATE
deprecated, use CURLAUTH_NEGOTIATE insteadCURLAUTH_NTLM
NTLM authentication CURLAUTH_ANY
cURL will automatically select the one it finds most secure. CURLAUTH_ANYSAFE
All except basic authentication. cURL will automatically select the one it finds most secure. CURLOPT_PROXY_CAINFOString CURLOPT_PROXY_CAPATHString CURLOPT_PROXY_CRLFILEString CURLOPT_PROXYHEADERString CURLOPT_PROXY_ISSUERCERT String CURLOPT_PROXY_KEYPASSWDString CURLOPT_PROXYPASSWORDString CURLOPT_PROXY_PINNEDPUBLICKEYString CURLOPT_PROXYPORTInteger CURLOPT_PROXY_SERVICE_NAMEString CURLOPT_PROXY_SSLCERTString CURLOPT_PROXY_SSLCERTTYPEString CURLOPT_PROXY_SSL_CIPHER_LISTString CURLOPT_PROXY_SSLKEYString CURLOPT_PROXY_SSLKEYTYPEString CURLOPT_PROXY_SSL_OPTIONSString CURLOPT_PROXY_SSL_VERIFYHOSTString CURLOPT_PROXY_SSL_VERIFYPEERString CURLOPT_PROXY_SSLVERSIONString CURLOPT_PROXY_TLS13_CIPHERSString CURLOPT_PROXY_TRANSFER_MODEString CURLOPT_PROXYTYPEConstant
CURLPROXY_HTTP
HTTP proxy CURLPROXY_SOCKS4
SOCKS4 proxy CURLPROXY_SOCKS5
SOCKS5 proxy CURLOPT_PROXYUSERNAMEString CURLOPT_PROXYUSERPWDString CURLOPT_PUTBoolean CURLOPT_QUICK_EXITBoolean CURLOPT_RANDOM_FILEString CURLOPT_RANGEString CURLOPT_READDATABlob CURLOPT_READFUNCTIONCallback CURLOPT_REDIR_PROTOCOLS_STRString CURLOPT_REFERERString CURLOPT_RESOLVEString CURLOPT_RESUME_FROMInteger CURLOPT_RESUME_FROM_LARGEInteger Integer CURLOPT_SERVICE_NAMEString CURLOPT_SOCKS5_AUTHString CURLOPT_SOCKS5_GSSAPI_NECString CURLOPT_SOCKS5_GSSAPI_SERVICEString CURLOPT_SSH_AUTH_TYPESConstant CURLSSH_AUTH_KEYBOARD is not implemented for obvious reasons.CURLOPT_SSH_HOSTKEYDATABlob CURLOPT_SSH_HOSTKEYFUNCTIONCallback CURLOPT_SSH_HOST_PUBLIC_KEY_SHA256String CURLOPT_SSH_PUBLIC_KEYFILEString CURLOPT_SSH_PUBLIC_KEY_MD5String CURLOPT_SSH_PRIVATE_KEYFILEString CURLOPT_SHAREFileHandle CURLOPT_SSLCERTString CURLOPT_SSLCERTTYPEString CURLOPT_SSLCERTPASSWDString CURLOPT_SSL_CIPHER_LISTString CURLOPT_SSL_CTX_DATABlob CURLOPT_SSL_CTX_FUNCTIONCallback CURLOPT_SSLENGINEString CURLOPT_SSLENGINE_DEFAULTNone CURLOPT_SSLKEYString CURLOPT_SSLKEYTYPEString CURLOPT_SSLKEYPASSWDString CURLOPT_SSL_OPTIONSConstant CURLSSLOPT_ALLOW_BEAST
Tells libcurl to not attempt to use any workarounds for a security flaw in the SSL3 and TLS1.0 protocols. See cURL documentation for more. CURLOPT_SSL_SESSIOID_CACHEBoolean CURLOPT_SSL_VERIFYHOSTInteger CURLOPT_SSL_VERIFYPEERBoolean CURLOPT_SSL_VERIFYSTATUSInteger CURLOPT_SSLVERSIONConstant CURL_SSLVERSION_DEFAULT
Default action. This will attempt to figure out the remote SSL protocol version. CURL_SSLVERSION_TLSv1
Use TLSv1.x. CURL_SSLVERSION_SSLv2
Use SSLv2. CURL_SSLVERSION_SSLv3
Use SSLv3. CURLOPT_STDERRFileHandle CURLOPT_TCP_NODELAYBoolean CURLOPT_TELNETOPTIONSArray(String) CURLOPT_TIMECONDITIONConstant CURL_TIMECOND_IFMODSINCE
CURL_TIMECOND_IFUNMODSINCE
CURLOPT_TIMEOUTInteger In seconds (see cURL documentation). CURLOPT_TIMEOUT_MSInteger In milliseconds (see cURL documentation). CURLOPT_TIMEVALUEInteger CURLOPT_TIMEVALUE_LARGEInteger CURLOPT_TLS13_CIPHERSString CURLOPT_TRANSFERTEXTBoolean CURLOPT_UNRESTRICTED_AUTHBoolean CURLOPT_UPLOADBoolean CURLOPT_URLString CURLOPT_USE_SSLConstant CURLUSESSL_NONE
Do not attempt to use SSL. CURLUSESSL_TRY
Try using SSL, proceed as normal otherwise. CURLUSESSL_CONTROL
Require SSL for the control connection CURLUSESSL_ALL
Require SSL for all communication. CURLOPT_USERAGENTString CURLOPT_USERPWDString CURLOPT_VERBOSEBoolean CURLOPT_WRITEDATABlob CURLOPT_WRITEFUNCTIONCallback CURLOPT_WS_OPTIONSBitmask CURLOPT_XOAUTH2_BEARERString
On this Page:
Related Pages:
Overview
Content Tools