# CloudFiles Class The CloudFiles class provides an easy way to upload, download, and manage files and folders with multiple service providers. ## Syntax ```text cloudstorage.CloudFiles ``` ## Remarks The CloudFiles class provides a single interface that can be used to work with a variety of services. By supporting multiple providers with a single API code may be written once and used to support multiple services. The following providers are currently supported by this class: - Amazon S3 - Azure Blob - Azure File - Backblaze B2 - Box.com - Digital Ocean Spaces - Dropbox - Google Cloud Storage - Google Drive - Hadoop DFS - IBM Cloud Object Storage - Linode Object Storage - Microsoft OneDrive - Wasabi The class supports simple file and folder management as well as encryption. Capabilities include uploading and downloading files, strong encryption support, creating folders, and more. To begin, first create an account and register your application. Consult the documentation of the individual service provider for instructions on this process. ## Authentication The following providers use OAuth 2.0 for authentication: - Box.com - Dropbox - Google Cloud Storage* - Google Drive - Microsoft OneDrive Use the OAuth class included in the toolkit, or any other OAuth implementation to perform authentication and retrieve an authorization string. Once you've obtained an authorization string like: ```text Bearer ya29.AHES6ZSZEJzATdZYjeihDn5W-VrXSsxEZu5p0pclxGdKKQ ``` Assign this value to the [Authorization](#authorization-property-cloudfiles-class) property before attempting any operations. Consult the service provider documentation for more information about supported scope values and more details on OAuth authentication. To authenticate with the remaining providers, set the [Account](#account-property-cloudfiles-class) fields shown in the table below: | Provider | Relevant fields | | --- | --- | | Amazon S3 | [AccessKey](#CloudFilesAccount_f_AccessKey) and [SecretKey](#CloudFilesAccount_f_SecretKey) | | Azure Blob | [Account](#CloudFilesAccount_f_Account) and [AccessKey](#CloudFilesAccount_f_AccessKey) | | Azure File | [Account](#CloudFilesAccount_f_Account) and [AccessKey](#CloudFilesAccount_f_AccessKey) | | Backblaze B2 | [ApplicationKeyId](#CloudFilesAccount_f_ApplicationKeyId) and [ApplicationKey](#CloudFilesAccount_f_ApplicationKey) | | Digital Ocean Spaces | [AccessKey](#CloudFilesAccount_f_AccessKey) and [SecretKey](#CloudFilesAccount_f_SecretKey) | | Google Cloud Storage* | [ProjectId](#CloudFilesAccount_f_ProjectId) (if using [Authorization](#authorization-property-cloudfiles-class) for OAuth); or, [AccessKey](#CloudFilesAccount_f_AccessKey) and [SecretKey](#CloudFilesAccount_f_SecretKey) | | Hadoop DFS | Multiple HTTP authentication schemes are supported; refer to [AuthMechanism](#CloudFilesAccount_f_AuthMechanism) for more information. [HadoopURL](#CloudFilesAccount_f_HadoopURL) must always be set. | | IBM Cloud Object Storage | [AccessKey](#CloudFilesAccount_f_AccessKey) and [SecretKey](#CloudFilesAccount_f_SecretKey) | | Linode Object Storage | [AccessKey](#CloudFilesAccount_f_AccessKey) and [SecretKey](#CloudFilesAccount_f_SecretKey) | | Wasabi | [AccessKey](#CloudFilesAccount_f_AccessKey) and [SecretKey](#CloudFilesAccount_f_SecretKey) | *****Google Cloud Storage supports two authentication methods. To authenticate with OAuth 2.0 (preferred) set the [Authorization](#authorization-property-cloudfiles-class) property and the [ProjectId](#CloudFilesAccount_f_ProjectId) field. To authenticate with an access and secret key, set the [AccessKey](#CloudFilesAccount_f_AccessKey) and [SecretKey](#CloudFilesAccount_f_SecretKey) fields instead. ## Selecting a Provider To specify the provider simply set [ServiceProvider](#serviceprovider-property-cloudfiles-class). This tells the class to which service requests will be made. ## Listing Files and Folders [ListDirectory](#listdirectory-method-cloudfiles-class) lists files and folder the path specified by [RemotePath](#remotepath-property-cloudfiles-class). The directory entries are provided through the [DirList](#dirlist-event-cloudfiles-class) event and also via the [DirList](#dirlist-property-cloudfiles-class) property. ```text cloudfiles.RemoteFile = ""; //Clear filemask cloudfiles.RemotePath = "MyFolder"; cloudfiles.ListDirectory(); for (int i = 0; i < cloudfiles.DirList.Count; i++) { Console.WriteLine(cloudfiles.DirList[i].FileName); Console.WriteLine(cloudfiles.DirList[i].FileSize); Console.WriteLine(cloudfiles.DirList[i].FileTime); Console.WriteLine(cloudfiles.DirList[i].IsDir); } ``` The [RemoteFile](#remotefile-property-cloudfiles-class) property may also be used as a filemask when listing files. For instance: ```text component.RemoteFile = "*.txt" component.ListDirectory() ``` Note: Since [RemoteFile](#remotefile-property-cloudfiles-class) is used as a filemask be sure to clear or reset this value before calling [ListDirectory](#listdirectory-method-cloudfiles-class) ## Downloading Files The [Download](#download-method-cloudfiles-class) method downloads a specific file. Set [RemoteFile](#remotefile-property-cloudfiles-class) to the name the file to download before calling this method. If [RemoteFile](#remotefile-property-cloudfiles-class) only specifies a filename it will be downloaded from the path specified by [RemotePath](#remotepath-property-cloudfiles-class). [RemoteFile](#remotefile-property-cloudfiles-class) may also be set to an absolute path. The file will be downloaded to the stream specified (if any) by [SetDownloadStream](#setdownloadstream-method-cloudfiles-class). If a stream is not specified and [LocalFile](#localfile-property-cloudfiles-class) is set the file will be saved to the specified location. If a stream is not specified and [LocalFile](#localfile-property-cloudfiles-class) is not set the file data will be held by ResourceData. To decrypt an encrypted file set [EncryptionAlgorithm](#encryptionalgorithm-property-cloudfiles-class) and [EncryptionPassword](#encryptionpassword-property-cloudfiles-class) before calling this method. ```text cloudfiles.RemotePath = "My Folder"; cloudfiles.RemoteFile = "MyFile.zip"; cloudfiles.LocalFile = "../MyFile.zip"; cloudfiles.Download(); ``` **Resuming Downloads** The class also supports resuming failed downloads by using the [StartByte](#startbyte-property-cloudfiles-class) property. If the download was interrupted, set [StartByte](#startbyte-property-cloudfiles-class) to the appropriate offset before calling this method to resume the download. ```text cloudfiles.RemotePath = myRemoteFolder; cloudfiles.RemoteFile = myRemoteFile; cloudfiles.LocalFile = downloadFile; cloudfiles.Download(); //The transfer is interrupted and Download() above fails. Later, resume the download: //Get the size of the partially downloaded file cloudfiles.StartByte = new FileInfo(downloadFile).Length; cloudfiles.RemotePath = myRemoteFolder; cloudfiles.RemoteFile = myRemoteFile; cloudfiles.LocalFile = downloadFile; cloudfiles.Download(); ``` **Resuming Encrypted File Downloads** Resuming encrypted file downloads is only supported when [LocalFile](#localfile-property-cloudfiles-class) was set in the initial download attempt. When beginning an encrypted download if [LocalFile](#localfile-property-cloudfiles-class) is set the class will create a temporary file in [TempPath](#TempPath) to hold the encrypted data until it is complete. If the download is interrupted [DownloadTempFile](#DownloadTempFile) will be populated with the temporary file holding the partial data. When resuming, [DownloadTempFile](#DownloadTempFile) must be populated along with [StartByte](#startbyte-property-cloudfiles-class) to allow the remainder of the encrypted data to be downloaded. Once the encrypted data is downloaded it will be decrypted and written to [LocalFile](#localfile-property-cloudfiles-class). ```text cloudfiles.RemotePath = myRemoteFolder; cloudfiles.RemoteFile = myRemoteFile; cloudfiles.LocalFile = downloadFile; cloudfiles.EncryptionPassword = "password"; cloudfiles.Download(); //The transfer is interrupted and Download() above fails. Later, resume the download: //Get the size of the partially download temp file cloudfiles.StartByte = new FileInfo(cloudfiles.Config("DownloadTempFile")).Length; cloudfiles.RemotePath = myRemoteFolder; cloudfiles.RemoteFile = myRemoteFile; cloudfiles.LocalFile = downloadFile; cloudfiles.EncryptionPassword = "password"; cloudfiles.Download(); ``` ## Uploading Files The [Upload](#upload-method-cloudfiles-class) method is used to upload files. If [SetUploadStream](#setuploadstream-method-cloudfiles-class) is used to set an upload stream the data to upload is taken from the stream instead. [RemoteFile](#remotefile-property-cloudfiles-class) should be set to either a relative or absolute path. If [RemoteFile](#remotefile-property-cloudfiles-class) is not an absolute path it will be uploaded relative to [RemotePath](#remotepath-property-cloudfiles-class). To encrypt a file before uploading set [EncryptionAlgorithm](#encryptionalgorithm-property-cloudfiles-class) and [EncryptionPassword](#encryptionpassword-property-cloudfiles-class). Note: Resuming uploads is not currently supported. **Code Example:** ```text //Upload with a relative path cloudfiles.LocalFile = "C:\localfile.txt" cloudfiles.RemoteFile = "remotefile.txt" cloudfiles.Upload() //Upload with an absolute path cloudfiles.LocalFile = "C:\localfile2.txt" cloudfiles.RemoteFile = "/folder/remotefile2.txt" cloudfiles.Upload() ``` ## Additional Functionality The CloudFiles class offers advanced functionality beyond simple uploads and downloads. For instance: - Encrypt and decrypt files using [EncryptionAlgorithm](#encryptionalgorithm-property-cloudfiles-class) and [EncryptionPassword](#encryptionpassword-property-cloudfiles-class). - [DeleteFile](#deletefile-method-cloudfiles-class) provides a way to delete files. - [MakeDirectory](#makedirectory-method-cloudfiles-class) and [RemoveDirectory](#removedirectory-method-cloudfiles-class) support creating and deleting folders. - [RenameFile](#renamefile-method-cloudfiles-class) allows renaming of existing files on the server. - And more! ## Property List *The following is the full list of the properties of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Account](#account-property-cloudfiles-class) | Account credentials. | | [Authorization](#authorization-property-cloudfiles-class) | The OAuth 2.0 authorization token. | | [DirList](#dirlist-property-cloudfiles-class) | Collection of entries resulting in the last directory listing. | | [EncryptionAlgorithm](#encryptionalgorithm-property-cloudfiles-class) | The encryption algorithm. | | [EncryptionPassword](#encryptionpassword-property-cloudfiles-class) | The encryption password. | | [Firewall](#firewall-property-cloudfiles-class) | A set of properties related to firewall access. | | [Idle](#idle-property-cloudfiles-class) | The current status of the class. | | [LocalFile](#localfile-property-cloudfiles-class) | The location of the local file. | | [LocalHost](#localhost-property-cloudfiles-class) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. | | [OAuth](#oauth-property-cloudfiles-class) | The OAuth settings. | | [Overwrite](#overwrite-property-cloudfiles-class) | Whether to overwrite the local or remote file. | | [Proxy](#proxy-property-cloudfiles-class) | A set of properties related to proxy access. | | [RemoteFile](#remotefile-property-cloudfiles-class) | The name of the remote file. | | [RemotePath](#remotepath-property-cloudfiles-class) | The current path on the server. | | [ServiceProvider](#serviceprovider-property-cloudfiles-class) | The storage service provider. | | [SSLAcceptServerCert](#sslacceptservercert-property-cloudfiles-class) | Instructs the class to unconditionally accept the server certificate that matches the supplied certificate. | | [SSLCert](#sslcert-property-cloudfiles-class) | The certificate to be used during Secure Sockets Layer (SSL) negotiation. | | [SSLProvider](#sslprovider-property-cloudfiles-class) | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. | | [SSLServerCert](#sslservercert-property-cloudfiles-class) | The server certificate for the last established connection. | | [StartByte](#startbyte-property-cloudfiles-class) | The byte offset from which to start download. | | [Timeout](#timeout-property-cloudfiles-class) | The timeout for the class. | ## Method List *The following is the full list of the methods of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Authorize](#authorize-method-cloudfiles-class) | Get the authorization string required to access the protected resource. | | [Config](#config-method-cloudfiles-class) | Sets or retrieves a configuration setting. | | [CopyFile](#copyfile-method-cloudfiles-class) | Copies the file. | | [DeleteFile](#deletefile-method-cloudfiles-class) | Remove a file specified by FileName from the server. | | [Download](#download-method-cloudfiles-class) | Download the specified file. | | [Interrupt](#interrupt-method-cloudfiles-class) | This method interrupts the current method. | | [ListDirectory](#listdirectory-method-cloudfiles-class) | Lists the current directory specified by RemotePath on the server. | | [MakeDirectory](#makedirectory-method-cloudfiles-class) | Creates a directory on the server. | | [RemoveDirectory](#removedirectory-method-cloudfiles-class) | Remove the specified directory. | | [RenameFile](#renamefile-method-cloudfiles-class) | Renames the file. | | [Reset](#reset-method-cloudfiles-class) | Resets the class to its initial state. | | [SetDownloadStream](#setdownloadstream-method-cloudfiles-class) | Sets the stream to which downloaded data will be written. | | [SetUploadStream](#setuploadstream-method-cloudfiles-class) | Sets the stream from which data is read when uploading. | | [Upload](#upload-method-cloudfiles-class) | Uploads the file specified by LocalFile to the server. | ## Event List *The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [DirList](#dirlist-event-cloudfiles-class) | Fired when a directory entry is received. | | [EndTransfer](#endtransfer-event-cloudfiles-class) | Fired when a document finishes transferring. | | [Error](#error-event-cloudfiles-class) | Fired when information is available about errors during data delivery. | | [Log](#log-event-cloudfiles-class) | Fired once for each log message. | | [Progress](#progress-event-cloudfiles-class) | Fires during an upload or download to indicate transfer progress. | | [SSLServerAuthentication](#sslserverauthentication-event-cloudfiles-class) | Fired after the server presents its certificate to the client. | | [SSLStatus](#sslstatus-event-cloudfiles-class) | Fired when secure connection progress messages are available. | | [StartTransfer](#starttransfer-event-cloudfiles-class) | Fired when a document starts transferring (after the headers). | | [Transfer](#transfer-event-cloudfiles-class) | Fired while a document transfers (delivers document). | ## Config Settings *The following is a list of config settings for the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AllowTransferEventOnly](#AllowTransferEventOnly) | Enables using just the Transfer event when downloading. | | [AWSProfile](#AWSProfile) | The name of the AWS CLI profile that the class should use to obtain authentication and region information. | | [AWSProfileDir](#AWSProfileDir) | The location of the AWS CLI credentials and config files. | | [ContentDisposition](#ContentDisposition) | The Content-Disposition to send when uploading an file to an S3-like storage provider. | | [ContentType](#ContentType) | The Content-Type to send when uploading an file to an S3-like storage provider. | | [DateFormat](#DateFormat) | The date format of the file time. | | [DocsExportFormat](#DocsExportFormat) | The file format to export Google Docs files as when downloading. | | [DownloadTempFile](#DownloadTempFile) | The temporary file used when downloading encrypted data. | | [DrawingsExportFormat](#DrawingsExportFormat) | The file format to export Google Drawings files as when downloading. | | [EncryptionIV](#EncryptionIV) | The initialization vector to be used for encryption/decryption. | | [EncryptionKey](#EncryptionKey) | The key to use during encryption/decryption. | | [EncryptionPasswordKDF](#EncryptionPasswordKDF) | The KDF algorithm to use during password based encryption and decryption. | | [FragmentSize](#FragmentSize) | The fragment size that the class should use when uploading files in multiple fragments. | | [ListResourcesScope](#ListResourcesScope) | Controls the scope of the results when listing GoogleDrive resources. | | [ListSharedResources](#ListSharedResources) | Whether to list shared resources when listing OneDrive resources. | | [NewVersionOnOverwrite](#NewVersionOnOverwrite) | Whether to upload new file versions instead of performing true overwrites. | | [NormalizedFileName\[i\]](#NormalizedFileName[i]) | The normalized file name. | | [OneDriveResourceIndex](#OneDriveResourceIndex) | The index corresponding to the OneDrive resource to be downloaded. | | [ProgressAbsolute](#ProgressAbsolute) | Whether the class should track transfer progress absolutely. | | [ProgressStep](#ProgressStep) | How often the progress event should be fired, in terms of percentage. | | [RawRequest](#RawRequest) | Returns the data that was sent to the server. | | [RawResponse](#RawResponse) | Returns the data that was received from the server. | | [Region](#Region) | For applicable providers, specifies the region to use. | | [SharedDriveId](#SharedDriveId) | The Id of the Google Drive shared drive to list resources for. | | [SheetsExportFormat](#SheetsExportFormat) | The file format to export Google Sheets files as when downloading. | | [SimpleUploadLimit](#SimpleUploadLimit) | The threshold above which the class will choose to perform a multipart upload, for applicable storage service providers. | | [SlidesExportFormat](#SlidesExportFormat) | The file format to export Google Slides files as when downloading. | | [TempPath](#TempPath) | The path to the directory where temporary files are created. | | [UseVirtualHosting](#UseVirtualHosting) | Determines which URL style S3-like storage service providers should use. | | [XChildCount](#XChildCount) | The number of child elements of the current element. | | [XChildName\[i\]](#XChildName[i]) | The name of the child element. | | [XChildXText\[i\]](#XChildXText[i]) | The inner text of the child element. | | [XElement](#XElement) | The name of the current element. | | [XParent](#XParent) | The parent of the current element. | | [XPath](#XPath) | Provides a way to point to a specific element in the returned XML or JSON response. | | [XSubTree](#XSubTree) | A snapshot of the current element in the document. | | [XText](#XText) | The text of the current element. | | [OAuthAccessTokenExpiration](#OAuthAccessTokenExpiration) | The lifetime of the access token. | | [OAuthAuthorizationTokenType](#OAuthAuthorizationTokenType) | The type of access token returned. | | [OAuthAutomaticRefresh](#OAuthAutomaticRefresh) | Whether or not to refresh an expired access token automatically. | | [OAuthBrowserResponseTimeout](#OAuthBrowserResponseTimeout) | Specifies the amount of time to wait for a response from the browser. | | [OAuthIncludeEmptyRedirectURI](#OAuthIncludeEmptyRedirectURI) | Whether an empty redirect_uri parameter is included in requests. | | [OAuthJWTPayload](#OAuthJWTPayload) | The payload of the JWT access token if present. | | [OAuthJWTXChildCount](#OAuthJWTXChildCount) | The number of child elements of the current element. | | [OauthJWTXChildName\[i\]](#OauthJWTXChildName[i]) | The name of the child element. | | [OAuthJWTXChildXText\[i\]](#OAuthJWTXChildXText[i]) | The inner text of the child element. | | [OAuthJWTXElement](#OAuthJWTXElement) | The name of the current element. | | [OauthJWTXParent](#OauthJWTXParent) | The parent of the current element. | | [OAuthJWTXPath](#OAuthJWTXPath) | Provides a way to point to a specific element in the returned payload of a JWT based access token. | | [OAuthJWTXSubTree](#OAuthJWTXSubTree) | A snapshot of the current element in the document. | | [OAuthJWTXText](#OAuthJWTXText) | The text of the current element. | | [OAuthParamCount](#OAuthParamCount) | Specifies the number of additional parameters variables to include in the request. | | [OAuthParamName\[i\]](#OAuthParamName[i]) | Specifies the parameter name at the specified index. | | [OAuthParamValue\[i\]](#OAuthParamValue[i]) | Specifies the parameter value at the specified index. | | [OAuthPasswordGrantUsername](#OAuthPasswordGrantUsername) | Used in the Resource Owner Password grant type. | | [OAuthPKCEChallengeEncoding](#OAuthPKCEChallengeEncoding) | The PKCE code challenge method to use. | | [OAuthPKCEVerifier](#OAuthPKCEVerifier) | The PKCE verifier used to generate the challenge. | | [OAuthResetData](#OAuthResetData) | Determines if the Reset method applies to the OAuth settings. | | [OAuthReUseWebServer](#OAuthReUseWebServer) | Determines if the same server instance is used between requests. | | [OAuthTransferredRequest](#OAuthTransferredRequest) | The full OAuth request last sent by the client. | | [OAuthUsePKCE](#OAuthUsePKCE) | Specifies if PKCE should be used. | | [OAuthWebServerActive](#OAuthWebServerActive) | Specifies and controls whether the embedded web server is active. | | [OAuthWebServerCertStore](#OAuthWebServerCertStore) | The certificate with private key to use when SSL is enabled. | | [OAuthWebServerCertStorePassword](#OAuthWebServerCertStorePassword) | The certificate with private key to use when SSL is enabled. | | [OAuthWebServerCertStoreType](#OAuthWebServerCertStoreType) | The certificate with private key to use when SSL is enabled. | | [OAuthWebServerCertSubject](#OAuthWebServerCertSubject) | The certificate with private key to use when SSL is enabled. | | [OAuthWebServerFailedResponse](#OAuthWebServerFailedResponse) | The custom response that will be displayed to the user if authentication failed. | | [OAuthWebServerHost](#OAuthWebServerHost) | The hostname used by the embedded web server displayed in the ReturnURL. | | [OAuthWebServerPort](#OAuthWebServerPort) | The local port on which the embedded web server listens. | | [OAuthWebServerResponse](#OAuthWebServerResponse) | The custom response that will be displayed to the user. | | [OAuthWebServerSSLEnabled](#OAuthWebServerSSLEnabled) | Whether the web server requires SSL connections. | | [AcceptEncoding](#AcceptEncoding) | Used to tell the server which types of content encodings the client supports. | | [AllowHTTPCompression](#AllowHTTPCompression) | This property enables HTTP compression for receiving data. | | [AllowHTTPFallback](#AllowHTTPFallback) | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. | | [AllowNTLMFallback](#AllowNTLMFallback) | Whether to allow fallback from Negotiate to NTLM when authenticating. | | [Append](#Append) | Whether to append data to LocalFile. | | [Authorization](#Authorization) | The Authorization string to be sent to the server. | | [BytesTransferred](#BytesTransferred) | Contains the number of bytes transferred in the response data. | | [ChunkSize](#ChunkSize) | Specifies the chunk size in bytes when using chunked encoding. | | [CompressHTTPRequest](#CompressHTTPRequest) | Set to true to compress the body of a PUT or POST request. | | [EncodeURL](#EncodeURL) | If set to True the URL will be encoded by the class. | | [FollowRedirects](#FollowRedirects) | Determines what happens when the server issues a redirect. | | [GetOn302Redirect](#GetOn302Redirect) | If set to True the class will perform a GET on the new location. | | [HTTP2HeadersWithoutIndexing](#HTTP2HeadersWithoutIndexing) | HTTP2 headers that should not update the dynamic header table with incremental indexing. | | [HTTPVersion](#HTTPVersion) | The version of HTTP used by the class. | | [IfModifiedSince](#IfModifiedSince) | A date determining the maximum age of the desired document. | | [KeepAlive](#KeepAlive) | Determines whether the HTTP connection is closed after completion of the request. | | [KerberosSPN](#KerberosSPN) | The Service Principal Name for the Kerberos Domain Controller. | | [LogLevel](#LogLevel) | The level of detail that is logged. | | [MaxHeaders](#MaxHeaders) | Instructs class to save the amount of headers specified that are returned by the server after a Header event has been fired. | | [MaxHTTPCookies](#MaxHTTPCookies) | Instructs class to save the amount of cookies specified that are returned by the server when a SetCookie event is fired. | | [MaxRedirectAttempts](#MaxRedirectAttempts) | Limits the number of redirects that are followed in a request. | | [NegotiatedHTTPVersion](#NegotiatedHTTPVersion) | The negotiated HTTP version. | | [OtherHeaders](#OtherHeaders) | Other headers as determined by the user (optional). | | [ProxyAuthorization](#ProxyAuthorization) | The authorization string to be sent to the proxy server. | | [ProxyAuthScheme](#ProxyAuthScheme) | The authorization scheme to be used for the proxy. | | [ProxyPassword](#ProxyPassword) | A password if authentication is to be used for the proxy. | | [ProxyPort](#ProxyPort) | Port for the proxy server (default 80). | | [ProxyServer](#ProxyServer) | Name or IP address of a proxy server (optional). | | [ProxyUser](#ProxyUser) | A user name if authentication is to be used for the proxy. | | [SentHeaders](#SentHeaders) | The full set of headers as sent by the client. | | [StatusCode](#StatusCode) | The status code of the last response from the server. | | [StatusLine](#StatusLine) | The first line of the last response from the server. | | [TransferredData](#TransferredData) | The contents of the last response from the server. | | [TransferredDataLimit](#TransferredDataLimit) | The maximum number of incoming bytes to be stored by the class. | | [TransferredHeaders](#TransferredHeaders) | The full set of headers as received from the server. | | [TransferredRequest](#TransferredRequest) | The full request as sent by the client. | | [UseChunkedEncoding](#UseChunkedEncoding) | Enables or Disables HTTP chunked encoding for transfers. | | [UseIDNs](#UseIDNs) | Whether to encode hostnames to internationalized domain names. | | [UsePlatformDeflate](#UsePlatformDeflate) | Whether to use the platform implementation to decompress compressed responses. | | [UsePlatformHTTPClient](#UsePlatformHTTPClient) | Whether or not to use the platform HTTP client. | | [UseProxyAutoConfigURL](#UseProxyAutoConfigURL) | Whether to use a Proxy auto-config file when attempting a connection. | | [UserAgent](#UserAgent) | Information about the user agent (browser). | | [CloseStreamAfterTransfer](#CloseStreamAfterTransfer) | If true, the class will close the upload or download stream after the transfer. | | [ConnectionTimeout](#ConnectionTimeout) | Sets a separate timeout value for establishing a connection. | | [FirewallAutoDetect](#FirewallAutoDetect) | Tells the class whether or not to automatically detect and use firewall system settings, if available. | | [FirewallHost](#FirewallHost) | Name or IP address of firewall (optional). | | [FirewallHTTPVersion](#FirewallHTTPVersion) | The HTTP version to be used when connecting through a tunneling proxy. | | [FirewallListener](#FirewallListener) | If true, the class binds to a SOCKS firewall as a server (TCPClient only). | | [FirewallPassword](#FirewallPassword) | Password to be used if authentication is to be used when connecting through the firewall. | | [FirewallPort](#FirewallPort) | The TCP port for the FirewallHost;. | | [FirewallType](#FirewallType) | Determines the type of firewall to connect through. | | [FirewallUser](#FirewallUser) | A user name if authentication is to be used connecting through a firewall. | | [KeepAliveInterval](#KeepAliveInterval) | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. | | [KeepAliveTime](#KeepAliveTime) | The inactivity time in milliseconds before a TCP keep-alive packet is sent. | | [Linger](#Linger) | When set to True, connections are terminated gracefully. | | [LingerTime](#LingerTime) | Time in seconds to have the connection linger. | | [LocalHost](#LocalHost) | The name of the local host through which connections are initiated or accepted. | | [LocalPort](#LocalPort) | The port in the local host where the class binds. | | [MaxLineLength](#MaxLineLength) | The maximum amount of data to accumulate when no EOL is found. | | [MaxTransferRate](#MaxTransferRate) | The transfer rate limit in bytes per second. | | [ProxyExceptionsList](#ProxyExceptionsList) | A semicolon separated list of hosts and IPs to bypass when using a proxy. | | [TCPKeepAlive](#TCPKeepAlive) | Determines whether or not the keep alive socket option is enabled. | | [TcpNoDelay](#TcpNoDelay) | Whether or not to delay when sending packets. | | [UseIPv6](#UseIPv6) | Whether to use IPv6. | | [UseNTLMv2](#UseNTLMv2) | Whether to use NTLM V2. | | [LogSSLPackets](#LogSSLPackets) | Controls whether SSL packets are logged when using the internal security API. | | [ReuseSSLSession](#ReuseSSLSession) | Determines if the SSL session is reused. | | [SSLCACerts](#SSLCACerts) | A newline separated list of CA certificates to be included when performing an SSL handshake. | | [SSLCheckCRL](#SSLCheckCRL) | Whether to check the Certificate Revocation List for the server certificate. | | [SSLCheckOCSP](#SSLCheckOCSP) | Whether to use OCSP to check the status of the server certificate. | | [SSLCipherStrength](#SSLCipherStrength) | The minimum cipher strength used for bulk encryption. | | [SSLClientCACerts](#SSLClientCACerts) | A newline separated list of CA certificates to use during SSL client certificate validation. | | [SSLContextProtocol](#SSLContextProtocol) | The protocol used when getting an SSLContext instance. | | [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) | The cipher suite to be used in an SSL negotiation. | | [SSLEnabledProtocols](#SSLEnabledProtocols) | Used to enable/disable the supported security protocols. | | [SSLEnableRenegotiation](#SSLEnableRenegotiation) | Whether the renegotiation_info SSL extension is supported. | | [SSLIncludeCertChain](#SSLIncludeCertChain) | Whether the entire certificate chain is included in the SSLServerAuthentication event. | | [SSLKeyLogFile](#SSLKeyLogFile) | The location of a file where per-session secrets are written for debugging purposes. | | [SSLNegotiatedCipher](#SSLNegotiatedCipher) | Returns the negotiated cipher suite. | | [SSLNegotiatedCipherStrength](#SSLNegotiatedCipherStrength) | Returns the negotiated cipher suite strength. | | [SSLNegotiatedCipherSuite](#SSLNegotiatedCipherSuite) | Returns the negotiated cipher suite. | | [SSLNegotiatedKeyExchange](#SSLNegotiatedKeyExchange) | Returns the negotiated key exchange algorithm. | | [SSLNegotiatedKeyExchangeStrength](#SSLNegotiatedKeyExchangeStrength) | Returns the negotiated key exchange algorithm strength. | | [SSLNegotiatedVersion](#SSLNegotiatedVersion) | Returns the negotiated protocol version. | | [SSLServerCACerts](#SSLServerCACerts) | A newline separated list of CA certificates to use during SSL server certificate validation. | | [SSLTrustManagerFactoryAlgorithm](#SSLTrustManagerFactoryAlgorithm) | The algorithm to be used to create a TrustManager through TrustManagerFactory. | | [TLS12SignatureAlgorithms](#TLS12SignatureAlgorithms) | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. | | [TLS12SupportedGroups](#TLS12SupportedGroups) | The supported groups for ECC. | | [TLS13KeyShareGroups](#TLS13KeyShareGroups) | The groups for which to pregenerate key shares. | | [TLS13SignatureAlgorithms](#TLS13SignatureAlgorithms) | The allowed certificate signature algorithms. | | [TLS13SupportedGroups](#TLS13SupportedGroups) | The supported groups for (EC)DHE key exchange. | | [AbsoluteTimeout](#AbsoluteTimeout) | Determines whether timeouts are inactivity timeouts or absolute timeouts. | | [FirewallData](#FirewallData) | Used to send extra data to the firewall. | | [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. | | [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. | | [BuildInfo](#BuildInfo) | Information about the product's build. | | [GUIAvailable](#GUIAvailable) | Whether or not a message loop is available for processing events. | | [LicenseInfo](#LicenseInfo) | Information about the current license. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. | | [UseDaemonThreads](#UseDaemonThreads) | Whether threads created by the class are daemon threads. | | [UseFIPSCompliantAPI](#UseFIPSCompliantAPI) | Tells the class whether or not to use FIPS certified APIs. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | | [UseVirtualThreads](#UseVirtualThreads) | Whether threads created by the class use virtual threads instead of platform threads. | # Account Property ([CloudFiles](#cloudfiles-class) Class) Account credentials. ## Syntax ```text public CloudFilesAccount getAccount(); public void setAccount(CloudFilesAccount account); ``` ## Remarks This property holds account credentials for the storage service provider. It is only applicable for providers which do not use OAuth for authentication (or that do use OAuth, but require additional configuration). Please refer to the [CloudFilesAccount](#cloudfilesaccount-type) type for a complete list of fields. # Authorization Property ([CloudFiles](#cloudfiles-class) Class) The OAuth 2.0 authorization token. ## Syntax ```text public String getAuthorization(); public void setAuthorization(String authorization); ``` ## Default Value "" ## Remarks This property is used to specify the OAuth 2.0 authorization token that was obtained as a result of performing OAuth. A valid OAuth token will come in the following format: ```text Bearer ACCESS_TOKEN ``` The *ACCESS_TOKEN* segment must be supplied to this property before attempting any other operations. Consult the documentation for the service for more information about supported scope values and more details on performing OAuth. # DirList Property ([CloudFiles](#cloudfiles-class) Class) Collection of entries resulting in the last directory listing. ## Syntax ```text public CFDirEntryList getDirList(); ``` ## Remarks This property contains a collection of entries after calling [ListDirectory](#listdirectory-method-cloudfiles-class). The collection holds details about each entry at [RemotePath](#remotepath-property-cloudfiles-class). This property is read-only and not available at design time. Please refer to the [CFDirEntry](#cfdirentry-type) type for a complete list of fields. # EncryptionAlgorithm Property ([CloudFiles](#cloudfiles-class) Class) The encryption algorithm. ## Syntax ```text public int getEncryptionAlgorithm(); public void setEncryptionAlgorithm(int encryptionAlgorithm); Enumerated values: public final static int eaAES = 0; public final static int eaBlowfish = 1; public final static int eaCAST = 2; public final static int eaDES = 3; public final static int eaIDEA = 4; public final static int eaRC2 = 5; public final static int eaRC4 = 6; public final static int eaTEA = 7; public final static int eaTripleDES = 8; public final static int eaTwofish = 9; public final static int eaRijndael = 10; public final static int eaChaCha = 11; public final static int eaXSalsa20 = 12; ``` ## Default Value 0 ## Remarks This property specifies the encryption algorithm to be used. The maximum allowable key size is automatically used for the selected algorithm. Possible values are: | Algorithm | Key Size | | --- | --- | | 0 (eaAES - default) | 256 | | 1 (eaBlowfish) | 448 | | 2 (eaCAST) | 128 | | 3 (eaDES) | 64 | | 4 (eaIDEA) | 128 | | 5 (eaRC2) | 128 | | 6 (eaRC4) | 2048 | | 7 (eaTEA) | 128 | | 8 (eaTripleDES) | 192 | | 9 (eaTwofish) | 256 | | 10 (eaRijndael) | 256 | | 11 (eaChaCha) | 256 | | 12 (eaXSalsa20) | 256 | # EncryptionPassword Property ([CloudFiles](#cloudfiles-class) Class) The encryption password. ## Syntax ```text public String getEncryptionPassword(); public void setEncryptionPassword(String encryptionPassword); ``` ## Default Value "" ## Remarks If this property is populated when UploadFile or DownloadFile is called, the class will attempt to encrypt or decrypt the data before uploading or after downloading it. The class uses the value specified here to generate the necessary encryption Key and IV values using the PKCS5 password digest algorithm. This provides a simpler alternative to creating and managing Key and IV values directly. However, it is also possible to explicitly specify the Key and IV values to use by setting the [EncryptionKey](#EncryptionKey) and [EncryptionIV](#EncryptionIV) configuration settings. This may be necessary if, e.g., the data needs to be encrypted/decrypted by another utility which generates Key and IV values differently. This property is not available at design time. # Firewall Property ([CloudFiles](#cloudfiles-class) Class) A set of properties related to firewall access. ## Syntax ```text public Firewall getFirewall(); public void setFirewall(Firewall firewall); ``` ## Remarks This is a [Firewall](#firewall-type)-type property, which contains fields describing the firewall through which the class will attempt to connect. Please refer to the [Firewall](#firewall-type) type for a complete list of fields. # Idle Property ([CloudFiles](#cloudfiles-class) Class) The current status of the class. ## Syntax ```text public boolean isIdle(); ``` ## Default Value True ## Remarks This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times. This property is read-only. # LocalFile Property ([CloudFiles](#cloudfiles-class) Class) The location of the local file. ## Syntax ```text public String getLocalFile(); public void setLocalFile(String localFile); ``` ## Default Value "" ## Remarks This property specifies the location of a file on disk. This is used as the source file when calling [Upload](#upload-method-cloudfiles-class), and as the destination file when calling [Download](#download-method-cloudfiles-class). Note: Setting this property to a non-empty value will discard any streams set using [SetDownloadStream](#setdownloadstream-method-cloudfiles-class) and [SetUploadStream](#setuploadstream-method-cloudfiles-class). Similarly, passing a non-null value to either of the aforementioned methods will clear this property. # LocalHost Property ([CloudFiles](#cloudfiles-class) Class) The name of the local host or user-assigned IP interface through which connections are initiated or accepted. ## Syntax ```text public String getLocalHost(); public void setLocalHost(String localHost); ``` ## Default Value "" ## Remarks This property 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 IP address of an interface will make the class initiate connections (or accept in the case of server classes) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used. If the class is connected, the LocalHost property 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). NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window. # OAuth Property ([CloudFiles](#cloudfiles-class) Class) The OAuth settings. ## Syntax ```text public OAuthSettings getOAuth(); ``` ## Remarks This property is used to configure the necessary fields to authenticate with the service provider. See the introduction for more information. This property is read-only and not available at design time. Please refer to the [OAuthSettings](#oauthsettings-type) type for a complete list of fields. # Overwrite Property ([CloudFiles](#cloudfiles-class) Class) Whether to overwrite the local or remote file. ## Syntax ```text public boolean isOverwrite(); public void setOverwrite(boolean overwrite); ``` ## Default Value False ## Remarks When calling DownloadFile, this property determines if [LocalFile](#localfile-property-cloudfiles-class) should be overwritten if it already exists. When calling UploadFile, this property determines if the remote file should be overwritten if it already exists. # Proxy Property ([CloudFiles](#cloudfiles-class) Class) A set of properties related to proxy access. ## Syntax ```text public Proxy getProxy(); public void setProxy(Proxy proxy); ``` ## Remarks This property contains fields describing the proxy through which the class will attempt to connect. Please refer to the [Proxy](#proxy-type) type for a complete list of fields. # RemoteFile Property ([CloudFiles](#cloudfiles-class) Class) The name of the remote file. ## Syntax ```text public String getRemoteFile(); public void setRemoteFile(String remoteFile); ``` ## Default Value "" ## Remarks This property contains the name of the remote file to upload or download. This value is either an absolute or relative path based on [RemotePath](#remotepath-property-cloudfiles-class). **Example (Setting RemoteFile)** ```text component.LocalFile = "C:\\test.txt"; component.RemoteFile = "test.txt"; component.Upload(); component.LocalFile = "C:\\test.txt"; component.RemoteFile = "/MyFolder/SubFolder/file.txt"; component.Upload(); ``` Note: This property will also act as a file mask when calling [ListDirectory](#listdirectory-method-cloudfiles-class). **Example (Using RemoteFile as a file mask):** ```text component.RemoteFile = "*.txt" component.ListDirectory() ``` 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. # RemotePath Property ([CloudFiles](#cloudfiles-class) Class) The current path on the server. ## Syntax ```text public String getRemotePath(); public void setRemotePath(String remotePath); ``` ## Default Value "" ## Remarks This property shows the current working directory on the server. It can also be used to change the working directory by setting an absolute or relative path. If the path begins with a "/" it is considered an absolute path. If the first two characters of the path are ".." this indicates a change to the parent directory. **Example (Changing Directory)** ```text component.RemotePath = "/MyFolder/Child"; //absolute component.RemotePath = "GrandChild"; //relative, change to a sub-folder of the current directory component.RemotePath = "../.."; //relative, use ".." to navigate to parent folders ``` # ServiceProvider Property ([CloudFiles](#cloudfiles-class) Class) The storage service provider. ## Syntax ```text public int getServiceProvider(); public void setServiceProvider(int serviceProvider); Enumerated values: public final static int cspAmazonS3 = 0; public final static int cspBox = 1; public final static int cspDropbox = 2; public final static int cspGoogleDrive = 3; public final static int cspOneDrive = 4; public final static int cspSharePoint = 5; public final static int cspAzureBlob = 6; public final static int cspWasabi = 7; public final static int cspDigitalOcean = 8; public final static int cspGoogleStorage = 9; public final static int cspHadoopDFS = 10; public final static int cspAzureFile = 11; public final static int cspBackblazeB2 = 12; public final static int cspIBMStorage = 13; public final static int cspLinode = 14; ``` ## Default Value 0 ## Remarks This property specifies the storage service provider which will be used. It is important to note that the ServiceProvider property must be set before setting any configuration settings through the [Config](#config-method-cloudfiles-class) method. Possible values are: - *cspAmazonS3 (0)* (default): Amazon S3 - *cspBox (1)*: Box.com - *cspDropbox (2)*: Dropbox - *cspGoogleDrive (3)*: Google Drive - *cspOneDrive (4)*: Microsoft OneDrive - *cspSharePoint (5)*: Microsoft SharePoint - *cspAzureBlob (6)*: Azure Blob - *cspWasabi (7)*: Wasabi - *cspDigitalOcean (8)*: Digital Ocean Spaces - *cspGoogleStorage (9)*: Google Cloud Storage - *cspHadoopDFS (10)*: Hadoop DFS - *cspAzureFile (11)*: Azure File - *cspBackblazeB2 (12)*: Backblaze B2 - *cspIBMStorage (13)*: IBM Cloud Object Storage - *cspLinode (14)*: Linode Object Storage This property is not available at design time. # SSLAcceptServerCert Property ([CloudFiles](#cloudfiles-class) Class) Instructs the class to unconditionally accept the server certificate that matches the supplied certificate. ## Syntax ```text public Certificate getSSLAcceptServerCert(); public void setSSLAcceptServerCert(Certificate SSLAcceptServerCert); ``` ## Remarks If it finds any issues with the certificate presented by the server, the class 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. NOTE: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # SSLCert Property ([CloudFiles](#cloudfiles-class) Class) The certificate to be used during Secure Sockets Layer (SSL) negotiation. ## Syntax ```text public Certificate getSSLCert(); public void setSSLCert(Certificate SSLCert); ``` ## Remarks This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the [Encoded](#Certificate_f_Encoded) field to the encoded certificate. To select a certificate, use the store and subject fields. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # SSLProvider Property ([CloudFiles](#cloudfiles-class) Class) The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. ## Syntax ```text public int getSSLProvider(); public void setSSLProvider(int SSLProvider); Enumerated values: public final static int sslpAutomatic = 0; public final static int sslpPlatform = 1; public final static int sslpInternal = 2; ``` ## Default Value 0 ## Remarks This property specifies the SSL/TLS implementation to use. In most cases the default value of *0* (Automatic) is recommended and should not be changed. When set to *0* (Automatic), the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used. Possible values are as follows: | | | | --- | --- | | 0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. | | 1 (sslpPlatform) | Uses the platform/system implementation. | | 2 (sslpInternal) | Uses the internal implementation. | **Additional Notes** In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform. When Automatic is selected, the platform implementation is used by default. When TLS 1.3 is enabled via [SSLEnabledProtocols](#SSLEnabledProtocols), the class will always try and use the platform implementation. If the platform TLS 1.3 implementation is not available, the internal implementation will be used. # SSLServerCert Property ([CloudFiles](#cloudfiles-class) Class) The server certificate for the last established connection. ## Syntax ```text public Certificate getSSLServerCert(); ``` ## Remarks This property contains the server certificate for the last established connection. SSLServerCert is reset every time a new connection is attempted. This property is read-only. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # StartByte Property ([CloudFiles](#cloudfiles-class) Class) The byte offset from which to start download. ## Syntax ```text public long getStartByte(); public void setStartByte(long startByte); ``` ## Default Value 0 ## Remarks This property may be set to resume a download. This specifies the offset in the file from which to resume. See [Download](#download-method-cloudfiles-class) for details about resuming downloads. Note: Resuming uploads is not currently supported. This property is not available at design time. # Timeout Property ([CloudFiles](#cloudfiles-class) Class) The timeout for the class. ## Syntax ```text public int getTimeout(); public void setTimeout(int timeout); ``` ## Default Value 60 ## Remarks 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 class will wait for the operation to complete before returning control. The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive. If Timeout expires, and the operation is not yet complete, the class throws an exception. NOTE: By default, all timeouts are *inactivity timeouts*, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received. The default value for the Timeout property is 60 seconds. # Authorize Method ([CloudFiles](#cloudfiles-class) Class) Get the authorization string required to access the protected resource. ## Syntax ```text public void authorize(); ``` ## Remarks This method is used to get an access token that is required to access the protected resource. The method will act differently based on what is set in the [ClientProfile](#OAuthSettings_f_ClientProfile) field and the [GrantType](#OAuthSettings_f_GrantType) field. This method is **not** to be used in conjunction with the [Authorization](#authorization-property-cloudfiles-class) property. It should instead be used when setting the [OAuth](#oauth-property-cloudfiles-class) property. This method is only applicable when [ServiceProvider](#serviceprovider-property-cloudfiles-class) is set to an OAuth-capable provider (Box, Dropbox, GoogleDrive, GoogleStorage, OneDrive, SharePoint, AzureBlob, or AzureFile). For all other providers it has no effect. # Config Method ([CloudFiles](#cloudfiles-class) Class) Sets or retrieves a configuration setting. ## Syntax ```text public String config(String configurationString); ``` ## Remarks Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-cloudfiles-class) for the class. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the Config method. To set a configuration setting named *PROPERTY*, you must call *Config("PROPERTY=VALUE")*, where *VALUE* is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter). To read (query) the value of a [configuration setting](#config-settings-cloudfiles-class), you must call *Config("PROPERTY")*. The value will be returned as a string. # CopyFile Method ([CloudFiles](#cloudfiles-class) Class) Copies the file. ## Syntax ```text public void copyFile(String newFilePath); ``` ## Remarks This method copies an existing file on the server to the location specified by *NewFilePath*. *NewFilePath* may be either an absolute path or a path relative to [RemotePath](#remotepath-property-cloudfiles-class). Note: CopyFile is not supported when [ServiceProvider](#serviceprovider-property-cloudfiles-class) is set to *cspHadoopDFS (10)*. # DeleteFile Method ([CloudFiles](#cloudfiles-class) Class) Remove a file specified by FileName from the server. ## Syntax ```text public void deleteFile(String fileName); ``` ## Remarks This method deletes the files specified by the *FileName* parameter from the server. *FileName* may be either an absolute path, or a path relative to [RemotePath](#remotepath-property-cloudfiles-class). # Download Method ([CloudFiles](#cloudfiles-class) Class) Download the specified file. ## Syntax ```text public void download(); ``` ## Remarks This method downloads the specified file. Set [RemoteFile](#remotefile-property-cloudfiles-class) to the name the file to download before calling this method. If [RemoteFile](#remotefile-property-cloudfiles-class) only specifies a filename it will be downloaded from the path specified by [RemotePath](#remotepath-property-cloudfiles-class). [RemoteFile](#remotefile-property-cloudfiles-class) may also be set to an absolute path. The file will be downloaded to the stream specified (if any) by [SetDownloadStream](#setdownloadstream-method-cloudfiles-class). If a stream is not specified and [LocalFile](#localfile-property-cloudfiles-class) is set the file will be saved to the specified location. If a stream is not specified and [LocalFile](#localfile-property-cloudfiles-class) is not set the file data will be held by ResourceData. To decrypt an encrypted file set [EncryptionAlgorithm](#encryptionalgorithm-property-cloudfiles-class) and [EncryptionPassword](#encryptionpassword-property-cloudfiles-class) before calling this method. ```text cloudfiles.RemotePath = "My Folder"; cloudfiles.RemoteFile = "MyFile.zip"; cloudfiles.LocalFile = "../MyFile.zip"; cloudfiles.Download(); ``` **Resuming Downloads** The class also supports resuming failed downloads by using the [StartByte](#startbyte-property-cloudfiles-class) property. If the download was interrupted, set [StartByte](#startbyte-property-cloudfiles-class) to the appropriate offset before calling this method to resume the download. ```text cloudfiles.RemotePath = myRemoteFolder; cloudfiles.RemoteFile = myRemoteFile; cloudfiles.LocalFile = downloadFile; cloudfiles.Download(); //The transfer is interrupted and Download() above fails. Later, resume the download: //Get the size of the partially downloaded file cloudfiles.StartByte = new FileInfo(downloadFile).Length; cloudfiles.RemotePath = myRemoteFolder; cloudfiles.RemoteFile = myRemoteFile; cloudfiles.LocalFile = downloadFile; cloudfiles.Download(); ``` **Resuming Encrypted File Downloads** Resuming encrypted file downloads is only supported when [LocalFile](#localfile-property-cloudfiles-class) was set in the initial download attempt. When beginning an encrypted download if [LocalFile](#localfile-property-cloudfiles-class) is set the class will create a temporary file in [TempPath](#TempPath) to hold the encrypted data until it is complete. If the download is interrupted [DownloadTempFile](#DownloadTempFile) will be populated with the temporary file holding the partial data. When resuming, [DownloadTempFile](#DownloadTempFile) must be populated along with [StartByte](#startbyte-property-cloudfiles-class) to allow the remainder of the encrypted data to be downloaded. Once the encrypted data is downloaded it will be decrypted and written to [LocalFile](#localfile-property-cloudfiles-class). ```text cloudfiles.RemotePath = myRemoteFolder; cloudfiles.RemoteFile = myRemoteFile; cloudfiles.LocalFile = downloadFile; cloudfiles.EncryptionPassword = "password"; cloudfiles.Download(); //The transfer is interrupted and Download() above fails. Later, resume the download: //Get the size of the partially download temp file cloudfiles.StartByte = new FileInfo(cloudfiles.Config("DownloadTempFile")).Length; cloudfiles.RemotePath = myRemoteFolder; cloudfiles.RemoteFile = myRemoteFile; cloudfiles.LocalFile = downloadFile; cloudfiles.EncryptionPassword = "password"; cloudfiles.Download(); ``` # Interrupt Method ([CloudFiles](#cloudfiles-class) Class) This method interrupts the current method. ## Syntax ```text public void interrupt(); ``` ## Remarks If there is no method in progress, Interrupt simply returns, doing nothing. # ListDirectory Method ([CloudFiles](#cloudfiles-class) Class) Lists the current directory specified by RemotePath on the server. ## Syntax ```text public void listDirectory(); ``` ## Remarks This method is used to list the directory specified by [RemotePath](#remotepath-property-cloudfiles-class). The directory entries are provided through the [DirList](#dirlist-event-cloudfiles-class) event and also via the [DirList](#dirlist-property-cloudfiles-class) property. ```text cloudfiles.RemoteFile = ""; //Clear filemask cloudfiles.RemotePath = "MyFolder"; cloudfiles.ListDirectory(); for (int i = 0; i < cloudfiles.DirList.Count; i++) { Console.WriteLine(cloudfiles.DirList[i].FileName); Console.WriteLine(cloudfiles.DirList[i].FileSize); Console.WriteLine(cloudfiles.DirList[i].FileTime); Console.WriteLine(cloudfiles.DirList[i].IsDir); } ``` The [RemoteFile](#remotefile-property-cloudfiles-class) property may also be used as a filemask when listing files. For instance: ```text component.RemoteFile = "*.txt" component.ListDirectory() ``` Note: Since [RemoteFile](#remotefile-property-cloudfiles-class) is used as a filemask be sure to clear or reset this value before calling ListDirectory # MakeDirectory Method ([CloudFiles](#cloudfiles-class) Class) Creates a directory on the server. ## Syntax ```text public void makeDirectory(String newDir); ``` ## Remarks This method is used to create a directory. The parameter *NewDir* specifies the name of the directory. *NewDir* may be either an absolute path, or a path relative to [RemotePath](#remotepath-property-cloudfiles-class). Note: After creating a directory [RemoteFile](#remotefile-property-cloudfiles-class) will be updated with the newly created directory name. # RemoveDirectory Method ([CloudFiles](#cloudfiles-class) Class) Remove the specified directory. ## Syntax ```text public void removeDirectory(String dirName); ``` ## Remarks This method removes the directory specified by the *DirName* parameter. *DirName* may be either an absolute path, or a path relative to [RemotePath](#remotepath-property-cloudfiles-class). Note: The directory and all of its contents will be deleted when calling this method. (With the exception of non-root-level directories for the *cspAzureFile (11)* [ServiceProvider](#serviceprovider-property-cloudfiles-class); such directories can only be deleted if they are empty.) # RenameFile Method ([CloudFiles](#cloudfiles-class) Class) Renames the file. ## Syntax ```text public void renameFile(String newName); ``` ## Remarks This method renames an existing file on the server. The *NewName* parameter specifies the new name of the file. ```text cloudfiles.RemotePath = "/MyFolder"; cloudfiles.RemoteFile = "file.txt"; cloudfiles.RenameFile("newfile.txt"); ``` Note: RenameFile is not supported when [ServiceProvider](#serviceprovider-property-cloudfiles-class) is set to one of the following: - *cspAmazonS3 (0)* - *cspAzureBlob (6)* - *cspDigitalOcean (8)* - *cspGoogleStorage (9)* - *cspBackblazeB2 (12)* - *cspIBMStorage (13)* - *cspLinode (14)* # Reset Method ([CloudFiles](#cloudfiles-class) Class) Resets the class to its initial state. ## Syntax ```text public void reset(); ``` ## Remarks This method resets the class to its initial state. # SetDownloadStream Method ([CloudFiles](#cloudfiles-class) Class) Sets the stream to which downloaded data will be written. ## Syntax ```text public void setDownloadStream(java.io.OutputStream downloadStream); ``` ## Remarks If a download stream is set before data is downloaded, the downloaded data will be written to the stream. The stream should be open and normally set to position 0. Note: Passing a non-null value for *DownloadStream* will cause [LocalFile](#localfile-property-cloudfiles-class) to be cleared. Similarly, setting [LocalFile](#localfile-property-cloudfiles-class) to a non-empty value will discard any stream set using this method. # SetUploadStream Method ([CloudFiles](#cloudfiles-class) Class) Sets the stream from which data is read when uploading. ## Syntax ```text public void setUploadStream(java.io.InputStream uploadStream); ``` ## Remarks If an upload stream is set before data is uploaded, the content of the stream will be read by the class and uploaded to the server. The stream should be open and normally set to position 0. Note: Passing a non-null value for *UploadStream* will cause [LocalFile](#localfile-property-cloudfiles-class) to be cleared. Similarly, setting [LocalFile](#localfile-property-cloudfiles-class) to a non-empty value will discard any stream set using this method. # Upload Method ([CloudFiles](#cloudfiles-class) Class) Uploads the file specified by LocalFile to the server. ## Syntax ```text public void upload(); ``` ## Remarks This method uploads the local file specified by [LocalFile](#localfile-property-cloudfiles-class) to the remote file specified by [RemoteFile](#remotefile-property-cloudfiles-class). If [SetUploadStream](#setuploadstream-method-cloudfiles-class) is used to set an upload stream the data to upload is taken from the stream instead. [RemoteFile](#remotefile-property-cloudfiles-class) should be set to either a relative or absolute path. If [RemoteFile](#remotefile-property-cloudfiles-class) is not an absolute path it will be uploaded relative to [RemotePath](#remotepath-property-cloudfiles-class). To encrypt a file before uploading set [EncryptionAlgorithm](#encryptionalgorithm-property-cloudfiles-class) and [EncryptionPassword](#encryptionpassword-property-cloudfiles-class). Note: Resuming uploads is not currently supported. **Code Example:** ```text //Upload with a relative path cloudfiles.LocalFile = "C:\localfile.txt" cloudfiles.RemoteFile = "remotefile.txt" cloudfiles.Upload() //Upload with an absolute path cloudfiles.LocalFile = "C:\localfile2.txt" cloudfiles.RemoteFile = "/folder/remotefile2.txt" cloudfiles.Upload() ``` # DirList Event ([CloudFiles](#cloudfiles-class) Class) Fired when a directory entry is received. ## Syntax ```text public class DefaultCloudFilesEventListener implements CloudFilesEventListener { ... public void dirList(CloudFilesDirListEvent e) {} ... } public class CloudFilesDirListEvent { public String fileName; public boolean isDir; public long fileSize; public String fileTime; } ``` ## Remarks This event fires once for each entry returned when [ListDirectory](#listdirectory-method-cloudfiles-class) is called. *FileName* holds the name of the file or folder. *IsDir* is *true* for directories and *false* for files. *FileSize* is the size of the file in bytes. For some providers this also applies directories and will return the size of all files and folders within the directory. The table below summarizes the applicability of this value on a per-provider basis: | Service Provider | Files | Directories | | --- | --- | --- | | cspAmazonS3 (0) | X | | | cspBox (1) | X | X | | cspDropbox (2) | X | | | cspGoogleDrive (3) | X | | | cspOneDrive (4) | X | X | | cspAzureBlob (6) | X | | | cspWasabi (7) | X | | | cspDigitalOcean (8) | X | | | cspGoogleStorage (9) | X | | | cspHadoopDFS (10) | X | | | cspAzureFile (11) | X | | | cspBackblazeB2 (12) | X | | | cspIBMStorage (13) | X | | | cspLinode (14) | X | | *FileTime* is the modified date of the file. By default the datetime format used is "yyyy-MM-dd'T'HH:mm:ss". To modify this format set [DateFormat](#DateFormat). Note: Modified times are not applicable to directories for the following providers: - *cspAmazonS3 (0)* - *cspDropbox (2)* - *cspWasabi (7)* - *cspDigitalOcean (8)* - *cspGoogleStorage (9)* - *cspBackblazeB2 (12)* - *cspIBMStorage (13)* - *cspLinode (14)* Additionally, the following providers do not return modified times at all: - *cspAzureFile (11)* # EndTransfer Event ([CloudFiles](#cloudfiles-class) Class) Fired when a document finishes transferring. ## Syntax ```text public class DefaultCloudFilesEventListener implements CloudFilesEventListener { ... public void endTransfer(CloudFilesEndTransferEvent e) {} ... } public class CloudFilesEndTransferEvent { public int direction; } ``` ## Remarks This event is fired first when the client finishes sending data to the server (in a *POST* or *PUT* request) and then when the document text finishes transferring from the server to the local host. The *Direction* parameter shows whether the client (0) or the server (1) is sending the data. # Error Event ([CloudFiles](#cloudfiles-class) Class) Fired when information is available about errors during data delivery. ## Syntax ```text public class DefaultCloudFilesEventListener implements CloudFilesEventListener { ... public void error(CloudFilesErrorEvent e) {} ... } public class CloudFilesErrorEvent { public int errorCode; public String description; } ``` ## Remarks The Error event is fired in case of exceptional conditions during message processing. Normally the class throws an exception. The *ErrorCode* parameter contains an error code, and the *Description* parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [Error Codes](#trappable-errors-cloudfiles-class) section. # Log Event ([CloudFiles](#cloudfiles-class) Class) Fired once for each log message. ## Syntax ```text public class DefaultCloudFilesEventListener implements CloudFilesEventListener { ... public void log(CloudFilesLogEvent e) {} ... } public class CloudFilesLogEvent { public int logLevel; public String message; public String logType; } ``` ## Remarks This event is fired once for each log message generated by the class. The verbosity is controlled by the [LogLevel](#LogLevel) setting. *LogLevel* indicates the level of message. Possible values are as follows: | | | | --- | --- | | 0 (None) | No events are logged. | | 1 (Info - default) | Informational events are logged. | | 2 (Verbose) | Detailed data are logged. | | 3 (Debug) | Debug data are logged. | The value 1 (Info) logs basic information, including the URL, HTTP version, and status details. The value 2 (Verbose) logs additional information about the request and response. The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any). *Message* is the log entry. *LogType* identifies the type of log entry. Possible values are as follows: - "Info" - "RequestHeaders" - "ResponseHeaders" - "RequestBody" - "ResponseBody" - "ProxyRequest" - "ProxyResponse" - "FirewallRequest" - "FirewallResponse" # Progress Event ([CloudFiles](#cloudfiles-class) Class) Fires during an upload or download to indicate transfer progress. ## Syntax ```text public class DefaultCloudFilesEventListener implements CloudFilesEventListener { ... public void progress(CloudFilesProgressEvent e) {} ... } public class CloudFilesProgressEvent { public int direction; public long bytesTransferred; public long totalBytes; public int percentDone; } ``` ## Remarks This event fires during an upload or download to indicate the progress of the transfer of the entire request. By default, this event will fire each time *PercentDone* increases by one percent; the [ProgressStep](#ProgressStep) configuration setting can be used to alter this behavior. *Direction* indicates whether the transfer is an upload (*0*) or a download (*1*). *BytesTransferred* reflects the number of bytes that have been transferred so far, or *0* if the transfer is starting (however, see note below). *TotalBytes* reflects the total number of bytes that are to be transferred, or *-1* if the total is unknown. This amount includes the size of everything in the request like HTTP headers. *PercentDone* reflects the overall progress of the transfer, or *-1* if the progress cannot be calculated. NOTE: By default, the class tracks transfer progress *absolutely*. If a transfer is interrupted and later resumed, the values reported by this event upon and after resumption will account for the data that was transferred *before* the interruption. For example, if 10MB of data was successfully transferred before the interruption, then this event will fire with a *BytesTransferred* value of *10485760* (10MB) when the transfer is first resumed, and then continue to fire with successively greater values as usual. This behavior can be changed by disabling the [ProgressAbsolute](#ProgressAbsolute) configuration setting, in which case the class will treat resumed transfers as "new" transfers. In this case, the *BytesTransferred* parameter will always be *0* the first time this event fires, regardless of whether the transfer is new or being resumed. # SSLServerAuthentication Event ([CloudFiles](#cloudfiles-class) Class) Fired after the server presents its certificate to the client. ## Syntax ```text public class DefaultCloudFilesEventListener implements CloudFilesEventListener { ... public void SSLServerAuthentication(CloudFilesSSLServerAuthenticationEvent e) {} ... } public class CloudFilesSSLServerAuthenticationEvent { public byte[] certEncoded; public String certSubject; public String certIssuer; public String status; public boolean accept; //read-write } ``` ## Remarks During this event, the client can decide whether or not to continue with the connection process. The *Accept* parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue. When *Accept* is False, *Status* shows why the verification failed (otherwise, *Status* contains the string *OK*). If it is decided to continue, you can override and accept the certificate by setting the *Accept* parameter to True. # SSLStatus Event ([CloudFiles](#cloudfiles-class) Class) Fired when secure connection progress messages are available. ## Syntax ```text public class DefaultCloudFilesEventListener implements CloudFilesEventListener { ... public void SSLStatus(CloudFilesSSLStatusEvent e) {} ... } public class CloudFilesSSLStatusEvent { public String message; } ``` ## Remarks The event is fired for informational and logging purposes only. This event tracks the progress of the connection. # StartTransfer Event ([CloudFiles](#cloudfiles-class) Class) Fired when a document starts transferring (after the headers). ## Syntax ```text public class DefaultCloudFilesEventListener implements CloudFilesEventListener { ... public void startTransfer(CloudFilesStartTransferEvent e) {} ... } public class CloudFilesStartTransferEvent { public int direction; } ``` ## Remarks This event is fired first when the client starts sending data to the server (in a *POST* or *PUT* request) and then when the document text starts transferring from the server to the local host. The *Direction* parameter shows whether the client (0) or the server (1) is sending the data. # Transfer Event ([CloudFiles](#cloudfiles-class) Class) Fired while a document transfers (delivers document). ## Syntax ```text public class DefaultCloudFilesEventListener implements CloudFilesEventListener { ... public void transfer(CloudFilesTransferEvent e) {} ... } public class CloudFilesTransferEvent { public int direction; public long bytesTransferred; public int percentDone; public byte[] text; } ``` ## Remarks The *Text* parameter contains the portion of the document text being received. It is empty if data are being posted to the server. The *BytesTransferred* parameter contains the number of bytes transferred in this *Direction* since the beginning of the document text (excluding HTTP response headers). The *Direction* parameter shows whether the client (0) or the server (1) is sending the data. The *PercentDone* parameter shows the progress of the transfer in the corresponding direction. If *PercentDone* can not be calculated the value will be -1. NOTE: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance. # Certificate Type This is 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. The following fields are available: - [EffectiveDate](#Certificate_f_EffectiveDate) - [ExpirationDate](#Certificate_f_ExpirationDate) - [ExtendedKeyUsage](#Certificate_f_ExtendedKeyUsage) - [Fingerprint](#Certificate_f_Fingerprint) - [FingerprintSHA1](#Certificate_f_FingerprintSHA1) - [FingerprintSHA256](#Certificate_f_FingerprintSHA256) - [Issuer](#Certificate_f_Issuer) - [KeyPassword](#Certificate_f_KeyPassword) - [PrivateKey](#Certificate_f_PrivateKey) - [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable) - [PrivateKeyContainer](#Certificate_f_PrivateKeyContainer) - [PublicKey](#Certificate_f_PublicKey) - [PublicKeyAlgorithm](#Certificate_f_PublicKeyAlgorithm) - [PublicKeyLength](#Certificate_f_PublicKeyLength) - [SerialNumber](#Certificate_f_SerialNumber) - [SignatureAlgorithm](#Certificate_f_SignatureAlgorithm) - [Store](#Certificate_f_Store) - [StorePassword](#Certificate_f_StorePassword) - [StoreType](#Certificate_f_StoreType) - [SubjectAltNames](#Certificate_f_SubjectAltNames) - [ThumbprintMD5](#Certificate_f_ThumbprintMD5) - [ThumbprintSHA1](#Certificate_f_ThumbprintSHA1) - [ThumbprintSHA256](#Certificate_f_ThumbprintSHA256) - [Usage](#Certificate_f_Usage) - [UsageFlags](#Certificate_f_UsageFlags) - [Version](#Certificate_f_Version) - [Subject](#Certificate_f_Subject) - [Encoded](#Certificate_f_Encoded) ## Fields **EffectiveDate** *String (read-only)* *Default Value: ""* The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. **ExpirationDate** *String (read-only)* *Default Value: ""* The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. **ExtendedKeyUsage** *String (read-only)* *Default Value: ""* A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). **Fingerprint** *String (read-only)* *Default Value: ""* The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* **FingerprintSHA1** *String (read-only)* *Default Value: ""* The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* **FingerprintSHA256** *String (read-only)* *Default Value: ""* The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* **Issuer** *String (read-only)* *Default Value: ""* The issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate. **KeyPassword** *String* *Default Value: ""* The password for the certificate's private key (if any). Some certificate stores may individually protect certificates' private keys, separate from the standard protection offered by the [StorePassword](#Certificate_f_StorePassword). This field can be used to read such password-protected private keys. NOTE: This property defaults to the value of [StorePassword](#Certificate_f_StorePassword). To clear it, you must set the property to the empty string (""). It can be set at any time, but when the private key's password is different from the store's password, then it must be set before calling [PrivateKey](#Certificate_f_PrivateKey). **PrivateKey** *String (read-only)* *Default Value: ""* The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [PrivateKey](#Certificate_f_PrivateKey) may be available but not exportable. In this case, [PrivateKey](#Certificate_f_PrivateKey) returns an empty string. **PrivateKeyAvailable** *boolean (read-only)* *Default Value: False* Whether a [PrivateKey](#Certificate_f_PrivateKey) is available for the selected certificate. If [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable) is True, the certificate may be used for authentication purposes (e.g., server authentication). **PrivateKeyContainer** *String (read-only)* *Default Value: ""* The name of the [PrivateKey](#Certificate_f_PrivateKey) container for the certificate (if available). This functionality is available only on Windows platforms. **PublicKey** *String (read-only)* *Default Value: ""* The public key of the certificate. The key is provided as PEM/Base64-encoded data. **PublicKeyAlgorithm** *String (read-only)* *Default Value: ""* The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. **PublicKeyLength** *int (read-only)* *Default Value: 0* The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. **SerialNumber** *String (read-only)* *Default Value: ""* The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. **SignatureAlgorithm** *String (read-only)* *Default Value: ""* The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. **Store** *String* *Default Value: "MY"* The name of the certificate store for the client certificate. The [StoreType](#Certificate_f_StoreType) field denotes the type of the certificate store specified by [Store](#Certificate_f_Store). If the store is password-protected, specify the password in [StorePassword](#Certificate_f_StorePassword). [Store](#Certificate_f_Store) is used in conjunction with the [Subject](#Certificate_f_Subject) field to specify client certificates. If [Store](#Certificate_f_Store) has a value, and [Subject](#Certificate_f_Subject) or [Encoded](#Certificate_f_Encoded) is set, a search for a certificate is initiated. Please see the [Subject](#Certificate_f_Subject) field for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | In Java, the certificate store normally is a file containing certificates and optional private keys. When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). **StoreB** *byte[]* *Default Value: "MY"* The name of the certificate store for the client certificate. The [StoreType](#Certificate_f_StoreType) field denotes the type of the certificate store specified by [Store](#Certificate_f_Store). If the store is password-protected, specify the password in [StorePassword](#Certificate_f_StorePassword). [Store](#Certificate_f_Store) is used in conjunction with the [Subject](#Certificate_f_Subject) field to specify client certificates. If [Store](#Certificate_f_Store) has a value, and [Subject](#Certificate_f_Subject) or [Encoded](#Certificate_f_Encoded) is set, a search for a certificate is initiated. Please see the [Subject](#Certificate_f_Subject) field for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | In Java, the certificate store normally is a file containing certificates and optional private keys. When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). **StorePassword** *String* *Default Value: ""* If the type of certificate store requires a password, this field is used to specify the password needed to open the certificate store. **StoreType** *int* *Default Value: 0* The type of certificate store for this certificate. The class supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the class will automatically determine the type. This field can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#certificate-type) object and pass cstPKCS11 as the [StoreType](#Certificate_f_StoreType), the full path of the PKCS#11 DLL as the [Store](#Certificate_f_Store), and the PIN as the [StorePassword](#Certificate_f_StorePassword). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the CertMgr class by calling the ListStoreCertificates method after setting the corresponding properties accordingly. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [Store](#Certificate_f_Store) and set [StorePassword](#Certificate_f_StorePassword) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | **SubjectAltNames** *String (read-only)* *Default Value: ""* Comma-separated lists of alternative subject names for the certificate. **ThumbprintMD5** *String (read-only)* *Default Value: ""* The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. **ThumbprintSHA1** *String (read-only)* *Default Value: ""* The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. **ThumbprintSHA256** *String (read-only)* *Default Value: ""* The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. **Usage** *String (read-only)* *Default Value: ""* The text description of [UsageFlags](#Certificate_f_UsageFlags). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. **UsageFlags** *int (read-only)* *Default Value: 0* The flags that show intended use for the certificate. The value of [UsageFlags](#Certificate_f_UsageFlags) is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the [Usage](#Certificate_f_Usage) field for a text representation of [UsageFlags](#Certificate_f_UsageFlags). This functionality currently is not available when the provider is OpenSSL. **Version** *String (read-only)* *Default Value: ""* The certificate's version number. The possible values are the strings "V1", "V2", and "V3". **Subject** *String* *Default Value: ""* The subject of the certificate used for client authentication. This field will be populated with the full subject of the loaded certificate. When loading a certificate, the subject is used to locate the certificate in the store. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still 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. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. **Encoded** *String* *Default Value: ""* The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The [Store](#Certificate_f_Store) and [Subject](#Certificate_f_Subject) fields also may be used to specify a certificate. When [Encoded](#Certificate_f_Encoded) is set, a search is initiated in the current [Store](#Certificate_f_Store) for the private key of the certificate. If the key is found, [Subject](#Certificate_f_Subject) is updated to reflect the full subject of the selected certificate; otherwise, [Subject](#Certificate_f_Subject) is set to an empty string. **EncodedB** *byte[]* *Default Value: ""* The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The [Store](#Certificate_f_Store) and [Subject](#Certificate_f_Subject) fields also may be used to specify a certificate. When [Encoded](#Certificate_f_Encoded) is set, a search is initiated in the current [Store](#Certificate_f_Store) for the private key of the certificate. If the key is found, [Subject](#Certificate_f_Subject) is updated to reflect the full subject of the selected certificate; otherwise, [Subject](#Certificate_f_Subject) is set to an empty string. ## Constructors ```text public Certificate(); ``` Creates a instance whose properties can be set. ```text public Certificate(String certificateFile); ``` Opens * CertificateFile * and reads out the contents as an X.509 public key. ```text public Certificate(byte[] encoded); ``` Parses * Encoded * as an X.509 public key. ```text public Certificate(int storeType, String store, String storePassword, String subject); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(int storeType, String store, String storePassword, String subject, String configurationString); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store. * ConfigurationString * is a newline-separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to the * cstUser * , * cstMachine * , * cstPublicKeyFile * , and * cstPFXFile * store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(int storeType, String store, String storePassword, byte[] encoded); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the class will load * Encoded * as an X.509 certificate and search the opened store for a corresponding private key. ```text public Certificate(int storeType, byte[] store, String storePassword, String subject); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(int storeType, byte[] store, String storePassword, String subject, String configurationString); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(int storeType, byte[] store, String storePassword, byte[] encoded); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the class will load * Encoded * as an X.509 certificate and search the opened store for a corresponding private key. # CFDirEntry Type A listing in a directory returned from the server. ## Remarks The DirEntry type contains details about each entry returned after calling [ListDirectory](#listdirectory-method-cloudfiles-class). The following fields are available: - [FileName](#CFDirEntry_f_FileName) - [FileSize](#CFDirEntry_f_FileSize) - [FileTime](#CFDirEntry_f_FileTime) - [IsDir](#CFDirEntry_f_IsDir) ## Fields **FileName** *String (read-only)* *Default Value: ""* This field holds the name of the file or folder. **FileSize** *long (read-only)* *Default Value: 0* This field holds the size of the file in bytes. This is also applicable to folders for depending on the [ServiceProvider](#serviceprovider-property-cloudfiles-class). The table below summarizes the applicability of this value on a per-provider basis: | Service Provider | Files | Directories | | --- | --- | --- | | cspAmazonS3 (0) | X | | | cspBox (1) | X | X | | cspDropbox (2) | X | | | cspGoogleDrive (3) | X | | | cspOneDrive (4) | X | X | | cspAzureBlob (6) | X | | | cspWasabi (7) | X | | | cspDigitalOcean (8) | X | | | cspGoogleStorage (9) | X | | | cspHadoopDFS (10) | X | | | cspAzureFile (11) | X | | | cspBackblazeB2 (12) | X | | | cspIBMStorage (13) | X | | | cspLinode (14) | X | | **FileTime** *String (read-only)* *Default Value: ""* This field holds the modified date of the file. By default the datetime format used is "yyyy-MM-dd'T'HH:mm:ss". To modify this format set DateFormat. Note: Modified times are not applicable to directories for the following providers: - *cspAmazonS3 (0)* - *cspDropbox (2)* - *cspWasabi (7)* - *cspDigitalOcean (8)* - *cspGoogleStorage (9)* - *cspBackblazeB2 (12)* - *cspIBMStorage (13)* - *cspLinode (14)* Additionally, the following providers do not return modified times at all: - *cspAzureFile (11)* **IsDir** *boolean (read-only)* *Default Value: False* This field specifies whether the entry is a directory. If *false* the entry is a file. ## Constructors ```text public CFDirEntry(); ``` # CloudFilesAccount Type This type holds non-OAuth storage account credentials. ## Remarks This type is used to hold account credentials for storages services which do not use OAuth for authentication. The following fields are available: - [AccessKey](#CloudFilesAccount_f_AccessKey) - [AccountName](#CloudFilesAccount_f_AccountName) - [ApplicationKey](#CloudFilesAccount_f_ApplicationKey) - [ApplicationKeyId](#CloudFilesAccount_f_ApplicationKeyId) - [AuthMechanism](#CloudFilesAccount_f_AuthMechanism) - [HadoopURL](#CloudFilesAccount_f_HadoopURL) - [Password](#CloudFilesAccount_f_Password) - [ProjectId](#CloudFilesAccount_f_ProjectId) - [SecretKey](#CloudFilesAccount_f_SecretKey) - [User](#CloudFilesAccount_f_User) ## Fields **AccessKey** *String* *Default Value: ""* A storage service provider access key. This field specifies the access key to use for authentication. It must be populated when using one of these storage service providers: - *cspAmazonS3 (0)* - *cspAzureBlob (6)* - *cspWasabi (7)* - *cspDigitalOcean (8)* - *cspGoogleStorage (9)* (only if [Authorization](#authorization-property-cloudfiles-class) and [ProjectId](#CloudFilesAccount_f_ProjectId) are not populated) - *cspAzureFile (11)* - *cspIBMStorage (13)* - *cspLinode (14)* **AccountName** *String* *Default Value: ""* A storage service provider account string. This field specifies the account string to use for authentication. It must be populated when using one of these storage service providers: - *cspAzureBlob (6)* - *cspAzureFile (11)* **ApplicationKey** *String* *Default Value: ""* A storage service provider application key. This field specifies the application key to use for authentication. It must be populated when using one of these storage service providers: - *cspBackblazeB2 (12)* **ApplicationKeyId** *String* *Default Value: ""* A storage service provider application key Id. This field specifies the application key Id to use for authentication. It must be populated when using one of these storage service providers: - *cspBackblazeB2 (12)* **AuthMechanism** *int* *Default Value: 0* The HTTP authentication scheme to use (for storage service providers that support multiple). For storage service providers that support more than one HTTP authentication scheme, this field specifies which should be used. This field is only relevant for the following storage service providers: - *cspHadoopDFS (10)* (For all other storage service providers, the class determines the correct authentication scheme automatically). ### Usage Possible values for this field are: | | | | --- | --- | | camNone (0) (default) | No authentication is performed. | | camSimple (1) | Hadoop pseudo/simple authentication is performed. | | camBasic (2) | Basic authentication is performed. | | camNTLM (3) | NTLM authentication is performed. | | camNegotiate (4) | Negotiate authentication is performed. | | camOAuth (5) | OAuth authentication is performed. | When set to *camSimple (1)*, the value of the [User](#CloudFilesAccount_f_User) field is automatically sent in every request using the *user.name* query parameter. (NOTE: This authentication scheme is only valid for the *cspHadoopDFS (10)* storage service provider.) When set to *camBasic (2)*, *camNTLM (3)*, or *camNegotiate (4)*, the values held by the [User](#CloudFilesAccount_f_User) and [Password](#CloudFilesAccount_f_Password) fields will be used to perform Basic, NTLM, or Negotiate authentication. When set to *camOAuth (5)*, the value of the [Authorization](#authorization-property-cloudfiles-class) property is automatically sent in every request using the *Authorization* HTTP header. **HadoopURL** *String* *Default Value: ""* The URL of the Hadoop WebHDFS server. This field specifies the URL of the Hadoop WebHDFS server to make requests against. It must be set when [ServiceProvider](#serviceprovider-property-cloudfiles-class) is set to *cspHadoopDFS (10)*. A full WebHDFS URL looks like *http[s]://:/webhdfs/v1*. The class will automatically append */webhdfs/v1* when making requests (if necessary). The class automatically detects whether to secure the connection using SSL/TLS based on whether the value begins with *http* (not secured) or *https* (secured). **Password** *String* *Default Value: ""* A storage service provider password. This field specifies the password to use for authentication. It must be populated when using one of these storage service providers: - *cspHadoopDFS (10)* (only required for certain [AuthMechanism](#CloudFilesAccount_f_AuthMechanism) options) **ProjectId** *String* *Default Value: ""* A Google Cloud Platform project Id string. This field specifies the Google Cloud Platform project Id string to use for authentication. It must be set when using OAuth 2.0 authentication (i.e., the [Authorization](#authorization-property-cloudfiles-class) property is populated) with one of these storage service providers: - *cspGoogleStorage (9)* Note that the above providers will fall back to using an [AccessKey](#CloudFilesAccount_f_AccessKey) and [SecretKey](#CloudFilesAccount_f_SecretKey) for authentication if either this field or the [Authorization](#authorization-property-cloudfiles-class) property is empty. **SecretKey** *String* *Default Value: ""* A storage service provider access key. This field specifies the access key to use for authentication. It must be populated when using one of these storage service providers: - *cspAmazonS3 (0)* - *cspWasabi (7)* - *cspDigitalOcean (8)* - *cspGoogleStorage (9)* (only if [Authorization](#authorization-property-cloudfiles-class) and [ProjectId](#CloudFilesAccount_f_ProjectId) are not populated) - *cspIBMStorage (13)* - *cspLinode (14)* **User** *String* *Default Value: ""* A storage service provider user name. This field specifies the user name to use for authentication. It must be populated when using one of these storage service providers: - *cspHadoopDFS (10)* (only required for certain [AuthMechanism](#CloudFilesAccount_f_AuthMechanism) options) ## Constructors ```text public CloudFilesAccount(); ``` # Firewall Type The firewall the class 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](#Firewall_f_Host) and the [FirewallType](#Firewall_f_FirewallType). The following fields are available: - [AutoDetect](#Firewall_f_AutoDetect) - [FirewallType](#Firewall_f_FirewallType) - [Host](#Firewall_f_Host) - [Password](#Firewall_f_Password) - [Port](#Firewall_f_Port) - [User](#Firewall_f_User) ## Fields **AutoDetect** *boolean* *Default Value: False* Whether to automatically detect and use firewall system settings, if available. Connection information will first be obtained from Java system properties, such as *http.proxyHost* and *https.proxyHost*. Java properties may be set in a variety of ways; please consult the Java documentation for information about how firewall and proxy values can be specified. If no Java system properties define connection information, the class will inspect the Windows registry for connection information that may be present on the system (applicable only on Windows systems). **FirewallType** *int* *Default Value: 0* The type of firewall to connect through. The applicable values are as follows: | | | | --- | --- | | fwNone (0) | No firewall (default setting). | | fwTunnel (1) | Connect through a tunneling proxy. [Port](#Firewall_f_Port) is set to 80. | | fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. [Port](#Firewall_f_Port) is set to 1080. | | fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. [Port](#Firewall_f_Port) is set to 1080. | | fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. [Port](#Firewall_f_Port) is set to 1080. | **Host** *String* *Default Value: ""* The name or IP address of the firewall (optional). If a [Host](#Firewall_f_Host) is given, the requested connections will be authenticated through the specified firewall when connecting. If this field is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this field is set to the corresponding address. If the search is not successful, the class throws an exception. **Password** *String* *Default Value: ""* A password if authentication is to be used when connecting through the firewall. If [Host](#Firewall_f_Host) is specified, the [User](#Firewall_f_User) and [Password](#Firewall_f_Password) fields are used to connect and authenticate to the given firewall. If the authentication fails, the class throws an exception. **Port** *int* *Default Value: 0* The Transmission Control Protocol (TCP) port for the firewall [Host](#Firewall_f_Host). See the description of the [Host](#Firewall_f_Host) field for details. NOTE: This field is set automatically when [FirewallType](#Firewall_f_FirewallType) is set to a valid value. See the description of the [FirewallType](#Firewall_f_FirewallType) field for details. **User** *String* *Default Value: ""* A username if authentication is to be used when connecting through a firewall. If [Host](#Firewall_f_Host) is specified, this field and the [Password](#Firewall_f_Password) field are used to connect and authenticate to the given [Firewall](#firewall-type). If the authentication fails, the class throws an exception. ## Constructors ```text public Firewall(); ``` # OAuthSettings Type The settings used to authenticate with the service provider. ## Remarks This type is used to give the class the necessary information needed to complete the OAuth process. The following fields are available: - [AccessToken](#OAuthSettings_f_AccessToken) - [AuthorizationCode](#OAuthSettings_f_AuthorizationCode) - [AuthorizationScope](#OAuthSettings_f_AuthorizationScope) - [ClientId](#OAuthSettings_f_ClientId) - [ClientProfile](#OAuthSettings_f_ClientProfile) - [ClientSecret](#OAuthSettings_f_ClientSecret) - [GrantType](#OAuthSettings_f_GrantType) - [RefreshToken](#OAuthSettings_f_RefreshToken) - [RequestRefreshToken](#OAuthSettings_f_RequestRefreshToken) - [ReturnURL](#OAuthSettings_f_ReturnURL) - [ServerAuthURL](#OAuthSettings_f_ServerAuthURL) - [ServerTokenURL](#OAuthSettings_f_ServerTokenURL) - [Timeout](#OAuthSettings_f_Timeout) - [WebAuthURL](#OAuthSettings_f_WebAuthURL) ## Fields **AccessToken** *String* *Default Value: ""* The access token returned by the authorization server. This is set when the class makes a request to the token server. **AuthorizationCode** *String* *Default Value: ""* The authorization code that is exchanged for an access token. This is required to be set when the [ClientProfile](#OAuthSettings_f_ClientProfile) field is set to the Web profile. Otherwise, this field is for information purposes only. **AuthorizationScope** *String* *Default Value: ""* The scope request or response parameter used during authorization. **ClientId** *String* *Default Value: ""* The id of the client assigned when registering the application. **ClientProfile** *int* *Default Value: 0* The type of client that is requesting authorization. See the introduction section for more information. Possible values are: | | | | --- | --- | | 0 (cocpApplication - Default) | The application profile is applicable to applications that are run by the user directly. For instance a windows form application would use the application profile. To authorize your application (client) using the application profile see the introduction section. | | 1 (cocpWeb) | The Web profile is applicable to applications that are run on the server side where the user uses the application from a web browser. To authorize your application (client) using this profile follow see the introduction section. | **ClientSecret** *String* *Default Value: ""* The secret value for the client assigned when registering the application. **GrantType** *int* *Default Value: 0* The OAuth grant type used to acquire an OAuth access token. See the introduction section for more information. Possible values are: | | | | --- | --- | | 0 (cogtAuthorizationCode - Default) | Authorization Code grant type | | 1 (cogtImplicit) | Implicit grant type | | 2 (cogtPassword) | Resource Owner Password Credentials grant type | | 3 (cogtClientCredentials) | Client Credentials grant type | **RefreshToken** *String* *Default Value: ""* Specifies the refresh token received from or sent to the authorization server. This field is set automatically if a refresh token is retrieved from the token server. If the OAuthAutomaticRefresh configuration setting is set to true, and the [GrantType](#OAuthSettings_f_GrantType) field is set to a grant that can use refresh tokens. **RequestRefreshToken** *boolean* *Default Value: True* Specifies whether the class will request a refresh token during authorization. By default, this value is *True*. When *True*, the class will automatically add the necessary scopes or parameters to obtain a refresh token. When *False*, this field will have no effect. If the necessary scopes or parameters are specified manually, a refresh token can still be obtained. NOTE: This field is only applicable when the [GrantType](#OAuthSettings_f_GrantType) field is set to *cogtAuthorizationCode*. **ReturnURL** *String* *Default Value: ""* The URL where the user (browser) returns after authenticating. This field is mapped to the *redirect_uri* parameter when making a request to the authorization server. Typically, this is automatically set by the class when using the embedded web server. If the OAuthWebServerPort or OAuthWebServerHost configuration settings is set, then this field should be set to match. If using the Web client profile, this should be set to the place where the authorization code will be parsed out of the response after the user finishes authorizing. **ServerAuthURL** *String* *Default Value: ""* The URL of the authorization server. **ServerTokenURL** *String* *Default Value: ""* The URL of the token server used to obtain the access token. **Timeout** *int* *Default Value: 60* The amount of time (in seconds) the component will wait for a response from the browser in the LaunchBrowser event. The default value is 60. **WebAuthURL** *String (read-only)* *Default Value: ""* The URL to which the user should be re-directed for authorization. This field is used to get the URL that the user should be redirected to when using the Web client profile. See introduction section for more information. ## Constructors ```text public OAuthSettings(); ``` # Proxy Type The proxy the class will connect to. ## Remarks When connecting through a proxy, this type is used to specify different properties of the proxy, such as the [Server](#Proxy_f_Server) and the [AuthScheme](#Proxy_f_AuthScheme). The following fields are available: - [AuthScheme](#Proxy_f_AuthScheme) - [AutoDetect](#Proxy_f_AutoDetect) - [Password](#Proxy_f_Password) - [Port](#Proxy_f_Port) - [Server](#Proxy_f_Server) - [SSL](#Proxy_f_SSL) - [User](#Proxy_f_User) ## Fields **AuthScheme** *int* *Default Value: 0* The type of authorization to perform when connecting to the proxy. This is used only when the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are set. [AuthScheme](#Proxy_f_AuthScheme) should be set to authNone (3) when no authentication is expected. By default, [AuthScheme](#Proxy_f_AuthScheme) is authBasic (0), and if the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are set, the class will attempt basic authentication. If [AuthScheme](#Proxy_f_AuthScheme) is set to authDigest (1), digest authentication will be attempted instead. If [AuthScheme](#Proxy_f_AuthScheme) is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token. If [AuthScheme](#Proxy_f_AuthScheme) is set to authNtlm (4), NTLM authentication will be used. For security reasons, setting this field will clear the values of [User](#Proxy_f_User) and [Password](#Proxy_f_Password). **AutoDetect** *boolean* *Default Value: False* Whether to automatically detect and use proxy system settings, if available. The default value is *false*. Note: This setting is applicable only in Windows. **Password** *String* *Default Value: ""* A password if authentication is to be used for the proxy. If [AuthScheme](#Proxy_f_AuthScheme) is set to Basic Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*. If [AuthScheme](#Proxy_f_AuthScheme) is set to Digest Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are used to respond to the Digest Authentication challenge from the server. If [AuthScheme](#Proxy_f_AuthScheme) is set to NTLM Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are used to authenticate through NTLM negotiation. **Port** *int* *Default Value: 80* The Transmission Control Protocol (TCP) port for the proxy [Server](#Proxy_f_Server) (default 80). See the description of the [Server](#Proxy_f_Server) field for details. **Server** *String* *Default Value: ""* If a proxy [Server](#Proxy_f_Server) is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. If the [Server](#Proxy_f_Server) field is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the [Server](#Proxy_f_Server) field is set to the corresponding address. If the search is not successful, an error is returned. **SSL** *int* *Default Value: 0* When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows: | | | | --- | --- | | psAutomatic (0) | Default setting. If the URL is an https URL, the class will use the psTunnel option. If the URL is an http URL, the class will use the psNever option. | | psAlways (1) | The connection is always SSL-enabled. | | psNever (2) | The connection is not SSL-enabled. | | psTunnel (3) | The connection is made through a tunneling (HTTP) proxy. | **User** *String* *Default Value: ""* A username if authentication is to be used for the proxy. If [AuthScheme](#Proxy_f_AuthScheme) is set to Basic Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*. If [AuthScheme](#Proxy_f_AuthScheme) is set to Digest Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are used to respond to the Digest Authentication challenge from the server. If [AuthScheme](#Proxy_f_AuthScheme) is set to NTLM Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are used to authenticate through NTLM negotiation. ## Constructors ```text public Proxy(); ``` ```text public Proxy(String server, int port); ``` ```text public Proxy(String server, int port, String user, String password); ``` # Config Settings ([CloudFiles](#cloudfiles-class) Class) The class 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 class, access to these *internal properties* is provided through the [Config](#config-method-cloudfiles-class) method. ### CloudFiles Config Settings **AllowTransferEventOnly**: Enables using just the Transfer event when downloading.When set to "True", you won't need to set [LocalFile](#localfile-property-cloudfiles-class) or call [SetDownloadStream](#setdownloadstream-method-cloudfiles-class) before downloading a file. This allows you to use just the [Transfer](#transfer-event-cloudfiles-class) event to capture incoming data. **AWSProfile**: The name of the AWS CLI profile that the class should use to obtain authentication and region information.This setting, if non-empty, must contain the name of the AWS CLI profile whose authentication and (optionally) region information the class should use to communicate with the server. To use the default profile, set this setting to *default*. Refer to the following pages of the AWS CLI documentation for more information about AWS profiles, and the *credentials* and *config* files used to store them: - [Configuration and Credential File Settings](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html) - [Named Profiles](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html) - [Using an IAM Role](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-role.html) The class supports key-based credential profiles; i.e., those which include the *aws_access_key_id*, *aws_secret_access_key*, and (optionally) *aws_session_token* elements. Role-based profiles are not supported at this time. In addition to the authentication-related elements mentioned above, the class also supports the *region* element, if it is present in the specified profile. The class searches for the specified profile's information in the *credentials* and *config* files. The [AWSProfileDir](#AWSProfileDir) setting can be used to configure the directory where the class looks for these files. If the aforementioned files do not exist, or the specified profile cannot be found or is missing information, an error will occur. Note: This setting is applicable only when [ServiceProvider](#serviceprovider-property-cloudfiles-class) is set to one of the following: - *cspAmazonS3 (0)* - *cspWasabi (7)* - *cspDigitalOcean (8)* - *cspGoogleStorage (9)* - *cspIBMStorage (13)* - *cspLinode (14)* **AWSProfileDir**: The location of the AWS CLI credentials and config files.This setting specifies the directory that the class should check when attempting to locate the AWS CLI *credentials* and *config* files. This setting is only used if the [AWSProfile](#AWSProfile) setting is non-empty. By default, this setting is empty, which will cause the class to check the default location used by the AWS CLI: an *.aws* directory in the current user's home directory; i.e., *%UserProfile%\.aws* (Windows) or *~/.aws* (Linux/macOS). Note: This setting is applicable only when [ServiceProvider](#serviceprovider-property-cloudfiles-class) is set to one of the following: - *cspAmazonS3 (0)* - *cspWasabi (7)* - *cspDigitalOcean (8)* - *cspGoogleStorage (9)* - *cspIBMStorage (13)* - *cspLinode (14)* **ContentDisposition**: The Content-Disposition to send when uploading an file to an S3-like storage provider.This setting specifies the value that should be sent for the *Content-Disposition* header when uploading a file. Note: This setting is applicable only when [ServiceProvider](#serviceprovider-property-cloudfiles-class) is set to one of the following: - *cspAmazonS3 (0)* - *cspWasabi (7)* - *cspDigitalOcean (8)* - *cspGoogleStorage (9)* - *cspIBMStorage (13)* - *cspLinode (14)* **ContentType**: The Content-Type to send when uploading an file to an S3-like storage provider.This setting specifies the value that should be sent for the *Content-Type* header when uploading a file. Note: This setting is applicable only when [ServiceProvider](#serviceprovider-property-cloudfiles-class) is set to one of the following: - *cspAmazonS3 (0)* - *cspWasabi (7)* - *cspDigitalOcean (8)* - *cspGoogleStorage (9)* - *cspIBMStorage (13)* - *cspLinode (14)* **DateFormat**: The date format of the file time.This setting specifies the format of the datetime used when reporting the file's modified date. The default value is "yyyy-MM-dd'T'HH:mm:ss" and the server time will be localized. If this setting is set to empty string the exact value sent by the server will be returned. **DocsExportFormat**: The file format to export Google Docs files as when downloading.This setting specifies what file format to export Google Docs as when downloading; it takes a file extension, which will be applied to the downloaded filename if necessary. Valid values (and their associated MIME types) are: - *docx* (default) - application/vnd.openxmlformats-officedocument.wordprocessingml.document - *epub* - application/epub+zip - *htm* or *html* - text/html - *odt* - application/vnd.oasis.opendocument.text - *pdf* - application/pdf - *rtf* - application/rtf - *txt* - text/plain - *zip* - application/zip You may also specify a string like *[extension],[MIME type]* instead of one of the file extensions above if you wish to customize the MIME type to export the file as and/or the file extension to apply to the downloaded file. Note that this configuration setting is only valid when the [ServiceProvider](#serviceprovider-property-cloudfiles-class) property is set to *cspGoogleDrive (3)*. **DownloadTempFile**: The temporary file used when downloading encrypted data.This setting specifies the temporary file used when downloading encrypted data. When downloading encrypted data with [LocalFile](#localfile-property-cloudfiles-class) set, the class will automatically create a temporary file at [TempPath](#TempPath) to hold the encrypted file contents. When the download is complete, the data is decrypted to [LocalFile](#localfile-property-cloudfiles-class). If the download is interrupted, the specified file will hold the partially downloaded encrypted file contents. Before resuming the download, this setting must be set to a valid file containing the partially encrypted file contents. See DownloadFile for details. **DrawingsExportFormat**: The file format to export Google Drawings files as when downloading.This setting specifies what file format to export Google Drawings as when downloading; it takes a file extension, which will be applied to the downloaded filename if necessary. Valid values (and their associated MIME types) are: - *jpg* or *jpeg* - image/jpeg - *pdf* - application/pdf - *png* (default) - image/png - *svg* - image/svg+xml You may also specify a string like *[extension],[MIME type]* instead of one of the file extensions above if you wish to customize the MIME type to export the file as and/or the file extension to apply to the downloaded file. Note that this configuration setting is only valid when the [ServiceProvider](#serviceprovider-property-cloudfiles-class) property is set to *cspGoogleDrive (3)*. **EncryptionIV**: The initialization vector to be used for encryption/decryption.When encrypting or decrypting a file, this setting may be set to specify the initialization vector. Normally the class will derive this value automatically from [EncryptionPassword](#encryptionpassword-property-cloudfiles-class). This setting accepts a hex encoded value. **EncryptionKey**: The key to use during encryption/decryption.When encrypting or decrypting a file, this setting may be set to specify the key to use. Normally the class will derive this value automatically from [EncryptionPassword](#encryptionpassword-property-cloudfiles-class). This setting accepts a hex encoded value. **EncryptionPasswordKDF**: The KDF algorithm to use during password based encryption and decryption.This setting specified the Key Derivation Function (KDF) used to derive a key from the specified [EncryptionPassword](#encryptionpassword-property-cloudfiles-class). Possible values are: - 0 (default) - PBKDF1 - 1 - PBKDF2 Note: PBKDF1 is not FIPS compliant. When operating in FIPS mode PBKDF2 should be used. Additionally when in FIPS mode the [EncryptionPassword](#encryptionpassword-property-cloudfiles-class) must be at least fourteen characters. **FragmentSize**: The fragment size that the class should use when uploading files in multiple fragments.The class will sometimes choose to upload files in multiple fragments, depending on the size of the file, and whether the currently-selected [ServiceProvider](#serviceprovider-property-cloudfiles-class)'s API includes native support for resumable uploads. In such cases, this setting specifies the fragment size, in bytes, that the class should use. This setting's default and minimum values vary by [ServiceProvider](#serviceprovider-property-cloudfiles-class); its maximum value is *2147483647* (2GB). Refer to the configuration settings documentation for each individual storage service provider class for more information. Note that this setting cannot be changed when [ServiceProvider](#serviceprovider-property-cloudfiles-class) is set to one of the following: - *cspBox (1)* - *cspAzureFile (11)* **ListResourcesScope**: Controls the scope of the results when listing GoogleDrive resources.When the [ServiceProvider](#serviceprovider-property-cloudfiles-class) property is set to *cspGoogleDrive (3)*, this setting controls the scope of the results when listing resources. Possible values are: | | | | --- | --- | | 0 - User (default) | Items in the user's "My Drive" and "Shared with me" collections. | | 1 - Domain | Items shared to the user's domain. | | 2 - Shared Drive | Items within the shared drive specified by the [SharedDriveId](#SharedDriveId) configuration setting. | | 3 - All Drives | Items in the user's "My Drive" and "Shared with me" collections, as well as all items in all shared drives that the user is a member of. | **ListSharedResources**: Whether to list shared resources when listing OneDrive resources.When the [ServiceProvider](#serviceprovider-property-cloudfiles-class) property is set to *cspOneDrive (4)*, this setting controls whether personal resources or resources that have been shared with the user are listed when listing resources. By default, this setting is disabled, and personal resources are listed. **NewVersionOnOverwrite**: Whether to upload new file versions instead of performing true overwrites.When the [Overwrite](#overwrite-property-cloudfiles-class) property is enabled, and the [Upload](#upload-method-cloudfiles-class) method is called, the class will normally perform a true overwrite if the destination file already exists (i.e., it will delete the old file before uploading the new one). For service providers that support it, this setting can be enabled to have the class simply upload a new file version instead of doing a true overwrite. By default, this setting is disabled. It is only applicable when the [ServiceProvider](#serviceprovider-property-cloudfiles-class) property is set to one of the following: - *cspBox (1)* **NormalizedFileName[i]**: The normalized file name.When using Google Drive as your service provider, any Google Apps files (Docs, Slides, Sheets, etc) are exported to the file formats specified by the ***ExportFormat** configuration settings when you call [Download](#download-method-cloudfiles-class). After calling [ListDirectory](#listdirectory-method-cloudfiles-class), you can query this configuration setting to get the normalized filename for any entry in [DirList](#dirlist-property-cloudfiles-class); for example: ```csharp cloudfiles1.RemotePath = "folder1/folder2/"; cloudfiles1.ListDirectory(); for (int i = 0; i < cloudfiles1.DirList.Count; i++) { CFDirEntry entry = cloudfiles1.DirList[i]; cloudfiles1.RemoteFile = entry.FileName; cloudfiles1.LocalFile = "C:\\Test\\" + cloudfiles1.Config("NormalizedFileName[" + i + "]"); cloudfiles1.Download(); } ``` For Google Apps files, the normalized file name is the name of the file, plus the appropriate extension (if not already present) based on which export formats were set when [ListDirectory](#listdirectory-method-cloudfiles-class) was last called. For other files, the normalized file name is the same as the file name reported in the [DirList](#dirlist-property-cloudfiles-class) entry. If you change one of the ***ExportFormat** configuration settings, you'll need to call [ListDirectory](#listdirectory-method-cloudfiles-class) again to refresh the values returned by this setting. Note that this configuration setting is only valid when the [ServiceProvider](#serviceprovider-property-cloudfiles-class) property is set to *cspGoogleDrive (3)*. **OneDriveResourceIndex**: The index corresponding to the OneDrive resource to be downloaded.When the [ServiceProvider](#serviceprovider-property-cloudfiles-class) property is set to *cspOneDrive (4)* and the [ListSharedResources](#ListSharedResources) configuration setting is enabled, this setting must be set to the index of a resource in the [DirList](#dirlist-property-cloudfiles-class) property when it is to be downloaded. This setting is useful when attempting to download resources that have been shared with the user. The default request made by the [Download](#download-method-cloudfiles-class) method is not valid when dealing with such resources, so the combination of enabling the [ListSharedResources](#ListSharedResources) configuration setting as well as supplying a valid index to this setting allows the class to formulate the proper request to download the shared resource. Note that in order to download resources that have been shared with the user, the [DirList](#dirlist-property-cloudfiles-class) property must first be populated as a result of calling the [ListDirectory](#listdirectory-method-cloudfiles-class) method. **ProgressAbsolute**: Whether the class should track transfer progress absolutely.This setting controls whether the class tracks upload and download progress absolutely or relatively, with regards to the values reported via the [Progress](#progress-event-cloudfiles-class) event when an interrupted transfer is resumed. If this setting is enabled (default), then when a transfer is interrupted and later resumed, the values reported by the [Progress](#progress-event-cloudfiles-class) event will account for the data that was successfully transferred before the interruption. If this setting is disabled, then the class will treat resumed transfers as "new" transfers, and the values reported by the [Progress](#progress-event-cloudfiles-class) event will start at *0* rather than from the number of bytes already transferred. Refer to the [Progress](#progress-event-cloudfiles-class) event for more information. **ProgressStep**: How often the progress event should be fired, in terms of percentage.This setting controls how often the class will fire the [Progress](#progress-event-cloudfiles-class) event during an upload or download, in terms of percentage. Valid values are *0* to *99*, inclusive. The default value, *1*, will cause the [Progress](#progress-event-cloudfiles-class) event to fire each time the event's *PercentDone* parameter value increases by one percent. Setting this setting to *0* will cause the [Progress](#progress-event-cloudfiles-class) event to fire *every* time data is transferred. Note that the [Progress](#progress-event-cloudfiles-class) event will *always* fire once at the beginning and end of a transfer, regardless of this setting's value. Also, if *PercentDone* cannot be calculated for a particular transfer (e.g., for downloads that use chunked transfer encoding), then the class will behave as if this setting were *0* for the duration of the transfer. **RawRequest**: Returns the data that was sent to the server.This setting may be queried after calling any method that sends data to the server to obtain the request data that was transmitted. Such data may be useful for troubleshooting purposes. **RawResponse**: Returns the data that was received from the server.This setting may be queried after calling any method that sends data to the server to obtain the response data that was received. Such data may be useful for troubleshooting purposes. **Region**: For applicable providers, specifies the region to use.This setting specifies the region to use, and is applicable when [ServiceProvider](#serviceprovider-property-cloudfiles-class) is set to one of the following: - *cspAmazonS3 (0)* - Refer to the [AmazonS3](AmazonS3.md#AmazonS3) class's [Region](AmazonS3.md#AmazonS3_p_Region) property for more information. - *cspWasabi (7)* - Refer to the [Wasabi](Wasabi.md#Wasabi) class's [Region](Wasabi.md#Wasabi_p_Region) property for more information. - *cspDigitalOcean (8)* - Refer to the [DigitalOcean](DigitalOcean.md#DigitalOcean) class's [Region](DigitalOcean.md#DigitalOcean_p_Region) property for more information. - *cspGoogleStorage (9)* - Refer to the [GoogleStorage](GoogleStorage.md#GoogleStorage) class's [Region](GoogleStorage.md#GoogleStorage_p_Region) property for more information. - *cspIBMStorage (13)* - Refer to the [IBMStorage](IBMStorage.md#IBMStorage) class's [Region](IBMStorage.md#IBMStorage_p_Region) property for more information. - *cspLinode (14)* - Refer to the [Linode](Linode.md#Linode) class's [Region](Linode.md#Linode_p_Region) property for more information. **SharedDriveId**: The Id of the Google Drive shared drive to list resources for.When the [ServiceProvider](#serviceprovider-property-cloudfiles-class) property is set to *cspGoogleDrive (3)*, and the [ListResourcesScope](#ListResourcesScope) setting is set to *2* (Shared Drive), this setting must be set to the Id of a shared drive before attempting to list resources. **SheetsExportFormat**: The file format to export Google Sheets files as when downloading.This setting specifies what file format to export Google Sheets as when downloading; it takes a file extension, which will be applied to the downloaded filename if necessary. Valid values (and their associated MIME types) are: - *csv* - text/csv - *ods* - application/vnd.oasis.opendocument.spreadsheet - *pdf* - application/pdf - *tsv* - text/tab-separated-values - *xlsx* (default) - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet - *zip* - application/zip You may also specify a string like *[extension],[MIME type]* instead of one of the file extensions above if you wish to customize the MIME type to export the file as and/or the file extension to apply to the downloaded file. Note that this configuration setting is only valid when the [ServiceProvider](#serviceprovider-property-cloudfiles-class) property is set to *cspGoogleDrive (3)*. **SimpleUploadLimit**: The threshold above which the class will choose to perform a multipart upload, for applicable storage service providers.This setting specifies the threshold, in bytes, above which the class will choose to perform a multipart upload rather than uploading everything in one request. It is only applicable when [ServiceProvider](#serviceprovider-property-cloudfiles-class) is set to one of the following: - *cspAmazonS3 (0)* - *cspAzureBlob (6)* - *cspWasabi (7)* - *cspDigitalOcean (8)* - *cspBackblazeB2 (12)* - *cspIBMStorage (13)* - *cspLinode (14)* For all other providers, the limit is either defined by the server, or the service's API includes native support for resumable uploads. **SlidesExportFormat**: The file format to export Google Slides files as when downloading.This setting specifies what file format to export Google Slides as when downloading; it takes a file extension, which will be applied to the downloaded filename if necessary. Valid values (and their associated MIME types) are: - *odp* - application/vnd.oasis.opendocument.presentation - *pdf* - application/pdf - *pptx* (default) - application/vnd.openxmlformats-officedocument.presentationml.presentation - *txt* - text/plain You may also specify a string like *[extension],[MIME type]* instead of one of the file extensions above if you wish to customize the MIME type to export the file as and/or the file extension to apply to the downloaded file. Note that this configuration setting is only valid when the [ServiceProvider](#serviceprovider-property-cloudfiles-class) property is set to *cspGoogleDrive (3)*. **TempPath**: The path to the directory where temporary files are created.This setting specifies the path where temporary files are created when downloading encrypted files. If not specified, the system's temporary directory is used. Refer to [DownloadTempFile](#DownloadTempFile) and DownloadFile for more information. **UseVirtualHosting**: Determines which URL style S3-like storage service providers should use.This setting determines whether S3-like storage service providers should use path-style or hosted-style URLs when making requests. It is applicable only when [ServiceProvider](#serviceprovider-property-cloudfiles-class) is set to one of the following: - *cspAmazonS3 (0)* - Defaults to *true*; refer to the [AmazonS3](AmazonS3.md#AmazonS3) class's [UseVirtualHosting](AmazonS3.md#AmazonS3_p_UseVirtualHosting) property for more information. - *cspWasabi (7)* - Defaults to *false*; refer to the [Wasabi](Wasabi.md#Wasabi) class's [UseVirtualHosting](Wasabi.md#Wasabi_p_UseVirtualHosting) property for more information. - *cspDigitalOcean (8)* - Defaults to *false*; refer to the [DigitalOcean](DigitalOcean.md#DigitalOcean) class's [UseVirtualHosting](DigitalOcean.md#DigitalOcean_p_UseVirtualHosting) property for more information. - *cspGoogleStorage (9)* - Defaults to *false*; refer to the [GoogleStorage](GoogleStorage.md#GoogleStorage) class's [UseVirtualHosting](GoogleStorage.md#GoogleStorage_p_UseVirtualHosting) property for more information. - *cspIBMStorage (13)* - Defaults to *true*; refer to the [IBMStorage](IBMStorage.md#IBMStorage) class's [UseVirtualHosting](IBMStorage.md#IBMStorage_p_UseVirtualHosting) property for more information. - *cspLinode (14)* - Defaults to *true*; refer to the [Linode](Linode.md#Linode) class's [UseVirtualHosting](Linode.md#Linode_p_UseVirtualHosting) property for more information. **XChildCount**: The number of child elements of the current element.This configuration settings specifies the number of child attributes of the current element. The XChild configuration settings will be indexed from 0 to ([XChildCount](#XChildCount) - 1). The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XChildName[i]**: The name of the child element.This configuration setting provides the name of the i-th child element of the current element. The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XChildXText[i]**: The inner text of the child element.This configuration setting provides the inner text of the i-th child element of the current element. The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XElement**: The name of the current element.This configuration setting provides the name of the current element. The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XParent**: The parent of the current element.This configuration setting provides the parent of the current element. The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XPath**: Provides a way to point to a specific element in the returned XML or JSON response.The [XPath](#XPath) setting allows you to point to specific elements in the XML or JSON response. When [XPath](#XPath) is set to a valid path, [XElement](#XElement) points to the name of the element, with [XText](#XText), [XParent](#XParent), [XSubTree](#XSubTree), [XChildCount](#XChildCount), [XChildName\[i\]](#XChildName[i]), and [XChildXText\[i\]](#XChildXText[i]) providing other properties of the element. XPath syntax is available for both XML and JSON documents. An XPath is a series of one or more element accessors separated by the */* character, for example, */A/B/C/D*. An XPath can be absolute (i.e., it starts with */*), or it can be relative to the current [XPath](#XPath) location. The following are possible values for an element accessor, which operates relative to the current location specified by the XPath accessors, which proceed it in the overall XPath string: | Accessor | Description | | --- | --- | | name | The first element with a particular name. Can be *. | | [i] | The i-th element. | | name[i] | The i-th element with a particular name. | | [last()] | The last element. | | [last()-i] | The element i before the last element. | | name[@attrname="attrvalue"] | The first element with a particular name that contains the specified attribute-value pair. Supports single and double quotes. (XML Only) | | . | The current element. | | .. | The parent element. | NOTE: XPath indices are *1-based*. For example, assume the following XML and JSON responses. XML: ```text value first second value three ``` JSON: ```text { "firstlevel": { "one": "value", "two": ["first", "second"], "three": "value three" } } ``` The following are examples of valid XPaths for these responses: | Description | XML XPath | JSON XPath | | --- | --- | --- | | Document root | / | /json | | Specific element | /firstlevel/one | /json/firstlevel/one | | i-th child | /firstlevel/two/item[2] | /json/firstlevel/two/[2] | This list is not exhaustive, but it provides a general idea of the possibilities. **XSubTree**: A snapshot of the current element in the document.This configuration setting provides the entirety of the current element (including its subelements). The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XText**: The text of the current element.This configuration setting provides the inner text of the current element. The current element is specified in the [XPath](#XPath) configuration setting. This configuration setting is read-only. ### OAuth Config Settings **OAuthAccessTokenExpiration**: The lifetime of the access token.This setting holds the lifetime of the access token in seconds. For instance the value *3600* indicates that the token will expire in one hour from the time it was generated. **OAuthAuthorizationTokenType**: The type of access token returned.The applicable values include the following: | | | | --- | --- | | Bearer (default) | When the access token returned by the server is a Bearer type, the authorization string returned by [Authorize](#authorize-method-cloudfiles-class) will be in the format "Bearer access_token". This can be supplied as the value of the HTTP Authorization header. | **OAuthAutomaticRefresh**: Whether or not to refresh an expired access token automatically.When this setting is set to *true* and the [Authorization](#authorization-property-cloudfiles-class) property is not set, the class will automatically get a new access token if it has the necessary properties to do so without user interaction. For example, when using the Authorization Code grant type, the [RefreshToken](#OAuthSettings_f_RefreshToken) field should be set to a valid refresh token. When using the Client Credential grant type however, the class does not need any additional properties set as it can already get a new access token without user interaction. **OAuthBrowserResponseTimeout**: Specifies the amount of time to wait for a response from the browser.This setting specifies the amount of time (in seconds) the class will wait for a response from the browser when requesting user authentication. The default value is *0*, meaning that the class will wait indefinitely. **OAuthIncludeEmptyRedirectURI**: Whether an empty redirect_uri parameter is included in requests.This setting specifies whether *redirect_uri* is included in the request made by [Authorize](#authorize-method-cloudfiles-class) if it is empty. If set to *true* (default) the *redirect_uri* will be sent in all cases. If set to *false* the *redirect_uri* will only be sent if it has a value. **OAuthJWTPayload**: The payload of the JWT access token if present.This configuration setting provides the payload section of a JWT access token if the access token is a JWT and the class is able to parse out the payload section. This setting only applies to **access tokens** that are returned from a service provider after successfully authorizing and authenticating with the service. To parse the payload for specific claims, see [OAuthJWTXPath](#OAuthJWTXPath). **OAuthJWTXChildCount**: The number of child elements of the current element.The number of child attributes of the current element. The OAuthJWTXChildCount configuration settings will be indexed from 0 to ([OAuthJWTXChildCount](#OAuthJWTXChildCount) - 1). The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only. **OauthJWTXChildName[i]**: The name of the child element.Provides the name of the i'th child element of the current element. The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only. **OAuthJWTXChildXText[i]**: The inner text of the child element.Provides the inner text of the i'th child element of the current element. The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only. **OAuthJWTXElement**: The name of the current element.Provides the name of the current element. The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only. **OauthJWTXParent**: The parent of the current element.Provides the parent of the current element. The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only. **OAuthJWTXPath**: Provides a way to point to a specific element in the returned payload of a JWT based access token.The [OAuthJWTXPath](#OAuthJWTXPath) setting allows you to point to specific claims within the payload of a JWT based access token. XPath syntax is available for the payload of JWT based access tokens if available. An XPath is a series of one or more element accessors separated by the */* character, for example: */A/B/C/D*. The following are possible values for an element accessor, which operates relative to the current location specified by the XPath accessors which proceed it in the overall XPath string: | Accessor | Description | | --- | --- | | name | The first element with a particular name. Can be *. | | [i] | The i-th element. | | name[i] | The i-th element with a particular name. | | [last()] | The last element. | | [last()-i] | The element i before the last element. | Here are some examples of valid XPaths and some common claims: | Description | JSON XPath | | --- | --- | | Document root | /json | | Specific element | /json/element_one | | Username Claim (Microsoft Specific) | /json/preferred_username | | Registered Application Name Claim (Microsoft Specific) | /json/app_displayname | This is not an exhaustive list by any means, but should provide a general idea of the possibilities. To get the text of the specified element, see [OAuthJWTXText](#OAuthJWTXText). **OAuthJWTXSubTree**: A snapshot of the current element in the document.Provides the entirety of the current element (including its sub-elements). The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only. **OAuthJWTXText**: The text of the current element.Provides the inner text of the current element. The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only. **OAuthParamCount**: Specifies the number of additional parameters variables to include in the request.This setting can be used to add query string parameters to the outgoing request. One common use for this method would be to add the "state" parameter to the request, which can be used when the [ClientProfile](#OAuthSettings_f_ClientProfile) is cocpWeb to add user defined data. The authorization server will include the "state" parameter in the response and will be available in the post back to your server which will allow you to maintain state in your application. This is used in conjunction with OAuthParamName[i] and OAuthParamValue[i]. For instance: ```text component.Config("OAuthParamCount=2"); component.Config("OAuthParamName[0]=myvar"); component.Config("OAuthParamValue[0]=myvalue"); component.Config("OAuthParamName[1]=testname"); component.Config("OAuthParamValue[1]=testvalue"); ``` Additionally, this will also be updated to hold the parameters returned in the response. ```text for (int i = 0; i < int.Parse(component.Config("OAuthParamCount")); i++) { string name = component.Config("OAuthParamName[" + i + "]"); string value = component.Config("OAuthParamValue[" + i + "]"); } ``` **OAuthParamName[i]**: Specifies the parameter name at the specified index.This setting can be used to retrieve or specify the parameter variable name at the index specified. See [OAuthParamCount](#OAuthParamCount) for details. **OAuthParamValue[i]**: Specifies the parameter value at the specified index.This setting can be used to retrieve or specify the parameter variable value at the index specified. See [OAuthParamCount](#OAuthParamCount) for details. **OAuthPasswordGrantUsername**: Used in the Resource Owner Password grant type.Used to set the username field when the [GrantType](#OAuthSettings_f_GrantType) is set to the password grant type and [Authorize](#authorize-method-cloudfiles-class) is called. **OAuthPKCEChallengeEncoding**: The PKCE code challenge method to use.This setting controls the PKCE code challenge method used when [OAuthUsePKCE](#OAuthUsePKCE) is set to *true*. Possible values are: - 1 (Plain) - 2 (S256/SHA256 - default) **OAuthPKCEVerifier**: The PKCE verifier used to generate the challenge.This configuration setting when queried provides the PKCE verifier that is used to generate the PKCE challenge for the [Authorize](#authorize-method-cloudfiles-class) method and the [WebAuthURL](#OAuthSettings_f_WebAuthURL) field when [OAuthUsePKCE](#OAuthUsePKCE) is set to true. When using the cocpWeb [ClientProfile](#OAuthSettings_f_ClientProfile), the configuration setting can be set instead to allow the authorization request to be made from a different instance than the authentication (token) request. **OAuthResetData**: Determines if the Reset method applies to the OAuth settings.If set to *true* (default), the [Reset](#reset-method-cloudfiles-class) method will reset the OAuth settings including any authorization fields like [AccessToken](#OAuthSettings_f_AccessToken) and [RefreshToken](#OAuthSettings_f_RefreshToken). This means the [Authorize](#authorize-method-cloudfiles-class) method must be called again to get new authorization information. When set to *false*, the [Reset](#reset-method-cloudfiles-class) method will **not** reset the [OAuth](#oauth-property-cloudfiles-class) property and the OAuth* configuration settings. This allows for the class to be reset without having to get authorization again. **OAuthReUseWebServer**: Determines if the same server instance is used between requests.If set to *true* (default), the same embedded web server instance will be used for multiple requests. If set to *false* the embedded web server will be created and destroyed on each call to [Authorize](#authorize-method-cloudfiles-class) **OAuthTransferredRequest**: The full OAuth request last sent by the client.This configuration setting returns the full OAuth request last sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request: .NET ```text Gmail gmail = new Gmail(); gmail.Config("OAuthTransferredRequest=on"); gmail.Authorize(); Console.WriteLine(gmail.Config("OAuthTransferredRequest")); ``` C++ ```text Gmail gmail; gmail.Config("OAuthTransferredRequest=on"); gmail.Authorize(); printf("%s\r\n", gmail.Config("OAuthTransferredRequest")); ``` **OAuthUsePKCE**: Specifies if PKCE should be used.If set to *true* (default), Proof Key for Code Exchange (PKCE) defined by RFC 7636 will be used when performing authorization. This setting applies when using the Authorization Code [GrantType](#OAuthSettings_f_GrantType). The [OAuthPKCEChallengeEncoding](#OAuthPKCEChallengeEncoding) configuration setting can be used to control the code challenge method that will be used. **OAuthWebServerActive**: Specifies and controls whether the embedded web server is active.The setting when queried will return the current state of the web server. If the webserver is active, it will return *"true"* and if it is inactive it will return *"false"*. This setting can also be set to activate or deactivate the web server. Under normal circumstances, this would not be required as the class will automatically start and stop the web server when [Authorize](#authorize-method-cloudfiles-class) is called. In certain cases, it is required to start the webserver before calling [Authorize](#authorize-method-cloudfiles-class). For example, if the [ReturnURL](#OAuthSettings_f_ReturnURL) needs to be set to a relay server, then you will need to start the web server manually. Another example would be when the [OAuthReUseWebServer](#OAuthReUseWebServer) is set to true, the server will not be automatically stopped, and this configuration setting must be set to *"false"* to stop the embedded web server. **OAuthWebServerCertStore**: The certificate with private key to use when SSL is enabled.The name of the certificate store used for the embedded web server's SSL. The [OAuthWebServerCertStoreType](#OAuthWebServerCertStoreType) field specifies the type of the certificate store specified by [OAuthWebServerCertStore](#OAuthWebServerCertStore). If the store is password protected, specify the password in [OAuthWebServerCertStorePassword](#OAuthWebServerCertStorePassword). [OAuthWebServerCertStore](#OAuthWebServerCertStore) is used in conjunction with the [OAuthWebServerCertSubject](#OAuthWebServerCertSubject) field in order to specify the certificate to be used during SSL. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | In Java, the certificate store normally is a file containing certificates and optional private keys. When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). Note: This is required when [OAuthWebServerSSLEnabled](#OAuthWebServerSSLEnabled) is set to *true*. **OAuthWebServerCertStorePassword**: The certificate with private key to use when SSL is enabled.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. Note: This is only applicable when [OAuthWebServerSSLEnabled](#OAuthWebServerSSLEnabled) is set to *true*. **OAuthWebServerCertStoreType**: The certificate with private key to use when SSL is enabled.This specifies the type of certificate store. Possible values are: | | | | --- | --- | | 0 | User - This is the default for Windows. This specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 | Machine - For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 | PFXFile - The certificate store is the name of a PFX (PKCS12) file containing certificates. | | 3 | PFXBlob - The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS12) format. | | 4 | JKSFile - The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is available only in Java. | | 5 | JKSBlob - The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is available only in Java. | | 6 | PEMKeyFile - The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 | PEMKeyBlob - The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 14 | PPKFile - The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 | PPKBlob - The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 | XMLFile - The certificate store is the name of a file that contains a certificate in XML format. | | 17 | XMLBlob - The certificate store is a string that contains a certificate in XML format. | Note: This is required when [OAuthWebServerSSLEnabled](#OAuthWebServerSSLEnabled) is set to *true*. **OAuthWebServerCertSubject**: The certificate with private key to use when SSL is enabled.The subject of the SSL certificate. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. Note: This is required when [OAuthWebServerSSLEnabled](#OAuthWebServerSSLEnabled) is set to *true*. **OAuthWebServerFailedResponse**: The custom response that will be displayed to the user if authentication failed.When [Authorize](#authorize-method-cloudfiles-class) is called the user will be redirected to the embedded web server upon completing authentication with the authorization server. If authentication failed, the HTML specified here will be sent to the user's browser. **OAuthWebServerHost**: The hostname used by the embedded web server displayed in the ReturnURL.This setting specifies the hostname used by the embedded web server when [ClientProfile](#OAuthSettings_f_ClientProfile) is set to cocpApplication. This specifies the interface on which the embedded web server listens, and also the value displayed in the [ReturnURL](#OAuthSettings_f_ReturnURL). This should be set to the hostname only, not the full URL. The default value is *localhost*. **OAuthWebServerPort**: The local port on which the embedded web server listens.This property specifies the port on which the embedded web server listens. Setting this to *0* (default) enables the system to choose a port at random. The chosen port will be returned when this setting is queried after the server has started listening.This is only applicable when using the embedded web server. **OAuthWebServerResponse**: The custom response that will be displayed to the user.When [Authorize](#authorize-method-cloudfiles-class) is called the user will be redirected to the embedded web server upon completing authentication with the authorization server. This setting allows you to specify the HTML that will be sent to the user's browser. **OAuthWebServerSSLEnabled**: Whether the web server requires SSL connections.This setting specifies whether the embedded web server will use SSL. If set to *True* OAuthWebServerCert* configs are required and the server will only accept SSL connections. If set to *False* only plaintext connects are supported. ### HTTP Config Settings **AcceptEncoding**: Used to tell the server which types of content encodings the client supports.When [AllowHTTPCompression](#AllowHTTPCompression) is True, the class adds an *Accept-Encoding* header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the *Accept-Encoding* header. NOTE: The class only supports gzip and deflate decompression algorithms. **AllowHTTPCompression**: This property enables HTTP compression for receiving data.This configuration setting enables HTTP compression for receiving data. When set to True (default), the class will accept compressed data. It then will uncompress the data it has received. The class will handle data compressed by both gzip and deflate compression algorithms. When True, the class adds an *Accept-Encoding* header to the outgoing request. The value for this header can be controlled by the [AcceptEncoding](#AcceptEncoding) configuration setting. The default value for this header is "gzip, deflate". The default value is True. **AllowHTTPFallback**: Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when HTTPVersion is set to "2.0". If set to True (default), the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class throws an exception if the server does not support HTTP/2. The default value is True. **AllowNTLMFallback**: Whether to allow fallback from Negotiate to NTLM when authenticating.This configuration setting applies only when AuthScheme is set to Negotiate. If set to True, the class will automatically use New Technology LAN Manager (NTLM) if the server does not support Negotiate authentication. NOTE: The server must indicate that it supports NTLM authentication through the WWW-Authenticate header for the fallback from Negotiate to NTLM to take place. The default value is False. **Append**: Whether to append data to LocalFile.This configuration setting determines whether data will be appended when writing to [LocalFile](#localfile-property-cloudfiles-class). When set to True, downloaded data will be appended to [LocalFile](#localfile-property-cloudfiles-class). This may be used in conjunction with Range to resume a failed download. This is applicable only when [LocalFile](#localfile-property-cloudfiles-class) is set. The default value is False. **Authorization**: The Authorization string to be sent to the server.If the [Authorization](#Authorization) property contains a nonempty string, an *Authorization* HTTP request header is added to the request. This header conveys Authorization information to the server. This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class. 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](#authorization-property-cloudfiles-class) property in the form "Basic [encoded-user-password]". **BytesTransferred**: Contains the number of bytes transferred in the response data.This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the [Transfer](#transfer-event-cloudfiles-class) event, by [BytesTransferred](#BytesTransferred). **ChunkSize**: Specifies the chunk size in bytes when using chunked encoding.This is applicable only when [UseChunkedEncoding](#UseChunkedEncoding) is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384. **CompressHTTPRequest**: Set to true to compress the body of a PUT or POST request.If set to True, the body of a *PUT* or *POST* request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request. The default value is False. **EncodeURL**: If set to True the URL will be encoded by the class.If set to True, the URL passed to the class will be URL encoded. The default value is False. **FollowRedirects**: Determines what happens when the server issues a redirect.This option determines what happens when the server issues a redirect. Normally, the class returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new URL for the object is retrieved automatically every time. If this property is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same; otherwise, the class throws an exception. **Note:** 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 potentially could change the conditions of the initial request and create security vulnerabilities. Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server. A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters). The default value is 0 (Never). In this case, redirects are never followed, and the class throws an exception instead. Following are the valid options: - 0 - Never - 1 - Always - 2 - Same Scheme **GetOn302Redirect**: If set to True the class will perform a GET on the new location.The default value is False. If set to True, the class will perform a *GET* on the new location. Otherwise, it will use the same HTTP method again. **HTTP2HeadersWithoutIndexing**: HTTP2 headers that should not update the dynamic header table with incremental indexing.HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names. **HTTPVersion**: The version of HTTP used by the class.This property specifies the HTTP version used by the class. Possible values are as follows: - "1.0" - "1.1" (default) - "2.0" - "3.0" When using HTTP/2 ("2.0") or HTTP/3 ("3.0"), additional restrictions apply. Please see the following notes for details. **HTTP/2 Notes** When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error. If the server does not support HTTP/2, the class will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check [NegotiatedHTTPVersion](#NegotiatedHTTPVersion) after calling a method. The [AllowHTTPFallback](#AllowHTTPFallback) setting controls whether this behavior is allowed (default) or disallowed. HTTP/2 is supported on all platforms. The class will use the internal security implementation in all cases when connecting. **HTTP/3 Notes** HTTP/3 is supported only in .NET and Java. When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error. **IfModifiedSince**: A date determining the maximum age of the desired document.If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example: ```text Sat, 29 Oct 2017 19:43:31 GMT. ``` **KeepAlive**: Determines whether the HTTP connection is closed after completion of the request.If *true*, the component will not send the *Connection: Close* header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. NOTE: Not all servers support persistent connections. If *false*, the connection will be closed immediately after the server response is received. The default value for [KeepAlive](#KeepAlive) is *false*. **KerberosSPN**: The Service Principal Name for the Kerberos Domain Controller.If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here. **LogLevel**: The level of detail that is logged.This configuration setting controls the level of detail that is logged through the [Log](#log-event-cloudfiles-class) event. Possible values are as follows: | | | | --- | --- | | 0 (None) | No events are logged. | | 1 (Info - default) | Informational events are logged. | | 2 (Verbose) | Detailed data are logged. | | 3 (Debug) | Debug data are logged. | The value 1 (Info) logs basic information, including the URL, HTTP version, and status details. The value 2 (Verbose) logs additional information about the request and response. The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any). **MaxHeaders**: Instructs class to save the amount of headers specified that are returned by the server after a Header event has been fired.This configuration setting should be set when the TransferredHeaders collection is to be populated when a Header event has been fired. This value represents the number of headers that are to be saved in the collection. To save all items to the collection, set this configuration setting to -1. If no items are wanted, set this to 0, which will not save any items to the collection. The default for this configuration setting is -1, so all items will be included in the collection. **MaxHTTPCookies**: Instructs class to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.This configuration setting should be set when populating the Cookies collection as a result of an HTTP request. This value represents the number of cookies that are to be saved in the collection. To save all items to the collection, set this configuration setting to -1. If no items are wanted, set this to 0, which will not save any items to the collection. The default for this configuration setting is -1, so all items will be included in the collection. **MaxRedirectAttempts**: Limits the number of redirects that are followed in a request.When FollowRedirects is set to any value other than frNever, the class will follow redirects until this maximum number of redirect attempts are made. The default value is 20. **NegotiatedHTTPVersion**: The negotiated HTTP version.This configuration setting may be queried after the request is complete to indicate the HTTP version used. When HTTPVersion is set to "2.0" (if the server does not support "2.0"), then the class will fall back to using "1.1" automatically. This setting will indicate which version was used. **OtherHeaders**: Other headers as determined by the user (optional).This configuration setting can be set to a string of headers to be appended to the HTTP request headers. The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF (*"\r\n"*) . Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail. This configuration setting is useful for extending the functionality of the class beyond what is provided. **ProxyAuthorization**: The authorization string to be sent to the proxy server.This is similar to the [Authorization](#Authorization) configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a *Proxy-Authorization* HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If [User](#Proxy_f_User) and [Password](#Proxy_f_Password) are specified, this value is calculated using the algorithm specified by [AuthScheme](#Proxy_f_AuthScheme). **ProxyAuthScheme**: The authorization scheme to be used for the proxy.This configuration setting is provided for use by classes that do not directly expose Proxy properties. **ProxyPassword**: A password if authentication is to be used for the proxy.This configuration setting is provided for use by classes that do not directly expose Proxy properties. **ProxyPort**: Port for the proxy server (default 80).This configuration setting is provided for use by classes that do not directly expose Proxy properties. **ProxyServer**: Name or IP address of a proxy server (optional).This configuration setting is provided for use by classes that do not directly expose Proxy properties. **ProxyUser**: A user name if authentication is to be used for the proxy.This configuration setting is provided for use by classes that do not directly expose Proxy properties. **SentHeaders**: The full set of headers as sent by the client.This configuration setting returns the complete set of raw headers as sent by the client. **StatusCode**: The status code of the last response from the server.This configuration setting contains the result code of the last response from the server. **StatusLine**: The first line of the last response from the server.This setting contains the first line of the last response from the server. The format of the line will be *[HTTP version] [Result Code] [Description]*. **TransferredData**: The contents of the last response from the server.This configuration setting contains the contents of the last response from the server. **TransferredDataLimit**: The maximum number of incoming bytes to be stored by the class.If [TransferredDataLimit](#TransferredDataLimit) is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the class. **TransferredHeaders**: The full set of headers as received from the server.This configuration setting returns the complete set of raw headers as received from the server. **TransferredRequest**: The full request as sent by the client.This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request: .NET ```text Http http = new Http(); http.Config("TransferredRequest=on"); http.PostData = "body"; http.Post("http://someserver.com"); Console.WriteLine(http.Config("TransferredRequest")); ``` C++ ```text HTTP http; http.Config("TransferredRequest=on"); http.SetPostData("body", 5); http.Post("http://someserver.com"); printf("%s\r\n", http.Config("TransferredRequest")); ``` **UseChunkedEncoding**: Enables or Disables HTTP chunked encoding for transfers.If [UseChunkedEncoding](#UseChunkedEncoding) is set to True, the class will use HTTP-chunked encoding when posting, if possible. HTTP-chunked encoding allows large files to be sent in chunks instead of all at once. If set to False, the class will not use HTTP-chunked encoding. The default value is False. NOTE: Some servers (such as the ASP.NET Development Server) may not support chunked encoding. **UseIDNs**: Whether to encode hostnames to internationalized domain names.This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name). The default value is False and the hostname will always be used exactly as specified. **UsePlatformDeflate**: Whether to use the platform implementation to decompress compressed responses.This configuration setting specifies whether the platform's deflate-algorithm implementation is used to decompress responses that use compression. If set to *True* (default), the platform implementation is used. If set to *False*, an internal implementation is used. **UsePlatformHTTPClient**: Whether or not to use the platform HTTP client.When using this configuration setting, if True, the component will use the default HTTP client for the platform (*URLConnection* in Java, *WebRequest* in .NET, or CFHTTPMessage in Mac/iOS) instead of the internal HTTP implementation. This is important for environments in which direct access to sockets is limited or not allowed (e.g., in the Google AppEngine). **UseProxyAutoConfigURL**: Whether to use a Proxy auto-config file when attempting a connection.This configuration specifies whether the class will attempt to use the Proxy auto-config URL when establishing a connection and [AutoDetect](#Proxy_f_AutoDetect) is set to *True*. When *True* (default), the class will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use. **UserAgent**: Information about the user agent (browser).This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com". Override the default with the name and version of your software. ### TCPClient Config Settings **CloseStreamAfterTransfer**: If true, the component will close the upload or download stream after the transfer.This configuration setting determines whether the input or output stream is closed after the transfer completes. When set to True (default), all streams will be closed after a transfer is completed. To keep streams open after the transfer of data, set this to False. The default value is True. **ConnectionTimeout**: Sets a separate timeout value for establishing a connection.When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use [Timeout](#timeout-property-cloudfiles-class) for establishing a connection and transmitting/receiving data. **FirewallAutoDetect**: Tells the class whether or not to automatically detect and use firewall system settings, if available.This configuration setting is provided for use by classes that do not directly expose Firewall properties. **FirewallHost**: Name or IP address of firewall (optional).If a [FirewallHost](#FirewallHost) is given, requested connections will be authenticated through the specified firewall when connecting. If the [FirewallHost](#FirewallHost) setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the [FirewallHost](#FirewallHost) setting is set to the corresponding address. If the search is not successful, an error is returned. NOTE: This setting is provided for use by classes that do not directly expose Firewall properties. **FirewallHTTPVersion**: The HTTP version to be used when connecting through a tunneling proxy.When [FirewallType](#FirewallType) is set to a tunneling proxy, this setting dictates which HTTP version is used when connecting. **FirewallListener**: If true, the component binds to a SOCKS firewall as a server (TCPClient only).This entry is for TCPClient only and does not work for other components that descend from TCPClient. If this entry is set, the class acts as a server. RemoteHost and RemotePort are used to tell the SOCKS firewall in which address and port to listen to. The firewall rules may ignore RemoteHost, and it is recommended that RemoteHost be set to empty string in this case. RemotePort is the port in which the firewall will listen to. If set to 0, the firewall will select a random port. The binding (address and port) is provided through the ConnectionStatus event. The connection to the firewall is made by calling the Connect method. **FirewallPassword**: Password to be used if authentication is to be used when connecting through the firewall.If [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the given firewall. If the authentication fails, the class throws an exception. NOTE: This setting is provided for use by classes that do not directly expose Firewall properties. **FirewallPort**: The TCP port for the FirewallHost;.The [FirewallPort](#FirewallPort) is set automatically when [FirewallType](#FirewallType) is set to a valid value. NOTE: This configuration setting is provided for use by classes that do not directly expose Firewall properties. **FirewallType**: Determines the type of firewall to connect through.Possible values are as follows: | | | | --- | --- | | 0 | No firewall (default setting). | | 1 | Connect through a tunneling proxy. [FirewallPort](#FirewallPort) is set to 80. | | 2 | Connect through a SOCKS4 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 3 | Connect through a SOCKS5 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 10 | Connect through a SOCKS4A Proxy. [FirewallPort](#FirewallPort) is set to 1080. | NOTE: This setting is provided for use by classes that do not directly expose Firewall properties. **FirewallUser**: A user name if authentication is to be used connecting through a firewall.If the [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the Firewall. If the authentication fails, the class throws an exception. NOTE: This setting is provided for use by classes that do not directly expose Firewall properties. **KeepAliveInterval**: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by [KeepAliveTime](#KeepAliveTime). If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second. NOTE: This value is not applicable in macOS. **KeepAliveTime**: The inactivity time in milliseconds before a TCP keep-alive packet is sent.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds. **Linger**: When set to True, connections are terminated gracefully.This property controls how a connection is closed. The default is True. In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if [LingerTime](#LingerTime) is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires. In the second scenario, if [LingerTime](#LingerTime) is a positive value, the system will attempt to send pending data until the specified [LingerTime](#LingerTime) is reached. If this attempt fails, then the system will reset the connection. The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes). Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action. **LingerTime**: Time in seconds to have the connection linger. LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout. **LocalHost**: The name of the local host through which connections are initiated or accepted. The [LocalHost](#localhost-property-cloudfiles-class) setting 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 class initiate connections (or accept in the case of server classes) only through that interface. If the class is connected, the [LocalHost](#localhost-property-cloudfiles-class) setting 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). **LocalPort**: The port in the local host where the class binds. This configuration setting must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine. Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established. LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error. This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems. **MaxLineLength**: The maximum amount of data to accumulate when no EOL is found.[MaxLineLength](#MaxLineLength) is the size of an internal buffer, which holds received data while waiting for an EOL string. If an EOL string is found in the input stream before [MaxLineLength](#MaxLineLength) bytes are received, the DataIn event is fired with the *EOL* parameter set to True, and the buffer is reset. If no EOL is found, and [MaxLineLength](#MaxLineLength) bytes are accumulated in the buffer, the DataIn event is fired with the *EOL* parameter set to False, and the buffer is reset. The minimum value for [MaxLineLength](#MaxLineLength) is 256 bytes. The default value is 2048 bytes. **MaxTransferRate**: The transfer rate limit in bytes per second.This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit. **ProxyExceptionsList**: A semicolon separated list of hosts and IPs to bypass when using a proxy.This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance: *www.google.com;www.example.com* **TCPKeepAlive**: Determines whether or not the keep alive socket option is enabled.If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set [KeepAliveTime](#KeepAliveTime) and [KeepAliveInterval](#KeepAliveInterval) to configure the timing of the keep-alive packets. NOTE: This value is not applicable in Java. **TcpNoDelay**: Whether or not to delay when sending packets. When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm. By default, this configuration setting is set to False. **UseIPv6**: Whether to use IPv6.When set to *0* (default), the class will use IPv4 exclusively. When set to *1*, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to *2*. The default value is *0*. Possible values are as follows: | | | | --- | --- | | 0 | IPv4 only | | 1 | IPv6 only | | 2 | IPv6 with IPv4 fallback | **UseNTLMv2**: Whether to use NTLM V2.When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is True and NTLM V2 will be used. Set this to False to use NTLM V1. ### SSL Config Settings **LogSSLPackets**: Controls whether SSL packets are logged when using the internal security API.When [SSLProvider](#sslprovider-property-cloudfiles-class) is set to *Internal*, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is *False*, as it is useful only for debugging purposes. When enabled, SSL packet logs are output using the [SSLStatus](#sslstatus-event-cloudfiles-class) event, which will fire each time an SSL packet is sent or received. Enabling this configuration setting has no effect if [SSLProvider](#sslprovider-property-cloudfiles-class) is set to *Platform*. **ReuseSSLSession**: Determines if the SSL session is reused. If set to True, the class will reuse the context if and only if the following criteria are met: - The target host name is the same. - The system cache entry has not expired (default timeout is 10 hours). - The application process that calls the function is the same. - The logon session is the same. - The instance of the class is the same. **SSLCACerts**: A newline separated list of CA certificates to be included when performing an SSL handshake.When [SSLProvider](#sslprovider-property-cloudfiles-class) is set to *Internal*, this configuration setting specifies one or more CA certificates to be included with the [SSLCert](#sslcert-property-cloudfiles-class) property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **SSLCheckCRL**: Whether to check the Certificate Revocation List for the server certificate.This configuration setting specifies whether the class will check the Certificate Revocation List (CRL) specified by the server certificate. If set to 1 or 2, the class will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The class will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class throws an exception. When set to 0 (default), the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported. This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems. **SSLCheckOCSP**: Whether to use OCSP to check the status of the server certificate.This configuration setting specifies whether the class will use OCSP to check the validity of the server certificate. If set to 1 or 2, the class will first obtain the Online Certificate Status Protocol (OCSP) URL from the server certificate's OCSP extension. The class will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation, the class throws an exception. When set to 0 (default), the class will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported. This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems. **SSLCipherStrength**: The minimum cipher strength used for bulk encryption. This minimum cipher strength is 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. NOTE: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the [SSLStatus](#sslstatus-event-cloudfiles-class) event. Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application. When the provider is OpenSSL, [SSLCipherStrength](#SSLCipherStrength) is currently not supported. This functionality is instead made available through the [OpenSSLCipherList](#OpenSSLCipherList) configuration setting. **SSLClientCACerts**: A newline separated list of CA certificates to use during SSL client certificate validation.This configuration setting is only applicable to server components (e.g., TCPServer) see [SSLServerCACerts](#SSLServerCACerts) for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when SSLAuthenticateClients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **SSLContextProtocol**: The protocol used when getting an SSLContext instance.Possible values are SSL, SSLv2, SSLv3, TLS, and TLSv1. Use this configuration setting only in case your security provider does not support TLS. This is the parameter "protocol" inside the SSLContext.getInstance(protocol) call. **SSLEnabledCipherSuites**: The cipher suite to be used in an SSL negotiation.This configuration setting enables the 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 class will pick all of the supported cipher suites. If [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is set to any other value, only the specified cipher suites will be considered. Multiple cipher suites are separated by semicolons. NOTE: This value must be set after [SSLProvider](#sslprovider-property-cloudfiles-class) is set. Example values: ```text obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=SSL_RSA_WITH_RC4_128_SHA"); obj.config("SSLEnabledCipherSuites=SSL_RSA_WITH_RC4_128_SHA; SSL_DHE_RSA_WITH_3DES_EDE_CBC_SHA"); ``` Possible values when [SSLProvider](#sslprovider-property-cloudfiles-class) is set to *Platform* include the following: - SSL_DHE_RSA_EXPORT_WITH_DES40_CBC_SHA - SSL_DHE_RSA_WITH_3DES_EDE_CBC_SHA - SSL_RSA_WITH_RC4_128_SHA - SSL_RSA_WITH_DES_CBC_SHA - SSL_RSA_EXPORT_WITH_DES40_CBC_SHA - SSL_DH_anon_WITH_DES_CBC_SHA - SSL_RSA_EXPORT_WITH_RC4_40_MD5 - SSL_DHE_DSS_EXPORT_WITH_DES40_CBC_SHA - SSL_DH_anon_EXPORT_WITH_RC4_40_MD5 - SSL_DHE_DSS_WITH_DES_CBC_SHA - SSL_RSA_WITH_NULL_MD5 - SSL_DH_anon_WITH_3DES_EDE_CBC_SHA - SSL_DHE_RSA_WITH_DES_CBC_SHA - SSL_DH_anon_EXPORT_WITH_DES40_CBC_SHA - SSL_RSA_WITH_NULL_SHA - SSL_DH_anon_WITH_RC4_128_MD5 - SSL_RSA_WITH_RC4_128_MD5 - SSL_DHE_DSS_WITH_3DES_EDE_CBC_SHA - SSL_RSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_ECDSA_WITH_NULL_SHA - TLS_DH_anon_WITH_AES_128_CBC_SHA256 (Not Recommended) - TLS_ECDH_anon_WITH_RC4_128_SHA - TLS_DH_anon_WITH_AES_128_CBC_SHA (Not Recommended) - TLS_DHE_RSA_WITH_AES_128_CBC_SHA - TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA - TLS_KRB5_WITH_3DES_EDE_CBC_SHA - TLS_DHE_DSS_WITH_AES_128_CBC_SHA256 - TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA - TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 - TLS_KRB5_EXPORT_WITH_RC4_40_SHA - TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256 - TLS_ECDHE_RSA_WITH_RC4_128_SHA - TLS_ECDH_ECDSA_WITH_RC4_128_SHA - TLS_ECDH_anon_WITH_NULL_SHA - TLS_ECDHE_ECDSA_WITH_RC4_128_SHA - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA - TLS_RSA_WITH_NULL_SHA256 - TLS_ECDH_anon_WITH_3DES_EDE_CBC_SHA - TLS_KRB5_WITH_RC4_128_MD5 - TLS_ECDHE_ECDSA_WITH_NULL_SHA - TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_RSA_WITH_RC4_128_SHA - TLS_EMPTY_RENEGOTIATION_INFO_SCSV - TLS_KRB5_WITH_3DES_EDE_CBC_MD5 - TLS_KRB5_WITH_RC4_128_SHA - TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_RSA_WITH_NULL_SHA - TLS_ECDH_RSA_WITH_AES_128_CBC_SHA - TLS_KRB5_WITH_DES_CBC_MD5 - TLS_KRB5_EXPORT_WITH_RC4_40_MD5 - TLS_KRB5_EXPORT_WITH_DES_CBC_40_MD5 - TLS_ECDH_anon_WITH_AES_128_CBC_SHA - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 - TLS_KRB5_WITH_DES_CBC_SHA - TLS_RSA_WITH_AES_128_CBC_SHA - TLS_KRB5_EXPORT_WITH_DES_CBC_40_SHA - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 - TLS_ECDHE_RSA_WITH_NULL_SHA - TLS_RSA_WITH_AES_128_CBC_SHA256 - TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA - TLS_DHE_DSS_WITH_AES_128_CBC_SHA Possible values when [SSLProvider](#sslprovider-property-cloudfiles-class) is set to *Internal* include the following: - TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_RSA_WITH_AES_256_GCM_SHA384 - TLS_RSA_WITH_AES_128_GCM_SHA256 - TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_DSS_WITH_AES_256_GCM_SHA384 - TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_DSS_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 - TLS_DHE_DSS_WITH_AES_256_CBC_SHA256 - TLS_RSA_WITH_AES_256_CBC_SHA256 - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 - TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384 - TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 - TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 - TLS_RSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256 - TLS_DHE_DSS_WITH_AES_128_CBC_SHA256 - TLS_RSA_WITH_AES_256_CBC_SHA - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA - TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA - TLS_DHE_RSA_WITH_AES_256_CBC_SHA - TLS_ECDH_RSA_WITH_AES_256_CBC_SHA - TLS_DHE_DSS_WITH_AES_256_CBC_SHA - TLS_RSA_WITH_AES_128_CBC_SHA - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA - TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA - TLS_ECDH_RSA_WITH_AES_128_CBC_SHA - TLS_DHE_RSA_WITH_AES_128_CBC_SHA - TLS_DHE_DSS_WITH_AES_128_CBC_SHA - TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA - TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA - TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA - TLS_RSA_WITH_3DES_EDE_CBC_SHA - TLS_RSA_WITH_DES_CBC_SHA - TLS_DHE_RSA_WITH_DES_CBC_SHA - TLS_DHE_DSS_WITH_DES_CBC_SHA - TLS_RSA_WITH_RC4_128_MD5 - TLS_RSA_WITH_RC4_128_SHA When TLS 1.3 is negotiated (see [SSLEnabledProtocols](#SSLEnabledProtocols)), only the following cipher suites are supported: - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 - TLS_AES_128_GCM_SHA256 [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is used together with [SSLCipherStrength](#SSLCipherStrength). **SSLEnabledProtocols**: Used to enable/disable the supported security protocols.This configuration setting is used to enable or disable the supported security protocols. Not all supported protocols are enabled by default. The default value is *4032* for client components, and *3072* for server components. To specify a combination of enabled protocol versions set this config to the binary *OR* of one or more of the following values: | | | | --- | --- | | TLS1.3 | 12288 (Hex 3000) | | TLS1.2 | 3072 (Hex C00) (Default - Client and Server) | | TLS1.1 | 768 (Hex 300) (Default - Client) | | TLS1 | 192 (Hex C0) (Default - Client) | | SSL3 | 48 (Hex 30) | | SSL2 | 12 (Hex 0C) | Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases. **SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:** By default when TLS 1.3 is enabled, the class will first try to use the platform TLS 1.3 implementation when the [SSLProvider](#sslprovider-property-cloudfiles-class) is set to Automatic for all editions. If the platform TLS 1.3 implementation is not available, the internal implementation will be used. In editions that are designed to run on Windows, [SSLProvider](#sslprovider-property-cloudfiles-class) can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version. If set to *1* (Platform provider), please be aware of the following notes: - The platform provider is available only on Windows 11/Windows Server 2022 and up. - [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) and other similar SSL configuration settings are not supported. - If [SSLEnabledProtocols](#SSLEnabledProtocols) includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions. **SSLEnabledProtocols: SSL2 and SSL3 Notes: ** SSL 2.0 and 3.0 are not supported by the class when the [SSLProvider](#sslprovider-property-cloudfiles-class) is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and [SSLProvider](#sslprovider-property-cloudfiles-class) needs to be set to platform. **SSLEnableRenegotiation**: Whether the renegotiation_info SSL extension is supported.This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is *false* by default, but it can be set to *true* to enable the extension. This configuration setting is applicable only when [SSLProvider](#sslprovider-property-cloudfiles-class) is set to *Internal*. **SSLIncludeCertChain**: Whether the entire certificate chain is included in the SSLServerAuthentication event.This configuration setting specifies whether the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-cloudfiles-class) event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-cloudfiles-class) event. If set to True, all certificates returned by the server will be present in the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-cloudfiles-class) event. This includes the leaf certificate, any intermediate certificate, and the root certificate. Note: When [SSLProvider](#sslprovider-property-cloudfiles-class) is set to *Internal* this value is automatically set to *true*. This is needed for proper validation when using the internal provider. **SSLKeyLogFile**: The location of a file where per-session secrets are written for debugging purposes.This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes. When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the class will only append, it will not overwrite previous values. NOTE: This configuration setting is applicable only when [SSLProvider](#sslprovider-property-cloudfiles-class) is set to *Internal*. **SSLNegotiatedCipher**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipher[connId]"); ``` **SSLNegotiatedCipherStrength**: Returns the negotiated cipher suite strength.This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherStrength[connId]"); ``` **SSLNegotiatedCipherSuite**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherSuite[connId]"); ``` **SSLNegotiatedKeyExchange**: Returns the negotiated key exchange algorithm.This configuration setting returns the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchange[connId]"); ``` **SSLNegotiatedKeyExchangeStrength**: Returns the negotiated key exchange algorithm strength.This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchangeStrength[connId]"); ``` **SSLNegotiatedVersion**: Returns the negotiated protocol version.This configuration setting returns the protocol version negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedVersion[connId]"); ``` **SSLServerCACerts**: A newline separated list of CA certificates to use during SSL server certificate validation.This configuration setting is only used by client components (e.g., TCPClient) see [SSLClientCACerts](#SSLClientCACerts) for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **SSLTrustManagerFactoryAlgorithm**: The algorithm to be used to create a TrustManager through TrustManagerFactory.Possible values include SunX509. This is the parameter "algorithm" inside the TrustManagerFactory.getInstance(algorithm) call. **TLS12SignatureAlgorithms**: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.This configuration setting specifies the allowed server certificate signature algorithms when [SSLProvider](#sslprovider-property-cloudfiles-class) is set to *Internal* and [SSLEnabledProtocols](#SSLEnabledProtocols) is set to allow TLS 1.2. When specified the class will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the class throws an exception. The format of this value is a comma-separated list of hash-signature combinations. For instance: ```csharp component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); ``` The default value for this configuration setting is *sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa*. To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent. **TLS12SupportedGroups**: The supported groups for ECC.This configuration 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 [SSLProvider](#sslprovider-property-cloudfiles-class) is set to *Internal*, the values refer to the supported groups for ECC. The following values are supported: - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" (default) **TLS13KeyShareGroups**: The groups for which to pregenerate key shares.This configuration 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 roundtrip 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 configuration setting. NOTE: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group. In most cases, this configuration setting does not need to be modified. This should be modified only 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: - "ecdhe_x25519" (default) - "ecdhe_x448" - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" - "ffdhe_2048" (default) - "ffdhe_3072" (default) - "ffdhe_4096" - "ffdhe_6144" - "ffdhe_8192" **TLS13SignatureAlgorithms**: The allowed certificate signature algorithms.This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following: - "ed25519" (default) - "ed448" (default) - "ecdsa_secp256r1_sha256" (default) - "ecdsa_secp384r1_sha384" (default) - "ecdsa_secp521r1_sha512" (default) - "rsa_pkcs1_sha256" (default) - "rsa_pkcs1_sha384" (default) - "rsa_pkcs1_sha512" (default) - "rsa_pss_sha256" (default) - "rsa_pss_sha384" (default) - "rsa_pss_sha512" (default) The default value is *rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448*. This configuration setting is applicable only when [SSLEnabledProtocols](#SSLEnabledProtocols) includes TLS 1.3. **TLS13SupportedGroups**: The supported groups for (EC)DHE key exchange.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only 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,mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768* The values are ordered from most preferred to least preferred. The following values are supported: - "ecdhe_x25519" (default) - "ecdhe_x448" (default) - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" (default) - "ffdhe_2048" (default) - "ffdhe_3072" (default) - "ffdhe_4096" (default) - "ffdhe_6144" (default) - "ffdhe_8192" (default) - "mlkem_512" (default) - "mlkem_768" (default) - "mlkem_1024" (default) - "x25519_mlkem_768" (default) - "secp256r1_mlkem_768" (default) Post-quantum algorithms (*mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*) in our components rely on the operating system's underlying cryptographic primitives. The following platforms are currently supported: - Windows Server 2025 - Windows 11 24H2 - Windows 11 25H2 ### Socket Config Settings **AbsoluteTimeout**: Determines whether timeouts are inactivity timeouts or absolute timeouts.If [AbsoluteTimeout](#AbsoluteTimeout) is set to True, any method that does not complete within [Timeout](#timeout-property-cloudfiles-class) seconds will be aborted. By default, *AbsoluteTimeout* is False, and the timeout is an inactivity timeout. NOTE: This option is not valid for User Datagram Protocol (UDP) ports. **FirewallData**: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes). **InBufferSize**: The size in bytes of the incoming queue of the socket.This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the *InBufferSize* setting can provide significant improvements in performance. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the *InBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small. **OutBufferSize**: The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the *OutBufferSize* setting can provide significant improvements in performance. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the *OutBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small. ### Base Config Settings **BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build. **GUIAvailable**: Whether or not a message loop is available for processing events.In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The class will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation. In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting [GUIAvailable](#GUIAvailable) to *false* will ensure that the class does not attempt to process external events. **LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information: - Product: The product the license is for. - Product Key: The key the license was generated from. - License Source: Where the license was found (e.g., RuntimeLicense, License File). - License Type: The type of license installed (e.g., Royalty Free, Single Server). - Last Valid Build: The last valid build number for which the license will work. **MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*. **UseDaemonThreads**: Whether threads created by the class are daemon threads.If set to True (default), when the class creates a thread, the thread's Daemon property will be explicitly set to True. When set to False, the class will not set the Daemon property on the created thread. The default value is True. **UseFIPSCompliantAPI**: Tells the class whether or not to use FIPS certified APIs.When set to *true*, the class will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle Federal Information Processing Standards (FIPS), while all other Windows editions make use of Microsoft security libraries. The Java edition requires installation of the FIPS-certified Bouncy Castle library regardless of the target operating system. This can be downloaded from [https://www.bouncycastle.org/fips-java/](https://www.bouncycastle.org/fips-java/). Only the "Provider" library is needed. The jar file should then be installed in a JRE search path. The following classes must be imported in the application in which the component will be used: ```text import java.security.Security; import org.bouncycastle.jcajce.provider.BouncyCastleFipsProvider; ``` The Bouncy Castle provider must be added as a valid provider and must also be configured to operate in FIPS mode: ```text System.setProperty("org.bouncycastle.fips.approved_only","true"); Security.addProvider(new BouncyCastleFipsProvider()); ``` When [UseFIPSCompliantAPI](#UseFIPSCompliantAPI) is *true*, Secure Sockets Layer (SSL)-enabled classes can optionally be configured to use the Transport Layer Security (TLS) Bouncy Castle library. When [SSLProvider](#sslprovider-property-cloudfiles-class) is set to *sslpAutomatic* (default) or *sslpInternal*, an internal TLS implementation is used, but all cryptographic operations are offloaded to the Bouncy Castle FIPS provider to achieve FIPS-compliant operation. If [SSLProvider](#sslprovider-property-cloudfiles-class) is set to *sslpPlatform*, the Bouncy Castle JSSE will be used in place of the internal TLS implementation. To enable the use of the Bouncy Castle JSSE take the following steps in addition to the steps above. Both the Bouncy Castle FIPS provider and the Bouncy Castle JSSE must be configured to use the Bouncy Castle TLS library in FIPS mode. Obtain the Bouncy Castle TLS library from [https://www.bouncycastle.org/fips-java/](https://www.bouncycastle.org/fips-java/). The jar file should then be installed in a JRE search path. The following classes must be imported in the application in which the component will be used: ```text import java.security.Security; import org.bouncycastle.jcajce.provider.BouncyCastleFipsProvider; //required to use BCJSSE when SSLProvider is set to sslpPlatform import org.bouncycastle.jsse.provider.BouncyCastleJsseProvider; ``` The Bouncy Castle provider must be added as a valid provider and also must be configured to operate in FIPS mode: ```text System.setProperty("org.bouncycastle.fips.approved_only","true"); Security.addProvider(new BouncyCastleFipsProvider()); //required to use BCJSSE when SSLProvider is set to sslpPlatform Security.addProvider(new BouncyCastleJsseProvider("fips:BCFIPS")); //optional - configure logging level of BCJSSE Logger.getLogger("org.bouncycastle.jsse").setLevel(java.util.logging.Level.OFF); //configure the class to use BCJSSE component.setSSLProvider(1); //platform component.config("UseFIPSCompliantAPI=true"); ``` NOTE: TLS 1.3 support requires the Bouncy Castle TLS library version 1.0.14 or later. FIPS mode can be enabled by setting the *UseFIPSCompliantAPI* configuration setting to *true*. This is a static setting that applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior. For more details, please see the [FIPS 140-2 Compliance](https://www.nsoftware.com/kb/articles/fips.rst) article. NOTE: Enabling FIPS compliance requires a special license; please contact [sales@nsoftware.com](mailto:sales@nsoftware.com) for details. **UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the class will use the system security libraries by default to perform cryptographic functions where applicable. Setting this configuration setting to *true* tells the class to use the internal implementation instead of using the system security libraries. This setting is set to *false* by default on all platforms. **UseVirtualThreads**: Whether threads created by the class use virtual threads instead of platform threads.If set to *true*, when the class creates a thread, it will be created as a virtual thread instead of a platform thread. Virtual threads are lightweight threads managed by the JVM that are multiplexed onto a small pool of carrier threads, significantly reducing memory usage and platform thread count under high-concurrency workloads. Requires Java 24 or later. The default value is *false*. # Trappable Errors ([CloudFiles](#cloudfiles-class) Class) ### Common Errors | | | | --- | --- | | 600 | A server error occurred, and/or the class was unable to process the server's response. Please refer to the error message for more information. | | 601 | An unsupported operation or action was attempted. | | 602 | The [RawRequest](#RawRequest) or [RawResponse](#RawResponse) configuration setting was queried without first setting the TransferredRequest configuration setting to ON. | | 603 | The login credentials specified were invalid. Please refer to the error message for more information. | | 604 | An invalid remote resource identifier (i.e., a name, path, Id, etc.) was specified. | | 605 | An invalid index was specified. | | 606 | An upload was aborted by the user before it could finish. | | 607 | The specified resource is a folder and cannot be downloaded. | | 608 | A download failed because the specified [LocalFile](#localfile-property-cloudfiles-class) already exists and [Overwrite](#overwrite-property-cloudfiles-class) is false. | | 609 | The class could not resume a download or upload. Please refer to the error message for more information. | | 610 | An encrypted download could not be resumed because the [DownloadTempFile](#DownloadTempFile) configuration setting is not set. | | 611 | An exception occurred while working with the specified [LocalFile](#localfile-property-cloudfiles-class) (or the current value of [LocalFile](#localfile-property-cloudfiles-class) is invalid). Please refer to the error message for more information. | | 612 | An exception occurred while working with the specified upload or download stream. Please refer to the error message for more information. | ### HTTP Errors | | | | --- | --- | | 118 | Firewall error. The error description contains the detailed message. | | 143 | Busy executing current method. | | 151 | HTTP protocol error. The error message has the server response. | | 152 | No server specified in URL. | | 153 | Specified URLScheme is invalid. | | 155 | Range operation is not supported by server. | | 156 | Invalid cookie index (out of range). | | 301 | Interrupted. | | 302 | Cannot open AttachedFile. | ### TCPClient Errors | | | | --- | --- | | 100 | You cannot change the RemotePort at this time. A connection is in progress. | | 101 | You cannot change the RemoteHost (Server) at this time. A connection is in progress. | | 102 | The RemoteHost address is invalid (0.0.0.0). | | 104 | Already connected. If you want to reconnect, close the current connection first. | | 106 | You cannot change the LocalPort at this time. A connection is in progress. | | 107 | You cannot change the [LocalHost](#localhost-property-cloudfiles-class) at this time. A connection is in progress. | | 112 | You cannot change [MaxLineLength](#MaxLineLength) at this time. A connection is in progress. | | 116 | RemotePort cannot be zero. Please specify a valid service port number. | | 117 | You cannot change the UseConnection option while the class is active. | | 135 | Operation would block. | | 201 | Timeout. | | 211 | Action impossible in control's present state. | | 212 | Action impossible while not connected. | | 213 | Action impossible while listening. | | 301 | Timeout. | | 303 | Could not open file. | | 434 | Unable to convert string to selected CodePage. | | 1105 | Already connecting. If you want to reconnect, close the current connection first. | | 1117 | You need to connect first. | | 1119 | You cannot change the LocalHost at this time. A connection is in progress. | | 1120 | Connection dropped by remote host. | ### SSL Errors | | | | --- | --- | | 270 | Cannot load specified security library. | | 271 | Cannot open certificate store. | | 272 | Cannot find specified certificate. | | 273 | Cannot acquire security credentials. | | 274 | Cannot find certificate chain. | | 275 | Cannot verify certificate chain. | | 276 | Error during handshake. | | 280 | Error verifying certificate. | | 281 | Could not find client certificate. | | 282 | Could not find server certificate. | | 283 | Error encrypting data. | | 284 | Error decrypting data. | ### TCP/IP Errors | | | | --- | --- | | 10004 | [10004] Interrupted system call. | | 10009 | [10009] Bad file number. | | 10013 | [10013] Access denied. | | 10014 | [10014] Bad address. | | 10022 | [10022] Invalid argument. | | 10024 | [10024] Too many open files. | | 10035 | [10035] Operation would block. | | 10036 | [10036] Operation now in progress. | | 10037 | [10037] Operation already in progress. | | 10038 | [10038] Socket operation on nonsocket. | | 10039 | [10039] Destination address required. | | 10040 | [10040] Message is too long. | | 10041 | [10041] Protocol wrong type for socket. | | 10042 | [10042] Bad protocol option. | | 10043 | [10043] Protocol is not supported. | | 10044 | [10044] Socket type is not supported. | | 10045 | [10045] Operation is not supported on socket. | | 10046 | [10046] Protocol family is not supported. | | 10047 | [10047] Address family is not supported by protocol family. | | 10048 | [10048] Address already in use. | | 10049 | [10049] Cannot assign requested address. | | 10050 | [10050] Network is down. | | 10051 | [10051] Network is unreachable. | | 10052 | [10052] Net dropped connection or reset. | | 10053 | [10053] Software caused connection abort. | | 10054 | [10054] Connection reset by peer. | | 10055 | [10055] No buffer space available. | | 10056 | [10056] Socket is already connected. | | 10057 | [10057] Socket is not connected. | | 10058 | [10058] Cannot send after socket shutdown. | | 10059 | [10059] Too many references, cannot splice. | | 10060 | [10060] Connection timed out. | | 10061 | [10061] Connection refused. | | 10062 | [10062] Too many levels of symbolic links. | | 10063 | [10063] File name is too long. | | 10064 | [10064] Host is down. | | 10065 | [10065] No route to host. | | 10066 | [10066] Directory is not empty | | 10067 | [10067] Too many processes. | | 10068 | [10068] Too many users. | | 10069 | [10069] Disc Quota Exceeded. | | 10070 | [10070] Stale NFS file handle. | | 10071 | [10071] Too many levels of remote in path. | | 10091 | [10091] Network subsystem is unavailable. | | 10092 | [10092] WINSOCK DLL Version out of range. | | 10093 | [10093] Winsock is not loaded yet. | | 11001 | [11001] Host not found. | | 11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). | | 11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. | | 11004 | [11004] Valid name, no data record (check DNS setup). |