WebDAV Connector
The WebDAV Component adds SSL-enabled WebDAV send and receive capabilities to your MuleSoft.
Remarks
The WebDAV Connector provides support for uploading and downloading files to and from a WebDAV server.
WebDAV Receive Connector
The WebDAV Receive Connector is used to download files from the WebDAV Server. To begin set the URL and FileMask properties.
URL should be set to the URL including the directory from which the files will be downloaded. For instance:
https://www.test.com/DAV/pictures/animals/cats/
FileMask should be set to a pattern like *.png. The connector will download files matching the specified pattern. The default value is *.*.
The Depth property specifies how deep the server should operate within a directory.
Authentication to the WebDAV server is supported by setting User and Password. A Variety of authentication methods are supported via the AuthScheme property.
The connector will connect to the WebDAV server every PollingInterval and list the directory at URL. All files that match the FileMask will be downloaded and submitted to the Mule Project as individual messages.
In order to guarantee that files are not downloaded multiple times, you may set the DeleteMode. Alternatively, you may use the Other property to configure either the DownloadCacheFile and EnableFileDetailsComparison settings, or the RenameTo and RenameMode settings.
WebDAV Send Connector
The WebDAV Send Connector is used to upload files to the WebDAV Server. To begin set the URL and RemoteFile properties.
URL should be set to the URL including the directory from which the files will be downloaded. For instance:
https://www.test.com/DAV/pictures/animals/cats/
RemoteFile should be set to the name of the file to be uploaded.
Authentication to the WebDAV server is supported by setting User and Password. A Variety of authentication methods are supported via the AuthScheme property.
The connector will connect to the WebDAV server whenever it has a message to send. The connector will attempt to upload to a resource URI generated based on the values of URL and RemoteFile.
In order to prevent parallel processing by another application before your upload is complete, you may need to set a temporary extension via TemporaryUploadExtension.
The WebDAV Send Connector is primarily used to upload files but it can be configured with other operations. See the Other property for more information.
Receiver Property List
The following is the full list of the properties of the receiver Connector with short descriptions. Click on the links for further details.
AuthScheme | The authorization scheme to be used when server authorization is to be performed. |
DeleteMode | Controls if and when the remote file is deleted after download. |
Depth | How deep the server should operate within a directory. |
FileMask | Indicates the type of files to download from the server. |
Firewall | A set of properties related to firewall access. |
HTTPProxy | A set of properties related to proxy access. |
LogFile | The file to write logging information to at runtime. |
LogMode | What information gets logged during component execution. |
LogType | How information gets logged during component execution. |
Other | Defines a set of configuration settings to be used by the component. |
Password | The password for login. |
ReceivedFileDate | The last modified date of the remote file received by the component. |
ReceivedFileName | The name of the remote file received by the component. |
ReceivedFileSize | The size of the remote file received by the component. |
ReceivedFileURI | The resource URI of the remote file received by the component. |
RuntimeLicense | Specifies the component runtime license key. |
SSLAcceptServerCert | Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. |
SSLCert | The certificate to use for client authentication during the SSL handshake. |
TempFileName | TBD. |
TempPath | A temporary local directory where data can be stored before the component processes it. |
Timeout | A timeout for the component. |
URL | The URL of the WebDAV location to which the request is made. |
User | The user id for login. |
Sender Property List
The following is the full list of the properties of the sender Connector with short descriptions. Click on the links for further details.
AuthScheme | The authorization scheme to be used when server authorization is to be performed. |
Firewall | A set of properties related to firewall access. |
HTTPProxy | A set of properties related to proxy access. |
LogFile | The file to write logging information to at runtime. |
LogMode | What information gets logged during component execution. |
LogType | How information gets logged during component execution. |
Other | Defines a set of configuration settings to be used by the component. |
Password | The password for login. |
RemoteFile | The name of the destination file on the server for uploading. |
RuntimeLicense | Specifies the component runtime license key. |
SSLAcceptServerCert | Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. |
SSLCert | The certificate to use for client authentication during the SSL handshake. |
Timeout | A timeout for the component. |
URL | The URL of the WebDAV location to which the request is made. |
User | The user id for login. |
Config Settings
The following is a list of config settings for the Connector with short descriptions. Click on the links for further details.
Authorization | The Authorization string to be sent to the server. |
DownloadCacheFile | When set, only new files will be downloaded from the server. |
DownloadCacheFileDuration | The number of minutes that a file name will remain in the download cache. |
EnableFileDetailsComparison | Whether the receive component should consider metadata differences when deciding whether to download a file again. |
FollowRedirects | Determines what happens when the server issues a redirect. |
RenameMode | The condition under which RenameTo is used. |
RenameTo | A filename to which RemoteFile will be renamed. |
TemporaryDownloadExtension | An extension to be appended during download. |
TemporaryUploadExtension | An extension to be appended during upload. |
TempURL | A temporary location on the server to store files before moving them to URL. |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLSecurityFlags | Flags that control certificate verification. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseInternalSecurityAPI | Tells the component whether or not to use the system security libraries or an internal implementation. |
AuthScheme Property (WebDAV Connector)
The authorization scheme to be used when server authorization is to be performed.
Data Type
EnumerationPossible Values
Basic (0)Digest (1)
Proprietary (2)
None (3)
Ntlm (4)
Negotiate (5)
OAuth (6)
Default Value
0Remarks
This property specifies the type of authentication to perform. Possible values are:
- Basic
- Digest
- Proprietary
- None
- NTLM
- Negotiate
- OAuth
In most cases this setting is only applicable if User and Password is set.
This property is also applicable without setting User and Password if the AuthScheme is set to NTLM or Negotiate. In that case the current user credentials will be used.
AuthScheme should be set to authNone (3) when no authentication is to be performed (or do not set User and Password).
By default, AuthScheme is authBasic (0), and if the User and Password properties are set, the connector will attempt basic authentication. If AuthScheme is set to authDigest (1) or authNtlm (4), digest or NTLM authentication will be attempted instead.
If AuthScheme is set to authProprietary (2) then the authorization token must be supplied through the Authorization property. Note that, if you set the Authorization property, the AuthScheme will be set automatically to authProprietary (2) by the connector.
If AuthScheme is set to authOAuth (6) then the authorization string must be supplied through Authorization property.
DeleteMode Property (WebDAV Connector)
Controls if and when the remote file is deleted after download.
Data Type
EnumerationPossible Values
Never (0)On Success (1)
On Failure (2)
Always (3)
Default Value
0Remarks
This property informs the connector as to whether or not it should delete a remote files from the server after a successful download. The possible values and their meanings are as follows:
Never | The remote file is never deleted. |
OnSuccess | The remote file is deleted after a successful download. |
OnFailure | The remote file is deleted if the transfer fails. |
Always | The remote file is deleted regardless of success or failure of the transfer. |
Note: the default value is Never for data protection purposes. Unless modified this will result in the connector continuously receiving the same data.
This property is not available in the Sender.
Depth Property (WebDAV Connector)
How deep the server should operate within a directory.
Data Type
EnumerationPossible Values
Unspecified (0)Resource Only (1)
Immediate Children (2)
Infinity (3)
Default Value
0Remarks
During its operation, the connector will use Depth to instruct the server on how deep to operate within a directory. Depth is an enumerated type with the following possible values:
dpUnspecified (0) | The server will use the protocol default depth for the operation (this is normally "infinity"). |
dpResourceOnly (1) | The server will operate only on the directory resource URI, and not on any of its internal member resources. |
dpImmediateChildren (2) | The server will operate on the directory resource URI and all of its immediate member resources (but on none of their member resources). |
dpInfinity (3) | The server will recursively operate on the target resource URI and all of its internal member URIs through all levels of the directory hierarchy. |
This property is not available in the Sender.
FileMask Property (WebDAV Connector)
Indicates the type of files to download from the server.
Data Type
StringDefault Value
"*.*"Remarks
This property will limit what kinds of files the connector will download from the server. Only files matching the pattern specified in FileMask will be retrieved.
The following special characters are supported for pattern matching:
? | Any single character. |
* | Any characters or no characters (e.g., C*t matches Cat, Cot, Coast, Ct). |
[,-] | A range of characters (e.g., [a-z], [a], [0-9], [0-9,a-d,f,r-z]). |
\ | The slash is ignored and exact matching is performed on the next character. |
If these characters need to be used as a literal in a pattern, then they must be escaped by surrounding them with brackets []. Note: "]" and "-" do not need to be escaped. See below for the escape sequences:
Character | Escape Sequence |
? | [?] |
* | [*] |
[ | [[] |
\ | [\] |
For example, to match the value [Something].txt, specify the pattern [[]Something].txt.
This property is not available in the Sender.
Firewall Property (WebDAV Connector)
A set of properties related to firewall access.
Data Type
FirewallRemarks
This is a Firewall type property which contains fields describing the firewall through which the connector will attempt to connect.
HTTPProxy Property (WebDAV Connector)
A set of properties related to proxy access.
Data Type
ProxyRemarks
This is a Proxy type property which contains fields describing the proxy through which the connector will attempt to connect.
LogFile Property (WebDAV Connector)
The file to write logging information to at runtime.
Data Type
StringDefault Value
""Remarks
To write logging information to a file instead of using the connector's logging API, set this property to a valid file on disk and set the LogType property to "File".
LogMode Property (WebDAV Connector)
What information gets logged during component execution.
Data Type
EnumerationPossible Values
Verbose (0)Info (1)
Warning (2)
Error (3)
Fatal (4)
Default Value
3Remarks
This property controls what information the connector logs. The possible values have the following affect on the connector's behavior:
Verbose | The connector will report all information regarding the transport. |
Info | The connector will report all major operations, as well as all warnings and errors. |
Warning | The connector will report any conditions that could result in unpredictable behavior as well as errors. |
Error | The connector will report all errors that prevent normal operations from completing. |
Fatal | The connector will report only serious errors that cause the connector to completely stop functioning. |
LogType Property (WebDAV Connector)
How information gets logged during component execution.
Data Type
EnumerationPossible Values
None (0)Console (1)
File (2)
Default Value
1Remarks
This property controls where the connector will log the information. The possible values have the following affect on the connector's behavior:
None | The connector will not report any logging information. |
Console | The connector will report all logging information to the console. |
File | The connector will report all logging information to a file. The desired file must be specified in the LogFile when this type has been selected. |
Other Property (WebDAV Connector)
Defines a set of configuration settings to be used by the component.
Data Type
StringDefault Value
""Remarks
The connector accepts one or more configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the connector, access to these internal properties is provided through the Other property.
The Other property may be set to one or more configuration settings (name/value pairs). Set one setting per line.
For example:
configname1=value1
configname2=value2
Password Property (WebDAV Connector)
The password for login.
Data Type
PasswordDefault Value
""Remarks
This property must be set before the connector connects to the server.
ReceivedFileDate Property (WebDAV Connector)
The last modified date of the remote file received by the component.
Data Type
StringDefault Value
""Remarks
This value contains the last modified date of the remote file being received by the connector. It can be read from the context of a message being received by a WebDAV connector receive location.
This property is not available in the Sender.
ReceivedFileName Property (WebDAV Connector)
The name of the remote file received by the component.
Data Type
StringDefault Value
""Remarks
This is the filename returned by the server.
This value is also placed in the File.ReceivedFileName and the WebDAV.ReceivedFileName context properties. This is to ensure compatibility with other connectors that poll those context properties when filling out macros such as %SourceFileName%.
This property is not available in the Sender.
ReceivedFileSize Property (WebDAV Connector)
The size of the remote file received by the component.
Data Type
IntegerDefault Value
0Remarks
This value contains the size of the remote file being received by the connector. It can be read from the context of a message being received by a WebDAV connector receive location.
This property is not available in the Sender.
ReceivedFileURI Property (WebDAV Connector)
The resource URI of the remote file received by the component.
Data Type
StringDefault Value
""Remarks
This is the resource URI returned by the server. It can be read from the context of a message being received by a WebDAV connector receive location.
This property is not available in the Sender.
RemoteFile Property (WebDAV Connector)
The name of the destination file on the server for uploading.
Data Type
StringDefault Value
"#[attributes.fileName]"Remarks
The value of RemoteFile should be a file name or path relative to URL.
This property is not available in the Receiver.
RuntimeLicense Property (WebDAV Connector)
Specifies the component runtime license key.
Data Type
StringDefault Value
""Remarks
You can use the RuntimeLicense property to set the runtime key for the connector license.
SSLAcceptServerCert Property (WebDAV Connector)
Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
Data Type
CertificateRemarks
If it finds any issues with the certificate presented by the server, the connector will normally terminate the connection with an error. You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.
This property is used to set a Public Key Certificate.
Ordinarily, the system will attempt to locate the public key in trusted certificate stores in the system registry. If a match is found, the certificate is trusted, and the process proceeds without error. If the certificate is not trusted, the connector will report an error.
You may explicitly set a public key, either to accept a key that is not installed on the system, or to ensure that a specific key is presented. Public key certificates may be loaded from the machine registry or from file.
Note: You may also set the Accept Any field to Yes without opening the certificate selection dialog to force the connector to unilaterally authenticate any server during the security handshake. It is strongly recommended that you use this only for testing purposes. Set the LogMode to Info to cause the connector to report the server's credentials to Location.
SSLCert Property (WebDAV Connector)
The certificate to use for client authentication during the SSL handshake.
Data Type
CertificateRemarks
This property is used to assign a specific certificate for SSL client authentication.
This field is used to set a Private Key Certificate.
Private key certificates may be loaded from the registry, from files in PKCS#12 format, or from a PEM file format.
TempFileName Property (WebDAV Connector)
TBD.
Data Type
StringDefault Value
""Remarks
If the TempPath was set, then TempFileName will be the filename of the downloading file. TBD.
This property is not available in the Sender.
TempPath Property (WebDAV Connector)
A temporary local directory where data can be stored before the component processes it.
Data Type
StringDefault Value
""Remarks
This property indicates a temporary directory where the connector can store any data before the connector processes it. If TempPath is empty, the connector will receive all data to memory. If set, the connector will generate and write all inbound data to a temporary file in the specified directory.
Once the file is submitted, the connector will handle closing the file stream and deleting the temporary file. However, if the connector is shut down during a transfer some temporary files may be left in the directory. To ensure optimal performance, server administrators should check the directory regularly and remove old or extraneous files. Note: by default, this property is empty and the connector will use memory streams to store all inbound data before submitting it. It is recommended that you use a temporary directory when downloading large batches or batches containing large files to alleviate potential increased memory requirements.
This property is not available in the Sender.
Timeout Property (WebDAV Connector)
A timeout for the component.
Data Type
IntegerDefault Value
60Remarks
If the Timeout property is set to 0, all operations will run uninterrupted until successful completion, or an error condition is encountered.
If Timeout is set to a positive value, the connector will wait for the operation to complete before returning control.
If Timeout expires, and the operation is not yet complete, the connector fails with an error.
Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when data is successfully sent or received.
Optionally, the behavior of the connector may be changed to absolute timeouts, i.e. the connector will wait for a maximum of Timeout seconds since the beginning of the operation, without extending the timeout period during communications.
This behavior is controlled by the AbsoluteTimeout configuration setting.
The default value for the Timeout property is 60 (seconds).
URL Property (WebDAV Connector)
The URL of the WebDAV location to which the request is made.
Data Type
StringDefault Value
""Remarks
This property specifies the URL of the WebDAV folder to which the request is made. For instance: https://www.test.com/DAV/pictures/animals/cats/.
TLS/SSL will be used if and only if the URL scheme is "https".
User Property (WebDAV Connector)
The user id for login.
Data Type
StringDefault Value
""Remarks
This property must be set before the connector connects to the server.
Certificate Type
The digital certificate being used.
Remarks
This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.
Fields
Store String |
The name of the certificate store for the client certificate. The StoreType field specifies the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword. Store is used in conjunction with the Subject field in order to specify client certificates. If Store has a value, and Subject is set, a search for a certificate is initiated. Please refer to the Subject field for details. Designations of certificate stores are platform-dependent. The following are designations of the most common User and Machine certificate stores in Windows:
In Java, the certificate store normally is a file containing certificates and optional private keys. When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store). If the provider is OpenSSL, the certificate store is a file containing a certificate and a private key. This property must be set to the name of the file. |
||||||||||||||||||||||||||||||||||||||||||||||||
StorePassword String |
If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store. |
||||||||||||||||||||||||||||||||||||||||||||||||
StoreType CertStoreTypes |
The type of certificate store for this certificate. The connector supports both public and private keys in a variety of formats. When the cstAuto value is used the connector will automatically determine the type. This field can take one of the following values:
|
||||||||||||||||||||||||||||||||||||||||||||||||
Subject String |
The subject of the certificate used for client authentication. When this property is set, a search is performed in the current certificate store certificate with matching subject. If an exact match is not found, the store is searched for subjects containing the value of the property. When setting the property to a partial subject, CN= should be omitted. For example, the following code would find the certificate with subject CN=Test Certificate, OU=People, C=US Example (Searching with partial subject)
If a match is not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. If a matching certificate is found, Subject is set to the full subject of the matching certificate. |
||||||||||||||||||||||||||||||||||||||||||||||||
Thumbprint String |
The thumbprint of the certificate. This field is used to specify the thumbprint of the certificate. When there are multiple certificates in the store that have the same subject, the thumbprint will be used to distinguish between them. |
Firewall Type
The firewall the component will connect through.
Remarks
When connecting through a firewall, this type is used to specify different properties of the firewall such as the firewall Host and the FirewallType.
Fields
AutoDetect Boolean |
Tells the connector whether or not to automatically detect and use firewall system settings, if available. |
||||||||
FirewallType FirewallTypes |
Determines the type of firewall to connect through. The applicable values are the following:
|
||||||||
Host String |
Name or IP address of firewall (optional). If a Host is given, requested connections will be authenticated through the specified firewall when connecting. If the Host field is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the Host field is set to the corresponding address. If the search is not successful, an error is returned. |
||||||||
Password String |
A password if authentication is to be used when connecting through the firewall. If Host is specified, the User and Password fields are used to connect and authenticate to the given firewall. If the authentication fails, a trappable error is fired. |
||||||||
Port Integer |
The TCP port for the firewall Host. See the description of the Host field for details. Note that the Port is set automatically when FirewallType is set to a valid value. See the description of the FirewallType field for details. |
||||||||
User String |
A user name if authentication is to be used connecting through a firewall. If the Host is specified, the User and Password fields are used to connect and authenticate to the given Firewall. If the authentication fails, a trappable error is fired. |
Proxy Type
The proxy the component will connect to.
Remarks
When connecting through a proxy, this type is used to specify different properties of the proxy such as the Server and the AuthScheme.
Fields
AuthScheme ProxyAuthSchemes |
Use the AuthScheme field to tell the connector which type of authorization to perform when connecting to the proxy. This is only used when the User and Password fields are set. AuthScheme should be set to authNone (3) when no authentication is expected. By default, AuthScheme is authBasic (0), and if the User and Password fields are set, the component will attempt basic authentication. If AuthScheme is set to authDigest (1), digest authentication will be attempted instead. If AuthScheme is set to authProprietary (2), then the authorization token will not be generated by the connector. Look at the configuration file for the connector being used to find more information about manually setting this token. If AuthScheme is set to authNtlm (4), NTLM authentication will be used. This option is only available in the SSL package. For security reasons, setting this property will clear the values of User and Password. |
||||||||
AutoDetect Boolean |
Tells the connector whether or not to automatically detect and use proxy system settings, if available. |
||||||||
Password String |
A password if authentication is to be used for the proxy. If AuthScheme is set to Basic Authentication, the User and Password are Base64 encoded and the proxy authentication token will be generated in the form "Basic [encoded-user-password]". If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server. If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation. |
||||||||
Port Integer |
The TCP port for the proxy Server (default 80). See the description of the Server field for details. |
||||||||
Server String |
If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. If the Server field is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, the Server field is set to the corresponding address. If the search is not successful, an error is returned. |
||||||||
SSL ProxySSLTypes |
Determines when to use SSL for the connection to the proxy. The applicable values are the following:
|
||||||||
User String |
A user name, if authentication is to be used for the proxy. If AuthScheme is set to Basic Authentication, the User and Password are Base64 encoded and the proxy authentication token will be generated in the form "Basic [encoded-user-password]". If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server. If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation. |
Config Settings (WebDAV Connector)
The connector accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the connector, access to these internal properties is provided through the Other property.WebDAV Config Settings | ||||||||||||||||||||||||
Authorization:
The Authorization string to be sent to the server.If the Authorization setting contains a non-empty string,
an Authorization HTTP request header is added to the
request. This header conveys Authorization information to the
server.
A common use for this property is to specify OAuth authorization string. This property is provided so that the WebDAV connector can be extended with other security schemes in addition to the authorization schemes already implemented by the connector. The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization header in the form "Basic [encoded-user-password]". |
||||||||||||||||||||||||
DownloadCacheFile: When set, only new files will be downloaded from the server.This may be set to the location of a file on disk that will hold the names of files that were previously downloaded from the server. On each PollingInterval the connector will check to see if the file on the server exists in this list. If the file exists in this list, it is determined that the file was previously downloaded and is not downloaded on the current polling interval. The list is automatically updated on each polling interval. | ||||||||||||||||||||||||
DownloadCacheFileDuration:
The number of minutes that a file name will remain in the download cache.If a file name is added to the DownloadCacheFile and is not seen on the server again within DownloadCacheFileDuration minutes, it will be removed from the cache.
This can prevent the download cache file from growing too large in certain cases.
The default value is 0, meaning that files will never be removed. This setting is only applicable if DownloadCacheFile is set. |
||||||||||||||||||||||||
EnableFileDetailsComparison:
Whether the receive connector should consider metadata differences when deciding whether to download a file again.This setting is used in conjunction with DownloadCacheFile, and is only available on the receive connector. If DownloadCacheFile is enabled, this setting can be used to control how the receive connector uses the download file cache information when deciding whether to download a file again. (Similar to the "Enable Timestamp Comparison" property on Microsoft's FTP BizTalk Adapter.)
If this is set to False, the receive connector will not download a file again if the cache contains any information about it (that is, if it has been downloaded before). If this is set to True, the receive connector will check the metadata of the remote file against its cached metadata, and will download the file again if any of the metadata differs. |
||||||||||||||||||||||||
FollowRedirects:
Determines what happens when the server issues a redirect.This setting determines what happens when the server issues a redirect. Normally, the connector returns an error if the server responds
with an "Object Moved" message. If this setting is set to 1 (always), the new URL for the object is retrieved automatically every time.
If this setting is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same, otherwise the connector will throw an exception. Note that following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for 'GET' or 'HEAD' requests. Other methods could potentially change the conditions of the initial request and create security vulnerabilities. Furthermore, if either the new URL server and port are different than the existing one, User and Password are also reset to empty, unless this setting is set to 1 (Always), in which case the same credentials are used to connect to the new server. The default value is 0 (Never). In this case, redirects are never followed, and the connector will throw an exception instead. Valid options are:
Note: This is applicable to the receive connector only. |
||||||||||||||||||||||||
RenameMode:
The condition under which RenameTo is used.This setting controls when the value specified by RenameTo is used. If RenameTo is not specified, this setting has no impact. By default, downloaded files are only renamed after being successfully submitted to BizTalk (a value of 1).
Possible values are:
|
||||||||||||||||||||||||
RenameTo:
A filename to which RemoteFile will be renamed.After downloading a file, the file on the server may be renamed using this setting. This rename action will take place
after the batch submission to BizTalk. If you need to perform actions on a file before this, use the AfterGet property.
This setting is used in conjunction with RenameMode to conditionally rename a file. For instance, to rename a
file after it has been successfully submitted to BizTalk set the Other property of the connector like so:
RenameTo=%SourceFileName%.done
|
||||||||||||||||||||||||
TemporaryDownloadExtension: An extension to be appended during download.During download, it may be necessary for the file on the server to be renamed. After the download is complete the file will be renamed back to the original name. | ||||||||||||||||||||||||
TemporaryUploadExtension: An extension to be appended during upload.During upload, it may be necessary for the RemoteFile to be written to a temporary file name. For example, some business process may be set up to expect a specific file extension. Using this setting will allow the connector to upload the file without the remainder of the process attempting to pick up the incomplete file. | ||||||||||||||||||||||||
TempURL:
A temporary location on the server to store files before moving them to URL.If a value is specified, the connector will directly upload the file to TempURL. Once the file transfer is complete, the connector will move the file to the URL.
Note: This is applicable to the send connector only. |
||||||||||||||||||||||||
SSL Config Settings | ||||||||||||||||||||||||
ReuseSSLSession:
Determines if the SSL session is reused.
If set to true, the connector will reuse the context if and only if the following criteria are met:
|
||||||||||||||||||||||||
SSLCipherStrength:
The minimum cipher strength used for bulk encryption.
This minimum cipher strength largely dependent on the security modules installed
on the system. If the cipher strength specified is not supported,
an error will be returned when connections are initiated.
Please note that this setting contains the minimum cipher strength requested from the security library. Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application. |
||||||||||||||||||||||||
SSLEnabledCipherSuites:
The cipher suite to be used in an SSL negotiation.The enabled cipher suites to be used in SSL negotiation.
By default, the enabled cipher suites will include all available ciphers ("*"). The special value "*" means that the connector will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered. Multiple cipher suites are separated by semicolons. Example values when UseInternalSecurityAPI is False (default):
// The "Other" property could contain ONE of the following lines:
SSLEnabledCipherSuites=*
SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA
SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA
Possible values when UseInternalSecurityAPI is True include:
If SSLEnabledProtocols is configured to use TLS 1.3 the following values are supported:
SSLEnabledCipherSuites is used together with SSLCipherStrength. |
||||||||||||||||||||||||
SSLEnabledProtocols:
Used to enable/disable the supported security protocols.Used to enable/disable the supported security protocols.
Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:
Note: TLS 1.1 and TLS1.2 support are only available starting with Windows 7. Note: Enabling TLS 1.3 will automatically set UseInternalSecurityAPI to True. |
||||||||||||||||||||||||
SSLIncludeCertChain:
Whether the entire certificate chain is included in the SSLServerAuthentication event.This setting specifies whether the transport log contains the full certificate chain. By default this value is False and only the leaf certificate will be present.
If set to True all certificates returned by the server will be present in the transport log. This includes the leaf certificate, any intermediate certificate, and the root certificate. Note: When UseInternalSecurityAPI is set to True this value is automatically set to True. This is needed for proper validation when using the internal provider. |
||||||||||||||||||||||||
SSLSecurityFlags:
Flags that control certificate verification.The following flags are defined (specified in hexadecimal
notation). They can be or-ed together to exclude multiple
conditions:
|
||||||||||||||||||||||||
TLS12SignatureAlgorithms:
Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.This setting specifies the allowed server certificate signature algorithms when UseInternalSecurityAPI is
True and SSLEnabledProtocols is set to allow TLS 1.2.
When specified the connector will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the connector will fail with an error. The format of this value is a comma separated list of hash-signature combinations. For instance:
In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent. |
||||||||||||||||||||||||
TLS12SupportedGroups:
The supported groups for ECC.This setting specifies a comma separated list of named groups used in TLS 1.2 for ECC.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1. When using TLS 1.2 and UseInternalSecurityAPI is set to True, the values refer to the supported groups for ECC. The following values are supported:
|
||||||||||||||||||||||||
TLS13KeyShareGroups:
The groups for which to pregenerate key shares.This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange.
The groups specified here will have key share data pregenerated locally before establishing a connection.
This can prevent an additional round trip during the handshake if the group is supported by the server.
The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting. Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group. In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so. The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072 The values are ordered from most preferred to least preferred. The following values are supported:
|
||||||||||||||||||||||||
TLS13SignatureAlgorithms:
The allowed certificate signature algorithms.This setting holds a comma separated list of allowed signature algorithms. Possible values are:
|
||||||||||||||||||||||||
TLS13SupportedGroups:
The supported groups for (EC)DHE key exchange.This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange.
This setting should only be modified if there is a specific reason to do so.
The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192 The values are ordered from most preferred to least preferred. The following values are supported:
|
||||||||||||||||||||||||
General Config Settings | ||||||||||||||||||||||||
AbsoluteTimeout: Determines whether timeouts are inactivity timeouts or absolute timeouts.If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout. | ||||||||||||||||||||||||
LocalHost:
The name of the local host or user-assigned IP interface through which connections are initiated or accepted.The LocalHost configuration contains the name of the local host as obtained by the Gethostname() system call, or if the user has assigned an IP address, the value of that address.
In multihomed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the connector initiate connections (or accept in the case of server connectors) only through that interface. If the connector is connected, the LocalHost configuration shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface). |
||||||||||||||||||||||||
TcpNoDelay:
Whether or not to delay when sending packets.
When true, the socket will send all data that is ready to send at once. When
false, the socket will send smaller buffered packets of data at small intervals.
This is known as the Nagle algorithm.
By default, this config is set to false. |
||||||||||||||||||||||||
UseInternalSecurityAPI: Tells the connector whether or not to use the system security libraries or an internal implementation. By default the connector will use the system security libraries to perform cryptographic functions where applicable. Setting this to True tells the connector to use the internal implementation instead of using the system's security API. |