Struct cloudfiles::HadoopDFS

Properties   Methods   Events   Config Settings   Errors  

The HadoopDFS struct provides easy access to files stored in HDFS clusters.

Syntax

cloudfiles::HadoopDFS

Remarks

The HadoopDFS struct 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 auth_mechanism property for more information about configuring the struct to authenticate correctly.

Addressing Resources

HDFS addresses resources (files, directories, and symlinks) using Linux-style absolute paths. Unless otherwise specified, the struct 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

list_resources lists resources (files, directories, and symlinks) within the specified directory. Calling this method will fire the on_resource_list 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 download_file method downloads files.

If local_file is set, the file will be saved to the specified location; otherwise, the file data will be held by resource_data.

To download and decrypt an encrypted file, set encryption_algorithm and encryption_password 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 struct also supports resuming failed downloads by using the start_byte property. If a download is interrupted, set start_byte 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 local_file was set in the initial download attempt.

If local_file is set when beginning an encrypted download, the struct 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 start_byte, to allow the remainder of the encrypted data to be downloaded. Once the encrypted data is downloaded it will be decrypted and written to local_file. 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 upload_file method uploads new files.

If local_file is set the file will be uploaded from the specified path. If local_file is not set the data in resource_data will be used.

To encrypt the file before uploading it, set encryption_algorithm and encryption_password. hdfs.LocalFile = "../MyFile.zip"; hdfs.UploadFile("/MyFile.zip");

Additional Functionality

The HadoopDFS struct offers advanced functionality beyond simple uploads and downloads. For instance:

• Encrypt and decrypt files using the encryption_algorithm and encryption_password properties.
• Basic file and folder manipulation and organization using methods such as append_file, delete_resource, make_directory, move_resource, and truncate_file.
• Advanced file and directory manipulation with set_file_replication, set_owner, set_permission, and set_times.
• Retrieval of both general file/directory information, as well as directory quota information, using get_resource_info and get_dir_summary.
• Execute any arbitrary WebHDFS operation with ease using the do_custom_op method.
• And more!

Object Lifetime

The new() method returns a mutable reference to a struct instance. The object itself is kept in the global list maintainted by CloudFiles. Due to this, the HadoopDFS struct cannot be disposed of automatically. Please, call the dispose(&mut self) method of HadoopDFS when you have finished using the instance.

Property List

The following is the full list of the properties of the struct with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the struct with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the struct with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the struct with short descriptions. Click on the links for further details.

auth_mechanism property (HadoopDFS Struct)

The authentication mechanism to use when connecting to the server.

Syntax

fn auth_mechanism(&self ) -> Result<i32, CloudFilesError> 
fn set_auth_mechanism(&self, value : i32) ->  Option<CloudFilesError> 

Possible Values

0   // None
1   // Simple
2   // Basic
3   // NTLM
4   // Negotiate
5   // OAuth

Default Value

0

Remarks

This property controls what authentication mechanism the struct should use when connecting to the server.

Possible values are:

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

i32

authorization property (HadoopDFS Struct)

The OAuth 2.0 authorization token.

Syntax

fn authorization(&self ) -> Result<String, CloudFilesError> 
fn set_authorization(&self, value : &str) ->  Option<CloudFilesError> 
fn set_authorization_ref(&self, value : &String) ->  Option<CloudFilesError> 

Default Value

""

Remarks

This property is used to specify the OAuth 2.0 authorization token that was obtained as a result of performing OAuth. A valid OAuth token will come in the following format:

Bearer ACCESS_TOKEN

The ACCESS_TOKEN segment must be supplied to this property before attempting any other operations. Consult the documentation for the service for more information about supported scope values and more details on performing OAuth.

Refer to auth_mechanism for more information.

Data Type

String

dir_summary_dir_count property (HadoopDFS Struct)

The number of subdirectories within the directory.

Syntax

fn dir_summary_dir_count(&self ) -> Result<i64, CloudFilesError> 

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.

Data Type

i64

dir_summary_file_count property (HadoopDFS Struct)

The number of files within the directory.

Syntax

fn dir_summary_file_count(&self ) -> Result<i64, CloudFilesError> 

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.

Data Type

i64

dir_summary_name_quota property (HadoopDFS Struct)

The name quota imposed on the directory.

Syntax

fn dir_summary_name_quota(&self ) -> Result<i64, CloudFilesError> 

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.

Data Type

i64

dir_summary_size property (HadoopDFS Struct)

The total size of the directory contents, excluding file replicas.

Syntax

fn dir_summary_size(&self ) -> Result<i64, CloudFilesError> 

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

Data Type

i64

dir_summary_space_quota property (HadoopDFS Struct)

The space quota imposed on the directory.

Syntax

fn dir_summary_space_quota(&self ) -> Result<i64, CloudFilesError> 

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 dir_summary_storage_quotas, and only one space quota may be applied to any given directory.

This property is read-only.

Data Type

i64

dir_summary_space_used property (HadoopDFS Struct)

The total amount of space the directory consumes on disk.

Syntax

fn dir_summary_space_used(&self ) -> Result<i64, CloudFilesError> 

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 dir_summary_size, this property's value includes space consumed by file replicas.

This property is read-only.

Data Type

i64

dir_summary_storage_quota property (HadoopDFS Struct)

The storage type quota imposed on the directory.

Syntax

fn dir_summary_storage_quota(&self ) -> Result<i64, CloudFilesError> 

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 dir_summary_storage_quota_type currently selected by dir_summary_storage_quota_index.

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

Use dir_summary_storage_quota_count to determine how many storage type quotas are imposed on a directory, and dir_summary_storage_quota_index to select which storage type quota's information to reflect in the dir_summary_storage_quota, dir_summary_storage_quota_type, and dir_summary_storage_quota_used 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.

Data Type

i64

dir_summary_storage_quota_count property (HadoopDFS Struct)

The number of storage type quotas associated with the directory.

Syntax

fn dir_summary_storage_quota_count(&self ) -> Result<i32, CloudFilesError> 

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 dir_summary_storage_quota_index property to select which storage type quota's information to reflect in the dir_summary_storage_quota, dir_summary_storage_quota_type, and dir_summary_storage_quota_used properties.

This property is read-only.

Data Type

i32

dir_summary_storage_quota_index property (HadoopDFS Struct)

Selects the storage type quota to show information for.

Syntax

fn dir_summary_storage_quota_index(&self ) -> Result<i32, CloudFilesError> 

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 dir_summary_storage_quota, dir_summary_storage_quota_type, and dir_summary_storage_quota_used properties; those properties are re-populated when this property's value is changed.

Valid values for this property are -1 to (dir_summary_storage_quota_count - 1); invalid indices are ignored. The default value is 0 if dir_summary_storage_quota_count is greater than 0, and -1 otherwise.

This property is read-only.

Data Type

i32

dir_summary_storage_quota_type property (HadoopDFS Struct)

The storage type associated with the storage type quota.

Syntax

fn dir_summary_storage_quota_type(&self ) -> Result<String, CloudFilesError> 

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 dir_summary_storage_quota_index

This property is read-only.

Data Type

String

dir_summary_storage_quota_used property (HadoopDFS Struct)

The number of bytes consumed for the storage type quota.

Syntax

fn dir_summary_storage_quota_used(&self ) -> Result<i64, CloudFilesError> 

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 dir_summary_storage_quota_index

This property is read-only.

Data Type

i64

encryption_algorithm property (HadoopDFS Struct)

The encryption algorithm.

Syntax

fn encryption_algorithm(&self ) -> Result<i32, CloudFilesError> 
fn set_encryption_algorithm(&self, value : i32) ->  Option<CloudFilesError> 

Possible Values

0   // AES
1   // Blowfish
2   // CAST
3   // DES
4   // IDEA
5   // RC2
6   // RC4
7   // TEA
8   // TripleDES
9   // Twofish
10   // Rijndael
11   // ChaCha
12   // XSalsa20

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:

Data Type

i32

encryption_password property (HadoopDFS Struct)

The encryption password.

Syntax

