RNIFReceiver Class

Properties   Methods   Events   Config Settings   Errors  

The RNIFReceiver class implements a RosettaNet server.

Syntax

class ipworksedi.RNIFReceiver

Remarks

The RNIFReceiver implements server-side receiving of RosettaNet messages, as specified by the RosettaNet community. It can be used to decrypt and verify incoming messages and to generate synchronous receipts and replies if needed. The class is designed to be easily incorporated into an HTTP server. RosettaNet is used in a variety of industries including Semiconductor Manufacturing, Electronic Components, Telecommunications, Logistics, the Chemical Industry (through CIDX), and more.

BASIC OPERATION

When a RosettaNet request comes in, you should first call the read_request method to read in the request. Once this is done, you must parse the headers and the request. You first parse the headers of the HTTP request using the parse_headers method. You may then set the appropriate certificates by setting the certificate to your private key certificate and signer_cert to your trading partner's (signing) certificate.

The next step is to parse the RosettaNet message using parse_request. This method decrypts the message if needed. The class then parses all parts of the message. The preamble, delivery, and service headers are all parsed into the preamble_header_xml, delivery_header_xml, and the service_header_xml, respectively. It also parses the actual body of the RosettaNet message, or the PIP, into the service_content. Any attachments that may be in the message are parsed into the attachment array, and may be accessed via the attachments property.

The class can also be used to handle synchronous responses. In order to complete this task, the receiver must first reset all header properties to values appropriate for a response. This may include changing values such as the message_sender_id, message_receiver_id, action_code, etc. The service_content should then be set to a response indicating the state of the transaction. A typical response is a simple receipt acknowledgement, which has all qualities of a valid RosettaNet action, but is simply a receipt. Once these properties have been set, the message is ready to be sent using the send_response method.

NOTE: the RNIFReceiver Class can only handle sending synchronous responses. If an asynchronous response is desired, or required by a particular Partner Interface Process (PIP), you should use the RNIFSender class.

The following example illustrates how to use the class within a web page.

EXAMPLE

