Struct ipworksedi::RNIFSender

Properties   Methods   Events   Config Settings   Errors  

The RNIFSender struct implements a RosettaNet Implementation Framework (RNIF) client.

Syntax

ipworksedi::RNIFSender

Remarks

The RNIFSender component may be used to send RosettaNet Implementation Framework (RNIF) messages over the TLS/SSL-secured HTTPS transport protocol. RosettaNet is used in a variety of industries including Semiconductor Manufacturing, Electronic Components, Telecommunications, Logistics, the Chemical Industry (through CIDX), and more.

A typical RosettaNet transaction is as follows:

1. The RNIF client creates a RosettaNet message and uploads it to the receiver over HTTPS. The contents and structures of these messages are defined by the RosettaNet community in the form of standardized Partner Interface Processes (PIPs). Due to the sensitive nature of most business documents, such messages will usually be encrypted and wrapped in an S/MIME entity along with a digital signature.
2. Upon receipt of the message, the receiver will verify the transport headers, then will attempt to decrypt the message and verify the digital signature.
3. Once these steps have been completed, the receiving application can process the PIP instance, and either send an acknowledgement of receipt or a reply in the form of another RosettaNet message back to the sender, depending upon the requirements of the particular PIP.

When sending a RosettaNet message, the client, at minimum, must specify the standard_name and standard_version of the message being sent in the preamble header. In the delivery header, the client must specify the secure_transport_required, message_date_time, message_receiver_id, message_sender_id, and message_tracking_id properties. For the service header, all properties that are relevant to the action, reply, or signal must be specified. The client, after setting all appropriate header properties, must then set the content of the RosettaNet message body by setting the service_content property.

Attachments may be added to the RosettaNet message. Attachments are arbitrary files allowed by specific PIPs, and may be simple text documents or pictures of products. Attachments are added to the RosettaNet message by adding instances of RNIFAttachment to the attachments collection.

To secure the RosettaNet message, the message may be signed and/or encrypted by setting the appropriate certificates. By default, the component will apply the highest level of message security if the appropriate certificates are specified. To sign the data, set certificate. To encrypt, set recipient_cert. To change which parts of the message, if any, are to be encrypted, set the encryption_type property.

The final property to be set is the url to which the client is posting the request. Once this is done, a call to the post method causes the struct to generate, sign, and encrypt the RosettaNet business document and upload it to the server.

NOTE: when the Post method is called, the struct will perform a minimal set of checks on the various RosettaNet message headers to ensure that an invalid business message is not sent. If any values in the header are missing or are in conflict, the message cannot be processed by the receiving entity. To avoid a round trip, the struct fails with an error with a description of which header field is in error.

The response, may be sent synchronously or asynchronously, whether it is a complete business reply or a simple receipt acknowledgement. To change whether a synchronous or asynchronous response is desired, set the response_type before calling post. If a synchronous response is received after the HTTPS post, reply_headers and reply_data will be populated appropriately.

Object Lifetime

The new() method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by IPWorksEDI. Due to this, the RNIFSender struct cannot be disposed of automatically. Please, call the dispose(&self) method of RNIFSender 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.

action_code property (RNIFSender Struct)

The code for this action.

Syntax