fn encryption_password(&self ) -> Result<String, CloudFilesError> 
fn set_encryption_password(&self, value : &str) ->  Option<CloudFilesError> 
fn set_encryption_password_ref(&self, value : &String) ->  Option<CloudFilesError> 

Default Value

""

Remarks

If this property is populated when upload_file or download_file is called, the struct will attempt to encrypt or decrypt the data before uploading or after downloading it.

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

Data Type

String

firewall_auto_detect property (HadoopDFS Struct)

Whether to automatically detect and use firewall system settings, if available.

Syntax

fn firewall_auto_detect(&self ) -> Result<bool, CloudFilesError> 
fn set_firewall_auto_detect(&self, value : bool) ->  Option<CloudFilesError> 

Default Value

false

Remarks

Whether to automatically detect and use firewall system settings, if available.

Data Type

bool

firewall_type property (HadoopDFS Struct)

The type of firewall to connect through.

Syntax

fn firewall_type(&self ) -> Result<i32, CloudFilesError> 
fn set_firewall_type(&self, value : i32) ->  Option<CloudFilesError> 

Possible Values

0   // None
1   // Tunnel
2   // SOCKS4
3   // SOCKS5
10   // SOCKS4A

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

Data Type

i32

firewall_host property (HadoopDFS Struct)

The name or IP address of the firewall (optional).

Syntax

fn firewall_host(&self ) -> Result<String, CloudFilesError> 
fn set_firewall_host(&self, value : &str) ->  Option<CloudFilesError> 
fn set_firewall_host_ref(&self, value : &String) ->  Option<CloudFilesError> 

Default Value

""

Remarks

The name or IP address of the firewall (optional). If a firewall_host 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 struct fails with an error.

Data Type

String

firewall_password property (HadoopDFS Struct)

A password if authentication is to be used when connecting through the firewall.

Syntax

fn firewall_password(&self ) -> Result<String, CloudFilesError> 
fn set_firewall_password(&self, value : &str) ->  Option<CloudFilesError> 
fn set_firewall_password_ref(&self, value : &String) ->  Option<CloudFilesError> 

Default Value

""

Remarks

A password if authentication is to be used when connecting through the firewall. If firewall_host is specified, the firewall_user and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the struct fails with an error.

Data Type

String

firewall_port property (HadoopDFS Struct)

The Transmission Control Protocol (TCP) port for the firewall Host .

Syntax

fn firewall_port(&self ) -> Result<i32, CloudFilesError> 
fn set_firewall_port(&self, value : i32) ->  Option<CloudFilesError> 

Default Value

0

Remarks

The Transmission Control Protocol (TCP) port for the firewall firewall_host. See the description of the firewall_host property for details.

NOTE: This property is set automatically when firewall_firewall_type is set to a valid value. See the description of the firewall_firewall_type property for details.

Data Type

i32

firewall_user property (HadoopDFS Struct)

A username if authentication is to be used when connecting through a firewall.

Syntax

fn firewall_user(&self ) -> Result<String, CloudFilesError> 
fn set_firewall_user(&self, value : &str) ->  Option<CloudFilesError> 
fn set_firewall_user_ref(&self, value : &String) ->  Option<CloudFilesError> 

Default Value

""

Remarks

A username if authentication is to be used when connecting through a firewall. If firewall_host is specified, this property and the firewall_password property are used to connect and authenticate to the given Firewall. If the authentication fails, the struct fails with an error.

Data Type

String

idle property (HadoopDFS Struct)

The current status of the struct.

Syntax

fn idle(&self ) -> Result<bool, CloudFilesError> 

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

bool

local_file property (HadoopDFS Struct)

The location of the local file.

Syntax

fn local_file(&self ) -> Result<String, CloudFilesError> 
fn set_local_file(&self, value : &str) ->  Option<CloudFilesError> 
fn set_local_file_ref(&self, value : &String) ->  Option<CloudFilesError> 

Default Value

""

Remarks

This property specifies the location of a file on disk. This is used as the source file when calling upload_file or append_file, and as the destination file when calling download_file or do_custom_op.

Data Type

String

local_host property (HadoopDFS Struct)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

fn local_host(&self ) -> Result<String, CloudFilesError> 
fn set_local_host(&self, value : &str) ->  Option<CloudFilesError> 
fn set_local_host_ref(&self, value : &String) ->  Option<CloudFilesError> 

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 struct initiate connections (or accept in the case of server structs) 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 struct is connected, the local_host 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: local_host is not persistent. You must always set it in code, and never in the property window.

Data Type

String

other_headers property (HadoopDFS Struct)

Other headers as determined by the user (optional).

Syntax

fn other_headers(&self ) -> Result<String, CloudFilesError> 
fn set_other_headers(&self, value : &str) ->  Option<CloudFilesError> 
fn set_other_headers_ref(&self, value : &String) ->  Option<CloudFilesError> 

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 content_type and from.

The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

Use this property with caution. If this property contains invalid headers, HTTP requests may fail.

This property is useful for extending the functionality of the struct beyond what is provided.

Data Type

String

overwrite property (HadoopDFS Struct)

Whether to overwrite the local or remote file.

Syntax

fn overwrite(&self ) -> Result<bool, CloudFilesError> 
fn set_overwrite(&self, value : bool) ->  Option<CloudFilesError> 

Default Value

false

Remarks

When calling download_file, this property determines if local_file should be overwritten if it already exists.

When calling upload_file, this property determines if the remote file should be overwritten if it already exists.

Data Type

bool

parsed_header_count property (HadoopDFS Struct)

The number of records in the ParsedHeader arrays.

Syntax

fn parsed_header_count(&self ) -> Result<i32, CloudFilesError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• parsed_header_field
• parsed_header_value

The array indices start at 0 and end at parsed_header_count - 1.

This property is read-only.

Data Type

i32

parsed_header_field property (HadoopDFS Struct)

This property contains the name of the HTTP header (this is the same case as it is delivered).

Syntax

fn parsed_header_field(&self , ParsedHeaderIndex : i32) -> Result<String, CloudFilesError> 

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.

Data Type

String

parsed_header_value property (HadoopDFS Struct)

This property contains the header contents.

Syntax

fn parsed_header_value(&self , ParsedHeaderIndex : i32) -> Result<String, CloudFilesError> 

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.

Data Type

String

password property (HadoopDFS Struct)

The password to use for authentication.

Syntax

fn password(&self ) -> Result<String, CloudFilesError> 
fn set_password(&self, value : &str) ->  Option<CloudFilesError> 
fn set_password_ref(&self, value : &String) ->  Option<CloudFilesError> 

Default Value

""

Remarks

This property specifies the password to user for authentication.

Refer to auth_mechanism for more information.

Data Type

String

proxy_auth_scheme property (HadoopDFS Struct)

The type of authorization to perform when connecting to the proxy.

Syntax

fn proxy_auth_scheme(&self ) -> Result<i32, CloudFilesError> 
fn set_proxy_auth_scheme(&self, value : i32) ->  Option<CloudFilesError> 

Possible Values

0   // Basic
1   // Digest
2   // Proprietary
3   // None
4   // Ntlm
5   // Negotiate

Default Value

0

Remarks

The type of authorization to perform when connecting to the proxy. This is used only when the proxy_user and proxy_password properties are set.

proxy_auth_scheme should be set to authNone (3) when no authentication is expected.

By default, proxy_auth_scheme is authBasic (0), and if the proxy_user and proxy_password properties are set, the struct will attempt basic authentication.

If proxy_auth_scheme is set to authDigest (1), digest authentication will be attempted instead.

If proxy_auth_scheme is set to authProprietary (2), then the authorization token will not be generated by the struct. Look at the configuration file for the struct being used to find more information about manually setting this token.

If proxy_auth_scheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of proxy_user and proxy_password.

Data Type

i32

proxy_auto_detect property (HadoopDFS Struct)

Whether to automatically detect and use proxy system settings, if available.

Syntax

fn proxy_auto_detect(&self ) -> Result<bool, CloudFilesError> 
fn set_proxy_auto_detect(&self, value : bool) ->  Option<CloudFilesError> 

