HadoopDFS Control
Properties Methods Events Config Settings Errors
The HadoopDFS control provides easy access to files stored in HDFS clusters.
Syntax
HadoopDFS
Remarks
The HadoopDFS control offers an easy-to-use API compatible with any Hadoop distributed file system (HDFS) cluster that exposes Hadoop's standard WebHDFS REST API. Capabilities include uploading and downloading files, strong encryption support, creating folders, file manipulation and organization, and more.
Authentication
First, set the URL property to the base WebHDFS URL of the server (see URL for more details).
Depending on how the server is configured, there are a few different authentication mechanisms that might be used; or, the server might not require authentication at all). Refer to the AuthMechanism property for more information about configuring the control to authenticate correctly.
Addressing Resources
HDFS addresses resources (files, directories, and symlinks) using Linux-style absolute paths. Unless otherwise specified, the control always works in terms of absolute paths, and will always prepend a forward slash (/) to any path passed to it that does not already start with one.
Listing Directory Contents
ListResources lists resources (files, directories, and symlinks) within the specified directory. Calling this method will fire the ResourceList event once for each resource, and will also populate the Resources properties.
// ResourceList event handler.
hdfs.OnResourceList += (s, e) => {
Console.WriteLine(e.Name);
};
hdfs.ListResources("/work_files/serious_business/cats");
for (int i = 0; i < hdfs.Resources.Count; i++) {
// Process resources here.
}
Downloading Files
The DownloadFile method downloads files.
If LocalFile is set, the file will be saved to the specified location; otherwise, the file data will be held by ResourceData.
To download and decrypt an encrypted file, set EncryptionAlgorithm and EncryptionPassword before calling this method.
Download Notes
In the simplest use-case, downloading a file looks like this:
hdfs.LocalFile = "../MyFile.zip";
hdfs.DownloadFile(hdfs.Resources[0].Path);
Resuming Downloads
The control also supports resuming failed downloads by using the StartByte property. If a download is interrupted, set StartByte to the appropriate offset before calling this method to resume the download.
string downloadFile = "../MyFile.zip";
hdfs.LocalFile = downloadFile;
hdfs.DownloadFile(hdfs.Resources[0].Path);
//The transfer is interrupted and DownloadFile() above fails. Later, resume the download:
//Get the size of the partially downloaded file
hdfs.StartByte = new FileInfo(downloadFile).Length;
hdfs.DownloadFile(hdfs.Resources[0].Path);
Resuming Encrypted File Downloads
Resuming encrypted file downloads is only supported when LocalFile was set in the initial download attempt.
If LocalFile is set when beginning an encrypted download, the control creates a temporary file in TempPath to hold the encrypted data until the download is complete. If the download is interrupted, DownloadTempFile will be populated with the path of the temporary file that holds the partial data.
To resume, DownloadTempFile must be populated, along with StartByte, 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.
hdfs.LocalFile = "../MyFile.zip";
hdfs.EncryptionPassword = "password";
hdfs.DownloadFile(hdfs.Resources[0].Path);
//The transfer is interrupted and DownloadFile() above fails. Later, resume the download:
//Get the size of the partially download temp file
hdfs.StartByte = new FileInfo(hdfs.Config("DownloadTempFile")).Length;
hdfs.DownloadFile(hdfs.Resources[0].Path);
Uploading Files
The UploadFile method uploads new files.
If LocalFile is set the file will be uploaded from the specified path. If LocalFile is not set the data in ResourceData will be used.
To encrypt the file before uploading it, set EncryptionAlgorithm and EncryptionPassword.
hdfs.LocalFile = "../MyFile.zip";
hdfs.UploadFile("/MyFile.zip");
Additional Functionality
The HadoopDFS control offers advanced functionality beyond simple uploads and downloads. For instance:
- Encrypt and decrypt files using the EncryptionAlgorithm and EncryptionPassword properties.
- Basic file and folder manipulation and organization using methods such as AppendFile, DeleteResource, MakeDirectory, MoveResource, and TruncateFile.
- Advanced file and directory manipulation with SetFileReplication, SetOwner, SetPermission, and SetTimes.
- Retrieval of both general file/directory information, as well as directory quota information, using GetResourceInfo and GetDirSummary.
- Execute any arbitrary WebHDFS operation with ease using the DoCustomOp method.
- And more!
Property List
The following is the full list of the properties of the control with short descriptions. Click on the links for further details.
| AuthMechanism | The authentication mechanism to use when connecting to the server. |
| Authorization | OAuth 2.0 Authorization Token. |
| DirSummaryDirCount | The number of subdirectories within the directory. |
| DirSummaryFileCount | The number of files within the directory. |
| DirSummaryNameQuota | The name quota imposed on the directory. |
| DirSummarySize | The total size of the directory contents, excluding file replicas. |
| DirSummarySpaceQuota | The space quota imposed on the directory. |
| DirSummarySpaceUsed | The total amount of space the directory consumes on disk. |
| DirSummaryStorageQuota | The storage type quota imposed on the directory. |
| DirSummaryStorageQuotaCount | The number of storage type quotas associated with the directory. |
| DirSummaryStorageQuotaIndex | Selects the storage type quota to show information for. |
| DirSummaryStorageQuotaType | The storage type associated with the storage type quota. |
| DirSummaryStorageQuotaUsed | The number of bytes consumed for the storage type quota. |
| EncryptionAlgorithm | The encryption algorithm. |
| EncryptionPassword | The encryption password. |
| FirewallAutoDetect | Whether to automatically detect and use firewall system settings, if available. |
| FirewallType | The type of firewall to connect through. |
| FirewallHost | The name or IP address of the firewall (optional). |
| FirewallPassword | A password if authentication is to be used when connecting through the firewall. |
| FirewallPort | The Transmission Control Protocol (TCP) port for the firewall Host . |
| FirewallUser | A username if authentication is to be used when connecting through a firewall. |
| Idle | The current status of the control. |
| LocalFile | The location of the local file. |
| LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| OtherHeaders | Other headers as determined by the user (optional). |
| Overwrite | Whether to overwrite the local or remote file. |
| ParsedHeaderCount | The number of records in the ParsedHeader arrays. |
| ParsedHeaderField | This property contains the name of the HTTP header (this is the same case as it is delivered). |
| ParsedHeaderValue | This property contains the header contents. |
| Password | The password to use for authentication. |
| ProxyAuthScheme | The type of authorization to perform when connecting to the proxy. |
| ProxyAutoDetect | Whether to automatically detect and use proxy system settings, if available. |
| ProxyPassword | A password if authentication is to be used for the proxy. |
| ProxyPort | The Transmission Control Protocol (TCP) port for the proxy Server (default 80). |
| ProxyServer | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
| ProxySSL | When to use a Secure Sockets Layer (SSL) for the connection to the proxy. |
| ProxyUser | A username if authentication is to be used for the proxy. |
| QueryParamCount | The number of records in the QueryParam arrays. |
| QueryParamName | The name of the query parameter. |
| QueryParamValue | The value of the query parameter. |
| ReadBytes | The number of bytes to read when downloading a file. |
| ResourceData | The data that was downloaded, or that should be uploaded. |
| ResourceCount | The number of records in the Resource arrays. |
| ResourceAccessTime | The last access time of the resource. |
| ResourceBlockSize | The block size of the file. |
| ResourceChildCount | The number of children in the directory. |
| ResourceGroup | The name of the resource's group. |
| ResourceModifiedTime | The last modified time of the resource. |
| ResourceName | The name of the resource. |
| ResourceOwner | The name of the resource's owner. |
| ResourcePath | The full path of the resource. |
| ResourcePermission | The resource's permission bits. |
| ResourceReplication | The replication factor of the file. |
| ResourceSize | The size of the file. |
| ResourceSymlinkTarget | The full target path of the symlink. |
| ResourceType | The resource type. |
| SSLAcceptServerCertEffectiveDate | The date on which this certificate becomes valid. |
| SSLAcceptServerCertExpirationDate | The date on which the certificate expires. |
| SSLAcceptServerCertExtendedKeyUsage | A comma-delimited list of extended key usage identifiers. |
| SSLAcceptServerCertFingerprint | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| SSLAcceptServerCertFingerprintSHA1 | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| SSLAcceptServerCertFingerprintSHA256 | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| SSLAcceptServerCertIssuer | The issuer of the certificate. |
| SSLAcceptServerCertPrivateKey | The private key of the certificate (if available). |
| SSLAcceptServerCertPrivateKeyAvailable | Whether a PrivateKey is available for the selected certificate. |
| SSLAcceptServerCertPrivateKeyContainer | The name of the PrivateKey container for the certificate (if available). |
| SSLAcceptServerCertPublicKey | The public key of the certificate. |
| SSLAcceptServerCertPublicKeyAlgorithm | The textual description of the certificate's public key algorithm. |
| SSLAcceptServerCertPublicKeyLength | The length of the certificate's public key (in bits). |
| SSLAcceptServerCertSerialNumber | The serial number of the certificate encoded as a string. |
| SSLAcceptServerCertSignatureAlgorithm | The text description of the certificate's signature algorithm. |
| SSLAcceptServerCertStore | The name of the certificate store for the client certificate. |
| SSLAcceptServerCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| SSLAcceptServerCertStoreType | The type of certificate store for this certificate. |
| SSLAcceptServerCertSubjectAltNames | Comma-separated lists of alternative subject names for the certificate. |
| SSLAcceptServerCertThumbprintMD5 | The MD5 hash of the certificate. |
| SSLAcceptServerCertThumbprintSHA1 | The SHA-1 hash of the certificate. |
| SSLAcceptServerCertThumbprintSHA256 | The SHA-256 hash of the certificate. |
| SSLAcceptServerCertUsage | The text description of UsageFlags . |
| SSLAcceptServerCertUsageFlags | The flags that show intended use for the certificate. |
| SSLAcceptServerCertVersion | The certificate's version number. |
| SSLAcceptServerCertSubject | The subject of the certificate used for client authentication. |
| SSLAcceptServerCertEncoded | The certificate (PEM/Base64 encoded). |
| SSLCertEffectiveDate | The date on which this certificate becomes valid. |
| SSLCertExpirationDate | The date on which the certificate expires. |
| SSLCertExtendedKeyUsage | A comma-delimited list of extended key usage identifiers. |
| SSLCertFingerprint | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| SSLCertFingerprintSHA1 | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| SSLCertFingerprintSHA256 | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| SSLCertIssuer | The issuer of the certificate. |
| SSLCertPrivateKey | The private key of the certificate (if available). |
| SSLCertPrivateKeyAvailable | Whether a PrivateKey is available for the selected certificate. |
| SSLCertPrivateKeyContainer | The name of the PrivateKey container for the certificate (if available). |
| SSLCertPublicKey | The public key of the certificate. |
| SSLCertPublicKeyAlgorithm | The textual description of the certificate's public key algorithm. |
| SSLCertPublicKeyLength | The length of the certificate's public key (in bits). |
| SSLCertSerialNumber | The serial number of the certificate encoded as a string. |
| SSLCertSignatureAlgorithm | The text description of the certificate's signature algorithm. |
| SSLCertStore | The name of the certificate store for the client certificate. |
| SSLCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| SSLCertStoreType | The type of certificate store for this certificate. |
| SSLCertSubjectAltNames | Comma-separated lists of alternative subject names for the certificate. |
| SSLCertThumbprintMD5 | The MD5 hash of the certificate. |
| SSLCertThumbprintSHA1 | The SHA-1 hash of the certificate. |
| SSLCertThumbprintSHA256 | The SHA-256 hash of the certificate. |
| SSLCertUsage | The text description of UsageFlags . |
| SSLCertUsageFlags | The flags that show intended use for the certificate. |
| SSLCertVersion | The certificate's version number. |
| SSLCertSubject | The subject of the certificate used for client authentication. |
| SSLCertEncoded | The certificate (PEM/Base64 encoded). |
| SSLProvider | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
| SSLServerCertEffectiveDate | The date on which this certificate becomes valid. |
| SSLServerCertExpirationDate | The date on which the certificate expires. |
| SSLServerCertExtendedKeyUsage | A comma-delimited list of extended key usage identifiers. |
| SSLServerCertFingerprint | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| SSLServerCertFingerprintSHA1 | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| SSLServerCertFingerprintSHA256 | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| SSLServerCertIssuer | The issuer of the certificate. |
| SSLServerCertPrivateKey | The private key of the certificate (if available). |
| SSLServerCertPrivateKeyAvailable | Whether a PrivateKey is available for the selected certificate. |
| SSLServerCertPrivateKeyContainer | The name of the PrivateKey container for the certificate (if available). |
| SSLServerCertPublicKey | The public key of the certificate. |
| SSLServerCertPublicKeyAlgorithm | The textual description of the certificate's public key algorithm. |
| SSLServerCertPublicKeyLength | The length of the certificate's public key (in bits). |
| SSLServerCertSerialNumber | The serial number of the certificate encoded as a string. |
| SSLServerCertSignatureAlgorithm | The text description of the certificate's signature algorithm. |
| SSLServerCertStore | The name of the certificate store for the client certificate. |
| SSLServerCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| SSLServerCertStoreType | The type of certificate store for this certificate. |
| SSLServerCertSubjectAltNames | Comma-separated lists of alternative subject names for the certificate. |
| SSLServerCertThumbprintMD5 | The MD5 hash of the certificate. |
| SSLServerCertThumbprintSHA1 | The SHA-1 hash of the certificate. |
| SSLServerCertThumbprintSHA256 | The SHA-256 hash of the certificate. |
| SSLServerCertUsage | The text description of UsageFlags . |
| SSLServerCertUsageFlags | The flags that show intended use for the certificate. |
| SSLServerCertVersion | The certificate's version number. |
| SSLServerCertSubject | The subject of the certificate used for client authentication. |
| SSLServerCertEncoded | The certificate (PEM/Base64 encoded). |
| StartByte | The byte offset from which to start downloading a file. |
| Timeout | The timeout for the control. |
| URL | The URL of the Hadoop WebHDFS server. |
| User | The user name to use for authentication. |
Method List
The following is the full list of the methods of the control with short descriptions. Click on the links for further details.
| AddQueryParam | Adds a query parameter to the QueryParams properties. |
| AppendFile | Appends data to an existing file. |
| CalcAuthorization | Calculates the Authorization header based on provided credentials. |
| Config | Sets or retrieves a configuration setting. |
| DeleteResource | Deletes a resource. |
| DoCustomOp | Executes an arbitrary WebHDFS operation. |
| DownloadFile | Downloads a file. |
| GetDirSummary | Gets a content summary for a directory. |
| GetResourceInfo | Gets information about a specific resource. |
| Interrupt | This method interrupts the current method. |
| JoinFileBlocks | Joins multiple files' blocks together into one file. |
| ListResources | Lists resources in a given directory. |
| MakeDirectory | Makes a directory. |
| MoveResource | Moves a resource. |
| Reset | Resets the control to its initial state. |
| SetFileReplication | Sets the replication factor for a file. |
| SetOwner | Sets a resource's owner and/or group. |
| SetPermission | Assigns the given permission to a resource. |
| SetTimes | Sets a resource's modification and/or access times. |
| TruncateFile | Truncates a file to a given size. |
| UploadFile | Uploads a file. |
Event List
The following is the full list of the events fired by the control with short descriptions. Click on the links for further details.
| EndTransfer | This event fires when a document finishes transferring. |
| Error | Fired when information is available about errors during data delivery. |
| Header | Fired every time a header line comes in. |
| Log | Fired once for each log message. |
| Progress | Fires during an upload or download to indicate transfer progress. |
| ResourceList | Fires once for each resource returned when listing resources. |
| SSLServerAuthentication | Fired after the server presents its certificate to the client. |
| SSLStatus | Fired when secure connection progress messages are available. |
| StartTransfer | This event fires when a document starts transferring (after the headers). |
| Transfer | Fired while a document transfers (delivers document). |
Config Settings
The following is a list of config settings for the control with short descriptions. Click on the links for further details.
| CreatePermission | The permission to assign when creating resources. |
| DownloadTempFile | The temporary file used when downloading encrypted data. |
| EncryptionIV | The initialization vector to be used for encryption/decryption. |
| EncryptionKey | The key to use during encryption/decryption. |
| EncryptionPasswordKDF | The KDF algorithm to use during password based encryption and decryption. |
| HomeDir | Can be queried to obtain the current user's home directory path. |
| ProgressAbsolute | Whether the control should track transfer progress absolutely. |
| ProgressStep | How often the progress event should be fired, in terms of percentage. |
| RawRequest | Returns the data that was sent to the server. |
| RawResponse | Returns the data that was received from the server. |
| RecursiveDelete | Whether to recursively delete non-empty directories. |
| TempPath | The path to the directory where temporary files are created. |
| XChildCount | The number of child elements of the current element. |
| XChildName[i] | The name of the child element. |
| XChildXText[i] | The inner text of the child element. |
| XElement | The name of the current element. |
| XParent | The parent of the current element. |
| XPath | Provides a way to point to a specific element in the returned XML or JSON response. |
| XSubTree | A snapshot of the current element in the document. |
| XText | The text of the current element. |
| AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
| AllowHTTPCompression | This property enables HTTP compression for receiving data. |
| AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
| Append | Whether to append data to LocalFile. |
| Authorization | The Authorization string to be sent to the server. |
| BytesTransferred | Contains the number of bytes transferred in the response data. |
| ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
| CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
| EncodeURL | If set to True the URL will be encoded by the control. |
| FollowRedirects | Determines what happens when the server issues a redirect. |
| GetOn302Redirect | If set to True the control will perform a GET on the new location. |
| HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
| HTTPVersion | The version of HTTP used by the control. |
| IfModifiedSince | A date determining the maximum age of the desired document. |
| KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
| KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
| LogLevel | The level of detail that is logged. |
| MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
| NegotiatedHTTPVersion | The negotiated HTTP version. |
| OtherHeaders | Other headers as determined by the user (optional). |
| ProxyAuthorization | The authorization string to be sent to the proxy server. |
| ProxyAuthScheme | The authorization scheme to be used for the proxy. |
| ProxyPassword | A password if authentication is to be used for the proxy. |
| ProxyPort | Port for the proxy server (default 80). |
| ProxyServer | Name or IP address of a proxy server (optional). |
| ProxyUser | A user name if authentication is to be used for the proxy. |
| SentHeaders | The full set of headers as sent by the client. |
| StatusCode | The status code of the last response from the server. |
| StatusLine | The first line of the last response from the server. |
| TransferredData | The contents of the last response from the server. |
| TransferredDataLimit | The maximum number of incoming bytes to be stored by the control. |
| TransferredHeaders | The full set of headers as received from the server. |
| TransferredRequest | The full request as sent by the client. |
| UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
| UseIDNs | Whether to encode hostnames to internationalized domain names. |
| UseProxyAutoConfigURL | Whether to use a Proxy auto-config file when attempting a connection. |
| UserAgent | Information about the user agent (browser). |
| ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
| FirewallAutoDetect | Tells the control whether or not to automatically detect and use firewall system settings, if available. |
| FirewallHost | Name or IP address of firewall (optional). |
| FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
| FirewallPort | The TCP port for the FirewallHost;. |
| FirewallType | Determines the type of firewall to connect through. |
| FirewallUser | A user name if authentication is to be used connecting through a firewall. |
| KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| Linger | When set to True, connections are terminated gracefully. |
| LingerTime | Time in seconds to have the connection linger. |
| LocalHost | The name of the local host through which connections are initiated or accepted. |
| LocalPort | The port in the local host where the control binds. |
| MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
| MaxTransferRate | The transfer rate limit in bytes per second. |
| ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
| TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| UseIPv6 | Whether to use IPv6. |
| LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
| OpenSSLCADir | The path to a directory containing CA certificates. |
| OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
| OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
| OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
| ReuseSSLSession | Determines if the SSL session is reused. |
| SSLCACerts | A newline separated list of CA certificates to be included when performing an SSL handshake. |
| SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
| SSLCheckOCSP | Whether to use OCSP to check the status of the server certificate. |
| SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
| SSLClientCACerts | A newline separated list of CA certificates to use during SSL client certificate validation. |
| SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
| SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
| SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
| SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
| SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
| SSLNegotiatedCipher | Returns the negotiated cipher suite. |
| SSLNegotiatedCipherStrength | Returns the negotiated cipher suite strength. |
| SSLNegotiatedCipherSuite | Returns the negotiated cipher suite. |
| SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
| SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
| SSLNegotiatedVersion | Returns the negotiated protocol version. |
| SSLSecurityFlags | Flags that control certificate verification. |
| SSLServerCACerts | A newline separated list of CA certificates to use during SSL server certificate validation. |
| TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
| TLS12SupportedGroups | The supported groups for ECC. |
| TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
| TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
| TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| FirewallData | Used to send extra data to the firewall. |
| InBufferSize | The size in bytes of the incoming queue of the socket. |
| OutBufferSize | The size in bytes of the outgoing queue of the socket. |
| CodePage | The system code page used for Unicode to Multibyte translations. |
| MaskSensitiveData | Whether sensitive data is masked in log messages. |
| UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
AuthMechanism Property (HadoopDFS Control)
The authentication mechanism to use when connecting to the server.
Syntax
hadoopdfscontrol.AuthMechanism[=integer]
Possible Values
amNone(0), amSimple(1), amBasic(2), amNTLM(3), amNegotiate(4), amOAuth(5)
Default Value
0
Remarks
This property controls what authentication mechanism the control should use when connecting to the server.
Possible values are:
| 0 (amNone - default) | No authentication is performed. |
| 1 (amSimple) | Hadoop pseudo/simple authentication is performed. |
| 2 (amBasic) | Basic authentication is performed. |
| 3 (amNTLM) | NTLM authentication is performed. |
| 4 (amNegotiate) | Negotiate authentication is performed. |
| 5 (amOAuth) | OAuth authentication is performed. |
When set to 1 (amSimple), the value of the User property is automatically sent in every request using the user.name query parameter.
When set to 2 (amBasic), 3 (amNTLM), or 4 (amNegotiate), the values held by the User and Password properties will be used to perform Basic, NTLM, or Negotiate (e.g., Kerberos SPNEGO) authentication.
When set to 5 (amOAuth), the value of the Authorization property is automatically sent in every request using the Authorization HTTP header.
Data Type
Integer
Authorization Property (HadoopDFS Control)
OAuth 2.0 Authorization Token.
Syntax
hadoopdfscontrol.Authorization[=string]
Default Value
""
Remarks
This control supports authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth property, using the OAuth control or a separate process. If using the OAuth property, then the Authorization property will not be used.
Bearer ACCESS_TOKENAssign this value to the Authorization property before attempting any operations. Consult the documentation for the service for more information about supported scope values and more details on OAuth authentication.
Refer to AuthMechanism for more information.
Data Type
String
DirSummaryDirCount Property (HadoopDFS Control)
The number of subdirectories within the directory.
Syntax
hadoopdfscontrol.DirSummaryDirCount
Default Value
0
Remarks
The number of subdirectories within the directory.
This property reflects the number of subdirectories contained within the directory, calculated recursively. Note that this count will always include the directory itself; i.e., this property would return 1 for a directory with no subfolders.
This property is read-only and not available at design time.
Data Type
Long64
DirSummaryFileCount Property (HadoopDFS Control)
The number of files within the directory.
Syntax
hadoopdfscontrol.DirSummaryFileCount
Default Value
0
Remarks
The number of files within the directory.
This property reflects the number of files contained within the directory, calculated recursively.
This property is read-only and not available at design time.
Data Type
Long64
DirSummaryNameQuota Property (HadoopDFS Control)
The name quota imposed on the directory.
Syntax
hadoopdfscontrol.DirSummaryNameQuota
Default Value
-1
Remarks
The name quota imposed on the directory.
This property reflects the name quota imposed on the directory, or -1 if the directory doesn't have a name quota set.
A name quota limits the number of files and directories that can be created within a directory (calculated recursively). Note that a directory's own name is counted against its own quota, so the minimum name quota that may be applied to a directory is 1 (which will force the directory to stay empty).
This property is read-only and not available at design time.
Data Type
Long64
DirSummarySize Property (HadoopDFS Control)
The total size of the directory contents, excluding file replicas.
Syntax
hadoopdfscontrol.DirSummarySize
Default Value
0
Remarks
The total size of the directory contents, excluding file replicas.
This property reflects the total size (in bytes) of the directory's contents, calculated recursively.
Unlike DirSummarySpaceUsed, this property's value does not take file replicas into account, and thus should not be interpreted as the actual number of bytes the directory's contents use on disk.
This property is read-only and not available at design time.
Data Type
Long64
DirSummarySpaceQuota Property (HadoopDFS Control)
The space quota imposed on the directory.
Syntax
hadoopdfscontrol.DirSummarySpaceQuota
Default Value
-1
Remarks
The space quota imposed on the directory.
This property reflects the overall space quota (in bytes) imposed on the directory, or -1 if the directory doesn't have a space quota set.
A space quota limits the total number of bytes the files within a directory (or any of its subdirectories) may consume across all storage mediums. Space quotas are tracked separately from each directory's various DirSummaryStorageQuotas, and only one space quota may be applied to any given directory.
This property is read-only and not available at design time.
Data Type
Long64
DirSummarySpaceUsed Property (HadoopDFS Control)
The total amount of space the directory consumes on disk.
Syntax
hadoopdfscontrol.DirSummarySpaceUsed
Default Value
0
Remarks
The total amount of space the directory consumes on disk.
This property reflects the total amount of space (in bytes) that the directory's contents, calculated recursively, consume on disk.
Unlike DirSummarySize, this property's value includes space consumed by file replicas.
This property is read-only and not available at design time.
Data Type
Long64
DirSummaryStorageQuota Property (HadoopDFS Control)
The storage type quota imposed on the directory.
Syntax
hadoopdfscontrol.DirSummaryStorageQuota
Default Value
-1
Remarks
The storage type quota imposed on the directory.
This property reflects the storage type quota (in bytes) imposed on the directory for the DirSummaryStorageQuotaType currently selected by DirSummaryStorageQuotaIndex.
Storage type quotas limit the number of bytes that files within a directory (or any of its subdirectories) may consume on specific types of storage mediums. Multiple storage type quotas, each associated with a different type of storage medium, may be imposed on a directory simultaneously. Storage type quotas are tracked separately from a directory's overall DirSummarySpaceQuota.
Use DirSummaryStorageQuotaCount to determine how many storage type quotas are imposed on a directory, and DirSummaryStorageQuotaIndex to select which storage type quota's information to reflect in the DirSummaryStorageQuota, DirSummaryStorageQuotaType, and DirSummaryStorageQuotaUsed properties.
Note that it is possible for a storage type quota to be imposed on a directory without actually restricting any space usage, in which case this property's value will be -1.
This property is read-only and not available at design time.
Data Type
Long64
DirSummaryStorageQuotaCount Property (HadoopDFS Control)
The number of storage type quotas associated with the directory.
Syntax
hadoopdfscontrol.DirSummaryStorageQuotaCount
Default Value
0
Remarks
The number of storage type quotas associated with the directory.
This property reflects the number of storage type quotas associated with the directory. Use the DirSummaryStorageQuotaIndex property to select which storage type quota's information to reflect in the DirSummaryStorageQuota, DirSummaryStorageQuotaType, and DirSummaryStorageQuotaUsed properties.
This property is read-only and not available at design time.
Data Type
Integer
DirSummaryStorageQuotaIndex Property (HadoopDFS Control)
Selects the storage type quota to show information for.
Syntax
hadoopdfscontrol.DirSummaryStorageQuotaIndex
Default Value
-1
Remarks
Selects the storage type quota to show information for.
This property selects which storage type quota's information to reflect in the DirSummaryStorageQuota, DirSummaryStorageQuotaType, and DirSummaryStorageQuotaUsed properties; those properties are re-populated when this property's value is changed.
Valid values for this property are -1 to (DirSummaryStorageQuotaCount - 1); invalid indices are ignored. The default value is 0 if DirSummaryStorageQuotaCount is greater than 0, and -1 otherwise.
This property is read-only and not available at design time.
Data Type
Integer
DirSummaryStorageQuotaType Property (HadoopDFS Control)
The storage type associated with the storage type quota.
Syntax
hadoopdfscontrol.DirSummaryStorageQuotaType
Default Value
""
Remarks
The storage type associated with the storage type quota.
This property reflects the storage type associated with the storage type quota currently selected by DirSummaryStorageQuotaIndex
This property is read-only and not available at design time.
Data Type
String
DirSummaryStorageQuotaUsed Property (HadoopDFS Control)
The number of bytes consumed for the storage type quota.
Syntax
hadoopdfscontrol.DirSummaryStorageQuotaUsed
Default Value
0
Remarks
The number of bytes consumed for the storage type quota.
This property reflects the number of bytes that have been consumed for the storage type quota currently selected by DirSummaryStorageQuotaIndex
This property is read-only and not available at design time.
Data Type
Long64
EncryptionAlgorithm Property (HadoopDFS Control)
The encryption algorithm.
Syntax
hadoopdfscontrol.EncryptionAlgorithm[=integer]
Possible Values
eaAES(0), eaBlowfish(1), eaCAST(2), eaDES(3), eaIDEA(4), eaRC2(5), eaRC4(6), eaTEA(7), eaTripleDES(8), eaTwofish(9), eaRijndael(10), eaChaCha(11), 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 |
Data Type
Integer
EncryptionPassword Property (HadoopDFS Control)
The encryption password.
Syntax
hadoopdfscontrol.EncryptionPassword[=string]
Default Value
""
Remarks
If this property is populated when UploadFile or DownloadFile is called, the control will attempt to encrypt or decrypt the data before uploading or after downloading it.
The control 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 and 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.
Data Type
String
FirewallAutoDetect Property (HadoopDFS Control)
Whether to automatically detect and use firewall system settings, if available.
Syntax
hadoopdfscontrol.FirewallAutoDetect[=boolean]
Default Value
False
Remarks
Whether to automatically detect and use firewall system settings, if available.
Data Type
Boolean
FirewallType Property (HadoopDFS Control)
The type of firewall to connect through.
Syntax
hadoopdfscontrol.FirewallType[=integer]
Possible Values
fwNone(0), fwTunnel(1), fwSOCKS4(2), fwSOCKS5(3), fwSOCKS4A(10)
Default Value
0
Remarks
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. FirewallPort is set to 80. |
| fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
| fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
| fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Data Type
Integer
FirewallHost Property (HadoopDFS Control)
The name or IP address of the firewall (optional).
Syntax
hadoopdfscontrol.FirewallHost[=string]
Default Value
""
Remarks
The name or IP address of the firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.
If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the control fails with an error.
Data Type
String
FirewallPassword Property (HadoopDFS Control)
A password if authentication is to be used when connecting through the firewall.
Syntax
hadoopdfscontrol.FirewallPassword[=string]
Default Value
""
Remarks
A password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the control fails with an error.
Data Type
String
FirewallPort Property (HadoopDFS Control)
The Transmission Control Protocol (TCP) port for the firewall Host .
Syntax
hadoopdfscontrol.FirewallPort[=integer]
Default Value
0
Remarks
The Transmission Control Protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.
Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.
Data Type
Integer
FirewallUser Property (HadoopDFS Control)
A username if authentication is to be used when connecting through a firewall.
Syntax
hadoopdfscontrol.FirewallUser[=string]
Default Value
""
Remarks
A username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property are used to connect and authenticate to the given Firewall. If the authentication fails, the control fails with an error.
Data Type
String
Idle Property (HadoopDFS Control)
The current status of the control.
Syntax
hadoopdfscontrol.Idle
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.
Data Type
Boolean
LocalFile Property (HadoopDFS Control)
The location of the local file.
Syntax
hadoopdfscontrol.LocalFile[=string]
Default Value
""
Remarks
This property specifies the location of a file on disk. This is used as the source file when calling UploadFile or AppendFile, and as the destination file when calling DownloadFile or DoCustomOp.
Data Type
String
LocalHost Property (HadoopDFS Control)
The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
hadoopdfscontrol.LocalHost[=string]
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 control initiate connections (or accept in the case of server controls) 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 control 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.
Data Type
String
OtherHeaders Property (HadoopDFS Control)
Other headers as determined by the user (optional).
Syntax
hadoopdfscontrol.OtherHeaders[=string]
Default Value
""
Remarks
This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType and From.
The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF (Chr$(13) & Chr$(10)) .
Use this property with caution. If this property contains invalid headers, HTTP requests may fail.
This property is useful for extending the functionality of the control beyond what is provided.
This property is not available at design time.
Data Type
String
Overwrite Property (HadoopDFS Control)
Whether to overwrite the local or remote file.
Syntax
hadoopdfscontrol.Overwrite[=boolean]
Default Value
False
Remarks
When calling DownloadFile, this property determines if LocalFile should be overwritten if it already exists.
When calling UploadFile, this property determines if the remote file should be overwritten if it already exists.
Data Type
Boolean
ParsedHeaderCount Property (HadoopDFS Control)
The number of records in the ParsedHeader arrays.
Syntax
hadoopdfscontrol.ParsedHeaderCount
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at ParsedHeaderCount - 1.This property is read-only and not available at design time.
Data Type
Integer
ParsedHeaderField Property (HadoopDFS Control)
This property contains the name of the HTTP header (this is the same case as it is delivered).
Syntax
hadoopdfscontrol.ParsedHeaderField(ParsedHeaderIndex)
Default Value
""
Remarks
This property contains the name of the HTTP Header (this is the same case as it is delivered).
The ParsedHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.
This property is read-only and not available at design time.
Data Type
String
ParsedHeaderValue Property (HadoopDFS Control)
This property contains the header contents.
Syntax
hadoopdfscontrol.ParsedHeaderValue(ParsedHeaderIndex)
Default Value
""
Remarks
This property contains the Header contents.
The ParsedHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.
This property is read-only and not available at design time.
Data Type
String
Password Property (HadoopDFS Control)
The password to use for authentication.
Syntax
hadoopdfscontrol.Password[=string]
Default Value
""
Remarks
This property specifies the password to user for authentication.
Refer to AuthMechanism for more information.
This property is not available at design time.
Data Type
String
ProxyAuthScheme Property (HadoopDFS Control)
The type of authorization to perform when connecting to the proxy.
Syntax
hadoopdfscontrol.ProxyAuthScheme[=integer]
Possible Values
authBasic(0), authDigest(1), authProprietary(2), authNone(3), authNtlm(4), authNegotiate(5)
Default Value
0
Remarks
The type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.
ProxyAuthScheme should be set to authNone (3) when no authentication is expected.
By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the control will attempt basic authentication.
If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.
If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the control. Look at the configuration file for the control being used to find more information about manually setting this token.
If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.
For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.
Data Type
Integer
ProxyAutoDetect Property (HadoopDFS Control)
Whether to automatically detect and use proxy system settings, if available.
Syntax
hadoopdfscontrol.ProxyAutoDetect[=boolean]
Default Value
False
Remarks
Whether to automatically detect and use proxy system settings, if available. The default value is .
Data Type
Boolean
ProxyPassword Property (HadoopDFS Control)
A password if authentication is to be used for the proxy.
Syntax
hadoopdfscontrol.ProxyPassword[=string]
Default Value
""
Remarks
A password if authentication is to be used for the proxy.
If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.
If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.
Data Type
String
ProxyPort Property (HadoopDFS Control)
The Transmission Control Protocol (TCP) port for the proxy Server (default 80).
Syntax
hadoopdfscontrol.ProxyPort[=integer]
Default Value
80
Remarks
The Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.
Data Type
Integer
ProxyServer Property (HadoopDFS Control)
If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
Syntax
hadoopdfscontrol.ProxyServer[=string]
Default Value
""
Remarks
If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.
Data Type
String
ProxySSL Property (HadoopDFS Control)
When to use a Secure Sockets Layer (SSL) for the connection to the proxy.
Syntax
hadoopdfscontrol.ProxySSL[=integer]
Possible Values
psAutomatic(0), psAlways(1), psNever(2), psTunnel(3)
Default Value
0
Remarks
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 control will use the psTunnel option. If the URL is an http URL, the control 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. |
Data Type
Integer
ProxyUser Property (HadoopDFS Control)
A username if authentication is to be used for the proxy.
Syntax
hadoopdfscontrol.ProxyUser[=string]
Default Value
""
Remarks
A username if authentication is to be used for the proxy.
If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.
If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.
Data Type
String
QueryParamCount Property (HadoopDFS Control)
The number of records in the QueryParam arrays.
Syntax
hadoopdfscontrol.QueryParamCount[=integer]
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at QueryParamCount - 1.This property is not available at design time.
Data Type
Integer
QueryParamName Property (HadoopDFS Control)
The name of the query parameter.
Syntax
hadoopdfscontrol.QueryParamName(QueryParamIndex)[=string]
Default Value
""
Remarks
The name of the query parameter.
This property specifies the name of the query parameter.
The QueryParamIndex parameter specifies the index of the item in the array. The size of the array is controlled by the QueryParamCount property.
This property is not available at design time.
Data Type
String
QueryParamValue Property (HadoopDFS Control)
The value of the query parameter.
Syntax
hadoopdfscontrol.QueryParamValue(QueryParamIndex)[=string]
Default Value
""
Remarks
The value of the query parameter.
This property specifies the value of the query parameter. The control will automatically URL-encode this value when sending the request.
The QueryParamIndex parameter specifies the index of the item in the array. The size of the array is controlled by the QueryParamCount property.
This property is not available at design time.
Data Type
String
ReadBytes Property (HadoopDFS Control)
The number of bytes to read when downloading a file.
Syntax
hadoopdfscontrol.ReadBytes[=long64]
Default Value
-1
Remarks
This property specifies how many bytes should be read when DownloadFile is called. It can be used in tandem with StartByte to specify a specific range of the file to download.
If set to -1 (default), there is no limit on how many bytes will be read.
This property is not available at design time.
Data Type
Long64
ResourceData Property (HadoopDFS Control)
The data that was downloaded, or that should be uploaded.
Syntax
hadoopdfscontrol.ResourceData[=string]
Default Value
""
Remarks
This property is populated with file data after calling DownloadFile if LocalFile is not set.
This property can also be set before calling UploadFile; its data will be uploaded if LocalFile is not set.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .ResourceDataB.
This property is not available at design time.
Data Type
Binary String
ResourceCount Property (HadoopDFS Control)
The number of records in the Resource arrays.
Syntax
hadoopdfscontrol.ResourceCount
Default Value
0
Remarks
This property controls the size of the following arrays:
- ResourceAccessTime
- ResourceBlockSize
- ResourceChildCount
- ResourceGroup
- ResourceModifiedTime
- ResourceName
- ResourceOwner
- ResourcePath
- ResourcePermission
- ResourceReplication
- ResourceSize
- ResourceSymlinkTarget
- ResourceType
This property is read-only and not available at design time.
Data Type
Integer
ResourceAccessTime Property (HadoopDFS Control)
The last access time of the resource.
Syntax
hadoopdfscontrol.ResourceAccessTime(ResourceIndex)
Default Value
0
Remarks
The last access time of the resource.
This property reflects the last access time of the resource, in milliseconds relative to the Unix epoch.
The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.
This property is read-only and not available at design time.
Data Type
Long64
ResourceBlockSize Property (HadoopDFS Control)
The block size of the file.
Syntax
hadoopdfscontrol.ResourceBlockSize(ResourceIndex)
Default Value
0
Remarks
The block size of the file.
This property reflects the block size of the file, in bytes.
The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.
This property is read-only and not available at design time.
Data Type
Long64
ResourceChildCount Property (HadoopDFS Control)
The number of children in the directory.
Syntax
hadoopdfscontrol.ResourceChildCount(ResourceIndex)
Default Value
0
Remarks
The number of children in the directory.
This property reflects the number of immediate children in the directory. Always 0 for files.
The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.
This property is read-only and not available at design time.
Data Type
Long64
ResourceGroup Property (HadoopDFS Control)
The name of the resource's group.
Syntax
hadoopdfscontrol.ResourceGroup(ResourceIndex)
Default Value
""
Remarks
The name of the resource's group.
This property reflects the name of the resource's group.
The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.
This property is read-only and not available at design time.
Data Type
String
ResourceModifiedTime Property (HadoopDFS Control)
The last modified time of the resource.
Syntax
hadoopdfscontrol.ResourceModifiedTime(ResourceIndex)
Default Value
0
Remarks
The last modified time of the resource.
This property reflects the last modified time of the resource, in milliseconds relative to the Unix epoch.
The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.
This property is read-only and not available at design time.
Data Type
Long64
ResourceName Property (HadoopDFS Control)
The name of the resource.
Syntax
hadoopdfscontrol.ResourceName(ResourceIndex)
Default Value
""
Remarks
The name of the resource.
This property reflects the name of the resource.
The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.
This property is read-only and not available at design time.
Data Type
String
ResourceOwner Property (HadoopDFS Control)
The name of the resource's owner.
Syntax
hadoopdfscontrol.ResourceOwner(ResourceIndex)
Default Value
""
Remarks
The name of the resource's owner.
This property reflects the name of the resource's owner.
The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.
This property is read-only and not available at design time.
Data Type
String
ResourcePath Property (HadoopDFS Control)
The full path of the resource.
Syntax
hadoopdfscontrol.ResourcePath(ResourceIndex)
Default Value
""
Remarks
The full path of the resource.
This property reflects the full path of the resource. (Note that this property's value is not returned by the server, it is calculated by the control for convenience.)
The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.
This property is read-only and not available at design time.
Data Type
String
ResourcePermission Property (HadoopDFS Control)
The resource's permission bits.
Syntax
hadoopdfscontrol.ResourcePermission(ResourceIndex)
Default Value
""
Remarks
The resource's permission bits.
This property reflects the resource's permission bits, represented as an octal string (e.g., 755).
The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.
This property is read-only and not available at design time.
Data Type
String
ResourceReplication Property (HadoopDFS Control)
The replication factor of the file.
Syntax
hadoopdfscontrol.ResourceReplication(ResourceIndex)
Default Value
0
Remarks
The replication factor of the file.
This property reflects the replication factor of the file. Always 0 for directories.
A file's replication factor determines how many copies of the file's data ("replicas") are maintained by HDFS. For example, a replication factor of 3 means that HDFS will maintain 2 replicas in addition to the original file. Thus, the minimum replication factor a file can have is 1.
The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.
This property is read-only and not available at design time.
Data Type
Integer
ResourceSize Property (HadoopDFS Control)
The size of the file.
Syntax
hadoopdfscontrol.ResourceSize(ResourceIndex)
Default Value
0
Remarks
The size of the file.
This property reflects the size of the file, in bytes. Always 0 for directories.
Note that the actual amount of space the file consumes will be greater than this property's value if ResourceReplication is greater than 1. In that case, multiply the values of this property and ResourceReplication to obtain the total number of bytes consumed by the file and its replicas.
The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.
This property is read-only and not available at design time.
Data Type
Long64
ResourceSymlinkTarget Property (HadoopDFS Control)
The full target path of the symlink.
Syntax
hadoopdfscontrol.ResourceSymlinkTarget(ResourceIndex)
Default Value
""
Remarks
The full target path of the symlink.
This property reflects the full target path of the symlink, if ResourceType is 2 (ftSymLink) and the server returns the target path information, or empty string otherwise.
The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.
This property is read-only and not available at design time.
Data Type
String
ResourceType Property (HadoopDFS Control)
The resource type.
Syntax
hadoopdfscontrol.ResourceType(ResourceIndex)
Possible Values
hrtFile(0), hrtDirectory(1), hrtSymLink(2)
Default Value
0
Remarks
The resource type.
This property reflects the resource's type. Possible values are:
| 0 (hrtFile) | A file. |
| 1 (hrtDirectory) | A directory. |
| 2 (hrtSymLink) | A symlink. |
The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.
This property is read-only and not available at design time.
Data Type
Integer
SSLAcceptServerCertEffectiveDate Property (HadoopDFS Control)
The date on which this certificate becomes valid.
Syntax
hadoopdfscontrol.SSLAcceptServerCertEffectiveDate
Default Value
""
Remarks
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.
This property is read-only.
Data Type
String
SSLAcceptServerCertExpirationDate Property (HadoopDFS Control)
The date on which the certificate expires.
Syntax
hadoopdfscontrol.SSLAcceptServerCertExpirationDate
Default Value
""
Remarks
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.
This property is read-only.
Data Type
String
SSLAcceptServerCertExtendedKeyUsage Property (HadoopDFS Control)
A comma-delimited list of extended key usage identifiers.
Syntax
hadoopdfscontrol.SSLAcceptServerCertExtendedKeyUsage
Default Value
""
Remarks
A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
Data Type
String
SSLAcceptServerCertFingerprint Property (HadoopDFS Control)
The hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
hadoopdfscontrol.SSLAcceptServerCertFingerprint
Default Value
""
Remarks
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
This property is read-only.
Data Type
String
SSLAcceptServerCertFingerprintSHA1 Property (HadoopDFS Control)
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
hadoopdfscontrol.SSLAcceptServerCertFingerprintSHA1
Default Value
""
Remarks
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
This property is read-only.
Data Type
String
SSLAcceptServerCertFingerprintSHA256 Property (HadoopDFS Control)
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
hadoopdfscontrol.SSLAcceptServerCertFingerprintSHA256
Default Value
""
Remarks
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
This property is read-only.
Data Type
String
SSLAcceptServerCertIssuer Property (HadoopDFS Control)
The issuer of the certificate.
Syntax
hadoopdfscontrol.SSLAcceptServerCertIssuer
Default Value
""
Remarks
The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
Data Type
String
SSLAcceptServerCertPrivateKey Property (HadoopDFS Control)
The private key of the certificate (if available).
Syntax
hadoopdfscontrol.SSLAcceptServerCertPrivateKey
Default Value
""
Remarks
The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.
This property is read-only.
Data Type
String
SSLAcceptServerCertPrivateKeyAvailable Property (HadoopDFS Control)
Whether a PrivateKey is available for the selected certificate.
Syntax
hadoopdfscontrol.SSLAcceptServerCertPrivateKeyAvailable
Default Value
False
Remarks
Whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
Boolean
SSLAcceptServerCertPrivateKeyContainer Property (HadoopDFS Control)
The name of the PrivateKey container for the certificate (if available).
Syntax
hadoopdfscontrol.SSLAcceptServerCertPrivateKeyContainer
Default Value
""
Remarks
The name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
SSLAcceptServerCertPublicKey Property (HadoopDFS Control)
The public key of the certificate.
Syntax
hadoopdfscontrol.SSLAcceptServerCertPublicKey
Default Value
""
Remarks
The public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
Data Type
String
SSLAcceptServerCertPublicKeyAlgorithm Property (HadoopDFS Control)
The textual description of the certificate's public key algorithm.
Syntax
hadoopdfscontrol.SSLAcceptServerCertPublicKeyAlgorithm
Default Value
""
Remarks
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.
This property is read-only.
Data Type
String
SSLAcceptServerCertPublicKeyLength Property (HadoopDFS Control)
The length of the certificate's public key (in bits).
Syntax
hadoopdfscontrol.SSLAcceptServerCertPublicKeyLength
Default Value
0
Remarks
The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
Integer
SSLAcceptServerCertSerialNumber Property (HadoopDFS Control)
The serial number of the certificate encoded as a string.
Syntax
hadoopdfscontrol.SSLAcceptServerCertSerialNumber
Default Value
""
Remarks
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.
This property is read-only.
Data Type
String
SSLAcceptServerCertSignatureAlgorithm Property (HadoopDFS Control)
The text description of the certificate's signature algorithm.
Syntax
hadoopdfscontrol.SSLAcceptServerCertSignatureAlgorithm
Default Value
""
Remarks
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.
This property is read-only.
Data Type
String
SSLAcceptServerCertStore Property (HadoopDFS Control)
The name of the certificate store for the client certificate.
Syntax
hadoopdfscontrol.SSLAcceptServerCertStore[=string]
Default Value
"MY"
Remarks
The name of the certificate store for the client certificate.
The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.
SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject property 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. |
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).
To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertStoreB.
Data Type
Binary String
SSLAcceptServerCertStorePassword Property (HadoopDFS Control)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
hadoopdfscontrol.SSLAcceptServerCertStorePassword[=string]
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Data Type
String
SSLAcceptServerCertStoreType Property (HadoopDFS Control)
The type of certificate store for this certificate.
Syntax
hadoopdfscontrol.SSLAcceptServerCertStoreType[=integer]
Possible Values
cstUser(0), cstMachine(1), cstPFXFile(2), cstPFXBlob(3), cstJKSFile(4), cstJKSBlob(5), cstPEMKeyFile(6), cstPEMKeyBlob(7), cstPublicKeyFile(8), cstPublicKeyBlob(9), cstSSHPublicKeyBlob(10), cstP7BFile(11), cstP7BBlob(12), cstSSHPublicKeyFile(13), cstPPKFile(14), cstPPKBlob(15), cstXMLFile(16), cstXMLBlob(17), cstJWKFile(18), cstJWKBlob(19), cstSecurityKey(20), cstBCFKSFile(21), cstBCFKSBlob(22), cstPKCS11(23), cstAuto(99)
Default Value
0
Remarks
The type of certificate store for this certificate.
The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:
| 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, the necessary data must first be collected using the CERTMGR control. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLAcceptServerCertStore and set SSLAcceptServerCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
| 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. |
Data Type
Integer
SSLAcceptServerCertSubjectAltNames Property (HadoopDFS Control)
Comma-separated lists of alternative subject names for the certificate.
Syntax
hadoopdfscontrol.SSLAcceptServerCertSubjectAltNames
Default Value
""
Remarks
Comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
SSLAcceptServerCertThumbprintMD5 Property (HadoopDFS Control)
The MD5 hash of the certificate.
Syntax
hadoopdfscontrol.SSLAcceptServerCertThumbprintMD5
Default Value
""
Remarks
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.
This property is read-only.
Data Type
String
SSLAcceptServerCertThumbprintSHA1 Property (HadoopDFS Control)
The SHA-1 hash of the certificate.
Syntax
hadoopdfscontrol.SSLAcceptServerCertThumbprintSHA1
Default Value
""
Remarks
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.
This property is read-only.
Data Type
String
SSLAcceptServerCertThumbprintSHA256 Property (HadoopDFS Control)
The SHA-256 hash of the certificate.
Syntax
hadoopdfscontrol.SSLAcceptServerCertThumbprintSHA256
Default Value
""
Remarks
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.
This property is read-only.
Data Type
String
SSLAcceptServerCertUsage Property (HadoopDFS Control)
The text description of UsageFlags .
Syntax
hadoopdfscontrol.SSLAcceptServerCertUsage
Default Value
""
Remarks
The text description of SSLAcceptServerCertUsageFlags.
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.
This property is read-only.
Data Type
String
SSLAcceptServerCertUsageFlags Property (HadoopDFS Control)
The flags that show intended use for the certificate.
Syntax
hadoopdfscontrol.SSLAcceptServerCertUsageFlags
Default Value
0
Remarks
The flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags 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 SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
Integer
SSLAcceptServerCertVersion Property (HadoopDFS Control)
The certificate's version number.
Syntax
hadoopdfscontrol.SSLAcceptServerCertVersion
Default Value
""
Remarks
The certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
Data Type
String
SSLAcceptServerCertSubject Property (HadoopDFS Control)
The subject of the certificate used for client authentication.
Syntax
hadoopdfscontrol.SSLAcceptServerCertSubject[=string]
Default Value
""
Remarks
The subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
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=support@nsoftware.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.
Data Type
String
SSLAcceptServerCertEncoded Property (HadoopDFS Control)
The certificate (PEM/Base64 encoded).
Syntax
hadoopdfscontrol.SSLAcceptServerCertEncoded[=string]
Default Value
""
Remarks
The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.
When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertEncodedB.
This property is not available at design time.
Data Type
Binary String
SSLCertEffectiveDate Property (HadoopDFS Control)
The date on which this certificate becomes valid.
Syntax
hadoopdfscontrol.SSLCertEffectiveDate
Default Value
""
Remarks
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.
This property is read-only.
Data Type
String
SSLCertExpirationDate Property (HadoopDFS Control)
The date on which the certificate expires.
Syntax
hadoopdfscontrol.SSLCertExpirationDate
Default Value
""
Remarks
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.
This property is read-only.
Data Type
String
SSLCertExtendedKeyUsage Property (HadoopDFS Control)
A comma-delimited list of extended key usage identifiers.
Syntax
hadoopdfscontrol.SSLCertExtendedKeyUsage
Default Value
""
Remarks
A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
Data Type
String
SSLCertFingerprint Property (HadoopDFS Control)
The hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
hadoopdfscontrol.SSLCertFingerprint
Default Value
""
Remarks
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
This property is read-only.
Data Type
String
SSLCertFingerprintSHA1 Property (HadoopDFS Control)
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
hadoopdfscontrol.SSLCertFingerprintSHA1
Default Value
""
Remarks
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
This property is read-only.
Data Type
String
SSLCertFingerprintSHA256 Property (HadoopDFS Control)
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
hadoopdfscontrol.SSLCertFingerprintSHA256
Default Value
""
Remarks
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
This property is read-only.
Data Type
String
SSLCertIssuer Property (HadoopDFS Control)
The issuer of the certificate.
Syntax
hadoopdfscontrol.SSLCertIssuer
Default Value
""
Remarks
The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
Data Type
String
SSLCertPrivateKey Property (HadoopDFS Control)
The private key of the certificate (if available).
Syntax
hadoopdfscontrol.SSLCertPrivateKey
Default Value
""
Remarks
The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.
This property is read-only.
Data Type
String
SSLCertPrivateKeyAvailable Property (HadoopDFS Control)
Whether a PrivateKey is available for the selected certificate.
Syntax
hadoopdfscontrol.SSLCertPrivateKeyAvailable
Default Value
False
Remarks
Whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
Boolean
SSLCertPrivateKeyContainer Property (HadoopDFS Control)
The name of the PrivateKey container for the certificate (if available).
Syntax
hadoopdfscontrol.SSLCertPrivateKeyContainer
Default Value
""
Remarks
The name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
SSLCertPublicKey Property (HadoopDFS Control)
The public key of the certificate.
Syntax
hadoopdfscontrol.SSLCertPublicKey
Default Value
""
Remarks
The public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
Data Type
String
SSLCertPublicKeyAlgorithm Property (HadoopDFS Control)
The textual description of the certificate's public key algorithm.
Syntax
hadoopdfscontrol.SSLCertPublicKeyAlgorithm
Default Value
""
Remarks
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.
This property is read-only.
Data Type
String
SSLCertPublicKeyLength Property (HadoopDFS Control)
The length of the certificate's public key (in bits).
Syntax
hadoopdfscontrol.SSLCertPublicKeyLength
Default Value
0
Remarks
The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
Integer
SSLCertSerialNumber Property (HadoopDFS Control)
The serial number of the certificate encoded as a string.
Syntax
hadoopdfscontrol.SSLCertSerialNumber
Default Value
""
Remarks
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.
This property is read-only.
Data Type
String
SSLCertSignatureAlgorithm Property (HadoopDFS Control)
The text description of the certificate's signature algorithm.
Syntax
hadoopdfscontrol.SSLCertSignatureAlgorithm
Default Value
""
Remarks
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.
This property is read-only.
Data Type
String
SSLCertStore Property (HadoopDFS Control)
The name of the certificate store for the client certificate.
Syntax
hadoopdfscontrol.SSLCertStore[=string]
Default Value
"MY"
Remarks
The name of the certificate store for the client certificate.
The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password-protected, specify the password in SSLCertStorePassword.
SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property 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. |
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).
To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertStoreB.
Data Type
Binary String
SSLCertStorePassword Property (HadoopDFS Control)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
hadoopdfscontrol.SSLCertStorePassword[=string]
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Data Type
String
SSLCertStoreType Property (HadoopDFS Control)
The type of certificate store for this certificate.
Syntax
hadoopdfscontrol.SSLCertStoreType[=integer]
Possible Values
cstUser(0), cstMachine(1), cstPFXFile(2), cstPFXBlob(3), cstJKSFile(4), cstJKSBlob(5), cstPEMKeyFile(6), cstPEMKeyBlob(7), cstPublicKeyFile(8), cstPublicKeyBlob(9), cstSSHPublicKeyBlob(10), cstP7BFile(11), cstP7BBlob(12), cstSSHPublicKeyFile(13), cstPPKFile(14), cstPPKBlob(15), cstXMLFile(16), cstXMLBlob(17), cstJWKFile(18), cstJWKBlob(19), cstSecurityKey(20), cstBCFKSFile(21), cstBCFKSBlob(22), cstPKCS11(23), cstAuto(99)
Default Value
0
Remarks
The type of certificate store for this certificate.
The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:
| 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, the necessary data must first be collected using the CERTMGR control. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLCertStore and set SSLCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
| 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. |
Data Type
Integer
SSLCertSubjectAltNames Property (HadoopDFS Control)
Comma-separated lists of alternative subject names for the certificate.
Syntax
hadoopdfscontrol.SSLCertSubjectAltNames
Default Value
""
Remarks
Comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
SSLCertThumbprintMD5 Property (HadoopDFS Control)
The MD5 hash of the certificate.
Syntax
hadoopdfscontrol.SSLCertThumbprintMD5
Default Value
""
Remarks
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.
This property is read-only.
Data Type
String
SSLCertThumbprintSHA1 Property (HadoopDFS Control)
The SHA-1 hash of the certificate.
Syntax
hadoopdfscontrol.SSLCertThumbprintSHA1
Default Value
""
Remarks
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.
This property is read-only.
Data Type
String
SSLCertThumbprintSHA256 Property (HadoopDFS Control)
The SHA-256 hash of the certificate.
Syntax
hadoopdfscontrol.SSLCertThumbprintSHA256
Default Value
""
Remarks
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.
This property is read-only.
Data Type
String
SSLCertUsage Property (HadoopDFS Control)
The text description of UsageFlags .
Syntax
hadoopdfscontrol.SSLCertUsage
Default Value
""
Remarks
The text description of SSLCertUsageFlags.
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.
This property is read-only.
Data Type
String
SSLCertUsageFlags Property (HadoopDFS Control)
The flags that show intended use for the certificate.
Syntax
hadoopdfscontrol.SSLCertUsageFlags
Default Value
0
Remarks
The flags that show intended use for the certificate. The value of SSLCertUsageFlags 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 SSLCertUsage property for a text representation of SSLCertUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
Integer
SSLCertVersion Property (HadoopDFS Control)
The certificate's version number.
Syntax
hadoopdfscontrol.SSLCertVersion
Default Value
""
Remarks
The certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
Data Type
String
SSLCertSubject Property (HadoopDFS Control)
The subject of the certificate used for client authentication.
Syntax
hadoopdfscontrol.SSLCertSubject[=string]
Default Value
""
Remarks
The subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
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=support@nsoftware.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.
Data Type
String
SSLCertEncoded Property (HadoopDFS Control)
The certificate (PEM/Base64 encoded).
Syntax
hadoopdfscontrol.SSLCertEncoded[=string]
Default Value
""
Remarks
The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.
When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertEncodedB.
This property is not available at design time.
Data Type
Binary String
SSLProvider Property (HadoopDFS Control)
The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
Syntax
hadoopdfscontrol.SSLProvider[=integer]
Possible Values
sslpAutomatic(0), sslpPlatform(1), 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 control 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. |
In most cases using the default value (Automatic) is recommended. The control 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, the internal implementation is used.
Data Type
Integer
SSLServerCertEffectiveDate Property (HadoopDFS Control)
The date on which this certificate becomes valid.
Syntax
hadoopdfscontrol.SSLServerCertEffectiveDate
Default Value
""
Remarks
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.
This property is read-only.
Data Type
String
SSLServerCertExpirationDate Property (HadoopDFS Control)
The date on which the certificate expires.
Syntax
hadoopdfscontrol.SSLServerCertExpirationDate
Default Value
""
Remarks
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.
This property is read-only.
Data Type
String
SSLServerCertExtendedKeyUsage Property (HadoopDFS Control)
A comma-delimited list of extended key usage identifiers.
Syntax
hadoopdfscontrol.SSLServerCertExtendedKeyUsage
Default Value
""
Remarks
A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
Data Type
String
SSLServerCertFingerprint Property (HadoopDFS Control)
The hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
hadoopdfscontrol.SSLServerCertFingerprint
Default Value
""
Remarks
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
This property is read-only.
Data Type
String
SSLServerCertFingerprintSHA1 Property (HadoopDFS Control)
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
hadoopdfscontrol.SSLServerCertFingerprintSHA1
Default Value
""
Remarks
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
This property is read-only.
Data Type
String
SSLServerCertFingerprintSHA256 Property (HadoopDFS Control)
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
hadoopdfscontrol.SSLServerCertFingerprintSHA256
Default Value
""
Remarks
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
This property is read-only.
Data Type
String
SSLServerCertIssuer Property (HadoopDFS Control)
The issuer of the certificate.
Syntax
hadoopdfscontrol.SSLServerCertIssuer
Default Value
""
Remarks
The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
Data Type
String
SSLServerCertPrivateKey Property (HadoopDFS Control)
The private key of the certificate (if available).
Syntax
hadoopdfscontrol.SSLServerCertPrivateKey
Default Value
""
Remarks
The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.
This property is read-only.
Data Type
String
SSLServerCertPrivateKeyAvailable Property (HadoopDFS Control)
Whether a PrivateKey is available for the selected certificate.
Syntax
hadoopdfscontrol.SSLServerCertPrivateKeyAvailable
Default Value
False
Remarks
Whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
Boolean
SSLServerCertPrivateKeyContainer Property (HadoopDFS Control)
The name of the PrivateKey container for the certificate (if available).
Syntax
hadoopdfscontrol.SSLServerCertPrivateKeyContainer
Default Value
""
Remarks
The name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
SSLServerCertPublicKey Property (HadoopDFS Control)
The public key of the certificate.
Syntax
hadoopdfscontrol.SSLServerCertPublicKey
Default Value
""
Remarks
The public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
Data Type
String
SSLServerCertPublicKeyAlgorithm Property (HadoopDFS Control)
The textual description of the certificate's public key algorithm.
Syntax
hadoopdfscontrol.SSLServerCertPublicKeyAlgorithm
Default Value
""
Remarks
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.
This property is read-only.
Data Type
String
SSLServerCertPublicKeyLength Property (HadoopDFS Control)
The length of the certificate's public key (in bits).
Syntax
hadoopdfscontrol.SSLServerCertPublicKeyLength
Default Value
0
Remarks
The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
Integer
SSLServerCertSerialNumber Property (HadoopDFS Control)
The serial number of the certificate encoded as a string.
Syntax
hadoopdfscontrol.SSLServerCertSerialNumber
Default Value
""
Remarks
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.
This property is read-only.
Data Type
String
SSLServerCertSignatureAlgorithm Property (HadoopDFS Control)
The text description of the certificate's signature algorithm.
Syntax
hadoopdfscontrol.SSLServerCertSignatureAlgorithm
Default Value
""
Remarks
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.
This property is read-only.
Data Type
String
SSLServerCertStore Property (HadoopDFS Control)
The name of the certificate store for the client certificate.
Syntax
hadoopdfscontrol.SSLServerCertStore
Default Value
"MY"
Remarks
The name of the certificate store for the client certificate.
The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.
SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject property 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. |
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).
To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertStoreB.
This property is read-only.
Data Type
Binary String
SSLServerCertStorePassword Property (HadoopDFS Control)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
hadoopdfscontrol.SSLServerCertStorePassword
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
This property is read-only.
Data Type
String
SSLServerCertStoreType Property (HadoopDFS Control)
The type of certificate store for this certificate.
Syntax
hadoopdfscontrol.SSLServerCertStoreType
Possible Values
cstUser(0), cstMachine(1), cstPFXFile(2), cstPFXBlob(3), cstJKSFile(4), cstJKSBlob(5), cstPEMKeyFile(6), cstPEMKeyBlob(7), cstPublicKeyFile(8), cstPublicKeyBlob(9), cstSSHPublicKeyBlob(10), cstP7BFile(11), cstP7BBlob(12), cstSSHPublicKeyFile(13), cstPPKFile(14), cstPPKBlob(15), cstXMLFile(16), cstXMLBlob(17), cstJWKFile(18), cstJWKBlob(19), cstSecurityKey(20), cstBCFKSFile(21), cstBCFKSBlob(22), cstPKCS11(23), cstAuto(99)
Default Value
0
Remarks
The type of certificate store for this certificate.
The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:
| 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, the necessary data must first be collected using the CERTMGR control. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLServerCertStore and set SSLServerCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
| 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. |
This property is read-only.
Data Type
Integer
SSLServerCertSubjectAltNames Property (HadoopDFS Control)
Comma-separated lists of alternative subject names for the certificate.
Syntax
hadoopdfscontrol.SSLServerCertSubjectAltNames
Default Value
""
Remarks
Comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
SSLServerCertThumbprintMD5 Property (HadoopDFS Control)
The MD5 hash of the certificate.
Syntax
hadoopdfscontrol.SSLServerCertThumbprintMD5
Default Value
""
Remarks
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.
This property is read-only.
Data Type
String
SSLServerCertThumbprintSHA1 Property (HadoopDFS Control)
The SHA-1 hash of the certificate.
Syntax
hadoopdfscontrol.SSLServerCertThumbprintSHA1
Default Value
""
Remarks
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.
This property is read-only.
Data Type
String
SSLServerCertThumbprintSHA256 Property (HadoopDFS Control)
The SHA-256 hash of the certificate.
Syntax
hadoopdfscontrol.SSLServerCertThumbprintSHA256
Default Value
""
Remarks
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.
This property is read-only.
Data Type
String
SSLServerCertUsage Property (HadoopDFS Control)
The text description of UsageFlags .
Syntax
hadoopdfscontrol.SSLServerCertUsage
Default Value
""
Remarks
The text description of SSLServerCertUsageFlags.
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.
This property is read-only.
Data Type
String
SSLServerCertUsageFlags Property (HadoopDFS Control)
The flags that show intended use for the certificate.
Syntax
hadoopdfscontrol.SSLServerCertUsageFlags
Default Value
0
Remarks
The flags that show intended use for the certificate. The value of SSLServerCertUsageFlags 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 SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
Integer
SSLServerCertVersion Property (HadoopDFS Control)
The certificate's version number.
Syntax
hadoopdfscontrol.SSLServerCertVersion
Default Value
""
Remarks
The certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
Data Type
String
SSLServerCertSubject Property (HadoopDFS Control)
The subject of the certificate used for client authentication.
Syntax
hadoopdfscontrol.SSLServerCertSubject
Default Value
""
Remarks
The subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
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=support@nsoftware.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.
This property is read-only.
Data Type
String
SSLServerCertEncoded Property (HadoopDFS Control)
The certificate (PEM/Base64 encoded).
Syntax
hadoopdfscontrol.SSLServerCertEncoded
Default Value
""
Remarks
The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.
When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertEncodedB.
This property is read-only and not available at design time.
Data Type
Binary String
StartByte Property (HadoopDFS Control)
The byte offset from which to start downloading a file.
Syntax
hadoopdfscontrol.StartByte[=long64]
Default Value
0
Remarks
This property specifies an offset (in bytes) from which to start reading a file when DownloadFile is called. It can be used in tandem with ReadBytes to specify a specific range of the file to download.
This property is not available at design time.
Data Type
Long64
Timeout Property (HadoopDFS Control)
The timeout for the control.
Syntax
hadoopdfscontrol.Timeout[=integer]
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 control will wait for the operation to complete before returning control.
The control 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 control fails with an error.
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.
Data Type
Integer
URL Property (HadoopDFS Control)
The URL of the Hadoop WebHDFS server.
Syntax
hadoopdfscontrol.URL[=string]
Default Value
""
Remarks
This property specifies the URL of the Hadoop WebHDFS server to make requests against.
A full WebHDFS URL looks like http[s]://<HOST>:<PORT>/webhdfs/v1. Anytime this property is set to a non-empty string, the control will automatically append /webhdfs/v1 to its value (if necessary).
The control automatically detects whether to secure the connection using SSL/TLS based on whether the URL begins with http (not secured) or https (secured).
This property is not available at design time.
Data Type
String
User Property (HadoopDFS Control)
The user name to use for authentication.
Syntax
hadoopdfscontrol.User[=string]
Default Value
""
Remarks
This property specifies the user name to use for authentication.
Refer to AuthMechanism for more information.
This property is not available at design time.
Data Type
String
AddQueryParam Method (HadoopDFS Control)
Adds a query parameter to the QueryParams properties.
Syntax
hadoopdfscontrol.AddQueryParam Name, Value
Remarks
This method is used to add a query parameter to the QueryParams properties. Name specifies the name of the parameter, and Value specifies the value of the parameter.
All specified Values will be URL encoded by the control automatically. Consult the service documentation for details on the available parameters.
AppendFile Method (HadoopDFS Control)
Appends data to an existing file.
Syntax
hadoopdfscontrol.AppendFile FilePath
Remarks
This method appends data to the existing file at FilePath.
If LocalFile is set data will be read from the file at the specified path. If LocalFile is not set the data in ResourceData will be used.
CalcAuthorization Method (HadoopDFS Control)
Calculates the Authorization header based on provided credentials.
Syntax
hadoopdfscontrol.CalcAuthorization
Remarks
This method calculates the Authorization value using the values provided in AuthScheme, User and Password.
In most cases this method does not need to be called. The control will automatically calculate any required authorization values when a method is called such as Get or Post.
This method may be useful in cases where the Authorization value needs to be calculated prior to sending a request.
Config Method (HadoopDFS Control)
Sets or retrieves a configuration setting.
Syntax
hadoopdfscontrol.Config ConfigurationString
Remarks
Config is a generic method available in every control. It is used to set and retrieve configuration settings for the control.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, 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, you must call Config("PROPERTY"). The value will be returned as a string.
DeleteResource Method (HadoopDFS Control)
Deletes a resource.
Syntax
hadoopdfscontrol.DeleteResource Path
Remarks
This method deletes the resource at Path.
The RecursiveDelete configuration setting can be used to control whether this method will recursively delete non-empty directories (it is enabled by default).
DoCustomOp Method (HadoopDFS Control)
Executes an arbitrary WebHDFS operation.
Syntax
hadoopdfscontrol.DoCustomOp HttpMethod, RequestPath, Op
Remarks
This method can be used to execute any WebHDFS operation the control does not explicitly implement.
Valid values for HttpMethod are:
- GET (default if empty)
- POST
- PUT
- DELETE
RequestPath must either be a valid resource path, or empty string. Op must be a valid WebHDFS operation (refer to the Hadoop WebHDFS documentation for a full list of supported operations).
Usage
When this method is called, the control will do the following:
- Build a request URL using URL, RequestPath, Op, and the query parameters held by the QueryParams properties.
- Send the request using the given HttpMethod, the request URL built in step 1, the headers held by OtherHeaders, and the currently-configured authentication (if any; refer to AuthMechanism for more information). The request is always sent with an empty body.
- Store the response headers in the ParsedHeaders properties, and the response body in the specified LocalFile, or ResourceData (using the same logic as DownloadFile).
If the response body is JSON data, the XPath, XText, and other X* configuration settings can then be used to navigate and extract information from it.
DownloadFile Method (HadoopDFS Control)
Downloads a file.
Syntax
hadoopdfscontrol.DownloadFile FilePath
Remarks
This method downloads the file at FilePath.
If LocalFile is set, the file will be saved to the specified location; otherwise, the file data will be held by ResourceData.
To download and decrypt an encrypted file, set EncryptionAlgorithm and EncryptionPassword before calling this method.
Download Notes
In the simplest use-case, downloading a file looks like this:
hdfs.LocalFile = "../MyFile.zip";
hdfs.DownloadFile(hdfs.Resources[0].Path);
Resuming Downloads
The control also supports resuming failed downloads by using the StartByte property. If a download is interrupted, set StartByte to the appropriate offset before calling this method to resume the download.
string downloadFile = "../MyFile.zip";
hdfs.LocalFile = downloadFile;
hdfs.DownloadFile(hdfs.Resources[0].Path);
//The transfer is interrupted and DownloadFile() above fails. Later, resume the download:
//Get the size of the partially downloaded file
hdfs.StartByte = new FileInfo(downloadFile).Length;
hdfs.DownloadFile(hdfs.Resources[0].Path);
Resuming Encrypted File Downloads
Resuming encrypted file downloads is only supported when LocalFile was set in the initial download attempt.
If LocalFile is set when beginning an encrypted download, the control creates a temporary file in TempPath to hold the encrypted data until the download is complete. If the download is interrupted, DownloadTempFile will be populated with the path of the temporary file that holds the partial data.
To resume, DownloadTempFile must be populated, along with StartByte, 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.
hdfs.LocalFile = "../MyFile.zip";
hdfs.EncryptionPassword = "password";
hdfs.DownloadFile(hdfs.Resources[0].Path);
//The transfer is interrupted and DownloadFile() above fails. Later, resume the download:
//Get the size of the partially download temp file
hdfs.StartByte = new FileInfo(hdfs.Config("DownloadTempFile")).Length;
hdfs.DownloadFile(hdfs.Resources[0].Path);
GetDirSummary Method (HadoopDFS Control)
Gets a content summary for a directory.
Syntax
hadoopdfscontrol.GetDirSummary DirPath
Remarks
This method gets a content summary for the directory at DirPath, populating the DirSummary object property's properties.
DirPath may be empty to get a content summary for the root directory (/).
GetResourceInfo Method (HadoopDFS Control)
Gets information about a specific resource.
Syntax
hadoopdfscontrol.GetResourceInfo Path
Remarks
This method gets information about the resource at Path. Path may be empty to get information about the root directory (/).
Calling this method will fire the ResourceList event, and will populate the Resources properties with a single item (clearing any previously-held items in the process).
Interrupt Method (HadoopDFS Control)
This method interrupts the current method.
Syntax
hadoopdfscontrol.Interrupt
Remarks
If there is no method in progress, Interrupt simply returns, doing nothing.
JoinFileBlocks Method (HadoopDFS Control)
Joins multiple files' blocks together into one file.
Syntax
hadoopdfscontrol.JoinFileBlocks TargetFilePath, SourceFilePaths
Remarks
This method joins the blocks from the files at one or more SourceFilePaths onto the end of the file at TargetFilePath. (If this operations is successful, the original source files will no longer be accessible.)
The order of the source files' paths in SourceFilePaths determines the order in which their blocks are joined onto the file at TargetFilePath.
Usage Constraints
The server imposes a number of constraints that must be satisfied in order for the join operation to complete successfully.
TargetFilePath and SourceFilePaths must both be non-empty.
SourceFilePaths must be specified as a comma-separated list of source file paths, with no duplicates or paths that match TargetFilePath.
Additionally, all files referred to by both TargetFilePath and SourceFilePaths must satisfy the following constraints:
- All files must already exist.
- All files must be located in the exact same directory (i.e., all files must be siblings).
- The block size of all source files must be less than or equal to the block size of the target file.
If any of the above constraints are not satisfied, the server will return an error.
The control will take care of verifying that all parameters are non-empty and that all paths begin with a forward slash (/).
ListResources Method (HadoopDFS Control)
Lists resources in a given directory.
Syntax
hadoopdfscontrol.ListResources DirPath
Remarks
This method lists resources within the directory at DirPath.
Calling this method will fire the ResourceList event once for each resource, and will also populate the Resources properties.
DirPath may be empty to list resources in the root directory (/).
// ResourceList event handler.
hdfs.OnResourceList += (s, e) => {
Console.WriteLine(e.Name);
};
hdfs.ListResources("/work_files/serious_business/cats");
for (int i = 0; i < hdfs.Resources.Count; i++) {
// Process resources here.
}
MakeDirectory Method (HadoopDFS Control)
Makes a directory.
Syntax
hadoopdfscontrol.MakeDirectory NewDirPath
Remarks
This method makes a new directory at NewDirPath and returns the full path of the new directory. Any non-existent parent directories will also be created.
If the CreatePermission configuration setting is non-empty, the directory will be created with the permission it specifies. Otherwise, the server's default (755) will be used.
MoveResource Method (HadoopDFS Control)
Moves a resource.
Syntax
hadoopdfscontrol.MoveResource FromPath, ToPath
Remarks
This method moves the resource at FromPath to ToPath.
Reset Method (HadoopDFS Control)
Resets the control to its initial state.
Syntax
hadoopdfscontrol.Reset
Remarks
This method resets the control to its initial state.
SetFileReplication Method (HadoopDFS Control)
Sets the replication factor for a file.
Syntax
hadoopdfscontrol.SetFileReplication FilePath, Replication
Remarks
This method sets the replication factor for the file at FilePath to Replication.
Valid values for Replication are 1 through 32767 (inclusive); or 0 to reset the file's replication factor back to the server default.
SetOwner Method (HadoopDFS Control)
Sets a resource's owner and/or group.
Syntax
hadoopdfscontrol.SetOwner Path, Owner, Group
Remarks
This method set the owner and/or group of the resource at Path to the given values.
If non-empty, Owner must be a valid user name, and Group must be a valid group name. If either parameter is empty, the file's current value will remain unchanged. (If both parameters are empty, no request is sent.)
SetPermission Method (HadoopDFS Control)
Assigns the given permission to a resource.
Syntax
hadoopdfscontrol.SetPermission Path, Permission
Remarks
This method assigns the given Permission to the resource at Path.
Permission must be formatted as an octal permission string. If Permission is empty string, the resource's permission will be reset to the server default (755).
SetTimes Method (HadoopDFS Control)
Sets a resource's modification and/or access times.
Syntax
hadoopdfscontrol.SetTimes Path, ModifiedTime, AccessTime
Remarks
This method sets the modification and/or access times of the resource at Path to the given values.
Both ModifiedTime and AccessTime should be specified as a number of milliseconds relative to the Unix epoch. If either parameter is negative, the file's current value will remain unchanged. (If both parameters are negative, no request is sent.)
TruncateFile Method (HadoopDFS Control)
Truncates a file to a given size.
Syntax
hadoopdfscontrol.TruncateFile FilePath, NewSize
Remarks
This method truncates the file at FilePath to the given NewSize (specified in bytes). NewSize must not be less than 0 or greater than the file's current size.
This method returns if the file has been truncated successfully and is immediately ready for further modifications.
This method returns if the server is still in the process of truncating the file (this could happen, e.g., if the server needs to truncate multiple replicas of the file). In this case, the server will reject any further attempts to modify the file until it has finished truncating it. Monitor the file's size using GetResourceInfo to determine when the truncation process has finished.
UploadFile Method (HadoopDFS Control)
Uploads a file.
Syntax
hadoopdfscontrol.UploadFile NewFilePath
Remarks
This method uploads a new file to NewFilePath and returns the full path of the uploaded file. If a file already exists on the server at NewFilePath, the Overwrite property controls whether the server will overwrite the file or return an error.
If the CreatePermission configuration setting is non-empty, the file will be created with the permission it specifies. Otherwise, the server's default (755) will be used.
If LocalFile is set the file will be uploaded from the specified path. If LocalFile is not set the data in ResourceData will be used.
To encrypt the file before uploading it, set EncryptionAlgorithm and EncryptionPassword.
hdfs.LocalFile = "../MyFile.zip";
hdfs.UploadFile("/MyFile.zip");
EndTransfer Event (HadoopDFS Control)
This event fires when a document finishes transferring.
Syntax
Sub hadoopdfscontrol_EndTransfer(Direction As Integer)
Remarks
The EndTransfer event is fired 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 (HadoopDFS Control)
Fired when information is available about errors during data delivery.
Syntax
Sub hadoopdfscontrol_Error(ErrorCode As Integer, Description As String)
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the control fails with an error.
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 section.
Header Event (HadoopDFS Control)
Fired every time a header line comes in.
Syntax
Sub hadoopdfscontrol_Header(Field As String, Value As String)
Remarks
The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.
If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).
Log Event (HadoopDFS Control)
Fired once for each log message.
Syntax
Sub hadoopdfscontrol_Log(LogLevel As Integer, Message As String, LogType As String)
Remarks
This event is fired once for each log message generated by the control. The verbosity is controlled by the 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 (HadoopDFS Control)
Fires during an upload or download to indicate transfer progress.
Syntax
Sub hadoopdfscontrol_Progress(Direction As Integer, BytesTransferred As Long64, TotalBytes As Long64, PercentDone As Integer)
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 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 control 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 configuration setting, in which case the control 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.
ResourceList Event (HadoopDFS Control)
Fires once for each resource returned when listing resources.
Syntax
Sub hadoopdfscontrol_ResourceList(Name As String, Path As String, ResourceType As Integer, ModifiedTime As Long64, AccessTime As Long64, Size As Long64, Permission As String, Owner As String, Group As String, Replication As Integer)
Remarks
This event fires once for each resource returned when ListResources or GetResourceInfo is called.
Name is the name of the resource.
Path is the full path of the resource.
ResourceType reflects the resource's type. Possible values are:
| 0 (hrtFile) | A file. |
| 1 (hrtDirectory) | A directory. |
| 2 (hrtSymLink) | A symlink. |
ModifiedTime and AccessTime reflect the resource's last modified and last access times, in milliseconds relative to the Unix epoch.
Size reflects the size of the file, in bytes. Always 0 for directories.
Permission reflects the resource's permission bits, represented as an octal string (e.g., 755).
Owner is the name of the resource's owner.
Group is the name of the resource's group.
Replication reflects the file's replication factor. Always 0 for directories.
SSLServerAuthentication Event (HadoopDFS Control)
Fired after the server presents its certificate to the client.
Syntax
Sub hadoopdfscontrol_SSLServerAuthentication(CertEncoded As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean)
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 (HadoopDFS Control)
Fired when secure connection progress messages are available.
Syntax
Sub hadoopdfscontrol_SSLStatus(Message As String)
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
StartTransfer Event (HadoopDFS Control)
This event fires when a document starts transferring (after the headers).
Syntax
Sub hadoopdfscontrol_StartTransfer(Direction As Integer)
Remarks
The StartTransfer event is fired 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 (HadoopDFS Control)
Fired while a document transfers (delivers document).
Syntax
Sub hadoopdfscontrol_Transfer(Direction As Integer, BytesTransferred As Long64, PercentDone As Integer, Text As String)
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.
Config Settings (HadoopDFS Control)
The control 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 control, access to these internal properties is provided through the Config method.HadoopDFS Config Settings
This setting must be formatted as an octal string; it is empty by default, causing the server's default (755) to be used.
When downloading encrypted data with LocalFile set, the control will automatically create a temporary file at TempPath to hold the encrypted file contents. When the download is complete, the data is decrypted to LocalFile.
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.
This setting accepts a hex encoded value.
This setting accepts a hex encoded value.
- 0 (default) - PBKDF1
- 1 - PBKDF2
If this setting is enabled (default), then when a transfer is interrupted and later resumed, the values reported by the Progress event will account for the data that was successfully transferred before the interruption.
If this setting is disabled, then the control will treat resumed transfers as "new" transfers, and the values reported by the Progress event will start at 0 rather than from the number of bytes already transferred.
Refer to the Progress event for more information.
The default value, 1, will cause the Progress event to fire each time the event's PercentDone parameter value increases by one percent. Setting this setting to 0 will cause the Progress event to fire every time data is transferred.
Note that the Progress 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 control will behave as if this setting were 0 for the duration of the transfer.
By default this setting is enabled. If this setting is disabled, non-empty directories must be emptied before they can be deleted.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
When XPath is set to a valid path, XElement points to the name of the element, with XText, XParent, XSubTree, XChildCount, XChildName[i], and 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 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. |
For example, assume the following XML and JSON responses.
XML:
<firstlevel>
<one>value</one>
<two>
<item>first</item>
<item>second</item>
</two>
<three>value three</three>
</firstlevel>
JSON:
{
"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.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified in the XPath configuration setting. This configuration setting is read-only.
HTTP Config Settings
When True, the control adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate".
The default value is True.
If set to True (default), the control will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the control fails with an error if the server does not support HTTP/2.
The default value is True.
This property is provided so that the HTTP control can be extended with other security schemes in addition to the authorization schemes already implemented by the control.
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 property in the form "Basic [encoded-user-password]".
The default value is False.
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 control fails with an error.
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 control fails with an error instead.
Following are the valid options:
- 0 - Never
- 1 - Always
- 2 - Same Scheme
- "1.0"
- "1.1" (default)
- "2.0"
- "3.0"
When using HTTP/2 ("2.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 control 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 after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.
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.
The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:
Sat, 29 Oct 2017 19:43:31 GMT.
The default value for KeepAlive is .
| 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).
The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF (Chr$(13) & Chr$(10)) .
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 control beyond what is provided.
.NET
Http http = new Http();
http.Config("TransferredRequest=on");
http.PostData = "body";
http.Post("http://someserver.com");
Console.WriteLine(http.Config("TransferredRequest"));
C++
HTTP http;
http.Config("TransferredRequest=on");
http.SetPostData("body", 5);
http.Post("http://someserver.com");
printf("%s\r\n", http.Config("TransferredRequest"));
Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.
The default value is False and the hostname will always be used exactly as specified. Note: The CodePage setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set CodePage to 65001.
When True (default), the control will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.
Override the default with the name and version of your software.
TCPClient Config Settings
If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the 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 controls that do not directly expose Firewall properties.
Note: This setting is provided for use by controls that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by controls that do not directly expose Firewall properties.
| 0 | No firewall (default setting). |
| 1 | Connect through a tunneling proxy. FirewallPort is set to 80. |
| 2 | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
| 3 | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
| 10 | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Note: This setting is provided for use by controls that do not directly expose Firewall properties.
Note: This setting is provided for use by controls that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if 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 is a positive value, the system will attempt to send pending data until the specified 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 control 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.
In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the control initiate connections (or accept in the case of server controls) only through that interface.
If the control is connected, the LocalHost 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).
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.
If an EOL string is found in the input stream before 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 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 is 256 bytes. The default value is 2048 bytes.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this configuration setting is set to False.
| 0 | IPv4 only |
| 1 | IPv6 only |
| 2 | IPv6 with IPv4 fallback |
SSL Config Settings
When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.
Enabling this configuration setting has no effect if SSLProvider is set to Platform.
The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g., 9d66eef0.0, 9d66eef0.1). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by the following sequences:
-----BEGIN CERTIFICATE-----
... (CA certificate in base64 encoding) ...
-----END CERTIFICATE-----
Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".
By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.
If set to True, the control 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 control is the same.
-----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-----
When set to 0 (default), the CRL check will not be performed by the control. 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.
When set to 0 (default), the control 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.
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 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 is currently not supported. This functionality is instead made available through the OpenSSLCipherList configuration setting.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----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-----
By default, the enabled cipher suites will include all available ciphers ("*").
The special value "*" means that the control will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.
Multiple cipher suites are separated by semicolons.
Example values when SSLProvider is set to Platform include the following:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
Possible values when SSLProvider is set to Platform include the following:
- CALG_3DES
- CALG_3DES_112
- CALG_AES
- CALG_AES_128
- CALG_AES_192
- CALG_AES_256
- CALG_AGREEDKEY_ANY
- CALG_CYLINK_MEK
- CALG_DES
- CALG_DESX
- CALG_DH_EPHEM
- CALG_DH_SF
- CALG_DSS_SIGN
- CALG_ECDH
- CALG_ECDH_EPHEM
- CALG_ECDSA
- CALG_ECMQV
- CALG_HASH_REPLACE_OWF
- CALG_HUGHES_MD5
- CALG_HMAC
- CALG_KEA_KEYX
- CALG_MAC
- CALG_MD2
- CALG_MD4
- CALG_MD5
- CALG_NO_SIGN
- CALG_OID_INFO_CNG_ONLY
- CALG_OID_INFO_PARAMETERS
- CALG_PCT1_MASTER
- CALG_RC2
- CALG_RC4
- CALG_RC5
- CALG_RSA_KEYX
- CALG_RSA_SIGN
- CALG_SCHANNEL_ENC_KEY
- CALG_SCHANNEL_MAC_KEY
- CALG_SCHANNEL_MASTER_HASH
- CALG_SEAL
- CALG_SHA
- CALG_SHA1
- CALG_SHA_256
- CALG_SHA_384
- CALG_SHA_512
- CALG_SKIPJACK
- CALG_SSL2_MASTER
- CALG_SSL3_MASTER
- CALG_SSL3_SHAMD5
- CALG_TEK
- CALG_TLS1_MASTER
- CALG_TLS1PRF
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA");
Possible values when SSLProvider 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), only the following cipher suites are supported:
- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256
SSLEnabledCipherSuites is used together with SSLCipherStrength.
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 control will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.
In editions that are designed to run on Windows, SSLProvider 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 and other similar SSL configuration settings are not supported.
- If 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 control when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.
This configuration setting is applicable only when SSLProvider is set to Internal.
If set to True, all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.
When set, the control 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 control will only append, it will not overwrite previous values.
Note: This configuration setting is applicable only when SSLProvider is set to Internal.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
| 0x00000001 | Ignore time validity status of certificate. |
| 0x00000002 | Ignore time validity status of CTL. |
| 0x00000004 | Ignore non-nested certificate times. |
| 0x00000010 | Allow unknown certificate authority. |
| 0x00000020 | Ignore wrong certificate usage. |
| 0x00000100 | Ignore unknown certificate revocation status. |
| 0x00000200 | Ignore unknown CTL signer revocation status. |
| 0x00000400 | Ignore unknown certificate authority revocation status. |
| 0x00000800 | Ignore unknown root revocation status. |
| 0x00008000 | Allow test root certificate. |
| 0x00004000 | Trust test root certificate. |
| 0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). |
This functionality is currently not available when the provider is OpenSSL.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----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-----
When specified the control 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 control fails with an error.
The format of this value is a comma-separated list of hash-signature combinations. For instance:
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.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.
When using TLS 1.2 and SSLProvider 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)
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"
- "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 ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192
The values are ordered from most preferred to least preferred. The following values are supported:
- "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)
Socket Config Settings
Note: This option is not valid for User Datagram Protocol (UDP) ports.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the control is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the control 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
The following is a list of valid code page identifiers:
| Identifier | Name |
| 037 | IBM EBCDIC - U.S./Canada |
| 437 | OEM - United States |
| 500 | IBM EBCDIC - International |
| 708 | Arabic - ASMO 708 |
| 709 | Arabic - ASMO 449+, BCON V4 |
| 710 | Arabic - Transparent Arabic |
| 720 | Arabic - Transparent ASMO |
| 737 | OEM - Greek (formerly 437G) |
| 775 | OEM - Baltic |
| 850 | OEM - Multilingual Latin I |
| 852 | OEM - Latin II |
| 855 | OEM - Cyrillic (primarily Russian) |
| 857 | OEM - Turkish |
| 858 | OEM - Multilingual Latin I + Euro symbol |
| 860 | OEM - Portuguese |
| 861 | OEM - Icelandic |
| 862 | OEM - Hebrew |
| 863 | OEM - Canadian-French |
| 864 | OEM - Arabic |
| 865 | OEM - Nordic |
| 866 | OEM - Russian |
| 869 | OEM - Modern Greek |
| 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
| 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
| 875 | IBM EBCDIC - Modern Greek |
| 932 | ANSI/OEM - Japanese, Shift-JIS |
| 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
| 949 | ANSI/OEM - Korean (Unified Hangul Code) |
| 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
| 1026 | IBM EBCDIC - Turkish (Latin-5) |
| 1047 | IBM EBCDIC - Latin 1/Open System |
| 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
| 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
| 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
| 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
| 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
| 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
| 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
| 1147 | IBM EBCDIC - France (20297 + Euro symbol) |
| 1148 | IBM EBCDIC - International (500 + Euro symbol) |
| 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
| 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
| 1201 | Unicode UCS-2 Big-Endian |
| 1250 | ANSI - Central European |
| 1251 | ANSI - Cyrillic |
| 1252 | ANSI - Latin I |
| 1253 | ANSI - Greek |
| 1254 | ANSI - Turkish |
| 1255 | ANSI - Hebrew |
| 1256 | ANSI - Arabic |
| 1257 | ANSI - Baltic |
| 1258 | ANSI/OEM - Vietnamese |
| 1361 | Korean (Johab) |
| 10000 | MAC - Roman |
| 10001 | MAC - Japanese |
| 10002 | MAC - Traditional Chinese (Big5) |
| 10003 | MAC - Korean |
| 10004 | MAC - Arabic |
| 10005 | MAC - Hebrew |
| 10006 | MAC - Greek I |
| 10007 | MAC - Cyrillic |
| 10008 | MAC - Simplified Chinese (GB 2312) |
| 10010 | MAC - Romania |
| 10017 | MAC - Ukraine |
| 10021 | MAC - Thai |
| 10029 | MAC - Latin II |
| 10079 | MAC - Icelandic |
| 10081 | MAC - Turkish |
| 10082 | MAC - Croatia |
| 12000 | Unicode UCS-4 Little-Endian |
| 12001 | Unicode UCS-4 Big-Endian |
| 20000 | CNS - Taiwan |
| 20001 | TCA - Taiwan |
| 20002 | Eten - Taiwan |
| 20003 | IBM5550 - Taiwan |
| 20004 | TeleText - Taiwan |
| 20005 | Wang - Taiwan |
| 20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
| 20106 | IA5 German (7-bit) |
| 20107 | IA5 Swedish (7-bit) |
| 20108 | IA5 Norwegian (7-bit) |
| 20127 | US-ASCII (7-bit) |
| 20261 | T.61 |
| 20269 | ISO 6937 Non-Spacing Accent |
| 20273 | IBM EBCDIC - Germany |
| 20277 | IBM EBCDIC - Denmark/Norway |
| 20278 | IBM EBCDIC - Finland/Sweden |
| 20280 | IBM EBCDIC - Italy |
| 20284 | IBM EBCDIC - Latin America/Spain |
| 20285 | IBM EBCDIC - United Kingdom |
| 20290 | IBM EBCDIC - Japanese Katakana Extended |
| 20297 | IBM EBCDIC - France |
| 20420 | IBM EBCDIC - Arabic |
| 20423 | IBM EBCDIC - Greek |
| 20424 | IBM EBCDIC - Hebrew |
| 20833 | IBM EBCDIC - Korean Extended |
| 20838 | IBM EBCDIC - Thai |
| 20866 | Russian - KOI8-R |
| 20871 | IBM EBCDIC - Icelandic |
| 20880 | IBM EBCDIC - Cyrillic (Russian) |
| 20905 | IBM EBCDIC - Turkish |
| 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
| 20932 | JIS X 0208-1990 & 0121-1990 |
| 20936 | Simplified Chinese (GB2312) |
| 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
| 21027 | Extended Alpha Lowercase |
| 21866 | Ukrainian (KOI8-U) |
| 28591 | ISO 8859-1 Latin I |
| 28592 | ISO 8859-2 Central Europe |
| 28593 | ISO 8859-3 Latin 3 |
| 28594 | ISO 8859-4 Baltic |
| 28595 | ISO 8859-5 Cyrillic |
| 28596 | ISO 8859-6 Arabic |
| 28597 | ISO 8859-7 Greek |
| 28598 | ISO 8859-8 Hebrew |
| 28599 | ISO 8859-9 Latin 5 |
| 28605 | ISO 8859-15 Latin 9 |
| 29001 | Europa 3 |
| 38598 | ISO 8859-8 Hebrew |
| 50220 | ISO 2022 Japanese with no halfwidth Katakana |
| 50221 | ISO 2022 Japanese with halfwidth Katakana |
| 50222 | ISO 2022 Japanese JIS X 0201-1989 |
| 50225 | ISO 2022 Korean |
| 50227 | ISO 2022 Simplified Chinese |
| 50229 | ISO 2022 Traditional Chinese |
| 50930 | Japanese (Katakana) Extended |
| 50931 | US/Canada and Japanese |
| 50933 | Korean Extended and Korean |
| 50935 | Simplified Chinese Extended and Simplified Chinese |
| 50936 | Simplified Chinese |
| 50937 | US/Canada and Traditional Chinese |
| 50939 | Japanese (Latin) Extended and Japanese |
| 51932 | EUC - Japanese |
| 51936 | EUC - Simplified Chinese |
| 51949 | EUC - Korean |
| 51950 | EUC - Traditional Chinese |
| 52936 | HZ-GB2312 Simplified Chinese |
| 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
| 57002 | ISCII Devanagari |
| 57003 | ISCII Bengali |
| 57004 | ISCII Tamil |
| 57005 | ISCII Telugu |
| 57006 | ISCII Assamese |
| 57007 | ISCII Oriya |
| 57008 | ISCII Kannada |
| 57009 | ISCII Malayalam |
| 57010 | ISCII Gujarati |
| 57011 | ISCII Punjabi |
| 65000 | Unicode UTF-7 |
| 65001 | Unicode UTF-8 |
| Identifier | Name |
| 1 | ASCII |
| 2 | NEXTSTEP |
| 3 | JapaneseEUC |
| 4 | UTF8 |
| 5 | ISOLatin1 |
| 6 | Symbol |
| 7 | NonLossyASCII |
| 8 | ShiftJIS |
| 9 | ISOLatin2 |
| 10 | Unicode |
| 11 | WindowsCP1251 |
| 12 | WindowsCP1252 |
| 13 | WindowsCP1253 |
| 14 | WindowsCP1254 |
| 15 | WindowsCP1250 |
| 21 | ISO2022JP |
| 30 | MacOSRoman |
| 10 | UTF16String |
| 0x90000100 | UTF16BigEndian |
| 0x94000100 | UTF16LittleEndian |
| 0x8c000100 | UTF32String |
| 0x98000100 | UTF32BigEndian |
| 0x9c000100 | UTF32LittleEndian |
| 65536 | Proprietary |
This setting only works on these controls: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
Setting this configuration setting to tells the control to use the internal implementation instead of using the system security libraries.
This setting is set to by default on all platforms.
Trappable Errors (HadoopDFS Control)
Common Errors
| 20601 | A server error occurred, and/or the control was unable to process the server's response. Please refer to the error message for more information. |
| 20602 | An unsupported operation or action was attempted. |
| 20603 | The RawRequest or RawResponse configuration setting was queried without first setting the TransferredRequest configuration setting to ON. |
| 20604 | The login credentials specified were invalid. Please refer to the error message for more information. |
| 20605 | An invalid remote resource identifier (i.e., a name, path, Id, etc.) was specified. |
| 20606 | An invalid index was specified. |
| 20607 | An upload was aborted by the user before it could finish. |
| 20608 | The specified resource is a folder and cannot be downloaded. |
| 20609 | A download failed because the specified LocalFile already exists and Overwrite is . |
| 20610 | The control could not resume a download or upload. Please refer to the error message for more information. |
| 20611 | An encrypted download could not be resumed because the DownloadTempFile configuration setting is not set. |
| 20612 | An exception occurred while working with the specified LocalFile (or the current value of LocalFile is invalid). Please refer to the error message for more information. |
| 20613 | An exception occurred while working with the specified upload or download stream. Please refer to the error message for more information. |
The control may also return one of the following error codes, which are inherited from other controls.
HTTP Errors
| 20119 | Firewall error. The error description contains the detailed message. |
| 20144 | Busy executing current method. |
| 20152 | HTTP protocol error. The error message has the server response. |
| 20153 | No server specified in URL. |
| 20154 | Specified URLScheme is invalid. |
| 20156 | Range operation is not supported by server. |
| 20157 | Invalid cookie index (out of range). |
| 20302 | Interrupted. |
| 20303 | Cannot open AttachedFile. |
The control may also return one of the following error codes, which are inherited from other controls.
TCPClient Errors
| 20101 | You cannot change the RemotePort at this time. A connection is in progress. |
| 20102 | You cannot change the RemoteHost (Server) at this time. A connection is in progress. |
| 20103 | The RemoteHost address is invalid (0.0.0.0). |
| 20105 | Already connected. If you want to reconnect, close the current connection first. |
| 20107 | You cannot change the LocalPort at this time. A connection is in progress. |
| 20108 | You cannot change the LocalHost at this time. A connection is in progress. |
| 20113 | You cannot change MaxLineLength at this time. A connection is in progress. |
| 20117 | RemotePort cannot be zero. Please specify a valid service port number. |
| 20118 | You cannot change the UseConnection option while the control is active. |
| 20136 | Operation would block. |
| 20202 | Timeout. |
| 20212 | Action impossible in control's present state. |
| 20213 | Action impossible while not connected. |
| 20214 | Action impossible while listening. |
| 20302 | Timeout. |
| 20303 | Could not open file. |
| 20435 | Unable to convert string to selected CodePage. |
| 21106 | Already connecting. If you want to reconnect, close the current connection first. |
| 21118 | You need to connect first. |
| 21120 | You cannot change the LocalHost at this time. A connection is in progress. |
| 21121 | Connection dropped by remote host. |
SSL Errors
| 20271 | Cannot load specified security library. |
| 20272 | Cannot open certificate store. |
| 20273 | Cannot find specified certificate. |
| 20274 | Cannot acquire security credentials. |
| 20275 | Cannot find certificate chain. |
| 20276 | Cannot verify certificate chain. |
| 20277 | Error during handshake. |
| 20281 | Error verifying certificate. |
| 20282 | Could not find client certificate. |
| 20283 | Could not find server certificate. |
| 20284 | Error encrypting data. |
| 20285 | Error decrypting data. |
TCP/IP Errors
| 25005 | [10004] Interrupted system call. |
| 25010 | [10009] Bad file number. |
| 25014 | [10013] Access denied. |
| 25015 | [10014] Bad address. |
| 25023 | [10022] Invalid argument. |
| 25025 | [10024] Too many open files. |
| 25036 | [10035] Operation would block. |
| 25037 | [10036] Operation now in progress. |
| 25038 | [10037] Operation already in progress. |
| 25039 | [10038] Socket operation on nonsocket. |
| 25040 | [10039] Destination address required. |
| 25041 | [10040] Message is too long. |
| 25042 | [10041] Protocol wrong type for socket. |
| 25043 | [10042] Bad protocol option. |
| 25044 | [10043] Protocol is not supported. |
| 25045 | [10044] Socket type is not supported. |
| 25046 | [10045] Operation is not supported on socket. |
| 25047 | [10046] Protocol family is not supported. |
| 25048 | [10047] Address family is not supported by protocol family. |
| 25049 | [10048] Address already in use. |
| 25050 | [10049] Cannot assign requested address. |
| 25051 | [10050] Network is down. |
| 25052 | [10051] Network is unreachable. |
| 25053 | [10052] Net dropped connection or reset. |
| 25054 | [10053] Software caused connection abort. |
| 25055 | [10054] Connection reset by peer. |
| 25056 | [10055] No buffer space available. |
| 25057 | [10056] Socket is already connected. |
| 25058 | [10057] Socket is not connected. |
| 25059 | [10058] Cannot send after socket shutdown. |
| 25060 | [10059] Too many references, cannot splice. |
| 25061 | [10060] Connection timed out. |
| 25062 | [10061] Connection refused. |
| 25063 | [10062] Too many levels of symbolic links. |
| 25064 | [10063] File name is too long. |
| 25065 | [10064] Host is down. |
| 25066 | [10065] No route to host. |
| 25067 | [10066] Directory is not empty |
| 25068 | [10067] Too many processes. |
| 25069 | [10068] Too many users. |
| 25070 | [10069] Disc Quota Exceeded. |
| 25071 | [10070] Stale NFS file handle. |
| 25072 | [10071] Too many levels of remote in path. |
| 25092 | [10091] Network subsystem is unavailable. |
| 25093 | [10092] WINSOCK DLL Version out of range. |
| 25094 | [10093] Winsock is not loaded yet. |
| 26002 | [11001] Host not found. |
| 26003 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). |
| 26004 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. |
| 26005 | [11004] Valid name, no data record (check DNS setup). |