fn action_code(&self) -> Result<String, IPWorksEDIError> 
fn set_action_code(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_action_code_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

This property is a string which denotes the type of action for the current RosettaNet message, if it is an action. If it is a reply, then the ActionCode describes the type of action that the message is in reply to. An example is a "Purchase Order Request Action."

This property is a field of the service header.

Data Type

String

action_message property (RNIFSender Struct)

Whether or not this message is an action message.

Syntax

fn action_message(&self) -> Result<bool, IPWorksEDIError> 
fn set_action_message(&self, value : bool) ->  Option<IPWorksEDIError> 

Default Value

false

Remarks

This property indicates whether or not the message is an action message. A RosettaNet action is defined as a message which requires or requests a business activity. A "PurchaseOrderRequestMessage" is a valid Business Action message, as is the corresponding "PurchaseOrderConfirmMessage". The latter, however, is also a reply to the original action request.

Receipt acknowledgments are considered Signals, and not Business Action messages, even though they contain all of the properties of a valid Business Action message.

This property is a field of the service header.

Data Type

bool

action_message_standard_name property (RNIFSender Struct)

The name of the standard used to create this action.

Syntax

fn action_message_standard_name(&self) -> Result<String, IPWorksEDIError> 
fn set_action_message_standard_name(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_action_message_standard_name_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

While the RosettaNet community has a set of widely adopted, pre-defined and standardized message templates, it also allows for business partners to agree on specification geared more toward their particular needs. If a special, non-RosettaNet standard is to be used to create the action message, the name of the standard must be reported in action_message_standard_name and the version in action_message_standard_version. This way, the receiving entity can know how to process and interpret the incoming business message.

Since replies may sent in response to a message created using such a specialized standard, the standard used to create the original message should be referenced using the original_message_standard_name and original_message_standard_version when creating or processing replies.

This property is a field of the service header.

Data Type

String

action_message_standard_version property (RNIFSender Struct)

The version of the standard used to create this action.

Syntax

fn action_message_standard_version(&self) -> Result<String, IPWorksEDIError> 
fn set_action_message_standard_version(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_action_message_standard_version_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

While the RosettaNet community has a set of widely adopted, pre-defined and standardized message templates, it also allows for business partners to agree on specification geared more toward their particular needs. If a special, non-RosettaNet standard is to be used to create the action message, the name of the standard must be reported in action_message_standard_name and the version in action_message_standard_version. This way, the receiving entity can know how to process and interpret the incoming business message.

Since replies may sent in response to a message created using such a specialized standard, the standard used to create the original message should be referenced using the original_message_standard_name and original_message_standard_version when creating or processing replies.

This property is a field of the service header.

Data Type

String

attachment_count property (RNIFSender Struct)

The number of records in the Attachment arrays.

Syntax

fn attachment_count(&self) -> Result<i32, IPWorksEDIError> 
fn set_attachment_count(&self, value : i32) ->  Option<IPWorksEDIError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• attachment_data
• attachment_description
• attachment_file_name
• attachment_id
• attachment_mime_type

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

Data Type

i32

attachment_data property (RNIFSender Struct)

Data contains the raw data of the current attachment.

Syntax

fn attachment_data(&self, AttachmentIndex : i32) -> Result<Vec<u8>, IPWorksEDIError> 
fn set_attachment_data(&self, AttachmentIndex : i32, value : Vec<u8>) ->  Option<IPWorksEDIError> 
fn set_attachment_data_ref(&self, AttachmentIndex : i32, value : &[u8]) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

attachment_data contains the raw data of the current attachment. If attachment_data is set, the value in attachment_file_name will be used to specify the name of the attachment when generating messages to be sent. When receiving, polling This property will cause the attachment to be parsed out of the transmitted MIME entity to memory rather than being parsed to a file.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the attachment_count property.

Data Type

Vec<u8>

attachment_description property (RNIFSender Struct)

Description contains descriptions for this attachment.

Syntax

fn attachment_description(&self, AttachmentIndex : i32) -> Result<String, IPWorksEDIError> 
fn set_attachment_description(&self, AttachmentIndex : i32, value : &str) ->  Option<IPWorksEDIError> 
fn set_attachment_description_ref(&self, AttachmentIndex : i32, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

attachment_description contains descriptions for this attachment. These descriptions are human-readable strings and may set to any arbitrary value. These descriptions should play no role in how the message is processed or interpreted.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the attachment_count property.

Data Type

String

attachment_file_name property (RNIFSender Struct)

FileName is the name of the file containing the decoded data of the current attachment.

Syntax

fn attachment_file_name(&self, AttachmentIndex : i32) -> Result<String, IPWorksEDIError> 
fn set_attachment_file_name(&self, AttachmentIndex : i32, value : &str) ->  Option<IPWorksEDIError> 
fn set_attachment_file_name_ref(&self, AttachmentIndex : i32, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

attachment_file_name is the name of the file containing the decoded data of the current attachment. When sending messages, this value tells the struct where to find the file and is used in accordance with MIME encoding rules to indicate the filename to be used by the receiving RNIF entity when parsing the attachments.

When receiving, polling This property will cause the attachment to be parsed out of the transmitted MIME entity to the filename indicated by the MIME encoding rules. When the property returns, the file will be written to the path indicated.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the attachment_count property.

Data Type

String

attachment_id property (RNIFSender Struct)

Id is a unique content-identifier used within the RosettaNet message to internally reference the attachments.

Syntax

fn attachment_id(&self, AttachmentIndex : i32) -> Result<String, IPWorksEDIError> 
fn set_attachment_id(&self, AttachmentIndex : i32, value : &str) ->  Option<IPWorksEDIError> 
fn set_attachment_id_ref(&self, AttachmentIndex : i32, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

attachment_id is a unique content-identifier used within the RosettaNet message to internally reference the attachments. Because these identifiers are used to reference the attachments, each attachment must have a unique identifier, but they only need to be unique within the scope of the current message. These values may take the form of a URI.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the attachment_count property.

Data Type

String

attachment_mime_type property (RNIFSender Struct)

MimeType is a value indicating how the rnifattachment should be interpreted.

Syntax

fn attachment_mime_type(&self, AttachmentIndex : i32) -> Result<String, IPWorksEDIError> 
fn set_attachment_mime_type(&self, AttachmentIndex : i32, value : &str) ->  Option<IPWorksEDIError> 
fn set_attachment_mime_type_ref(&self, AttachmentIndex : i32, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

attachment_mime_type is a value indicating how the RNIFAttachment should be interpreted. Valid MIME types include, but are not limited to, the following:

• "plain/html"
• "plain/text"
• "image/jpg"
• "image/gif"
• "image/bmp"
• "application/stream"

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the attachment_count property.

Data Type

String

business_activity property (RNIFSender Struct)

This property denotes the type of business activity.

Syntax

fn business_activity(&self) -> Result<String, IPWorksEDIError> 
fn set_business_activity(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_business_activity_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

This property simply tells the receiver what type of business activity the RosettaNet document that is sent refers to. An example is: "Create Purchase Order".

Data Type

String

cert_effective_date property (RNIFSender Struct)

The date on which this certificate becomes valid.

Syntax

fn cert_effective_date(&self) -> Result<String, IPWorksEDIError> 

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

cert_expiration_date property (RNIFSender Struct)

The date on which the certificate expires.

Syntax

fn cert_expiration_date(&self) -> Result<String, IPWorksEDIError> 

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

cert_extended_key_usage property (RNIFSender Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn cert_extended_key_usage(&self) -> Result<String, IPWorksEDIError> 

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

cert_fingerprint property (RNIFSender Struct)

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

Syntax

fn cert_fingerprint(&self) -> Result<String, IPWorksEDIError> 

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

cert_fingerprint_sha1 property (RNIFSender Struct)

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

Syntax

fn cert_fingerprint_sha1(&self) -> Result<String, IPWorksEDIError> 

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

cert_fingerprint_sha256 property (RNIFSender Struct)

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

Syntax

fn cert_fingerprint_sha256(&self) -> Result<String, IPWorksEDIError> 

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

cert_issuer property (RNIFSender Struct)

The issuer of the certificate.

Syntax

fn cert_issuer(&self) -> Result<String, IPWorksEDIError> 

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

cert_private_key property (RNIFSender Struct)

The private key of the certificate (if available).

Syntax

fn cert_private_key(&self) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

cert_private_key_available property (RNIFSender Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn cert_private_key_available(&self) -> Result<bool, IPWorksEDIError> 

Default Value

false

Remarks

Whether a cert_private_key is available for the selected certificate. If 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

cert_private_key_container property (RNIFSender Struct)

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

Syntax

fn cert_private_key_container(&self) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

The name of the 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

cert_public_key property (RNIFSender Struct)

The public key of the certificate.

Syntax

fn cert_public_key(&self) -> Result<String, IPWorksEDIError> 

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

cert_public_key_algorithm property (RNIFSender Struct)

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

Syntax

fn cert_public_key_algorithm(&self) -> Result<String, IPWorksEDIError> 

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

cert_public_key_length property (RNIFSender Struct)

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

Syntax

fn cert_public_key_length(&self) -> Result<i32, IPWorksEDIError> 

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

cert_serial_number property (RNIFSender Struct)

The serial number of the certificate encoded as a string.

Syntax

fn cert_serial_number(&self) -> Result<String, IPWorksEDIError> 

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

cert_signature_algorithm property (RNIFSender Struct)

The text description of the certificate's signature algorithm.

Syntax

fn cert_signature_algorithm(&self) -> Result<String, IPWorksEDIError> 

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

cert_store property (RNIFSender Struct)

The name of the certificate store for the client certificate.

Syntax

fn cert_store(&self) -> Result<Vec<u8>, IPWorksEDIError> 
fn set_cert_store(&self, value : Vec<u8>) ->  Option<IPWorksEDIError> 
fn set_cert_store_ref(&self, value : &[u8]) ->  Option<IPWorksEDIError> 

Default Value

"MY"

Remarks

The cert_store_type property denotes the type of the certificate store specified by cert_store. If the store is password-protected, specify the password in cert_store_password.

cert_store is used in conjunction with the cert_subject property to specify client certificates. If cert_store has a value, and cert_subject or cert_encoded is set, a search for a certificate is initiated. Please see the 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<u8>

cert_store_password property (RNIFSender 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 cert_store_password(&self) -> Result<String, IPWorksEDIError> 
fn set_cert_store_password(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_cert_store_password_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

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

cert_store_type property (RNIFSender Struct)

The type of certificate store for this certificate.

Syntax

fn cert_store_type(&self) -> Result<i32, IPWorksEDIError> 
fn set_cert_store_type(&self, value : i32) ->  Option<IPWorksEDIError> 

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

cert_subject_alt_names property (RNIFSender Struct)

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

Syntax

fn cert_subject_alt_names(&self) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

cert_thumbprint_md5 property (RNIFSender Struct)

The MD5 hash of the certificate.

Syntax

fn cert_thumbprint_md5(&self) -> Result<String, IPWorksEDIError> 

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

cert_thumbprint_sha1 property (RNIFSender Struct)

The SHA-1 hash of the certificate.

Syntax

fn cert_thumbprint_sha1(&self) -> Result<String, IPWorksEDIError> 

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

cert_thumbprint_sha256 property (RNIFSender Struct)

The SHA-256 hash of the certificate.

Syntax

fn cert_thumbprint_sha256(&self) -> Result<String, IPWorksEDIError> 

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

cert_usage property (RNIFSender Struct)

The text description of UsageFlags .

Syntax

fn cert_usage(&self) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

cert_usage_flags property (RNIFSender Struct)

The flags that show intended use for the certificate.

Syntax

fn cert_usage_flags(&self) -> Result<i32, IPWorksEDIError> 

Default Value

0

Remarks

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

Please see the cert_usage property for a text representation of cert_usage_flags.

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

This property is read-only.

Data Type

i32

cert_version property (RNIFSender Struct)

The certificate's version number.

Syntax

fn cert_version(&self) -> Result<String, IPWorksEDIError> 

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

cert_subject property (RNIFSender Struct)

The subject of the certificate used for client authentication.

Syntax

fn cert_subject(&self) -> Result<String, IPWorksEDIError> 
fn set_cert_subject(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_cert_subject_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

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

cert_encoded property (RNIFSender Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn cert_encoded(&self) -> Result<Vec<u8>, IPWorksEDIError> 
fn set_cert_encoded(&self, value : Vec<u8>) ->  Option<IPWorksEDIError> 
fn set_cert_encoded_ref(&self, value : &[u8]) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

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

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

Data Type

Vec<u8>

cookie_count property (RNIFSender Struct)

The number of records in the Cookie arrays.

Syntax

fn cookie_count(&self) -> Result<i32, IPWorksEDIError> 
fn set_cookie_count(&self, value : i32) ->  Option<IPWorksEDIError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• cookie_domain
• cookie_expiration
• cookie_name
• cookie_path
• cookie_secure
• cookie_value

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

Data Type

i32

cookie_domain property (RNIFSender Struct)

The domain of a received cookie.

Syntax

fn cookie_domain(&self, CookieIndex : i32) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

The domain of a received cookie. This property contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, this property will contain an empty string. The convention in this case is to use the server name specified by url_server as the cookie domain.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.

This property is read-only.

Data Type

String

cookie_expiration property (RNIFSender Struct)

An expiration time for the cookie (if provided by the server).

Syntax

fn cookie_expiration(&self, CookieIndex : i32) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

An expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, this property will contain an empty string. The convention is to drop the cookie at the end of the session.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.

This property is read-only.

Data Type

String

cookie_name property (RNIFSender Struct)

The name of the cookie.

Syntax

fn cookie_name(&self, CookieIndex : i32) -> Result<String, IPWorksEDIError> 
fn set_cookie_name(&self, CookieIndex : i32, value : &str) ->  Option<IPWorksEDIError> 
fn set_cookie_name_ref(&self, CookieIndex : i32, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

This property, along with cookie_value, stores the cookie that is to be sent to the server. The on_set_cookie event displays the cookies sent by the server and their properties.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.

Data Type

String

cookie_path property (RNIFSender Struct)

A path name to limit the cookie to (if provided by the server).

Syntax

fn cookie_path(&self, CookieIndex : i32) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

A path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the path property will be an empty string. The convention in this case is to use the path specified by url_path as the cookie path.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.

This property is read-only.

Data Type

String

cookie_secure property (RNIFSender Struct)

The security flag of the received cookie.

Syntax

fn cookie_secure(&self, CookieIndex : i32) -> Result<bool, IPWorksEDIError> 

Default Value

false

Remarks

The security flag of the received cookie. This property specifies whether the cookie is secure. If the value of this property is True, the cookie value must be submitted only through a secure (HTTPS) connection.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.

This property is read-only.

Data Type

bool

cookie_value property (RNIFSender Struct)

The value of the cookie.

Syntax

fn cookie_value(&self, CookieIndex : i32) -> Result<String, IPWorksEDIError> 
fn set_cookie_value(&self, CookieIndex : i32, value : &str) ->  Option<IPWorksEDIError> 
fn set_cookie_value_ref(&self, CookieIndex : i32, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

The value of the cookie. A corresponding value is associated with the cookie specified by cookie_name. This property holds that value.

The on_set_cookie event provides the cookies set by the server.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.

Data Type

String

delivery_header_xml property (RNIFSender Struct)

The complete XML data from the Delivery Header.

Syntax

fn delivery_header_xml(&self) -> Result<String, IPWorksEDIError> 
fn set_delivery_header_xml(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_delivery_header_xml_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

This property is the full XML data of the RosettaNet message Delivery Header. This header contains information about the sending and receiving business processes, as well as tracking data for the message itself. This header was introduced by RNIF 2.0 to speed the movement of RosettaNet messages through message-forwarding hubs.

This property is an aggregate property containing XML either generated from or parsed into various other properties of the struct. If the value of a related property changes, this property will be updated the next time it is polled and the current valid XML will be returned. When this property is set directly, the struct will automatically parse the XML and validate the content of the header to ensure that all required fields contain appropriate values. Once this property has been set and validated, the following properties will be populated:

• secure_transport_required
• message_date_time
• message_receiver_id
• message_receiver_location
• message_sender_id
• message_sender_location
• message_tracking_id

NOTE: If rnif_version is set to v1, the value of this property is ignored when generating messages.

Data Type

String

encryption_algorithm property (RNIFSender Struct)

The algorithm used to encrypt the EDI data.

Syntax

fn encryption_algorithm(&self) -> Result<String, IPWorksEDIError> 
fn set_encryption_algorithm(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_encryption_algorithm_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

"AESCBC256"

Remarks

If recipient_certs contains a valid certificate, the data will be encrypted using this certificate and the algorithm specified in encryption_algorithm. If encryption_algorithm is set to the empty string, the data will not be encrypted.

The struct supports "AESCBC256", or industry-standard 256-bit AES-CBC encryption, by default.

The struct supports "AES" encryption with a default keysize of 128 bits. You may also set "AESCBC192", "AESCBC256", "AESGCM128", "AESGCM192", or "AESGCM256" for other AES modes and keysizes. 3DES and DES remain available for legacy interoperability.

Possible values are:

• 3DES
• DES
• AESCBC128
• AESCBC192
• AESCBC256 (default)
• AESGCM128
• AESGCM192
• AESGCM256

Data Type

String

encryption_type property (RNIFSender Struct)

The encryption type for RNIF 2.0.

Syntax

fn encryption_type(&self) -> Result<i32, IPWorksEDIError> 
fn set_encryption_type(&self, value : i32) ->  Option<IPWorksEDIError> 

Possible Values

0   // NoEncryption
1   // EncryptServiceContent
2   // EncryptPayloadContainer

Default Value

0

Remarks

RNIF 2.0 allows encryption of a message at three different levels:

NOTE: By default, the value is etNoEncryption. Therefore, if encryption is desired, the encryption_type property must be specified, even if a certificate is supplied through the certificate properties. See recipient_cert for more information on specifying a certificate for encryption.

Data Type

i32

firewall_auto_detect property (RNIFSender Struct)

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

Syntax

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

Default Value

false

Remarks

Data Type

bool

firewall_type property (RNIFSender Struct)

The type of firewall to connect through.

Syntax

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

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

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

Syntax

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

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

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

Syntax

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

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

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

Syntax

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

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_type is set to a valid value. See the description of the firewall_type property for details.

Data Type

i32

firewall_user property (RNIFSender Struct)

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

Syntax

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

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

from_role property (RNIFSender Struct)

The business role of the entity that originated this message.

Syntax

fn from_role(&self) -> Result<String, IPWorksEDIError> 
fn set_from_role(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_from_role_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

This property describes what role the process sending this message plays in the business model. This may be a one-word description, e.g. "Buyer".

This property is a field of the service header.

Data Type

String

from_service property (RNIFSender Struct)

The service that originated this message.

Syntax

fn from_service(&self) -> Result<String, IPWorksEDIError> 
fn set_from_service(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_from_service_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

This property describes the type of service that is being provided by the sender of this message. This can be a short description of the service being provided, e.g. "Buyer Service".

This property is a field of the service header.

Data Type

String

global_usage_code property (RNIFSender Struct)

A universal code describing basic usage for this message.

Syntax

fn global_usage_code(&self) -> Result<i32, IPWorksEDIError> 
fn set_global_usage_code(&self, value : i32) ->  Option<IPWorksEDIError> 

Possible Values

0   // Test
1   // Production

Default Value

0

Remarks

global_usage_code is a value that specifies how the RosettaNet message is to be treated from a business standpoint.This property currently only supports the following two values:

• 0 (gucTest)
• 1 (gucProduction)

This property is a field of the service header.

Data Type

i32

message_date_time property (RNIFSender Struct)

The time at which this message was sent.

Syntax

fn message_date_time(&self) -> Result<String, IPWorksEDIError> 
fn set_message_date_time(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_message_date_time_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

This property is a date and time stamp representing the moment the RosettaNet message was created. The sending process should set this value as close to the time when it sends as possible. The accepted standard for date fields in RosettaNet messages uses the format "YYYYMMDDThhmmss.sssZ", e.g. "20001121T145200.000Z". The format is interpreted as follows:

The message in the example was sent at 2:52:00.000 PM November 11, 2000.

This property is a field of the delivery header.

Data Type

String

message_receiver_id property (RNIFSender Struct)

Identity of the entity receiving this message.

Syntax

fn message_receiver_id(&self) -> Result<String, IPWorksEDIError> 
fn set_message_receiver_id(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_message_receiver_id_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

MessageReceiverId describes the identity of the receiver for this message. It is specifically the DUNS number for the trading partner.

This property is a field of the delivery header.

Data Type

String

message_receiver_location property (RNIFSender Struct)

Location of the entity receiving this message.

Syntax

fn message_receiver_location(&self) -> Result<String, IPWorksEDIError> 
fn set_message_receiver_location(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_message_receiver_location_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

This property describes the location of the receiver for this message. The location is not an address, but may be a city name.

This property is a field of the delivery header.

Data Type

String

message_sender_id property (RNIFSender Struct)

Identity of the entity that sent this message.

Syntax

fn message_sender_id(&self) -> Result<String, IPWorksEDIError> 
fn set_message_sender_id(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_message_sender_id_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

message_sender_id describes the identity of the sender for this message. It is specifically the DUNS number for the trading partner.

This property is a field of the delivery header.

Data Type

String

message_sender_location property (RNIFSender Struct)

Location of the entity that sent this message.

Syntax

fn message_sender_location(&self) -> Result<String, IPWorksEDIError> 
fn set_message_sender_location(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_message_sender_location_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

This property describes the location of the sender for this message. The location is not an address, but may be a city name.

This property is a field of the delivery header.

Data Type

String

message_tracking_id property (RNIFSender Struct)

Unique value that identifies this message.

Syntax

fn message_tracking_id(&self) -> Result<String, IPWorksEDIError> 
fn set_message_tracking_id(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_message_tracking_id_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

message_tracking_id is a unique instance identifier for this message. This value is used by both parties to keep a record of all the messages it receives. It is the responsibility of the sender to ensure that this value is unique for each transaction. The receiving entity should respond with an error if it receives a message with a previously used tracking id. This value can be used to persist any information relevant to the current business process to an external database .

This property is a field of the delivery header.

Data Type

String

original_action_code property (RNIFSender Struct)

The action code of the original message.

Syntax

fn original_action_code(&self) -> Result<String, IPWorksEDIError> 
fn set_original_action_code(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_original_action_code_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

This property describes the action code of the original message. This is useful when acquiring or processing replies. This tells a process what the original action was which started the current business process of actions and replies.

This property is a field of the service header.

Data Type

String

original_message_standard_name property (RNIFSender Struct)

The name of the standard used to create the original message.

Syntax

fn original_message_standard_name(&self) -> Result<String, IPWorksEDIError> 
fn set_original_message_standard_name(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_original_message_standard_name_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

While the RosettaNet community has a set of widely adopted, pre-defined and standardized message templates, it also allows for business partners to agree on specification geared more toward their particular needs. If a special, non-RosettaNet standard is to be used to create the action message, the name of the standard must be reported in action_message_standard_name and the version in action_message_standard_version. This way, the receiving entity can know how to process and interpret the incoming business message.

Since replies may sent in response to a message created using such a specialized standard, the standard used to create the original message should be referenced using the original_message_standard_name and original_message_standard_version when creating or processing replies.

This property is a field of the service header.

Data Type

String

original_message_standard_version property (RNIFSender Struct)

The version of the standard used to create the original message.

Syntax

fn original_message_standard_version(&self) -> Result<String, IPWorksEDIError> 
fn set_original_message_standard_version(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_original_message_standard_version_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

While the RosettaNet community has a set of widely adopted, pre-defined and standardized message templates, it also allows for business partners to agree on specification geared more toward their particular needs. If a special, non-RosettaNet standard is to be used to create the action message, the name of the standard must be reported in action_message_standard_name and the version in action_message_standard_version. This way, the receiving entity can know how to process and interpret the incoming business message.

Since replies may sent in response to a message created using such a specialized standard, the standard used to create the original message should be referenced using the original_message_standard_name and original_message_standard_version when creating or processing replies.

This property is a field of the service header.

Data Type

String

original_message_tracking_id property (RNIFSender Struct)

Tracking identifier for the original message.

Syntax

fn original_message_tracking_id(&self) -> Result<String, IPWorksEDIError> 
fn set_original_message_tracking_id(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_original_message_tracking_id_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

This property contains the identifier used to track the original message. This can be used when processing replies to previous actions to look up details about the original action that started the current business process. Complementary to the message_tracking_id, this property can be used to retrieve any information relevant to the current business process from an external database.

This property is a field of the service header.

Data Type

String

partner_id property (RNIFSender Struct)

Identity of the partner.

Syntax

fn partner_id(&self) -> Result<String, IPWorksEDIError> 
fn set_partner_id(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_partner_id_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

partner_known denotes whether or not the initiating partner for the current transaction is known. If the partner is known the sender should specify their business identifier using the partner_id property. This allows the receiving entity to look up information on how to reply, or forward the current message, to the partner in question. Also, partner_location can be specified. This property is not an address, but may be a city.

NOTE: If the partner is not known, then a partner_url MUST be specified in order for the messages and responses to reach their appropriate destinations.

This property is a field of the service header.

Data Type

String

partner_known property (RNIFSender Struct)

Whether or not the partner is known.

Syntax

fn partner_known(&self) -> Result<bool, IPWorksEDIError> 
fn set_partner_known(&self, value : bool) ->  Option<IPWorksEDIError> 

Default Value

false

Remarks

partner_known denotes whether or not the initiating partner for the current transaction is known. If the partner is known the sender should specify their business identifier using the partner_id property. This allows the receiving entity to look up information on how to reply, or forward the current message, to the partner in question. Also, partner_location can be specified. This property is not an address, but may be a city.

NOTE: If the partner is not known, then a partner_url MUST be specified in order for the messages and responses to reach their appropriate destinations.

This property is a field of the service header.

Data Type

bool

partner_location property (RNIFSender Struct)

Location of the partner.

Syntax

fn partner_location(&self) -> Result<String, IPWorksEDIError> 
fn set_partner_location(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_partner_location_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

partner_known denotes whether or not the initiating partner for the current transaction is known. If the partner is known the sender should specify their business identifier using the partner_id property. This allows the receiving entity to look up information on how to reply, or forward the current message, to the partner in question. Also, partner_location can be specified. This property is not an address, but may be a city.

NOTE: If the partner is not known, then a partner_url MUST be specified in order for the messages and responses to reach their appropriate destinations.

This property is a field of the service header.

Data Type

String

partner_pip_binding_id property (RNIFSender Struct)

The partner-defined PIP payload binding ID.

Syntax

fn partner_pip_binding_id(&self) -> Result<String, IPWorksEDIError> 
fn set_partner_pip_binding_id(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_partner_pip_binding_id_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

This property is only defined when non-RosettaNet content is bound in the payload portion of the RosettaNet Business message. This may only be used with PIPs which specifically support the use of non-RosettaNet content. Both trading partners must agree on the use of non-RosettaNet content, and on the Id being used. The Id is used to identify the two partners' own version of the PIP used.

NOTE: This property MUST be set when non-RosettaNet content is being sent in the payload, and MUST NOT be set when regular PIP's are being used.

Data Type

String

partner_url property (RNIFSender Struct)

A URL to which replies must be sent if the partner is unknown.

Syntax

fn partner_url(&self) -> Result<String, IPWorksEDIError> 
fn set_partner_url(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_partner_url_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

partner_known denotes whether or not the initiating partner for the current transaction is known. If the partner is known the sender should specify their business identifier using the partner_id property. This allows the receiving entity to look up information on how to reply, or forward the current message, to the partner in question. Also, partner_location can be specified. This property is not an address, but may be a city.

NOTE: If the partner is not known, then a partner_url MUST be specified in order for the messages and responses to reach their appropriate destinations.

This property is a field of the service header.

This property is a field of the service header.

NOTE: If partner is unknown and this value is not specified, further processing may not be possible.

Data Type

String

pip_code property (RNIFSender Struct)

RosettaNet PIP code of this message.

Syntax

fn pip_code(&self) -> Result<String, IPWorksEDIError> 
fn set_pip_code(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_pip_code_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

The service_content of a RosettaNet message is an instance of a pre-defined, widely accepted and standardized RosettaNet business action document called a Partner Interface Process (PIP). These documents define the most common business action scenarios, as well as the most common information used by a company to complete transactions under these scenarios. Each PIP has its own code, and many PIPs are defined in multiple versions. To ensure that the receiving partner knows how to interpret the PIP instance, the code should be set in pip_code and the version in pip_version.

Since no two business actions are exactly the same, each instance of PIP needs to have an associated identifier so that information about the transaction may be easily persisted to and retrieved from an external database. These instance ids are reported by the pip_instance_id property. It is up to the sending client to ensure that this value is unique. The receiver should respond with an error if it receives a PIP instance id that has already been used.

This property is a field of the service header.

Data Type

String

pip_instance_id property (RNIFSender Struct)

The Id of this PIP instance.

Syntax

fn pip_instance_id(&self) -> Result<String, IPWorksEDIError> 
fn set_pip_instance_id(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_pip_instance_id_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

The service_content of a RosettaNet message is an instance of a pre-defined, widely accepted and standardized RosettaNet business action document called a Partner Interface Process (PIP). These documents define the most common business action scenarios, as well as the most common information used by a company to complete transactions under these scenarios. Each PIP has its own code, and many PIPs are defined in multiple versions. To ensure that the receiving partner knows how to interpret the PIP instance, the code should be set in pip_code and the version in pip_version.

Since no two business actions are exactly the same, each instance of PIP needs to have an associated identifier so that information about the transaction may be easily persisted to and retrieved from an external database. These instance ids are reported by the pip_instance_id property. It is up to the sending client to ensure that this value is unique. The receiver should respond with an error if it receives a PIP instance id that has already been used.

This property is a field of the service header.

Data Type

String

pip_version property (RNIFSender Struct)

RosettaNet PIP version of this message.

Syntax

fn pip_version(&self) -> Result<String, IPWorksEDIError> 
fn set_pip_version(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_pip_version_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

The service_content of a RosettaNet message is an instance of a pre-defined, widely accepted and standardized RosettaNet business action document called a Partner Interface Process (PIP). These documents define the most common business action scenarios, as well as the most common information used by a company to complete transactions under these scenarios. Each PIP has its own code, and many PIPs are defined in multiple versions. To ensure that the receiving partner knows how to interpret the PIP instance, the code should be set in pip_code and the version in pip_version.

Since no two business actions are exactly the same, each instance of PIP needs to have an associated identifier so that information about the transaction may be easily persisted to and retrieved from an external database. These instance ids are reported by the pip_instance_id property. It is up to the sending client to ensure that this value is unique. The receiver should respond with an error if it receives a PIP instance id that has already been used.

This property is a field of the service header.

Data Type

String

preamble_header_xml property (RNIFSender Struct)

The complete XML data from the Preamble Header.

Syntax

fn preamble_header_xml(&self) -> Result<String, IPWorksEDIError> 
fn set_preamble_header_xml(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_preamble_header_xml_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

The contents of preamble_header_xml are the full XML data RosettaNet message Preamble Header. This header includes information about the version of the RosettaNet Implementation Framework (RNIF) protocol used to create the message.

This property is an aggregate property containing XML either generated from or parsed into various other properties of the struct. If the value of a related property changes, this property will be updated the next time it is polled and the current valid XML will be returned. When this property is set directly, the struct will automatically parse the XML and validate the content of the header to ensure that all required fields contain appropriate values. Once this property has been set and validated, the following properties will be populated:

• standard_name
• standard_version

Data Type

String

proxy_auth_scheme property (RNIFSender Struct)

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

Syntax

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

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

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

Syntax

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

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

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

Syntax

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

Default Value

""

Remarks

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

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

Syntax

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

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 (RNIFSender 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, IPWorksEDIError> 
fn set_proxy_server(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_proxy_server_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

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

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

Syntax

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

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

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

Syntax

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

Default Value

""

Remarks

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

qos_specification_count property (RNIFSender Struct)

The number of records in the QOSSpecification arrays.

Syntax

fn qos_specification_count(&self) -> Result<i32, IPWorksEDIError> 
fn set_qos_specification_count(&self, value : i32) ->  Option<IPWorksEDIError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• qos_specification_code
• qos_specification_value

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

Data Type

i32

qos_specification_code property (RNIFSender Struct)

Code is a string representing a quality of service measurement category.

Syntax

fn qos_specification_code(&self, QOSIndex : i32) -> Result<String, IPWorksEDIError> 
fn set_qos_specification_code(&self, QOSIndex : i32, value : &str) ->  Option<IPWorksEDIError> 
fn set_qos_specification_code_ref(&self, QOSIndex : i32, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

qos_specification_code is a string representing a quality of service measurement category.

The QOSIndex parameter specifies the index of the item in the array. The size of the array is controlled by the qos_specification_count property.

Data Type

String

qos_specification_value property (RNIFSender Struct)

Value is a string that defines the constraints for the category in Code .

Syntax

fn qos_specification_value(&self, QOSIndex : i32) -> Result<String, IPWorksEDIError> 
fn set_qos_specification_value(&self, QOSIndex : i32, value : &str) ->  Option<IPWorksEDIError> 
fn set_qos_specification_value_ref(&self, QOSIndex : i32, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

qos_specification_value is a string that defines the constraints for the category in qos_specification_code.

The QOSIndex parameter specifies the index of the item in the array. The size of the array is controlled by the qos_specification_count property.

Data Type

String

receipt_signer_cert_effective_date property (RNIFSender Struct)

The date on which this certificate becomes valid.

Syntax

fn receipt_signer_cert_effective_date(&self) -> Result<String, IPWorksEDIError> 

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

receipt_signer_cert_expiration_date property (RNIFSender Struct)

The date on which the certificate expires.

Syntax

fn receipt_signer_cert_expiration_date(&self) -> Result<String, IPWorksEDIError> 

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

receipt_signer_cert_extended_key_usage property (RNIFSender Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn receipt_signer_cert_extended_key_usage(&self) -> Result<String, IPWorksEDIError> 

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

receipt_signer_cert_fingerprint property (RNIFSender Struct)

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

Syntax

fn receipt_signer_cert_fingerprint(&self) -> Result<String, IPWorksEDIError> 

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

receipt_signer_cert_fingerprint_sha1 property (RNIFSender Struct)

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

Syntax

fn receipt_signer_cert_fingerprint_sha1(&self) -> Result<String, IPWorksEDIError> 

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

receipt_signer_cert_fingerprint_sha256 property (RNIFSender Struct)

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

Syntax

fn receipt_signer_cert_fingerprint_sha256(&self) -> Result<String, IPWorksEDIError> 

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

receipt_signer_cert_issuer property (RNIFSender Struct)

The issuer of the certificate.

Syntax

fn receipt_signer_cert_issuer(&self) -> Result<String, IPWorksEDIError> 

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

receipt_signer_cert_private_key property (RNIFSender Struct)

The private key of the certificate (if available).

Syntax

fn receipt_signer_cert_private_key(&self) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

receipt_signer_cert_private_key_available property (RNIFSender Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn receipt_signer_cert_private_key_available(&self) -> Result<bool, IPWorksEDIError> 

Default Value

false

Remarks

Whether a receipt_signer_cert_private_key is available for the selected certificate. If receipt_signer_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

receipt_signer_cert_private_key_container property (RNIFSender Struct)

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

Syntax

fn receipt_signer_cert_private_key_container(&self) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

The name of the receipt_signer_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

receipt_signer_cert_public_key property (RNIFSender Struct)

The public key of the certificate.

Syntax

fn receipt_signer_cert_public_key(&self) -> Result<String, IPWorksEDIError> 

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

receipt_signer_cert_public_key_algorithm property (RNIFSender Struct)

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

Syntax

fn receipt_signer_cert_public_key_algorithm(&self) -> Result<String, IPWorksEDIError> 

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

receipt_signer_cert_public_key_length property (RNIFSender Struct)

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

Syntax

fn receipt_signer_cert_public_key_length(&self) -> Result<i32, IPWorksEDIError> 

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

receipt_signer_cert_serial_number property (RNIFSender Struct)

The serial number of the certificate encoded as a string.

Syntax

fn receipt_signer_cert_serial_number(&self) -> Result<String, IPWorksEDIError> 

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

receipt_signer_cert_signature_algorithm property (RNIFSender Struct)

The text description of the certificate's signature algorithm.

Syntax

fn receipt_signer_cert_signature_algorithm(&self) -> Result<String, IPWorksEDIError> 

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

receipt_signer_cert_store property (RNIFSender Struct)

The name of the certificate store for the client certificate.

Syntax

fn receipt_signer_cert_store(&self) -> Result<Vec<u8>, IPWorksEDIError> 
fn set_receipt_signer_cert_store(&self, value : Vec<u8>) ->  Option<IPWorksEDIError> 
fn set_receipt_signer_cert_store_ref(&self, value : &[u8]) ->  Option<IPWorksEDIError> 

Default Value

"MY"

Remarks

The receipt_signer_cert_store_type property denotes the type of the certificate store specified by receipt_signer_cert_store. If the store is password-protected, specify the password in receipt_signer_cert_store_password.

receipt_signer_cert_store is used in conjunction with the receipt_signer_cert_subject property to specify client certificates. If receipt_signer_cert_store has a value, and receipt_signer_cert_subject or receipt_signer_cert_encoded is set, a search for a certificate is initiated. Please see the receipt_signer_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<u8>

receipt_signer_cert_store_password property (RNIFSender 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 receipt_signer_cert_store_password(&self) -> Result<String, IPWorksEDIError> 
fn set_receipt_signer_cert_store_password(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_receipt_signer_cert_store_password_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

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

receipt_signer_cert_store_type property (RNIFSender Struct)

The type of certificate store for this certificate.

Syntax

fn receipt_signer_cert_store_type(&self) -> Result<i32, IPWorksEDIError> 
fn set_receipt_signer_cert_store_type(&self, value : i32) ->  Option<IPWorksEDIError> 

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

receipt_signer_cert_subject_alt_names property (RNIFSender Struct)

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

Syntax

fn receipt_signer_cert_subject_alt_names(&self) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

receipt_signer_cert_thumbprint_md5 property (RNIFSender Struct)

The MD5 hash of the certificate.

Syntax

fn receipt_signer_cert_thumbprint_md5(&self) -> Result<String, IPWorksEDIError> 

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

receipt_signer_cert_thumbprint_sha1 property (RNIFSender Struct)

The SHA-1 hash of the certificate.

Syntax

fn receipt_signer_cert_thumbprint_sha1(&self) -> Result<String, IPWorksEDIError> 

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

receipt_signer_cert_thumbprint_sha256 property (RNIFSender Struct)

The SHA-256 hash of the certificate.

Syntax

fn receipt_signer_cert_thumbprint_sha256(&self) -> Result<String, IPWorksEDIError> 

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

receipt_signer_cert_usage property (RNIFSender Struct)

The text description of UsageFlags .

Syntax

fn receipt_signer_cert_usage(&self) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

receipt_signer_cert_usage_flags property (RNIFSender Struct)

The flags that show intended use for the certificate.

Syntax

fn receipt_signer_cert_usage_flags(&self) -> Result<i32, IPWorksEDIError> 

Default Value

0

Remarks

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

Please see the receipt_signer_cert_usage property for a text representation of receipt_signer_cert_usage_flags.

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

This property is read-only.

Data Type

i32

receipt_signer_cert_version property (RNIFSender Struct)

The certificate's version number.

Syntax

fn receipt_signer_cert_version(&self) -> Result<String, IPWorksEDIError> 

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

receipt_signer_cert_subject property (RNIFSender Struct)

The subject of the certificate used for client authentication.

Syntax

fn receipt_signer_cert_subject(&self) -> Result<String, IPWorksEDIError> 
fn set_receipt_signer_cert_subject(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_receipt_signer_cert_subject_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

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

receipt_signer_cert_encoded property (RNIFSender Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn receipt_signer_cert_encoded(&self) -> Result<Vec<u8>, IPWorksEDIError> 
fn set_receipt_signer_cert_encoded(&self, value : Vec<u8>) ->  Option<IPWorksEDIError> 
fn set_receipt_signer_cert_encoded_ref(&self, value : &[u8]) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

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

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

Data Type

Vec<u8>

recipient_cert_effective_date property (RNIFSender Struct)

The date on which this certificate becomes valid.

Syntax

fn recipient_cert_effective_date(&self) -> Result<String, IPWorksEDIError> 

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

recipient_cert_expiration_date property (RNIFSender Struct)

The date on which the certificate expires.

Syntax

fn recipient_cert_expiration_date(&self) -> Result<String, IPWorksEDIError> 

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

recipient_cert_extended_key_usage property (RNIFSender Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn recipient_cert_extended_key_usage(&self) -> Result<String, IPWorksEDIError> 

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

recipient_cert_fingerprint property (RNIFSender Struct)

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

Syntax

fn recipient_cert_fingerprint(&self) -> Result<String, IPWorksEDIError> 

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

recipient_cert_fingerprint_sha1 property (RNIFSender Struct)

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

Syntax

fn recipient_cert_fingerprint_sha1(&self) -> Result<String, IPWorksEDIError> 

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

recipient_cert_fingerprint_sha256 property (RNIFSender Struct)

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

Syntax

fn recipient_cert_fingerprint_sha256(&self) -> Result<String, IPWorksEDIError> 

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

recipient_cert_issuer property (RNIFSender Struct)

The issuer of the certificate.

Syntax

fn recipient_cert_issuer(&self) -> Result<String, IPWorksEDIError> 

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

recipient_cert_private_key property (RNIFSender Struct)

The private key of the certificate (if available).

Syntax

fn recipient_cert_private_key(&self) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

recipient_cert_private_key_available property (RNIFSender Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn recipient_cert_private_key_available(&self) -> Result<bool, IPWorksEDIError> 

Default Value

false

Remarks

Whether a recipient_cert_private_key is available for the selected certificate. If recipient_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

recipient_cert_private_key_container property (RNIFSender Struct)

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

Syntax

fn recipient_cert_private_key_container(&self) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

The name of the recipient_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

recipient_cert_public_key property (RNIFSender Struct)

The public key of the certificate.

Syntax

fn recipient_cert_public_key(&self) -> Result<String, IPWorksEDIError> 

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

recipient_cert_public_key_algorithm property (RNIFSender Struct)

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

Syntax

fn recipient_cert_public_key_algorithm(&self) -> Result<String, IPWorksEDIError> 

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

recipient_cert_public_key_length property (RNIFSender Struct)

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

Syntax

fn recipient_cert_public_key_length(&self) -> Result<i32, IPWorksEDIError> 

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

recipient_cert_serial_number property (RNIFSender Struct)

The serial number of the certificate encoded as a string.

Syntax

fn recipient_cert_serial_number(&self) -> Result<String, IPWorksEDIError> 

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

recipient_cert_signature_algorithm property (RNIFSender Struct)

The text description of the certificate's signature algorithm.

Syntax

fn recipient_cert_signature_algorithm(&self) -> Result<String, IPWorksEDIError> 

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

recipient_cert_store property (RNIFSender Struct)

The name of the certificate store for the client certificate.

Syntax

fn recipient_cert_store(&self) -> Result<Vec<u8>, IPWorksEDIError> 
fn set_recipient_cert_store(&self, value : Vec<u8>) ->  Option<IPWorksEDIError> 
fn set_recipient_cert_store_ref(&self, value : &[u8]) ->  Option<IPWorksEDIError> 

Default Value

"MY"

Remarks

The recipient_cert_store_type property denotes the type of the certificate store specified by recipient_cert_store. If the store is password-protected, specify the password in recipient_cert_store_password.

recipient_cert_store is used in conjunction with the recipient_cert_subject property to specify client certificates. If recipient_cert_store has a value, and recipient_cert_subject or recipient_cert_encoded is set, a search for a certificate is initiated. Please see the recipient_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<u8>

recipient_cert_store_password property (RNIFSender 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 recipient_cert_store_password(&self) -> Result<String, IPWorksEDIError> 
fn set_recipient_cert_store_password(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_recipient_cert_store_password_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

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

recipient_cert_store_type property (RNIFSender Struct)

The type of certificate store for this certificate.

Syntax

fn recipient_cert_store_type(&self) -> Result<i32, IPWorksEDIError> 
fn set_recipient_cert_store_type(&self, value : i32) ->  Option<IPWorksEDIError> 

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

recipient_cert_subject_alt_names property (RNIFSender Struct)

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

Syntax

fn recipient_cert_subject_alt_names(&self) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

recipient_cert_thumbprint_md5 property (RNIFSender Struct)

The MD5 hash of the certificate.

Syntax

fn recipient_cert_thumbprint_md5(&self) -> Result<String, IPWorksEDIError> 

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

recipient_cert_thumbprint_sha1 property (RNIFSender Struct)

The SHA-1 hash of the certificate.

Syntax

fn recipient_cert_thumbprint_sha1(&self) -> Result<String, IPWorksEDIError> 

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

recipient_cert_thumbprint_sha256 property (RNIFSender Struct)

The SHA-256 hash of the certificate.

Syntax

fn recipient_cert_thumbprint_sha256(&self) -> Result<String, IPWorksEDIError> 

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

recipient_cert_usage property (RNIFSender Struct)

The text description of UsageFlags .

Syntax

fn recipient_cert_usage(&self) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

recipient_cert_usage_flags property (RNIFSender Struct)

The flags that show intended use for the certificate.

Syntax

fn recipient_cert_usage_flags(&self) -> Result<i32, IPWorksEDIError> 

Default Value

0

Remarks

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

Please see the recipient_cert_usage property for a text representation of recipient_cert_usage_flags.

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

This property is read-only.

Data Type

i32

recipient_cert_version property (RNIFSender Struct)

The certificate's version number.

Syntax

fn recipient_cert_version(&self) -> Result<String, IPWorksEDIError> 

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

recipient_cert_subject property (RNIFSender Struct)

The subject of the certificate used for client authentication.

Syntax

fn recipient_cert_subject(&self) -> Result<String, IPWorksEDIError> 
fn set_recipient_cert_subject(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_recipient_cert_subject_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

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

recipient_cert_encoded property (RNIFSender Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn recipient_cert_encoded(&self) -> Result<Vec<u8>, IPWorksEDIError> 
fn set_recipient_cert_encoded(&self, value : Vec<u8>) ->  Option<IPWorksEDIError> 
fn set_recipient_cert_encoded_ref(&self, value : &[u8]) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

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

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

Data Type

Vec<u8>

reply_data property (RNIFSender Struct)

This property is used to retrieve synchronous reply message content.

Syntax

fn reply_data(&self) -> Result<Vec<u8>, IPWorksEDIError> 

Default Value

""

Remarks

This property is only used when the sender is requiring a synchronous reply or signal of acknowledgement to be sent following its action message. This gets the message body content from the receiver from the synchronous connection.

NOTE: This property is only populated when a synchronous reply (i.e., a reply over the same HTTP connection as the POST) is received. In all other cases, it will be empty.

This property is read-only.

Data Type

Vec<u8>

reply_headers property (RNIFSender Struct)

This property is used to retrieve headers from synchronous reply messages.

Syntax

fn reply_headers(&self) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

This property is only used when the sender is requiring a synchronous reply or signal of acknowledgement to be sent by the receiver following its action message. This gets the header of the reply message or signal sent from the receiver. It is received from the synchronous connection.

NOTE: This property is only populated when a synchronous reply (i.e., a reply over the same HTTP connection as the POST) is received. In all other cases, it will be empty.

This property is read-only.

Data Type

String

reply_message property (RNIFSender Struct)

Whether or not this message is a reply to another message.

Syntax

fn reply_message(&self) -> Result<bool, IPWorksEDIError> 
fn set_reply_message(&self, value : bool) ->  Option<IPWorksEDIError> 

Default Value

false

Remarks

This property is a boolean value indicating whether or not the message is a reply to a previous message or not. The first message in any business process is always an action message. Reply messages may be an update, another action, or a signal.

Some actions may request data, in which case a reply RosettaNet message must be sent with the data that was requested. All action messages sent in response to the original action message are considered replies.

When sending a reply, this property should be set to "True" to tell the receiver how to interpret and handle the message.

This property is a field of the service header.

Data Type

bool

response_type property (RNIFSender Struct)

Requested response type. Available only in RNIF 2.0.

Syntax

fn response_type(&self) -> Result<i32, IPWorksEDIError> 
fn set_response_type(&self, value : i32) ->  Option<IPWorksEDIError> 

Possible Values

0   // Sync
1   // Async

Default Value

0

Remarks

This property tells the receiver which type of response the sender is expecting.

The following types of supported responses are:

This property is only available in RNIF version 2.0.

Data Type

i32

rnif_version property (RNIFSender Struct)

The RNIF Standard Version used to generate this message.

Syntax

fn rnif_version(&self) -> Result<i32, IPWorksEDIError> 
fn set_rnif_version(&self, value : i32) ->  Option<IPWorksEDIError> 

Possible Values

0   // 1
1   // 2

Default Value

0

Remarks

This property describes which standard version of RNIF was used to generate this message. Possible values are::

Data Type

i32

secure_transport_required property (RNIFSender Struct)

Indicates that security is required when forwarding this message.

Syntax

fn secure_transport_required(&self) -> Result<bool, IPWorksEDIError> 
fn set_secure_transport_required(&self, value : bool) ->  Option<IPWorksEDIError> 

Default Value

false

Remarks

This property is a boolean value which denotes whether or not security is required when forwarding this message. Since RosettaNet messages are business messages, secure transport is often required. See RNIFSender for more information on sending messages over a secure transport.

This property is a field of the delivery header.

Data Type

bool

service_content property (RNIFSender Struct)

The PIP message data.

Syntax

fn service_content(&self) -> Result<String, IPWorksEDIError> 
fn set_service_content(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_service_content_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

The ServiceContent property contains the PIP message data. This is the body of the message which contains the request, action, or reply being sent from one business process to another.

There are specific formats to which this data must adhere. These formats are specified by the RosettaNet community in the form of Partner Interface Processes (PIPs). Each PIP instance also has an ID associated with it which is stored in the pip_instance_id property.

Data Type

String

service_header_xml property (RNIFSender Struct)

The complete XML data from the Service Header.

Syntax

fn service_header_xml(&self) -> Result<String, IPWorksEDIError> 
fn set_service_header_xml(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_service_header_xml_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

service_header_xml contains the full XML data of the RosettaNet message Service Header. This header includes information about the contents of the RosettaNet message itself. It contains information about the type of message, the PIP used to create the service content, and the various attachments as well as information about the business partners involved in the transaction, such as each entity's role.

This property is an aggregate property containing XML either generated from or parsed into various other properties of the struct. If the value of a related property changes, this property will be updated the next time it is polled and the current valid XML will be returned. When this property is set directly, the struct will automatically parse the XML and validate the content of the header to ensure that all required fields contain appropriate values. Once this property has been set and validated, the following properties will be populated:

• action_code
• action_message
• action_message_standard_name
• action_message_standard_version
• attachments
• from_role
• from_service
• original_action_code
• original_message_standard_name
• original_message_standard_version
• original_message_tracking_id
• partner_id
• partner_known
• partner_location
• partner_pip_binding_id
• partner_url
• pip_code
• pip_instance_id
• pip_version
• qos_specifications
• reply_message
• signal_code
• signal_message
• global_usage_code
• signal_version
• to_role
• to_service

Data Type

String

signal_code property (RNIFSender Struct)

The code for this signal.

Syntax

fn signal_code(&self) -> Result<String, IPWorksEDIError> 
fn set_signal_code(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_signal_code_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

This is the code for the signal message received. This property is only set if the message is a signal. The code denotes what type of signal is being received, or sent.

Data Type

String

signal_message property (RNIFSender Struct)

Whether or not this message is a signal.

Syntax

fn signal_message(&self) -> Result<bool, IPWorksEDIError> 
fn set_signal_message(&self, value : bool) ->  Option<IPWorksEDIError> 

Default Value

false

Remarks

signal_message is a boolean value indicating whether or not the message is a signal. Signals do not contain content that is of business nature. Instead, they are simply acknowledgments to business actions.

RNIF 2.0 specifies two types of signals: a positive, and a negative. A positive signal has all of the properties of a valid RosettaNet action message, however it is simply an acknowledgement of receipt of a valid Business Action message. A negative signal is an acknowledgement sent to notify the originating entity of an error. In RNIF 2.0, there is only one type of exception message, as opposed to the three types in RNIF 1.1.

NOTE: only Business Actions may be acknowledged, Signals cannot.

This property is a field of the service header.

Data Type

bool

signal_version property (RNIFSender Struct)

The version of this signal.

Syntax

fn signal_version(&self) -> Result<String, IPWorksEDIError> 
fn set_signal_version(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_signal_version_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

This is the version for the signal message received. This property is only set if the message is a signal. The version denotes what version of signal is being received, or sent.

Data Type

String

signature_algorithm property (RNIFSender Struct)

Signature algorithm to be used in outgoing messages.

Syntax

fn signature_algorithm(&self) -> Result<String, IPWorksEDIError> 
fn set_signature_algorithm(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_signature_algorithm_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

"sha-256"

Remarks

Signature Algorithm can be set to indicate the preferred signing algorithm. Possible values are:

• sha1
• md5
• sha256 (default)
• sha384
• sha512
• sha224

The default value is "sha256".

Data Type

String

signer_cert_effective_date property (RNIFSender Struct)

The date on which this certificate becomes valid.

Syntax

fn signer_cert_effective_date(&self) -> Result<String, IPWorksEDIError> 

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

signer_cert_expiration_date property (RNIFSender Struct)

The date on which the certificate expires.

Syntax

fn signer_cert_expiration_date(&self) -> Result<String, IPWorksEDIError> 

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

signer_cert_extended_key_usage property (RNIFSender Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn signer_cert_extended_key_usage(&self) -> Result<String, IPWorksEDIError> 

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

signer_cert_fingerprint property (RNIFSender Struct)

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

Syntax

fn signer_cert_fingerprint(&self) -> Result<String, IPWorksEDIError> 

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

signer_cert_fingerprint_sha1 property (RNIFSender Struct)

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

Syntax

fn signer_cert_fingerprint_sha1(&self) -> Result<String, IPWorksEDIError> 

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

signer_cert_fingerprint_sha256 property (RNIFSender Struct)

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

Syntax

fn signer_cert_fingerprint_sha256(&self) -> Result<String, IPWorksEDIError> 

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

signer_cert_issuer property (RNIFSender Struct)

The issuer of the certificate.

Syntax

fn signer_cert_issuer(&self) -> Result<String, IPWorksEDIError> 

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

signer_cert_private_key property (RNIFSender Struct)

The private key of the certificate (if available).

Syntax

fn signer_cert_private_key(&self) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

signer_cert_private_key_available property (RNIFSender Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn signer_cert_private_key_available(&self) -> Result<bool, IPWorksEDIError> 

Default Value

false

Remarks

Whether a signer_cert_private_key is available for the selected certificate. If signer_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

signer_cert_private_key_container property (RNIFSender Struct)

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

Syntax

fn signer_cert_private_key_container(&self) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

The name of the signer_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

signer_cert_public_key property (RNIFSender Struct)

The public key of the certificate.

Syntax

fn signer_cert_public_key(&self) -> Result<String, IPWorksEDIError> 

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

signer_cert_public_key_algorithm property (RNIFSender Struct)

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

Syntax

fn signer_cert_public_key_algorithm(&self) -> Result<String, IPWorksEDIError> 

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

signer_cert_public_key_length property (RNIFSender Struct)

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

Syntax

fn signer_cert_public_key_length(&self) -> Result<i32, IPWorksEDIError> 

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

signer_cert_serial_number property (RNIFSender Struct)

The serial number of the certificate encoded as a string.

Syntax

fn signer_cert_serial_number(&self) -> Result<String, IPWorksEDIError> 

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

signer_cert_signature_algorithm property (RNIFSender Struct)

The text description of the certificate's signature algorithm.

Syntax

fn signer_cert_signature_algorithm(&self) -> Result<String, IPWorksEDIError> 

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

signer_cert_store property (RNIFSender Struct)

The name of the certificate store for the client certificate.

Syntax

fn signer_cert_store(&self) -> Result<Vec<u8>, IPWorksEDIError> 
fn set_signer_cert_store(&self, value : Vec<u8>) ->  Option<IPWorksEDIError> 
fn set_signer_cert_store_ref(&self, value : &[u8]) ->  Option<IPWorksEDIError> 

Default Value

"MY"

Remarks

The signer_cert_store_type property denotes the type of the certificate store specified by signer_cert_store. If the store is password-protected, specify the password in signer_cert_store_password.

signer_cert_store is used in conjunction with the signer_cert_subject property to specify client certificates. If signer_cert_store has a value, and signer_cert_subject or signer_cert_encoded is set, a search for a certificate is initiated. Please see the signer_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<u8>

signer_cert_store_password property (RNIFSender 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 signer_cert_store_password(&self) -> Result<String, IPWorksEDIError> 
fn set_signer_cert_store_password(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_signer_cert_store_password_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

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

signer_cert_store_type property (RNIFSender Struct)

The type of certificate store for this certificate.

Syntax

fn signer_cert_store_type(&self) -> Result<i32, IPWorksEDIError> 
fn set_signer_cert_store_type(&self, value : i32) ->  Option<IPWorksEDIError> 

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

signer_cert_subject_alt_names property (RNIFSender Struct)

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

Syntax

fn signer_cert_subject_alt_names(&self) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

signer_cert_thumbprint_md5 property (RNIFSender Struct)

The MD5 hash of the certificate.

Syntax

fn signer_cert_thumbprint_md5(&self) -> Result<String, IPWorksEDIError> 

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

signer_cert_thumbprint_sha1 property (RNIFSender Struct)

The SHA-1 hash of the certificate.

Syntax

fn signer_cert_thumbprint_sha1(&self) -> Result<String, IPWorksEDIError> 

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

signer_cert_thumbprint_sha256 property (RNIFSender Struct)

The SHA-256 hash of the certificate.

Syntax

fn signer_cert_thumbprint_sha256(&self) -> Result<String, IPWorksEDIError> 

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

signer_cert_usage property (RNIFSender Struct)

The text description of UsageFlags .

Syntax

fn signer_cert_usage(&self) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

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

signer_cert_usage_flags property (RNIFSender Struct)

The flags that show intended use for the certificate.

Syntax

fn signer_cert_usage_flags(&self) -> Result<i32, IPWorksEDIError> 

Default Value

0

Remarks

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

Please see the signer_cert_usage property for a text representation of signer_cert_usage_flags.

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

This property is read-only.

Data Type

i32

signer_cert_version property (RNIFSender Struct)

The certificate's version number.

Syntax

fn signer_cert_version(&self) -> Result<String, IPWorksEDIError> 

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

signer_cert_subject property (RNIFSender Struct)

The subject of the certificate used for client authentication.

Syntax

fn signer_cert_subject(&self) -> Result<String, IPWorksEDIError> 
fn set_signer_cert_subject(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_signer_cert_subject_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

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

signer_cert_encoded property (RNIFSender Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn signer_cert_encoded(&self) -> Result<Vec<u8>, IPWorksEDIError> 
fn set_signer_cert_encoded(&self, value : Vec<u8>) ->  Option<IPWorksEDIError> 
fn set_signer_cert_encoded_ref(&self, value : &[u8]) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

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

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

Data Type

Vec<u8>

ssl_accept_server_cert_effective_date property (RNIFSender Struct)

The date on which this certificate becomes valid.

Syntax

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

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

The date on which the certificate expires.

Syntax

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

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

A comma-delimited list of extended key usage identifiers.

Syntax

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

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

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

Syntax

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

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

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

Syntax

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

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

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

Syntax

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

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

The issuer of the certificate.

Syntax

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

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

The private key of the certificate (if available).

Syntax

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

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

Whether a PrivateKey is available for the selected certificate.

Syntax

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

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

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

Syntax

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

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

The public key of the certificate.

Syntax

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

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

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

Syntax

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

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

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

Syntax

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

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

The serial number of the certificate encoded as a string.

Syntax

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

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

The text description of the certificate's signature algorithm.

Syntax

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

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

The name of the certificate store for the client certificate.

Syntax

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

Default Value

"MY"

Remarks

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

ssl_accept_server_cert_store_password property (RNIFSender 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, IPWorksEDIError> 
fn set_ssl_accept_server_cert_store_password(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_ssl_accept_server_cert_store_password_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

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

The type of certificate store for this certificate.

Syntax

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

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

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

Syntax

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

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

The MD5 hash of the certificate.

Syntax

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

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

The SHA-1 hash of the certificate.

Syntax

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

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

The SHA-256 hash of the certificate.

Syntax

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

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

The text description of UsageFlags .

Syntax

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

Default Value

""

Remarks

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

The flags that show intended use for the certificate.

Syntax

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

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

The certificate's version number.

Syntax

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

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

The subject of the certificate used for client authentication.

Syntax

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

Default Value

""

Remarks

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

The certificate (PEM/Base64 encoded).

Syntax

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

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

ssl_cert_effective_date property (RNIFSender Struct)

The date on which this certificate becomes valid.

Syntax

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

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

The date on which the certificate expires.

Syntax

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

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

A comma-delimited list of extended key usage identifiers.

Syntax

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

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

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

Syntax

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

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

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

Syntax

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

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

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

Syntax

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

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

The issuer of the certificate.

Syntax

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

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

The private key of the certificate (if available).

Syntax

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

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

Whether a PrivateKey is available for the selected certificate.

Syntax

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

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

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

Syntax

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

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

The public key of the certificate.

Syntax

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

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

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

Syntax

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

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

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

Syntax

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

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

The serial number of the certificate encoded as a string.

Syntax

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

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

The text description of the certificate's signature algorithm.

Syntax

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

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

The name of the certificate store for the client certificate.

Syntax

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

Default Value

"MY"

Remarks

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

ssl_cert_store_password property (RNIFSender 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, IPWorksEDIError> 
fn set_ssl_cert_store_password(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_ssl_cert_store_password_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

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

The type of certificate store for this certificate.

Syntax

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

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

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

Syntax

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

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

The MD5 hash of the certificate.

Syntax

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

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

The SHA-1 hash of the certificate.

Syntax

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

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

The SHA-256 hash of the certificate.

Syntax

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

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

The text description of UsageFlags .

Syntax

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

Default Value

""

Remarks

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

The flags that show intended use for the certificate.

Syntax

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

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

The certificate's version number.

Syntax

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

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

The subject of the certificate used for client authentication.

Syntax

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

Default Value

""

Remarks

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

The certificate (PEM/Base64 encoded).

Syntax

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

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

ssl_provider property (RNIFSender Struct)

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

Syntax

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

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:

Additional Notes

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 struct will always try and use the platform implementation. If the platform TLS 1.3 implementation is not available, the internal implementation will be used.

Data Type

i32

ssl_server_cert_effective_date property (RNIFSender Struct)

The date on which this certificate becomes valid.

Syntax

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

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

The date on which the certificate expires.

Syntax

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

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

A comma-delimited list of extended key usage identifiers.

Syntax

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

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

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

Syntax

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

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

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

Syntax

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

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

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

Syntax

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

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

The issuer of the certificate.

Syntax

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

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

The private key of the certificate (if available).

Syntax

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

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

Whether a PrivateKey is available for the selected certificate.

Syntax

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

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

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

Syntax

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

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

The public key of the certificate.

Syntax

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

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

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

Syntax

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

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

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

Syntax

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

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

The serial number of the certificate encoded as a string.

Syntax

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

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

The text description of the certificate's signature algorithm.

Syntax

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

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

The name of the certificate store for the client certificate.

Syntax

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

Default Value

"MY"

Remarks

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

ssl_server_cert_store_password property (RNIFSender 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, IPWorksEDIError> 

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

The type of certificate store for this certificate.

Syntax

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

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

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

Syntax

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

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

The MD5 hash of the certificate.

Syntax

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

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

The SHA-1 hash of the certificate.

Syntax

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

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

The SHA-256 hash of the certificate.

Syntax

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

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

The text description of UsageFlags .

Syntax

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

Default Value

""

Remarks

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

The flags that show intended use for the certificate.

Syntax

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

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

The certificate's version number.

Syntax

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

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

The subject of the certificate used for client authentication.

Syntax

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

Default Value

""

Remarks

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

The certificate (PEM/Base64 encoded).

Syntax

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

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

standard_name property (RNIFSender Struct)

The name of the standard used to create this message.

Syntax

fn standard_name(&self) -> Result<String, IPWorksEDIError> 
fn set_standard_name(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_standard_name_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

This property is the name of the standard which was used to create the message. In this case, we are working with RosettaNet, so RosettaNet will always be the StandardName, unless this specification is used to send a non-RosettaNet type message. The type name and version must be specified when this occurs.

This property is a field of the preamble.

Data Type

String

standard_version property (RNIFSender Struct)

The version of the standard used to create this message.

Syntax

fn standard_version(&self) -> Result<String, IPWorksEDIError> 
fn set_standard_version(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_standard_version_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

StandardVersion describes the version of the standard used to create this message. In this case, the standard being used is RosettaNet. Therefore, the version will be which version of RosettaNet the sender is using.

This property is a field of the preamble.

Data Type

String

timeout property (RNIFSender Struct)

The timeout for the struct.

Syntax

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

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

to_role property (RNIFSender Struct)

The role of the entity receiving this message.

Syntax

fn to_role(&self) -> Result<String, IPWorksEDIError> 
fn set_to_role(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_to_role_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

This describes what role the process receiving this message plays in the business model. This may be a one-word description, e.g. "Seller".

This property is a field of the service header.

Data Type

String

to_service property (RNIFSender Struct)

The service for which this message is bound.

Syntax

fn to_service(&self) -> Result<String, IPWorksEDIError> 
fn set_to_service(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_to_service_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

This property describes the type of service that is being provided by the receiver of this message. This can be a short description of the service being provided, e.g. "Seller Service".

This property is a field of the service header.

Data Type

String

url property (RNIFSender Struct)

The URL to which requests are sent.

Syntax

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

Default Value

""

Remarks

This property describes the URL location where the partner will receive the message being sent. This must be set before the message may be sent. It tells HTTP where to send the message. The URL of the partner process should be known by each of the processes.

Data Type

String

config method (RNIFSender Struct)

Sets or retrieves a configuration setting.

Syntax

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

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.

post method (RNIFSender Struct)

Posts Message to the RNIF partner.

Syntax

fn post(&self) -> Result<(), IPWorksEDIError>

Remarks

This method posts the message to the RNIF partner server. When post is called, the struct will generate, encrypt, and sign the RosettaNet message in accordance with the various message settings.

NOTE: url must be set before a call to Post.

reset method (RNIFSender Struct)

This property is used to reset all attributes of the Rnifsender instance.

Syntax

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

Remarks

reset is used to reset all attributes of the Rnifreceiver instance including the headers, attachments, etc. to their default values. This may be useful when multiple messages need to be created.

reset_headers method (RNIFSender Struct)

Resets all HTTP headers and cookies.

Syntax

fn reset_headers(&self) -> Result<(), IPWorksEDIError>

Remarks

Resets all the HTTP headers to "" (empty string). Also clears the cookies collection. Use this method before creating a new request, so that headers from the previous message are not carried over to the next one.

set_request_header method (RNIFSender Struct)

Allows the user to set or add arbitrary HTTP request headers.

Syntax

fn set_request_header(&self, header : &str, value : &str) -> Result<(), IPWorksEDIError>

Remarks

This method is used when preparing the message. It allows the user to set or add HTTP request headers as needed. You must pass this method a name of the header and a value. This method then looks to see if the header you are trying to set is already in the HTTP request message. If it is, then this method simply changes the value of the header. If it is not found, this method adds the new header.

on_connected event (RNIFSender Struct)

Fired immediately after a connection completes (or fails).

Syntax

// RNIFSenderConnectedEventArgs carries the RNIFSender Connected event's parameters.
pub struct RNIFSenderConnectedEventArgs {
  fn status_code(&self) -> i32
  fn description(&self) -> &String
}

// RNIFSenderConnectedEvent defines the signature of the RNIFSender Connected event's handler function.
pub trait RNIFSenderConnectedEvent {
  fn on_connected(&self, sender : RNIFSender, e : &mut RNIFSenderConnectedEventArgs);
}

impl <'a> RNIFSender<'a> {
  pub fn on_connected(&self) -> &'a dyn RNIFSenderConnectedEvent;
  pub fn set_on_connected(&mut self, value : &'a dyn RNIFSenderConnectedEvent);
  ...
}

Remarks

If the connection is made normally, status_code is 0 and description is "OK".

If the connection fails, status_code has the error code returned by the Transmission Control Protocol (TCP)/IP stack. description contains a description of this code. The value of status_code is equal to the value of the error.

Please refer to the Error Codes section for more information.

on_disconnected event (RNIFSender Struct)

Fired when a connection is closed.

Syntax

// RNIFSenderDisconnectedEventArgs carries the RNIFSender Disconnected event's parameters.
pub struct RNIFSenderDisconnectedEventArgs {
  fn status_code(&self) -> i32
  fn description(&self) -> &String
}

// RNIFSenderDisconnectedEvent defines the signature of the RNIFSender Disconnected event's handler function.
pub trait RNIFSenderDisconnectedEvent {
  fn on_disconnected(&self, sender : RNIFSender, e : &mut RNIFSenderDisconnectedEventArgs);
}

impl <'a> RNIFSender<'a> {
  pub fn on_disconnected(&self) -> &'a dyn RNIFSenderDisconnectedEvent;
  pub fn set_on_disconnected(&mut self, value : &'a dyn RNIFSenderDisconnectedEvent);
  ...
}

Remarks

If the connection is broken normally, status_code is 0 and description is "OK".

If the connection is broken for any other reason, status_code has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. description contains a description of this code. The value of status_code is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

on_end_transfer event (RNIFSender Struct)

Fired when a document finishes transferring.

Syntax

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

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

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

Remarks

This event is fired first when the client finishes sending data to the server (in a POST or PUT request) and then when the document text finishes transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

on_error event (RNIFSender Struct)

Fired when information is available about errors during data delivery.

Syntax

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

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

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

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the struct fails with an error.

The error_code 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 (RNIFSender Struct)

Fired every time a header line comes in.

Syntax

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

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

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

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_redirect event (RNIFSender Struct)

Fired when a redirection is received from the server.

Syntax

// RNIFSenderRedirectEventArgs carries the RNIFSender Redirect event's parameters.
pub struct RNIFSenderRedirectEventArgs {
  fn location(&self) -> &String
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// RNIFSenderRedirectEvent defines the signature of the RNIFSender Redirect event's handler function.
pub trait RNIFSenderRedirectEvent {
  fn on_redirect(&self, sender : RNIFSender, e : &mut RNIFSenderRedirectEventArgs);
}

impl <'a> RNIFSender<'a> {
  pub fn on_redirect(&self) -> &'a dyn RNIFSenderRedirectEvent;
  pub fn set_on_redirect(&mut self, value : &'a dyn RNIFSenderRedirectEvent);
  ...
}

Remarks

This event is fired in cases in which the client can decide whether or not to continue with the redirection process. The accept parameter is always True by default, but if you do not want to follow the redirection, accept may be set to False, in which case the struct fails with an error. location is the location to which the client is being redirected. Further control over redirection is provided in the follow_redirects property.

on_set_cookie event (RNIFSender Struct)

Fired for every cookie set by the server.

Syntax

// RNIFSenderSetCookieEventArgs carries the RNIFSender SetCookie event's parameters.
pub struct RNIFSenderSetCookieEventArgs {
  fn name(&self) -> &String
  fn value(&self) -> &String
  fn expires(&self) -> &String
  fn domain(&self) -> &String
  fn path(&self) -> &String
  fn secure(&self) -> bool
}

// RNIFSenderSetCookieEvent defines the signature of the RNIFSender SetCookie event's handler function.
pub trait RNIFSenderSetCookieEvent {
  fn on_set_cookie(&self, sender : RNIFSender, e : &mut RNIFSenderSetCookieEventArgs);
}

impl <'a> RNIFSender<'a> {
  pub fn on_set_cookie(&self) -> &'a dyn RNIFSenderSetCookieEvent;
  pub fn set_on_set_cookie(&mut self, value : &'a dyn RNIFSenderSetCookieEvent);
  ...
}

Remarks

This event is fired for every Set-Cookie: header received from the HTTP server.

The name parameter contains the name of the cookie, with the corresponding value supplied in the value parameter.

The expires parameter contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, the expires parameter will be an empty string. In this case, the convention is to drop the cookie at the end of the session.

The domain parameter contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, the domain parameter will be an empty string. The convention in this case is to use the server specified in the URL (url_server) as the cookie domain.

The path parameter contains a path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the path parameter will be an empty string. The convention in this case is to use the path specified in the URL (url_path) as the cookie path.

The secure parameter specifies whether the cookie is secure. If the value of this parameter is True, the cookie value must be submitted only through a secure (HTTPS) connection.

on_ssl_server_authentication event (RNIFSender Struct)

Fired after the server presents its certificate to the client.

Syntax

// RNIFSenderSSLServerAuthenticationEventArgs carries the RNIFSender SSLServerAuthentication event's parameters.
pub struct RNIFSenderSSLServerAuthenticationEventArgs {
  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)
}

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

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

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

Fired when secure connection progress messages are available.

Syntax

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

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

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

Remarks

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

on_start_transfer event (RNIFSender Struct)

Fired when a document starts transferring (after the headers).

Syntax

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

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

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

Remarks

This event is fired first when the client starts sending data to the server (in a POST or PUT request) and then when the document text starts transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

on_transfer event (RNIFSender Struct)

Fired while a document transfers (delivers document).

Syntax

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

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

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

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 bytes_transferred 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 (RNIFSender Struct)

The struct accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these internal properties is provided through the config method.

RNIFSender Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (RNIFSender Struct)

SMIME Errors

XML Errors

HTTP Errors

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

TCPClient Errors

TCP/IP Errors