Default Value

false

Remarks

Whether to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

bool

proxy_password property (HadoopDFS Struct)

A password if authentication is to be used for the proxy.

Syntax

fn proxy_password(&self ) -> Result<String, CloudFilesError> 
fn set_proxy_password(&self, value : &str) ->  Option<CloudFilesError> 
fn set_proxy_password_ref(&self, value : &String) ->  Option<CloudFilesError> 

Default Value

""

Remarks

A password if authentication is to be used for the proxy.

If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

Data Type

String

proxy_port property (HadoopDFS Struct)

The Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

fn proxy_port(&self ) -> Result<i32, CloudFilesError> 
fn set_proxy_port(&self, value : i32) ->  Option<CloudFilesError> 

Default Value

80

Remarks

The Transmission Control Protocol (TCP) port for the proxy proxy_server (default 80). See the description of the proxy_server property for details.

Data Type

i32

proxy_server property (HadoopDFS Struct)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

fn proxy_server(&self ) -> Result<String, CloudFilesError> 
fn set_proxy_server(&self, value : &str) ->  Option<CloudFilesError> 
fn set_proxy_server_ref(&self, value : &String) ->  Option<CloudFilesError> 

Default Value

""

Remarks

If a proxy proxy_server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the proxy_server property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the proxy_server property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

proxy_ssl property (HadoopDFS Struct)

When to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

fn proxy_ssl(&self ) -> Result<i32, CloudFilesError> 
fn set_proxy_ssl(&self, value : i32) ->  Option<CloudFilesError> 

Possible Values

0   // Automatic
1   // Always
2   // Never
3   // Tunnel

Default Value

0

Remarks

When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

i32

proxy_user property (HadoopDFS Struct)

A username if authentication is to be used for the proxy.

Syntax

fn proxy_user(&self ) -> Result<String, CloudFilesError> 
fn set_proxy_user(&self, value : &str) ->  Option<CloudFilesError> 
fn set_proxy_user_ref(&self, value : &String) ->  Option<CloudFilesError> 

Default Value

""

Remarks

A username if authentication is to be used for the proxy.

If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

Data Type

String

query_param_count property (HadoopDFS Struct)

The number of records in the QueryParam arrays.

Syntax

fn query_param_count(&self ) -> Result<i32, CloudFilesError> 
fn set_query_param_count(&self, value : i32) ->  Option<CloudFilesError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• query_param_name
• query_param_value

The array indices start at 0 and end at query_param_count - 1.

Data Type

i32

query_param_name property (HadoopDFS Struct)

The name of the query parameter.

Syntax

fn query_param_name(&self , QueryParamIndex : i32) -> Result<String, CloudFilesError> 
fn set_query_param_name(&self, QueryParamIndex : i32, value : &str) ->  Option<CloudFilesError> 
fn set_query_param_name_ref(&self, QueryParamIndex : i32, value : &String) ->  Option<CloudFilesError> 

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.

Data Type

String

query_param_value property (HadoopDFS Struct)

The value of the query parameter.

Syntax

fn query_param_value(&self , QueryParamIndex : i32) -> Result<String, CloudFilesError> 
fn set_query_param_value(&self, QueryParamIndex : i32, value : &str) ->  Option<CloudFilesError> 
fn set_query_param_value_ref(&self, QueryParamIndex : i32, value : &String) ->  Option<CloudFilesError> 

Default Value

""

Remarks

The value of the query parameter.

This property specifies the value of the query parameter. The struct 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.

Data Type

String

read_bytes property (HadoopDFS Struct)

The number of bytes to read when downloading a file.

Syntax

fn read_bytes(&self ) -> Result<i64, CloudFilesError> 
fn set_read_bytes(&self, value : i64) ->  Option<CloudFilesError> 

Default Value

-1

Remarks

This property specifies how many bytes should be read when download_file is called. It can be used in tandem with start_byte 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.

Data Type

i64

resource_data property (HadoopDFS Struct)

The data that was downloaded, or that should be uploaded.

Syntax

fn resource_data(&self ) -> Result<Vec<u8>, CloudFilesError> 
fn set_resource_data(&self, value : Vec<u8>) ->  Option<CloudFilesError> 
fn set_resource_data_ref(&self, value : &[u8]) ->  Option<CloudFilesError> 

Default Value

""

Remarks

This property is populated with file data after calling download_file if local_file is not set.

This property can also be set before calling upload_file; its data will be uploaded if local_file is not set.

Data Type

Vec

resource_count property (HadoopDFS Struct)

The number of records in the Resource arrays.

Syntax

fn resource_count(&self ) -> Result<i32, CloudFilesError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• resource_access_time
• resource_block_size
• resource_child_count
• resource_group
• resource_modified_time
• resource_name
• resource_owner
• resource_path
• resource_permission
• resource_replication
• resource_size
• resource_symlink_target
• resource_type

The array indices start at 0 and end at resource_count - 1.

This property is read-only.

Data Type

i32

resource_access_time property (HadoopDFS Struct)

The last access time of the resource.

Syntax

fn resource_access_time(&self , ResourceIndex : i32) -> Result<i64, CloudFilesError> 

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.

Data Type

i64

resource_block_size property (HadoopDFS Struct)

The block size of the file.

Syntax

fn resource_block_size(&self , ResourceIndex : i32) -> Result<i64, CloudFilesError> 

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.

Data Type

i64

resource_child_count property (HadoopDFS Struct)

The number of children in the directory.

Syntax

fn resource_child_count(&self , ResourceIndex : i32) -> Result<i64, CloudFilesError> 

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.

Data Type

i64

resource_group property (HadoopDFS Struct)

The name of the resource's group.

Syntax

fn resource_group(&self , ResourceIndex : i32) -> Result<String, CloudFilesError> 

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.

Data Type

String

resource_modified_time property (HadoopDFS Struct)

The last modified time of the resource.

Syntax

fn resource_modified_time(&self , ResourceIndex : i32) -> Result<i64, CloudFilesError> 

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.

Data Type

i64

resource_name property (HadoopDFS Struct)

The name of the resource.

Syntax

fn resource_name(&self , ResourceIndex : i32) -> Result<String, CloudFilesError> 

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.

Data Type

String

resource_owner property (HadoopDFS Struct)

The name of the resource's owner.

Syntax

fn resource_owner(&self , ResourceIndex : i32) -> Result<String, CloudFilesError> 

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.

Data Type

String

resource_path property (HadoopDFS Struct)

The full path of the resource.

Syntax

fn resource_path(&self , ResourceIndex : i32) -> Result<String, CloudFilesError> 

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

Data Type

String

resource_permission property (HadoopDFS Struct)

The resource's permission bits.

Syntax

fn resource_permission(&self , ResourceIndex : i32) -> Result<String, CloudFilesError> 

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.

Data Type

String

resource_replication property (HadoopDFS Struct)

The replication factor of the file.

Syntax

fn resource_replication(&self , ResourceIndex : i32) -> Result<i32, CloudFilesError> 

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.

Data Type

i32

resource_size property (HadoopDFS Struct)

The size of the file.

Syntax

fn resource_size(&self , ResourceIndex : i32) -> Result<i64, CloudFilesError> 

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 resource_replication is greater than 1. In that case, multiply the values of this property and resource_replication 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.

Data Type

i64

resource_symlink_target property (HadoopDFS Struct)

The full target path of the symlink.

Syntax

fn resource_symlink_target(&self , ResourceIndex : i32) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The full target path of the symlink.

This property reflects the full target path of the symlink, if resource_type 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.

Data Type

String

resource_type property (HadoopDFS Struct)

The resource type.

Syntax

fn resource_type(&self , ResourceIndex : i32) -> Result<i32, CloudFilesError> 

Possible Values

0   // File
1   // Directory
2   // SymLink

Default Value

0

Remarks

The resource type.

This property reflects the resource's type. Possible values are:

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.

Data Type

i32

ssl_accept_server_cert_effective_date property (HadoopDFS Struct)

The date on which this certificate becomes valid.

Syntax