RNIFReceiver.ReadRequest(); RNIFReceiver.Certificate = new Certificate(CertStoreTypes.cstPFXFile, // Store type "\my_server_directory\encrypt.pfx", // File name "my password", // Password "CN=Encrypt"); // Subject RNIFReceiver.SignerCert = new Certificate("\my_server_directory\partnercert.cer"); RNIFReceiver.ParseHeaders(); RNIFReceiver.ParseRequest();

The server can then get the data from the preamble header, delivery header, service header, and the PIP content from their properties: preamble_header_xml, delivery_header_xml, service_header_xml<;, and the service_content, respectively. The message may then be easily processed, as all details of the transaction will be populated into their respective properties.

NOTE: Any attachments are saved by the name in the corresponding attachments entry, and in the directory specified by the receiver. The directory is specified using the AttachmentOutputPath config property, and must be specified before you read and process the request. For example:

RNIFReceiver.Config("AttachmentOutputPath='\my_server_directory\Attachments'")

NOTE: In the above example, a receipt acknowledgement was not sent.

Additional functionality allows the user to examine details of the client's request, to permit certain types of errors, or to customize the RosettaNet response message. See the property and method list for details.

Property List

---

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

Method List

---

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

Event List

---

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

Config Settings

---

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

action_code property

The code for this action.

Syntax

def get_action_code() -> str: ...

def set_action_code(value: str) -> None: ...


action_code = property(get_action_code, set_action_code)

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.

action_message property

Whether or not this message is an action message.

Syntax

def get_action_message() -> bool: ...

def set_action_message(value: bool) -> None: ...


action_message = property(get_action_message, set_action_message)

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.

action_message_standard_name property

The name of the standard used to create this action.

Syntax

def get_action_message_standard_name() -> str: ...

def set_action_message_standard_name(value: str) -> None: ...


action_message_standard_name = property(get_action_message_standard_name, set_action_message_standard_name)

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.

action_message_standard_version property

The version of the standard used to create this action.

Syntax

def get_action_message_standard_version() -> str: ...

def set_action_message_standard_version(value: str) -> None: ...


action_message_standard_version = property(get_action_message_standard_version, set_action_message_standard_version)

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.

attachment_count property

The number of records in the Attachment arrays.

Syntax

def get_attachment_count() -> int: ...

def set_attachment_count(value: int) -> None: ...


attachment_count = property(get_attachment_count, set_attachment_count)

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.

attachment_data property

Data contains the raw data of the current attachment.

Syntax

def get_attachment_data(attachment_index: int) -> bytes: ...

def set_attachment_data(attachment_index: int, value: bytes) -> None: ...

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 attachment_index parameter specifies the index of the item in the array. The size of the array is controlled by the attachment_count property.

attachment_description property

Description contains descriptions for this attachment.

Syntax

def get_attachment_description(attachment_index: int) -> str: ...

def set_attachment_description(attachment_index: int, value: str) -> None: ...

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 attachment_index parameter specifies the index of the item in the array. The size of the array is controlled by the attachment_count property.

attachment_file_name property

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

Syntax

def get_attachment_file_name(attachment_index: int) -> str: ...

def set_attachment_file_name(attachment_index: int, value: str) -> None: ...

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 class 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 attachment_index parameter specifies the index of the item in the array. The size of the array is controlled by the attachment_count property.

attachment_id property

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

Syntax

def get_attachment_id(attachment_index: int) -> str: ...

def set_attachment_id(attachment_index: int, value: str) -> None: ...

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 attachment_index parameter specifies the index of the item in the array. The size of the array is controlled by the attachment_count property.

attachment_mime_type property

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

Syntax

def get_attachment_mime_type(attachment_index: int) -> str: ...

def set_attachment_mime_type(attachment_index: int, value: str) -> None: ...

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 attachment_index parameter specifies the index of the item in the array. The size of the array is controlled by the attachment_count property.

business_activity property

This property denotes the type of business activity.

Syntax

def get_business_activity() -> str: ...

def set_business_activity(value: str) -> None: ...


business_activity = property(get_business_activity, set_business_activity)

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

cert_effective_date property

The date on which this certificate becomes valid.

Syntax

def get_cert_effective_date() -> str: ...


cert_effective_date = property(get_cert_effective_date, None)

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.

cert_encoded property

The certificate (PEM/Base64 encoded).

Syntax

def get_cert_encoded() -> bytes: ...

def set_cert_encoded(value: bytes) -> None: ...


cert_encoded = property(get_cert_encoded, set_cert_encoded)

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.

cert_expiration_date property

The date on which the certificate expires.

Syntax

def get_cert_expiration_date() -> str: ...


cert_expiration_date = property(get_cert_expiration_date, None)

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.

cert_extended_key_usage property

A comma-delimited list of extended key usage identifiers.

Syntax

def get_cert_extended_key_usage() -> str: ...


cert_extended_key_usage = property(get_cert_extended_key_usage, None)

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.

cert_fingerprint property

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

Syntax

def get_cert_fingerprint() -> str: ...


cert_fingerprint = property(get_cert_fingerprint, None)

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.

cert_fingerprint_sha1 property

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

Syntax

def get_cert_fingerprint_sha1() -> str: ...


cert_fingerprint_sha1 = property(get_cert_fingerprint_sha1, None)

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.

cert_fingerprint_sha256 property

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

Syntax

def get_cert_fingerprint_sha256() -> str: ...


cert_fingerprint_sha256 = property(get_cert_fingerprint_sha256, None)

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.

cert_issuer property

The issuer of the certificate.

Syntax

def get_cert_issuer() -> str: ...


cert_issuer = property(get_cert_issuer, None)

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.

cert_private_key property

The private key of the certificate (if available).

Syntax

def get_cert_private_key() -> str: ...


cert_private_key = property(get_cert_private_key, None)

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.

cert_private_key_available property

Whether a PrivateKey is available for the selected certificate.

Syntax

def get_cert_private_key_available() -> bool: ...


cert_private_key_available = property(get_cert_private_key_available, None)

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.

cert_private_key_container property

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

Syntax

def get_cert_private_key_container() -> str: ...


cert_private_key_container = property(get_cert_private_key_container, None)

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.

cert_public_key property

The public key of the certificate.

Syntax

def get_cert_public_key() -> str: ...


cert_public_key = property(get_cert_public_key, None)

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

cert_public_key_algorithm property

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

Syntax

def get_cert_public_key_algorithm() -> str: ...


cert_public_key_algorithm = property(get_cert_public_key_algorithm, None)

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.

cert_public_key_length property

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

Syntax

def get_cert_public_key_length() -> int: ...


cert_public_key_length = property(get_cert_public_key_length, None)

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.

cert_serial_number property

The serial number of the certificate encoded as a string.

Syntax

def get_cert_serial_number() -> str: ...


cert_serial_number = property(get_cert_serial_number, None)

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.

cert_signature_algorithm property

The text description of the certificate's signature algorithm.

Syntax

def get_cert_signature_algorithm() -> str: ...


cert_signature_algorithm = property(get_cert_signature_algorithm, None)

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.

cert_store property

The name of the certificate store for the client certificate.

Syntax

def get_cert_store() -> bytes: ...

def set_cert_store(value: bytes) -> None: ...


cert_store = property(get_cert_store, set_cert_store)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

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

cert_store_password property

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

Syntax

def get_cert_store_password() -> str: ...

def set_cert_store_password(value: str) -> None: ...


cert_store_password = property(get_cert_store_password, set_cert_store_password)

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.

cert_store_type property

The type of certificate store for this certificate.

Syntax

def get_cert_store_type() -> int: ...

def set_cert_store_type(value: int) -> None: ...


cert_store_type = property(get_cert_store_type, set_cert_store_type)

Possible Values

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

Default Value

0

Remarks

The type of certificate store for this certificate.

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

cert_subject property

The subject of the certificate used for client authentication.

Syntax

def get_cert_subject() -> str: ...

def set_cert_subject(value: str) -> None: ...


cert_subject = property(get_cert_subject, set_cert_subject)

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

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

cert_subject_alt_names property

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

Syntax

def get_cert_subject_alt_names() -> str: ...


cert_subject_alt_names = property(get_cert_subject_alt_names, None)

Default Value

""

Remarks

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

This property is read-only.

cert_thumbprint_md5 property

The MD5 hash of the certificate.

Syntax

def get_cert_thumbprint_md5() -> str: ...


cert_thumbprint_md5 = property(get_cert_thumbprint_md5, None)

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.

cert_thumbprint_sha1 property

The SHA-1 hash of the certificate.

Syntax

def get_cert_thumbprint_sha1() -> str: ...


cert_thumbprint_sha1 = property(get_cert_thumbprint_sha1, None)

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.

cert_thumbprint_sha256 property

The SHA-256 hash of the certificate.

Syntax

def get_cert_thumbprint_sha256() -> str: ...


cert_thumbprint_sha256 = property(get_cert_thumbprint_sha256, None)

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.

cert_usage property

The text description of UsageFlags .

Syntax

def get_cert_usage() -> str: ...


cert_usage = property(get_cert_usage, None)

Default Value

""

Remarks

The text description of cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

cert_usage_flags property

The flags that show intended use for the certificate.

Syntax

def get_cert_usage_flags() -> int: ...


cert_usage_flags = property(get_cert_usage_flags, None)

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.

cert_version property

The certificate's version number.

Syntax

def get_cert_version() -> str: ...


cert_version = property(get_cert_version, None)

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

delivery_header_xml property

The complete XML data from the Delivery Header.

Syntax

def get_delivery_header_xml() -> str: ...

def set_delivery_header_xml(value: str) -> None: ...


delivery_header_xml = property(get_delivery_header_xml, set_delivery_header_xml)

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

encryption_algorithm property

The algorithm used to encrypt the EDI data.

Syntax

def get_encryption_algorithm() -> str: ...

def set_encryption_algorithm(value: str) -> None: ...


encryption_algorithm = property(get_encryption_algorithm, set_encryption_algorithm)

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 class supports "AESCBC256", or industry-standard 256-bit AES-CBC encryption, by default.

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

encryption_type property

The encryption type for RNIF 2.0.

Syntax

def get_encryption_type() -> int: ...

def set_encryption_type(value: int) -> None: ...


encryption_type = property(get_encryption_type, set_encryption_type)

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.

from_role property

The business role of the entity that originated this message.

Syntax

def get_from_role() -> str: ...

def set_from_role(value: str) -> None: ...


from_role = property(get_from_role, set_from_role)

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.

from_service property

The service that originated this message.

Syntax

def get_from_service() -> str: ...

def set_from_service(value: str) -> None: ...


from_service = property(get_from_service, set_from_service)

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.

global_usage_code property

A universal code describing basic usage for this message.

Syntax

def get_global_usage_code() -> int: ...

def set_global_usage_code(value: int) -> None: ...


global_usage_code = property(get_global_usage_code, set_global_usage_code)

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.

message_date_time property

The time at which this message was sent.

Syntax

def get_message_date_time() -> str: ...

def set_message_date_time(value: str) -> None: ...


message_date_time = property(get_message_date_time, set_message_date_time)

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.

message_receiver_id property

Identity of the entity receiving this message.

Syntax

def get_message_receiver_id() -> str: ...

def set_message_receiver_id(value: str) -> None: ...


message_receiver_id = property(get_message_receiver_id, set_message_receiver_id)

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.

message_receiver_location property

Location of the entity receiving this message.

Syntax

def get_message_receiver_location() -> str: ...

def set_message_receiver_location(value: str) -> None: ...


message_receiver_location = property(get_message_receiver_location, set_message_receiver_location)

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.

message_sender_id property

Identity of the entity that sent this message.

Syntax

def get_message_sender_id() -> str: ...

def set_message_sender_id(value: str) -> None: ...


message_sender_id = property(get_message_sender_id, set_message_sender_id)

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.

message_sender_location property

Location of the entity that sent this message.

Syntax

def get_message_sender_location() -> str: ...

def set_message_sender_location(value: str) -> None: ...


message_sender_location = property(get_message_sender_location, set_message_sender_location)

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.

message_tracking_id property

Unique value that identifies this message.

Syntax

def get_message_tracking_id() -> str: ...

def set_message_tracking_id(value: str) -> None: ...


message_tracking_id = property(get_message_tracking_id, set_message_tracking_id)

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.

original_action_code property

The action code of the original message.

Syntax

def get_original_action_code() -> str: ...

def set_original_action_code(value: str) -> None: ...


original_action_code = property(get_original_action_code, set_original_action_code)

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.

original_message_standard_name property

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

Syntax

def get_original_message_standard_name() -> str: ...

def set_original_message_standard_name(value: str) -> None: ...


original_message_standard_name = property(get_original_message_standard_name, set_original_message_standard_name)

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.

original_message_standard_version property

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

Syntax

def get_original_message_standard_version() -> str: ...

def set_original_message_standard_version(value: str) -> None: ...


original_message_standard_version = property(get_original_message_standard_version, set_original_message_standard_version)

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.

original_message_tracking_id property

Tracking identifier for the original message.

Syntax

def get_original_message_tracking_id() -> str: ...

def set_original_message_tracking_id(value: str) -> None: ...


original_message_tracking_id = property(get_original_message_tracking_id, set_original_message_tracking_id)

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.

partner_id property

Identity of the partner.

Syntax

def get_partner_id() -> str: ...

def set_partner_id(value: str) -> None: ...


partner_id = property(get_partner_id, set_partner_id)

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.

partner_known property

Whether or not the partner is known.

Syntax

def get_partner_known() -> bool: ...

def set_partner_known(value: bool) -> None: ...


partner_known = property(get_partner_known, set_partner_known)

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.

partner_location property

Location of the partner.

Syntax

def get_partner_location() -> str: ...

def set_partner_location(value: str) -> None: ...


partner_location = property(get_partner_location, set_partner_location)

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.

partner_pip_binding_id property

The partner-defined PIP payload binding ID.

Syntax

def get_partner_pip_binding_id() -> str: ...

def set_partner_pip_binding_id(value: str) -> None: ...


partner_pip_binding_id = property(get_partner_pip_binding_id, set_partner_pip_binding_id)

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.

partner_url property

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

Syntax

def get_partner_url() -> str: ...

def set_partner_url(value: str) -> None: ...


partner_url = property(get_partner_url, set_partner_url)

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.

pip_code property

RosettaNet PIP code of this message.

Syntax

def get_pip_code() -> str: ...

def set_pip_code(value: str) -> None: ...


pip_code = property(get_pip_code, set_pip_code)

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.

pip_instance_id property

The Id of this PIP instance.

Syntax

def get_pip_instance_id() -> str: ...

def set_pip_instance_id(value: str) -> None: ...


pip_instance_id = property(get_pip_instance_id, set_pip_instance_id)

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.

pip_version property

RosettaNet PIP version of this message.

Syntax

def get_pip_version() -> str: ...

def set_pip_version(value: str) -> None: ...


pip_version = property(get_pip_version, set_pip_version)

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.

preamble_header_xml property

The complete XML data from the Preamble Header.

Syntax

def get_preamble_header_xml() -> str: ...

def set_preamble_header_xml(value: str) -> None: ...


preamble_header_xml = property(get_preamble_header_xml, set_preamble_header_xml)

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

qos_specification_count property

The number of records in the QOSSpecification arrays.

Syntax

def get_qos_specification_count() -> int: ...

def set_qos_specification_count(value: int) -> None: ...


qos_specification_count = property(get_qos_specification_count, set_qos_specification_count)

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.

qos_specification_code property

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

Syntax

def get_qos_specification_code(qos_index: int) -> str: ...

def set_qos_specification_code(qos_index: int, value: str) -> None: ...

Default Value

""

Remarks

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

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

qos_specification_value property

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

Syntax

def get_qos_specification_value(qos_index: int) -> str: ...

def set_qos_specification_value(qos_index: int, value: str) -> None: ...

Default Value

""

Remarks

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

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

recipient_cert_effective_date property

The date on which this certificate becomes valid.

Syntax

def get_recipient_cert_effective_date() -> str: ...


recipient_cert_effective_date = property(get_recipient_cert_effective_date, None)

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.

recipient_cert_encoded property

The certificate (PEM/Base64 encoded).

Syntax

def get_recipient_cert_encoded() -> bytes: ...

def set_recipient_cert_encoded(value: bytes) -> None: ...


recipient_cert_encoded = property(get_recipient_cert_encoded, set_recipient_cert_encoded)

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.

recipient_cert_expiration_date property

The date on which the certificate expires.

Syntax

def get_recipient_cert_expiration_date() -> str: ...


recipient_cert_expiration_date = property(get_recipient_cert_expiration_date, None)

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.

recipient_cert_extended_key_usage property

A comma-delimited list of extended key usage identifiers.

Syntax

def get_recipient_cert_extended_key_usage() -> str: ...


recipient_cert_extended_key_usage = property(get_recipient_cert_extended_key_usage, None)

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.

recipient_cert_fingerprint property

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

Syntax

def get_recipient_cert_fingerprint() -> str: ...


recipient_cert_fingerprint = property(get_recipient_cert_fingerprint, None)

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.

recipient_cert_fingerprint_sha1 property

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

Syntax

def get_recipient_cert_fingerprint_sha1() -> str: ...


recipient_cert_fingerprint_sha1 = property(get_recipient_cert_fingerprint_sha1, None)

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.

recipient_cert_fingerprint_sha256 property

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

Syntax

def get_recipient_cert_fingerprint_sha256() -> str: ...


recipient_cert_fingerprint_sha256 = property(get_recipient_cert_fingerprint_sha256, None)

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.

recipient_cert_issuer property

The issuer of the certificate.

Syntax

def get_recipient_cert_issuer() -> str: ...


recipient_cert_issuer = property(get_recipient_cert_issuer, None)

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.

recipient_cert_private_key property

The private key of the certificate (if available).

Syntax

def get_recipient_cert_private_key() -> str: ...


recipient_cert_private_key = property(get_recipient_cert_private_key, None)

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.

recipient_cert_private_key_available property

Whether a PrivateKey is available for the selected certificate.

Syntax

def get_recipient_cert_private_key_available() -> bool: ...


recipient_cert_private_key_available = property(get_recipient_cert_private_key_available, None)

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.

recipient_cert_private_key_container property

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

Syntax

def get_recipient_cert_private_key_container() -> str: ...


recipient_cert_private_key_container = property(get_recipient_cert_private_key_container, None)

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.

recipient_cert_public_key property

The public key of the certificate.

Syntax

def get_recipient_cert_public_key() -> str: ...


recipient_cert_public_key = property(get_recipient_cert_public_key, None)

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

recipient_cert_public_key_algorithm property

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

Syntax

def get_recipient_cert_public_key_algorithm() -> str: ...


recipient_cert_public_key_algorithm = property(get_recipient_cert_public_key_algorithm, None)

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.

recipient_cert_public_key_length property

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

Syntax

def get_recipient_cert_public_key_length() -> int: ...


recipient_cert_public_key_length = property(get_recipient_cert_public_key_length, None)

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.

recipient_cert_serial_number property

The serial number of the certificate encoded as a string.

Syntax

def get_recipient_cert_serial_number() -> str: ...


recipient_cert_serial_number = property(get_recipient_cert_serial_number, None)

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.

recipient_cert_signature_algorithm property

The text description of the certificate's signature algorithm.

Syntax

def get_recipient_cert_signature_algorithm() -> str: ...


recipient_cert_signature_algorithm = property(get_recipient_cert_signature_algorithm, None)

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.

recipient_cert_store property

The name of the certificate store for the client certificate.

Syntax

def get_recipient_cert_store() -> bytes: ...

def set_recipient_cert_store(value: bytes) -> None: ...


recipient_cert_store = property(get_recipient_cert_store, set_recipient_cert_store)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

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

recipient_cert_store_password property

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

Syntax

def get_recipient_cert_store_password() -> str: ...

def set_recipient_cert_store_password(value: str) -> None: ...


recipient_cert_store_password = property(get_recipient_cert_store_password, set_recipient_cert_store_password)

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.

recipient_cert_store_type property

The type of certificate store for this certificate.

Syntax

def get_recipient_cert_store_type() -> int: ...

def set_recipient_cert_store_type(value: int) -> None: ...


recipient_cert_store_type = property(get_recipient_cert_store_type, set_recipient_cert_store_type)

Possible Values

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

Default Value

0

Remarks

The type of certificate store for this certificate.

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

recipient_cert_subject property

The subject of the certificate used for client authentication.

Syntax

def get_recipient_cert_subject() -> str: ...

def set_recipient_cert_subject(value: str) -> None: ...


recipient_cert_subject = property(get_recipient_cert_subject, set_recipient_cert_subject)

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

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

recipient_cert_subject_alt_names property

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

Syntax

def get_recipient_cert_subject_alt_names() -> str: ...


recipient_cert_subject_alt_names = property(get_recipient_cert_subject_alt_names, None)

Default Value

""

Remarks

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

This property is read-only.

recipient_cert_thumbprint_md5 property

The MD5 hash of the certificate.

Syntax

def get_recipient_cert_thumbprint_md5() -> str: ...


recipient_cert_thumbprint_md5 = property(get_recipient_cert_thumbprint_md5, None)

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.

recipient_cert_thumbprint_sha1 property

The SHA-1 hash of the certificate.

Syntax

def get_recipient_cert_thumbprint_sha1() -> str: ...


recipient_cert_thumbprint_sha1 = property(get_recipient_cert_thumbprint_sha1, None)

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.

recipient_cert_thumbprint_sha256 property

The SHA-256 hash of the certificate.

Syntax

def get_recipient_cert_thumbprint_sha256() -> str: ...


recipient_cert_thumbprint_sha256 = property(get_recipient_cert_thumbprint_sha256, None)

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.

recipient_cert_usage property

The text description of UsageFlags .

Syntax

def get_recipient_cert_usage() -> str: ...


recipient_cert_usage = property(get_recipient_cert_usage, None)

Default Value

""

Remarks

The text description of recipient_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

recipient_cert_usage_flags property

The flags that show intended use for the certificate.

Syntax

def get_recipient_cert_usage_flags() -> int: ...


recipient_cert_usage_flags = property(get_recipient_cert_usage_flags, None)

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.

recipient_cert_version property

The certificate's version number.

Syntax

def get_recipient_cert_version() -> str: ...


recipient_cert_version = property(get_recipient_cert_version, None)

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

reply_message property

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

Syntax

def get_reply_message() -> bool: ...

def set_reply_message(value: bool) -> None: ...


reply_message = property(get_reply_message, set_reply_message)

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.

request property

The HTTP request to be processed.

Syntax

def get_request() -> bytes: ...

def set_request(value: bytes) -> None: ...


request = property(get_request, set_request)

Default Value

""

Remarks

This property holds the body of the request to be processed. The HTTP headers may be set separately in request_headers or may be included in request. If they are included, a double CRLF pair should be used to separate the headers from the body.

When read_request is called the contents of request are overwritten.

request_header_count property

The number of records in the RequestHeader arrays.

Syntax

def get_request_header_count() -> int: ...

def set_request_header_count(value: int) -> None: ...


request_header_count = property(get_request_header_count, set_request_header_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• request_header_field
• request_header_value

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

request_header_field property

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

Syntax

def get_request_header_field(request_header_index: int) -> str: ...

def set_request_header_field(request_header_index: int, value: str) -> None: ...

Default Value

""

Remarks

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

The request_header_index parameter specifies the index of the item in the array. The size of the array is controlled by the request_header_count property.

request_header_value property

This property contains the header contents.

Syntax

def get_request_header_value(request_header_index: int) -> str: ...

def set_request_header_value(request_header_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the Header contents.

The request_header_index parameter specifies the index of the item in the array. The size of the array is controlled by the request_header_count property.

request_headers_string property

The HTTP headers in the RNIF request.

Syntax

def get_request_headers_string() -> str: ...

def set_request_headers_string(value: str) -> None: ...


request_headers_string = property(get_request_headers_string, set_request_headers_string)

Default Value

""

Remarks

The entire list of headers, concatenated into a single string. These will include RNIF-specific headers as well as general HTTP headers. You may access specific headers through request_headers.

When assigning an RNIF request to the component, the headers may be included in request or specified separately in request_headers or request_headers_string. If the headers are included in request they will be parsed out whenever read_request, parse_request, or process_request is invoked.

response_type property

Requested response type. Available only in RNIF 2.0.

Syntax

def get_response_type() -> int: ...


response_type = property(get_response_type, None)

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.

This property is read-only.

rnif_version property

The RNIF Standard Version used to generate this message.

Syntax

def get_rnif_version() -> int: ...


rnif_version = property(get_rnif_version, None)

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

This property is read-only.

secure_transport_required property

Indicates that security is required when forwarding this message.

Syntax

def get_secure_transport_required() -> bool: ...

def set_secure_transport_required(value: bool) -> None: ...


secure_transport_required = property(get_secure_transport_required, set_secure_transport_required)

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.

service_content property

The PIP message data.

Syntax

def get_service_content() -> str: ...

def set_service_content(value: str) -> None: ...


service_content = property(get_service_content, set_service_content)

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.

service_header_xml property

The complete XML data from the Service Header.

Syntax

def get_service_header_xml() -> str: ...

def set_service_header_xml(value: str) -> None: ...


service_header_xml = property(get_service_header_xml, set_service_header_xml)

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

signal_code property

The code for this signal.

Syntax

def get_signal_code() -> str: ...

def set_signal_code(value: str) -> None: ...


signal_code = property(get_signal_code, set_signal_code)

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.

signal_message property

Whether or not this message is a signal.

Syntax

def get_signal_message() -> bool: ...

def set_signal_message(value: bool) -> None: ...


signal_message = property(get_signal_message, set_signal_message)

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.

signal_version property

The version of this signal.

Syntax

def get_signal_version() -> str: ...

def set_signal_version(value: str) -> None: ...


signal_version = property(get_signal_version, set_signal_version)

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.

signer_cert_effective_date property

The date on which this certificate becomes valid.

Syntax

def get_signer_cert_effective_date() -> str: ...


signer_cert_effective_date = property(get_signer_cert_effective_date, None)

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.

signer_cert_encoded property

The certificate (PEM/Base64 encoded).

Syntax

def get_signer_cert_encoded() -> bytes: ...

def set_signer_cert_encoded(value: bytes) -> None: ...


signer_cert_encoded = property(get_signer_cert_encoded, set_signer_cert_encoded)

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.

signer_cert_expiration_date property

The date on which the certificate expires.

Syntax

def get_signer_cert_expiration_date() -> str: ...


signer_cert_expiration_date = property(get_signer_cert_expiration_date, None)

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.

signer_cert_extended_key_usage property

A comma-delimited list of extended key usage identifiers.

Syntax

def get_signer_cert_extended_key_usage() -> str: ...


signer_cert_extended_key_usage = property(get_signer_cert_extended_key_usage, None)

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.

signer_cert_fingerprint property

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

Syntax

def get_signer_cert_fingerprint() -> str: ...


signer_cert_fingerprint = property(get_signer_cert_fingerprint, None)

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.

signer_cert_fingerprint_sha1 property

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

Syntax

def get_signer_cert_fingerprint_sha1() -> str: ...


signer_cert_fingerprint_sha1 = property(get_signer_cert_fingerprint_sha1, None)

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.

signer_cert_fingerprint_sha256 property

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

Syntax

def get_signer_cert_fingerprint_sha256() -> str: ...


signer_cert_fingerprint_sha256 = property(get_signer_cert_fingerprint_sha256, None)

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.

signer_cert_issuer property

The issuer of the certificate.

Syntax

def get_signer_cert_issuer() -> str: ...


signer_cert_issuer = property(get_signer_cert_issuer, None)

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.

signer_cert_private_key property

The private key of the certificate (if available).

Syntax

def get_signer_cert_private_key() -> str: ...


signer_cert_private_key = property(get_signer_cert_private_key, None)

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.

signer_cert_private_key_available property

Whether a PrivateKey is available for the selected certificate.

Syntax

def get_signer_cert_private_key_available() -> bool: ...


signer_cert_private_key_available = property(get_signer_cert_private_key_available, None)

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.

signer_cert_private_key_container property

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

Syntax

def get_signer_cert_private_key_container() -> str: ...


signer_cert_private_key_container = property(get_signer_cert_private_key_container, None)

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.

signer_cert_public_key property

The public key of the certificate.

Syntax

def get_signer_cert_public_key() -> str: ...


signer_cert_public_key = property(get_signer_cert_public_key, None)

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

signer_cert_public_key_algorithm property

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

Syntax

def get_signer_cert_public_key_algorithm() -> str: ...


signer_cert_public_key_algorithm = property(get_signer_cert_public_key_algorithm, None)

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.

signer_cert_public_key_length property

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

Syntax

def get_signer_cert_public_key_length() -> int: ...


signer_cert_public_key_length = property(get_signer_cert_public_key_length, None)

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.

signer_cert_serial_number property

The serial number of the certificate encoded as a string.

Syntax

def get_signer_cert_serial_number() -> str: ...


signer_cert_serial_number = property(get_signer_cert_serial_number, None)

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.

signer_cert_signature_algorithm property

The text description of the certificate's signature algorithm.

Syntax

def get_signer_cert_signature_algorithm() -> str: ...


signer_cert_signature_algorithm = property(get_signer_cert_signature_algorithm, None)

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.

signer_cert_store property

The name of the certificate store for the client certificate.

Syntax

def get_signer_cert_store() -> bytes: ...

def set_signer_cert_store(value: bytes) -> None: ...


signer_cert_store = property(get_signer_cert_store, set_signer_cert_store)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

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

signer_cert_store_password property

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

Syntax

def get_signer_cert_store_password() -> str: ...

def set_signer_cert_store_password(value: str) -> None: ...


signer_cert_store_password = property(get_signer_cert_store_password, set_signer_cert_store_password)

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.

signer_cert_store_type property

The type of certificate store for this certificate.

Syntax

def get_signer_cert_store_type() -> int: ...

def set_signer_cert_store_type(value: int) -> None: ...


signer_cert_store_type = property(get_signer_cert_store_type, set_signer_cert_store_type)

Possible Values

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

Default Value

0

Remarks

The type of certificate store for this certificate.

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

signer_cert_subject property

The subject of the certificate used for client authentication.

Syntax

def get_signer_cert_subject() -> str: ...

def set_signer_cert_subject(value: str) -> None: ...


signer_cert_subject = property(get_signer_cert_subject, set_signer_cert_subject)

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

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

signer_cert_subject_alt_names property

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

Syntax

def get_signer_cert_subject_alt_names() -> str: ...


signer_cert_subject_alt_names = property(get_signer_cert_subject_alt_names, None)

Default Value

""

Remarks

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

This property is read-only.

signer_cert_thumbprint_md5 property

The MD5 hash of the certificate.

Syntax

def get_signer_cert_thumbprint_md5() -> str: ...


signer_cert_thumbprint_md5 = property(get_signer_cert_thumbprint_md5, None)

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.

signer_cert_thumbprint_sha1 property

The SHA-1 hash of the certificate.

Syntax

def get_signer_cert_thumbprint_sha1() -> str: ...


signer_cert_thumbprint_sha1 = property(get_signer_cert_thumbprint_sha1, None)

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.

signer_cert_thumbprint_sha256 property

The SHA-256 hash of the certificate.

Syntax

def get_signer_cert_thumbprint_sha256() -> str: ...


signer_cert_thumbprint_sha256 = property(get_signer_cert_thumbprint_sha256, None)

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.

signer_cert_usage property

The text description of UsageFlags .

Syntax

def get_signer_cert_usage() -> str: ...


signer_cert_usage = property(get_signer_cert_usage, None)

Default Value

""

Remarks

The text description of signer_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

signer_cert_usage_flags property

The flags that show intended use for the certificate.

Syntax

def get_signer_cert_usage_flags() -> int: ...


signer_cert_usage_flags = property(get_signer_cert_usage_flags, None)

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.

signer_cert_version property

The certificate's version number.

Syntax

def get_signer_cert_version() -> str: ...


signer_cert_version = property(get_signer_cert_version, None)

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

standard_name property

The name of the standard used to create this message.

Syntax

def get_standard_name() -> str: ...

def set_standard_name(value: str) -> None: ...


standard_name = property(get_standard_name, set_standard_name)

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.

standard_version property

The version of the standard used to create this message.

Syntax

def get_standard_version() -> str: ...

def set_standard_version(value: str) -> None: ...


standard_version = property(get_standard_version, set_standard_version)

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.

to_role property

The role of the entity receiving this message.

Syntax

def get_to_role() -> str: ...

def set_to_role(value: str) -> None: ...


to_role = property(get_to_role, set_to_role)

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.

to_service property

The service for which this message is bound.

Syntax

def get_to_service() -> str: ...

def set_to_service(value: str) -> None: ...


to_service = property(get_to_service, set_to_service)

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.

config method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

parse_headers method

Processes the headers, and populates the appropriate properties.

Syntax

def parse_headers() -> None: ...

Remarks

When this method is called, the headers are parsed from the HTTP request. Based on the headers, the class will set the rnif_version and response_type properties. After parse_headers is called, these two properties should be polled to determine how the message should be handled.

parse_request method

Parses the MIME message in the request property.

Syntax

def parse_request() -> None: ...

Remarks

Once the message is acquired from the sender and the rnif_version and response_type properties have been parsed out, this method should be called to MIME decode the RosettaNet message, verify the signature if present, and decrypt the service content if needed. The preamble_header_xml, delivery_header_xml, service_header_xml and service_content properties are all populated, as well as the attachment properties, if any exist.

NOTE: before calling this method, the message must be read from the server via a call to read_request.

read_request method

Reads the RNIF request from the given HTTP servlet request.

Syntax

def read_request() -> None: ...

Remarks

This method acquires the request from the HTTP servlet. Once this is done, read_request then calls parse_headers, which parses the headers for the acquired message.

request_header method

Gets the specified header from the HTTP request.

Syntax

def request_header(header: str) -> str: ...

Remarks

This method is invoked to return a specific header from the HTTP request. Header is the name of a header from the incoming HTTP request. The method will return either the value of that header or the empty string if the header did not exist.

reset method

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

Syntax

def reset() -> None: ...

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.

NOTE: The application should always call Reset and set all message properties to valid value before sending a response message.

send_response method

Optional. Acknowledges the incoming request.

Syntax

def send_response() -> None: ...

Remarks

This sends a signal to the client. The signal may be a receipt of acknowledgement or a notification of failure. send_response will send the response message synchronously over the original HTTP connection. If an asynchronous response is requested by the client or required by the PIP, you should use the RNIFSender.

NOTE: This method does not create the RosettaNet acknowledgement receipt or notification of failure, it simply sends it. You must create the response message and set it via the service_content, along with setting the headers to valid values, before you calling this method.

on_error event

Fired when information is available about errors during data delivery.

Syntax

class RNIFReceiverErrorEventParams(object):
  @property
  def error_code() -> int: ...
  @property
  def description() -> str: ...
# In class RNIFReceiver:
@property
def on_error() -> Callable[[RNIFReceiverErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[RNIFReceiverErrorEventParams], None]) -> None: ...

Remarks

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

RNIFReceiver Config Settings

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

RNIFReceiver Config Settings

Base Config Settings

RNIFReceiver Errors

SMIME Errors

XML Errors