fn ssl_accept_server_cert_effective_date(&self ) -> Result<String, CloudFilesError> 

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

ssl_accept_server_cert_expiration_date property (HadoopDFS Struct)

The date on which the certificate expires.

Syntax

fn ssl_accept_server_cert_expiration_date(&self ) -> Result<String, CloudFilesError> 

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

ssl_accept_server_cert_extended_key_usage property (HadoopDFS Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn ssl_accept_server_cert_extended_key_usage(&self ) -> Result<String, CloudFilesError> 

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

ssl_accept_server_cert_fingerprint property (HadoopDFS Struct)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fn ssl_accept_server_cert_fingerprint(&self ) -> Result<String, CloudFilesError> 

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

ssl_accept_server_cert_fingerprint_sha1 property (HadoopDFS Struct)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fn ssl_accept_server_cert_fingerprint_sha1(&self ) -> Result<String, CloudFilesError> 

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

ssl_accept_server_cert_fingerprint_sha256 property (HadoopDFS Struct)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fn ssl_accept_server_cert_fingerprint_sha256(&self ) -> Result<String, CloudFilesError> 

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

ssl_accept_server_cert_issuer property (HadoopDFS Struct)

The issuer of the certificate.

Syntax

fn ssl_accept_server_cert_issuer(&self ) -> Result<String, CloudFilesError> 

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

ssl_accept_server_cert_private_key property (HadoopDFS Struct)

The private key of the certificate (if available).

Syntax

fn ssl_accept_server_cert_private_key(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The ssl_accept_server_cert_private_key may be available but not exportable. In this case, ssl_accept_server_cert_private_key returns an empty string.

This property is read-only.

Data Type

String

ssl_accept_server_cert_private_key_available property (HadoopDFS Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn ssl_accept_server_cert_private_key_available(&self ) -> Result<bool, CloudFilesError> 

Default Value

false

Remarks

Whether a ssl_accept_server_cert_private_key is available for the selected certificate. If ssl_accept_server_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

ssl_accept_server_cert_private_key_container property (HadoopDFS Struct)

The name of the PrivateKey container for the certificate (if available).

Syntax

fn ssl_accept_server_cert_private_key_container(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The name of the ssl_accept_server_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

ssl_accept_server_cert_public_key property (HadoopDFS Struct)

The public key of the certificate.

Syntax

fn ssl_accept_server_cert_public_key(&self ) -> Result<String, CloudFilesError> 

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

ssl_accept_server_cert_public_key_algorithm property (HadoopDFS Struct)

The textual description of the certificate's public key algorithm.

Syntax

fn ssl_accept_server_cert_public_key_algorithm(&self ) -> Result<String, CloudFilesError> 

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

ssl_accept_server_cert_public_key_length property (HadoopDFS Struct)

The length of the certificate's public key (in bits).

Syntax

fn ssl_accept_server_cert_public_key_length(&self ) -> Result<i32, CloudFilesError> 

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

i32

ssl_accept_server_cert_serial_number property (HadoopDFS Struct)

The serial number of the certificate encoded as a string.

Syntax

fn ssl_accept_server_cert_serial_number(&self ) -> Result<String, CloudFilesError> 

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

ssl_accept_server_cert_signature_algorithm property (HadoopDFS Struct)

The text description of the certificate's signature algorithm.

Syntax

fn ssl_accept_server_cert_signature_algorithm(&self ) -> Result<String, CloudFilesError> 

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

ssl_accept_server_cert_store property (HadoopDFS Struct)

The name of the certificate store for the client certificate.

Syntax

fn ssl_accept_server_cert_store(&self ) -> Result<Vec<u8>, CloudFilesError> 
fn set_ssl_accept_server_cert_store(&self, value : Vec<u8>) ->  Option<CloudFilesError> 
fn set_ssl_accept_server_cert_store_ref(&self, value : &[u8]) ->  Option<CloudFilesError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_accept_server_cert_store_type property denotes the type of the certificate store specified by ssl_accept_server_cert_store. If the store is password-protected, specify the password in ssl_accept_server_cert_store_password.

ssl_accept_server_cert_store is used in conjunction with the ssl_accept_server_cert_subject property to specify client certificates. If ssl_accept_server_cert_store has a value, and ssl_accept_server_cert_subject or ssl_accept_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_accept_server_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

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

Data Type

Vec

ssl_accept_server_cert_store_password property (HadoopDFS Struct)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

fn ssl_accept_server_cert_store_password(&self ) -> Result<String, CloudFilesError> 
fn set_ssl_accept_server_cert_store_password(&self, value : &str) ->  Option<CloudFilesError> 
fn set_ssl_accept_server_cert_store_password_ref(&self, value : &String) ->  Option<CloudFilesError> 

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

ssl_accept_server_cert_store_type property (HadoopDFS Struct)

The type of certificate store for this certificate.

Syntax

fn ssl_accept_server_cert_store_type(&self ) -> Result<i32, CloudFilesError> 
fn set_ssl_accept_server_cert_store_type(&self, value : i32) ->  Option<CloudFilesError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

Data Type

i32

ssl_accept_server_cert_subject_alt_names property (HadoopDFS Struct)

Comma-separated lists of alternative subject names for the certificate.

Syntax

fn ssl_accept_server_cert_subject_alt_names(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

ssl_accept_server_cert_thumbprint_md5 property (HadoopDFS Struct)

The MD5 hash of the certificate.

Syntax

fn ssl_accept_server_cert_thumbprint_md5(&self ) -> Result<String, CloudFilesError> 

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

ssl_accept_server_cert_thumbprint_sha1 property (HadoopDFS Struct)

The SHA-1 hash of the certificate.

Syntax

fn ssl_accept_server_cert_thumbprint_sha1(&self ) -> Result<String, CloudFilesError> 

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

ssl_accept_server_cert_thumbprint_sha256 property (HadoopDFS Struct)

The SHA-256 hash of the certificate.

Syntax

fn ssl_accept_server_cert_thumbprint_sha256(&self ) -> Result<String, CloudFilesError> 

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

ssl_accept_server_cert_usage property (HadoopDFS Struct)

The text description of UsageFlags .

Syntax

fn ssl_accept_server_cert_usage(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The text description of ssl_accept_server_cert_usage_flags.

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

ssl_accept_server_cert_usage_flags property (HadoopDFS Struct)

The flags that show intended use for the certificate.

Syntax

fn ssl_accept_server_cert_usage_flags(&self ) -> Result<i32, CloudFilesError> 

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_accept_server_cert_usage_flags is a combination of the following flags:

Please see the ssl_accept_server_cert_usage property for a text representation of ssl_accept_server_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

i32

ssl_accept_server_cert_version property (HadoopDFS Struct)

The certificate's version number.

Syntax

fn ssl_accept_server_cert_version(&self ) -> Result<String, CloudFilesError> 

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

ssl_accept_server_cert_subject property (HadoopDFS Struct)

The subject of the certificate used for client authentication.

Syntax

fn ssl_accept_server_cert_subject(&self ) -> Result<String, CloudFilesError> 
fn set_ssl_accept_server_cert_subject(&self, value : &str) ->  Option<CloudFilesError> 
fn set_ssl_accept_server_cert_subject_ref(&self, value : &String) ->  Option<CloudFilesError> 

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=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

ssl_accept_server_cert_encoded property (HadoopDFS Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn ssl_accept_server_cert_encoded(&self ) -> Result<Vec<u8>, CloudFilesError> 
fn set_ssl_accept_server_cert_encoded(&self, value : Vec<u8>) ->  Option<CloudFilesError> 
fn set_ssl_accept_server_cert_encoded_ref(&self, value : &[u8]) ->  Option<CloudFilesError> 

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_accept_server_cert_store and ssl_accept_server_cert_subject properties also may be used to specify a certificate.

When ssl_accept_server_cert_encoded is set, a search is initiated in the current ssl_accept_server_cert_store for the private key of the certificate. If the key is found, ssl_accept_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_accept_server_cert_subject is set to an empty string.

Data Type

Vec

ssl_cert_effective_date property (HadoopDFS Struct)

The date on which this certificate becomes valid.

Syntax

fn ssl_cert_effective_date(&self ) -> Result<String, CloudFilesError> 

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

ssl_cert_expiration_date property (HadoopDFS Struct)

The date on which the certificate expires.

Syntax

fn ssl_cert_expiration_date(&self ) -> Result<String, CloudFilesError> 

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

ssl_cert_extended_key_usage property (HadoopDFS Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn ssl_cert_extended_key_usage(&self ) -> Result<String, CloudFilesError> 

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

ssl_cert_fingerprint property (HadoopDFS Struct)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fn ssl_cert_fingerprint(&self ) -> Result<String, CloudFilesError> 

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

ssl_cert_fingerprint_sha1 property (HadoopDFS Struct)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fn ssl_cert_fingerprint_sha1(&self ) -> Result<String, CloudFilesError> 

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

ssl_cert_fingerprint_sha256 property (HadoopDFS Struct)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fn ssl_cert_fingerprint_sha256(&self ) -> Result<String, CloudFilesError> 

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

ssl_cert_issuer property (HadoopDFS Struct)

The issuer of the certificate.

Syntax

fn ssl_cert_issuer(&self ) -> Result<String, CloudFilesError> 

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

ssl_cert_private_key property (HadoopDFS Struct)

The private key of the certificate (if available).

Syntax

fn ssl_cert_private_key(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The ssl_cert_private_key may be available but not exportable. In this case, ssl_cert_private_key returns an empty string.

This property is read-only.

Data Type

String

ssl_cert_private_key_available property (HadoopDFS Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn ssl_cert_private_key_available(&self ) -> Result<bool, CloudFilesError> 

Default Value

false

Remarks

Whether a ssl_cert_private_key is available for the selected certificate. If ssl_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

ssl_cert_private_key_container property (HadoopDFS Struct)

The name of the PrivateKey container for the certificate (if available).

Syntax

fn ssl_cert_private_key_container(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The name of the ssl_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

ssl_cert_public_key property (HadoopDFS Struct)

The public key of the certificate.

Syntax

fn ssl_cert_public_key(&self ) -> Result<String, CloudFilesError> 

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

ssl_cert_public_key_algorithm property (HadoopDFS Struct)

The textual description of the certificate's public key algorithm.

Syntax

fn ssl_cert_public_key_algorithm(&self ) -> Result<String, CloudFilesError> 

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

ssl_cert_public_key_length property (HadoopDFS Struct)

The length of the certificate's public key (in bits).

Syntax

fn ssl_cert_public_key_length(&self ) -> Result<i32, CloudFilesError> 

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

i32

ssl_cert_serial_number property (HadoopDFS Struct)

The serial number of the certificate encoded as a string.

Syntax

fn ssl_cert_serial_number(&self ) -> Result<String, CloudFilesError> 

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

ssl_cert_signature_algorithm property (HadoopDFS Struct)

The text description of the certificate's signature algorithm.

Syntax

fn ssl_cert_signature_algorithm(&self ) -> Result<String, CloudFilesError> 

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

ssl_cert_store property (HadoopDFS Struct)

The name of the certificate store for the client certificate.

Syntax

fn ssl_cert_store(&self ) -> Result<Vec<u8>, CloudFilesError> 
fn set_ssl_cert_store(&self, value : Vec<u8>) ->  Option<CloudFilesError> 
fn set_ssl_cert_store_ref(&self, value : &[u8]) ->  Option<CloudFilesError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password-protected, specify the password in ssl_cert_store_password.

ssl_cert_store is used in conjunction with the ssl_cert_subject property to specify client certificates. If ssl_cert_store has a value, and ssl_cert_subject or ssl_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

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

Data Type

Vec

ssl_cert_store_password property (HadoopDFS Struct)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

fn ssl_cert_store_password(&self ) -> Result<String, CloudFilesError> 
fn set_ssl_cert_store_password(&self, value : &str) ->  Option<CloudFilesError> 
fn set_ssl_cert_store_password_ref(&self, value : &String) ->  Option<CloudFilesError> 

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

ssl_cert_store_type property (HadoopDFS Struct)

The type of certificate store for this certificate.

Syntax

fn ssl_cert_store_type(&self ) -> Result<i32, CloudFilesError> 
fn set_ssl_cert_store_type(&self, value : i32) ->  Option<CloudFilesError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

Data Type

i32

ssl_cert_subject_alt_names property (HadoopDFS Struct)

Comma-separated lists of alternative subject names for the certificate.

Syntax

fn ssl_cert_subject_alt_names(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

ssl_cert_thumbprint_md5 property (HadoopDFS Struct)

The MD5 hash of the certificate.

Syntax

fn ssl_cert_thumbprint_md5(&self ) -> Result<String, CloudFilesError> 

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

ssl_cert_thumbprint_sha1 property (HadoopDFS Struct)

The SHA-1 hash of the certificate.

Syntax

fn ssl_cert_thumbprint_sha1(&self ) -> Result<String, CloudFilesError> 

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

ssl_cert_thumbprint_sha256 property (HadoopDFS Struct)

The SHA-256 hash of the certificate.

Syntax

fn ssl_cert_thumbprint_sha256(&self ) -> Result<String, CloudFilesError> 

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

ssl_cert_usage property (HadoopDFS Struct)

The text description of UsageFlags .

Syntax

fn ssl_cert_usage(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The text description of ssl_cert_usage_flags.

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

ssl_cert_usage_flags property (HadoopDFS Struct)

The flags that show intended use for the certificate.

Syntax

fn ssl_cert_usage_flags(&self ) -> Result<i32, CloudFilesError> 

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_cert_usage_flags is a combination of the following flags:

Please see the ssl_cert_usage property for a text representation of ssl_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

i32

ssl_cert_version property (HadoopDFS Struct)

The certificate's version number.

Syntax

fn ssl_cert_version(&self ) -> Result<String, CloudFilesError> 

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

ssl_cert_subject property (HadoopDFS Struct)

The subject of the certificate used for client authentication.

Syntax

fn ssl_cert_subject(&self ) -> Result<String, CloudFilesError> 
fn set_ssl_cert_subject(&self, value : &str) ->  Option<CloudFilesError> 
fn set_ssl_cert_subject_ref(&self, value : &String) ->  Option<CloudFilesError> 

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=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

ssl_cert_encoded property (HadoopDFS Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn ssl_cert_encoded(&self ) -> Result<Vec<u8>, CloudFilesError> 
fn set_ssl_cert_encoded(&self, value : Vec<u8>) ->  Option<CloudFilesError> 
fn set_ssl_cert_encoded_ref(&self, value : &[u8]) ->  Option<CloudFilesError> 

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_cert_store and ssl_cert_subject properties also may be used to specify a certificate.

When ssl_cert_encoded is set, a search is initiated in the current ssl_cert_store for the private key of the certificate. If the key is found, ssl_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_cert_subject is set to an empty string.

Data Type

Vec

ssl_provider property (HadoopDFS Struct)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

fn ssl_provider(&self ) -> Result<i32, CloudFilesError> 
fn set_ssl_provider(&self, value : i32) ->  Option<CloudFilesError> 

Possible Values

0   // Automatic
1   // Platform
2   // Internal

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 struct 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:

In most cases using the default value (Automatic) is recommended. The struct will select a provider depending on the current platform.

When Automatic is selected, on Windows, the struct will use the platform implementation. On Linux/macOS, the struct will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

Data Type

i32

ssl_server_cert_effective_date property (HadoopDFS Struct)

The date on which this certificate becomes valid.

Syntax

fn ssl_server_cert_effective_date(&self ) -> Result<String, CloudFilesError> 

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

ssl_server_cert_expiration_date property (HadoopDFS Struct)

The date on which the certificate expires.

Syntax

fn ssl_server_cert_expiration_date(&self ) -> Result<String, CloudFilesError> 

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

ssl_server_cert_extended_key_usage property (HadoopDFS Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn ssl_server_cert_extended_key_usage(&self ) -> Result<String, CloudFilesError> 

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

ssl_server_cert_fingerprint property (HadoopDFS Struct)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fn ssl_server_cert_fingerprint(&self ) -> Result<String, CloudFilesError> 

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

ssl_server_cert_fingerprint_sha1 property (HadoopDFS Struct)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fn ssl_server_cert_fingerprint_sha1(&self ) -> Result<String, CloudFilesError> 

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

ssl_server_cert_fingerprint_sha256 property (HadoopDFS Struct)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fn ssl_server_cert_fingerprint_sha256(&self ) -> Result<String, CloudFilesError> 

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

ssl_server_cert_issuer property (HadoopDFS Struct)

The issuer of the certificate.

Syntax

fn ssl_server_cert_issuer(&self ) -> Result<String, CloudFilesError> 

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

ssl_server_cert_private_key property (HadoopDFS Struct)

The private key of the certificate (if available).

Syntax

fn ssl_server_cert_private_key(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The ssl_server_cert_private_key may be available but not exportable. In this case, ssl_server_cert_private_key returns an empty string.

This property is read-only.

Data Type

String

ssl_server_cert_private_key_available property (HadoopDFS Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn ssl_server_cert_private_key_available(&self ) -> Result<bool, CloudFilesError> 

Default Value

false

Remarks

Whether a ssl_server_cert_private_key is available for the selected certificate. If ssl_server_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

ssl_server_cert_private_key_container property (HadoopDFS Struct)

The name of the PrivateKey container for the certificate (if available).

Syntax

fn ssl_server_cert_private_key_container(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The name of the ssl_server_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

ssl_server_cert_public_key property (HadoopDFS Struct)

The public key of the certificate.

Syntax

fn ssl_server_cert_public_key(&self ) -> Result<String, CloudFilesError> 

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

ssl_server_cert_public_key_algorithm property (HadoopDFS Struct)

The textual description of the certificate's public key algorithm.

Syntax

fn ssl_server_cert_public_key_algorithm(&self ) -> Result<String, CloudFilesError> 

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

ssl_server_cert_public_key_length property (HadoopDFS Struct)

The length of the certificate's public key (in bits).

Syntax

fn ssl_server_cert_public_key_length(&self ) -> Result<i32, CloudFilesError> 

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

i32

ssl_server_cert_serial_number property (HadoopDFS Struct)

The serial number of the certificate encoded as a string.

Syntax

fn ssl_server_cert_serial_number(&self ) -> Result<String, CloudFilesError> 

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

ssl_server_cert_signature_algorithm property (HadoopDFS Struct)

The text description of the certificate's signature algorithm.

Syntax

fn ssl_server_cert_signature_algorithm(&self ) -> Result<String, CloudFilesError> 

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

ssl_server_cert_store property (HadoopDFS Struct)

The name of the certificate store for the client certificate.

Syntax

fn ssl_server_cert_store(&self ) -> Result<Vec<u8>, CloudFilesError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_server_cert_store_type property denotes the type of the certificate store specified by ssl_server_cert_store. If the store is password-protected, specify the password in ssl_server_cert_store_password.

ssl_server_cert_store is used in conjunction with the ssl_server_cert_subject property to specify client certificates. If ssl_server_cert_store has a value, and ssl_server_cert_subject or ssl_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_server_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

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

This property is read-only.

Data Type

Vec

ssl_server_cert_store_password property (HadoopDFS Struct)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

fn ssl_server_cert_store_password(&self ) -> Result<String, CloudFilesError> 

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

ssl_server_cert_store_type property (HadoopDFS Struct)

The type of certificate store for this certificate.

Syntax

fn ssl_server_cert_store_type(&self ) -> Result<i32, CloudFilesError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

This property is read-only.

Data Type

i32

ssl_server_cert_subject_alt_names property (HadoopDFS Struct)

Comma-separated lists of alternative subject names for the certificate.

Syntax

fn ssl_server_cert_subject_alt_names(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

ssl_server_cert_thumbprint_md5 property (HadoopDFS Struct)

The MD5 hash of the certificate.

Syntax

fn ssl_server_cert_thumbprint_md5(&self ) -> Result<String, CloudFilesError> 

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

ssl_server_cert_thumbprint_sha1 property (HadoopDFS Struct)

The SHA-1 hash of the certificate.

Syntax

fn ssl_server_cert_thumbprint_sha1(&self ) -> Result<String, CloudFilesError> 

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

ssl_server_cert_thumbprint_sha256 property (HadoopDFS Struct)

The SHA-256 hash of the certificate.

Syntax

fn ssl_server_cert_thumbprint_sha256(&self ) -> Result<String, CloudFilesError> 

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

ssl_server_cert_usage property (HadoopDFS Struct)

The text description of UsageFlags .

Syntax

fn ssl_server_cert_usage(&self ) -> Result<String, CloudFilesError> 

Default Value

""

Remarks

The text description of ssl_server_cert_usage_flags.

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

ssl_server_cert_usage_flags property (HadoopDFS Struct)

The flags that show intended use for the certificate.

Syntax

fn ssl_server_cert_usage_flags(&self ) -> Result<i32, CloudFilesError> 

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_server_cert_usage_flags is a combination of the following flags:

Please see the ssl_server_cert_usage property for a text representation of ssl_server_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

i32

ssl_server_cert_version property (HadoopDFS Struct)

The certificate's version number.

Syntax

fn ssl_server_cert_version(&self ) -> Result<String, CloudFilesError> 

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

ssl_server_cert_subject property (HadoopDFS Struct)

The subject of the certificate used for client authentication.

Syntax

fn ssl_server_cert_subject(&self ) -> Result<String, CloudFilesError> 

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=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

This property is read-only.

Data Type

String

ssl_server_cert_encoded property (HadoopDFS Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn ssl_server_cert_encoded(&self ) -> Result<Vec<u8>, CloudFilesError> 

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_server_cert_store and ssl_server_cert_subject properties also may be used to specify a certificate.

When ssl_server_cert_encoded is set, a search is initiated in the current ssl_server_cert_store for the private key of the certificate. If the key is found, ssl_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_server_cert_subject is set to an empty string.

This property is read-only.

Data Type

Vec

start_byte property (HadoopDFS Struct)

The byte offset from which to start downloading a file.

Syntax

fn start_byte(&self ) -> Result<i64, CloudFilesError> 
fn set_start_byte(&self, value : i64) ->  Option<CloudFilesError> 

Default Value

0

Remarks

This property specifies an offset (in bytes) from which to start reading a file when download_file is called. It can be used in tandem with read_bytes to specify a specific range of the file to download.

Data Type

i64

timeout property (HadoopDFS Struct)

The timeout for the struct.

Syntax

fn timeout(&self ) -> Result<i32, CloudFilesError> 
fn set_timeout(&self, value : i32) ->  Option<CloudFilesError> 

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 struct will wait for the operation to complete before returning control.

The struct will use do_events 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 struct 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

i32

url property (HadoopDFS Struct)

The URL of the Hadoop WebHDFS server.

Syntax

fn url(&self ) -> Result<String, CloudFilesError> 
fn set_url(&self, value : &str) ->  Option<CloudFilesError> 
fn set_url_ref(&self, value : &String) ->  Option<CloudFilesError> 

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 struct will automatically append /webhdfs/v1 to its value (if necessary).

The struct automatically detects whether to secure the connection using SSL/TLS based on whether the url begins with http (not secured) or https (secured).

Data Type

String

user property (HadoopDFS Struct)

The user name to use for authentication.

Syntax

fn user(&self ) -> Result<String, CloudFilesError> 
fn set_user(&self, value : &str) ->  Option<CloudFilesError> 
fn set_user_ref(&self, value : &String) ->  Option<CloudFilesError> 

Default Value

""

Remarks

This property specifies the user name to use for authentication.

Refer to auth_mechanism for more information.

Data Type

String

add_query_param method (HadoopDFS Struct)

Adds a query parameter to the QueryParams properties.

Syntax

fn add_query_param(&self, name : &str, value : &str) -> Result<(), CloudFilesError>

Remarks

This method is used to add a query parameter to the query_params 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 struct automatically. Consult the service documentation for details on the available parameters.

append_file method (HadoopDFS Struct)

Appends data to an existing file.

Syntax

fn append_file(&self, file_path : &str) -> Result<(), CloudFilesError>

Remarks

This method appends data to the existing file at FilePath.

If local_file is set data will be read from the file at the specified path. If local_file is not set the data in resource_data will be used.

calc_authorization method (HadoopDFS Struct)

Calculates the Authorization header based on provided credentials.

Syntax

fn calc_authorization(&self) -> Result<(), CloudFilesError>

Remarks

This method calculates the authorization value using the values provided in auth_scheme, user and password.

In most cases this method does not need to be called. The struct 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 Struct)

Sets or retrieves a configuration setting.

Syntax

fn config(&self, configuration_string : &str) ->  Result<String, CloudFilesError>

Remarks

config is a generic method available in every struct. It is used to set and retrieve configuration settings for the struct.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, 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.

delete_resource method (HadoopDFS Struct)

Deletes a resource.

Syntax

fn delete_resource(&self, path : &str) -> Result<(), CloudFilesError>

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

do_custom_op method (HadoopDFS Struct)

Executes an arbitrary WebHDFS operation.

Syntax

fn do_custom_op(&self, http_method : &str, request_path : &str, op : &str) -> Result<(), CloudFilesError>

Remarks

This method can be used to execute any WebHDFS operation the struct 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 struct will do the following:

1. Build a request URL using url, RequestPath, Op, and the query parameters held by the query_params properties.
2. Send the request using the given HttpMethod, the request URL built in step 1, the headers held by other_headers, and the currently-configured authentication (if any; refer to auth_mechanism for more information). The request is always sent with an empty body.
3. Store the response headers in the parsed_headers properties, and the response body in the specified local_file, or resource_data (using the same logic as download_file).

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.

download_file method (HadoopDFS Struct)

Downloads a file.

Syntax

fn download_file(&self, file_path : &str) -> Result<(), CloudFilesError>

Remarks

This method downloads the file at FilePath.

If local_file is set, the file will be saved to the specified location; otherwise, the file data will be held by resource_data.

To download and decrypt an encrypted file, set encryption_algorithm and encryption_password 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 struct also supports resuming failed downloads by using the start_byte property. If a download is interrupted, set start_byte 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 local_file was set in the initial download attempt.

If local_file is set when beginning an encrypted download, the struct 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 start_byte, to allow the remainder of the encrypted data to be downloaded. Once the encrypted data is downloaded it will be decrypted and written to local_file. 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);

get_dir_summary method (HadoopDFS Struct)

Gets a content summary for a directory.

Syntax

fn get_dir_summary(&self, dir_path : &str) -> Result<(), CloudFilesError>

Remarks

This method gets a content summary for the directory at DirPath, populating the dir_summary object property's properties.

DirPath may be empty to get a content summary for the root directory (/).

get_resource_info method (HadoopDFS Struct)

Gets information about a specific resource.

Syntax

fn get_resource_info(&self, path : &str) -> Result<(), CloudFilesError>

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 on_resource_list event, and will populate the resources properties with a single item (clearing any previously-held items in the process).

interrupt method (HadoopDFS Struct)

This method interrupts the current method.

Syntax

fn interrupt(&self) -> Result<(), CloudFilesError>

Remarks

If there is no method in progress, interrupt simply returns, doing nothing.

join_file_blocks method (HadoopDFS Struct)

Joins multiple files' blocks together into one file.

Syntax

fn join_file_blocks(&self, target_file_path : &str, source_file_paths : &str) -> Result<(), CloudFilesError>

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 struct will take care of verifying that all parameters are non-empty and that all paths begin with a forward slash (/).

list_resources method (HadoopDFS Struct)

Lists resources in a given directory.

Syntax

fn list_resources(&self, dir_path : &str) -> Result<(), CloudFilesError>

Remarks

This method lists resources within the directory at DirPath.

Calling this method will fire the on_resource_list 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. }

make_directory method (HadoopDFS Struct)

Makes a directory.

Syntax

fn make_directory(&self, new_dir_path : &str) ->  Result<String, CloudFilesError>

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.

move_resource method (HadoopDFS Struct)

Moves a resource.

Syntax

fn move_resource(&self, from_path : &str, to_path : &str) -> Result<(), CloudFilesError>

Remarks

This method moves the resource at FromPath to ToPath.

reset method (HadoopDFS Struct)

Resets the struct to its initial state.

Syntax

fn reset(&self) -> Result<(), CloudFilesError>

Remarks

This method resets the struct to its initial state.

set_file_replication method (HadoopDFS Struct)

Sets the replication factor for a file.

Syntax

fn set_file_replication(&self, file_path : &str, replication : i32) -> Result<(), CloudFilesError>

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.

set_owner method (HadoopDFS Struct)

Sets a resource's owner and/or group.

Syntax

fn set_owner(&self, path : &str, owner : &str, group : &str) -> Result<(), CloudFilesError>

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

set_permission method (HadoopDFS Struct)

Assigns the given permission to a resource.

Syntax

fn set_permission(&self, path : &str, permission : &str) -> Result<(), CloudFilesError>

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

set_times method (HadoopDFS Struct)

Sets a resource's modification and/or access times.

Syntax

fn set_times(&self, path : &str, modified_time : i64, access_time : i64) -> Result<(), CloudFilesError>

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

truncate_file method (HadoopDFS Struct)

Truncates a file to a given size.

Syntax

fn truncate_file(&self, file_path : &str, new_size : i64) ->  Result<bool, CloudFilesError>

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 true if the file has been truncated successfully and is immediately ready for further modifications.

This method returns false 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 get_resource_info to determine when the truncation process has finished.

upload_file method (HadoopDFS Struct)

Uploads a file.

Syntax

fn upload_file(&self, new_file_path : &str) ->  Result<String, CloudFilesError>

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 local_file is set the file will be uploaded from the specified path. If local_file is not set the data in resource_data will be used.

To encrypt the file before uploading it, set encryption_algorithm and encryption_password. hdfs.LocalFile = "../MyFile.zip"; hdfs.UploadFile("/MyFile.zip");

on_end_transfer event (HadoopDFS Struct)

This event fires when a document finishes transferring.

Syntax

// HadoopDFSEndTransferEventArgs carries the HadoopDFS EndTransfer event's parameters.
pub struct HadoopDFSEndTransferEventArgs {
  fn direction(&self) -> i32
}

// HadoopDFSEndTransferEvent defines the signature of the HadoopDFS EndTransfer event's handler function.
pub trait HadoopDFSEndTransferEvent {
  fn on_end_transfer(&self, sender : HadoopDFS, e : &mut HadoopDFSEndTransferEventArgs);
}

impl <'a> HadoopDFS<'a> {
  pub fn on_end_transfer(&self) -> &'a dyn HadoopDFSEndTransferEvent;
  pub fn set_on_end_transfer(&mut self, value : &'a dyn HadoopDFSEndTransferEvent);
  ...
}

Remarks

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

on_error event (HadoopDFS Struct)

Fired when information is available about errors during data delivery.

Syntax

// HadoopDFSErrorEventArgs carries the HadoopDFS Error event's parameters.
pub struct HadoopDFSErrorEventArgs {
  fn error_code(&self) -> i32
  fn description(&self) -> &String
}

// HadoopDFSErrorEvent defines the signature of the HadoopDFS Error event's handler function.
pub trait HadoopDFSErrorEvent {
  fn on_error(&self, sender : HadoopDFS, e : &mut HadoopDFSErrorEventArgs);
}

impl <'a> HadoopDFS<'a> {
  pub fn on_error(&self) -> &'a dyn HadoopDFSErrorEvent;
  pub fn set_on_error(&mut self, value : &'a dyn HadoopDFSErrorEvent);
  ...
}

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the struct 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.

on_header event (HadoopDFS Struct)

Fired every time a header line comes in.

Syntax

// HadoopDFSHeaderEventArgs carries the HadoopDFS Header event's parameters.
pub struct HadoopDFSHeaderEventArgs {
  fn field(&self) -> &String
  fn value(&self) -> &String
}

// HadoopDFSHeaderEvent defines the signature of the HadoopDFS Header event's handler function.
pub trait HadoopDFSHeaderEvent {
  fn on_header(&self, sender : HadoopDFS, e : &mut HadoopDFSHeaderEventArgs);
}

impl <'a> HadoopDFS<'a> {
  pub fn on_header(&self) -> &'a dyn HadoopDFSHeaderEvent;
  pub fn set_on_header(&mut self, value : &'a dyn HadoopDFSHeaderEvent);
  ...
}

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

on_log event (HadoopDFS Struct)

Fired once for each log message.

Syntax

// HadoopDFSLogEventArgs carries the HadoopDFS Log event's parameters.
pub struct HadoopDFSLogEventArgs {
  fn log_level(&self) -> i32
  fn message(&self) -> &String
  fn log_type(&self) -> &String
}

// HadoopDFSLogEvent defines the signature of the HadoopDFS Log event's handler function.
pub trait HadoopDFSLogEvent {
  fn on_log(&self, sender : HadoopDFS, e : &mut HadoopDFSLogEventArgs);
}

impl <'a> HadoopDFS<'a> {
  pub fn on_log(&self) -> &'a dyn HadoopDFSLogEvent;
  pub fn set_on_log(&mut self, value : &'a dyn HadoopDFSLogEvent);
  ...
}

Remarks

This event is fired once for each log message generated by the struct. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

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"

on_progress event (HadoopDFS Struct)

Fires during an upload or download to indicate transfer progress.

Syntax

// HadoopDFSProgressEventArgs carries the HadoopDFS Progress event's parameters.
pub struct HadoopDFSProgressEventArgs {
  fn direction(&self) -> i32
  fn bytes_transferred(&self) -> i64
  fn total_bytes(&self) -> i64
  fn percent_done(&self) -> i32
}

// HadoopDFSProgressEvent defines the signature of the HadoopDFS Progress event's handler function.
pub trait HadoopDFSProgressEvent {
  fn on_progress(&self, sender : HadoopDFS, e : &mut HadoopDFSProgressEventArgs);
}

impl <'a> HadoopDFS<'a> {
  pub fn on_progress(&self) -> &'a dyn HadoopDFSProgressEvent;
  pub fn set_on_progress(&mut self, value : &'a dyn HadoopDFSProgressEvent);
  ...
}

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

on_resource_list event (HadoopDFS Struct)

Fires once for each resource returned when listing resources.

Syntax

// HadoopDFSResourceListEventArgs carries the HadoopDFS ResourceList event's parameters.
pub struct HadoopDFSResourceListEventArgs {
  fn name(&self) -> &String
  fn path(&self) -> &String
  fn resource_type(&self) -> i32
  fn modified_time(&self) -> i64
  fn access_time(&self) -> i64
  fn size(&self) -> i64
  fn permission(&self) -> &String
  fn owner(&self) -> &String
  fn group(&self) -> &String
  fn replication(&self) -> i32
}

// HadoopDFSResourceListEvent defines the signature of the HadoopDFS ResourceList event's handler function.
pub trait HadoopDFSResourceListEvent {
  fn on_resource_list(&self, sender : HadoopDFS, e : &mut HadoopDFSResourceListEventArgs);
}

impl <'a> HadoopDFS<'a> {
  pub fn on_resource_list(&self) -> &'a dyn HadoopDFSResourceListEvent;
  pub fn set_on_resource_list(&mut self, value : &'a dyn HadoopDFSResourceListEvent);
  ...
}

Remarks

This event fires once for each resource returned when list_resources or get_resource_info 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:

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.

on_ssl_server_authentication event (HadoopDFS Struct)

Fired after the server presents its certificate to the client.

Syntax

// HadoopDFSSSLServerAuthenticationEventArgs carries the HadoopDFS SSLServerAuthentication event's parameters.
pub struct HadoopDFSSSLServerAuthenticationEventArgs {
  fn cert_encoded(&self) -> &[u8]
  fn cert_subject(&self) -> &String
  fn cert_issuer(&self) -> &String
  fn status(&self) -> &String
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// HadoopDFSSSLServerAuthenticationEvent defines the signature of the HadoopDFS SSLServerAuthentication event's handler function.
pub trait HadoopDFSSSLServerAuthenticationEvent {
  fn on_ssl_server_authentication(&self, sender : HadoopDFS, e : &mut HadoopDFSSSLServerAuthenticationEventArgs);
}

impl <'a> HadoopDFS<'a> {
  pub fn on_ssl_server_authentication(&self) -> &'a dyn HadoopDFSSSLServerAuthenticationEvent;
  pub fn set_on_ssl_server_authentication(&mut self, value : &'a dyn HadoopDFSSSLServerAuthenticationEvent);
  ...
}

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.

on_ssl_status event (HadoopDFS Struct)

Fired when secure connection progress messages are available.

Syntax

// HadoopDFSSSLStatusEventArgs carries the HadoopDFS SSLStatus event's parameters.
pub struct HadoopDFSSSLStatusEventArgs {
  fn message(&self) -> &String
}

// HadoopDFSSSLStatusEvent defines the signature of the HadoopDFS SSLStatus event's handler function.
pub trait HadoopDFSSSLStatusEvent {
  fn on_ssl_status(&self, sender : HadoopDFS, e : &mut HadoopDFSSSLStatusEventArgs);
}

impl <'a> HadoopDFS<'a> {
  pub fn on_ssl_status(&self) -> &'a dyn HadoopDFSSSLStatusEvent;
  pub fn set_on_ssl_status(&mut self, value : &'a dyn HadoopDFSSSLStatusEvent);
  ...
}

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

on_start_transfer event (HadoopDFS Struct)

This event fires when a document starts transferring (after the headers).

Syntax

// HadoopDFSStartTransferEventArgs carries the HadoopDFS StartTransfer event's parameters.
pub struct HadoopDFSStartTransferEventArgs {
  fn direction(&self) -> i32
}

// HadoopDFSStartTransferEvent defines the signature of the HadoopDFS StartTransfer event's handler function.
pub trait HadoopDFSStartTransferEvent {
  fn on_start_transfer(&self, sender : HadoopDFS, e : &mut HadoopDFSStartTransferEventArgs);
}

impl <'a> HadoopDFS<'a> {
  pub fn on_start_transfer(&self) -> &'a dyn HadoopDFSStartTransferEvent;
  pub fn set_on_start_transfer(&mut self, value : &'a dyn HadoopDFSStartTransferEvent);
  ...
}

Remarks

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

on_transfer event (HadoopDFS Struct)

Fired while a document transfers (delivers document).

Syntax

// HadoopDFSTransferEventArgs carries the HadoopDFS Transfer event's parameters.
pub struct HadoopDFSTransferEventArgs {
  fn direction(&self) -> i32
  fn bytes_transferred(&self) -> i64
  fn percent_done(&self) -> i32
  fn text(&self) -> &[u8]
}

// HadoopDFSTransferEvent defines the signature of the HadoopDFS Transfer event's handler function.
pub trait HadoopDFSTransferEvent {
  fn on_transfer(&self, sender : HadoopDFS, e : &mut HadoopDFSTransferEventArgs);
}

impl <'a> HadoopDFS<'a> {
  pub fn on_transfer(&self) -> &'a dyn HadoopDFSTransferEvent;
  pub fn set_on_transfer(&mut self, value : &'a dyn HadoopDFSTransferEvent);
  ...
}

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 Struct)

HadoopDFS Config Settings

<firstlevel>
  <one>value</one>
  <two>
    <item>first</item>
    <item>second</item>
  </two>
  <three>value three</three>
</firstlevel>

{
  "firstlevel": {
    "one": "value",
    "two": ["first", "second"],
    "three": "value three"
  }
}

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

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

Socket Config Settings

Base Config Settings

Trappable Errors (HadoopDFS Struct)

Common Errors

The class may also return one of the following error codes, which are inherited from other classes.

HTTP Errors

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

SSL Errors

TCP/IP Errors