RNIFReceiver Component

Properties   Methods   Events   Config Settings   Errors  

The RNIFReceiver class implements a RosettaNet server.

Syntax

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 component 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 ReadRequest 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 ParseHeaders method. You may then set the appropriate certificates by setting the Certificate to your private key certificate and SignerCert to your trading partner's (signing) certificate.

The next step is to parse the RosettaNet message using ParseRequest. This method decrypts the message if needed. The component then parses all parts of the message. The preamble, delivery, and service headers are all parsed into the PreambleHeaderXML, DeliveryHeaderXML, and the ServiceHeaderXML, respectively. It also parses the actual body of the RosettaNet message, or the PIP, into the ServiceContent. Any attachments that may be in the message are parsed into the attachment array, and may be accessed via the Attachments property.

The component 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 MessageSenderId, MessageReceiverId, ActionCode, etc. The ServiceContent 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 SendResponse method.

NOTE: the RNIFReceiver Component 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 component.

The following example illustrates how to use the component 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: PreambleHeaderXML, DeliveryHeaderXML, ServiceHeaderXML<;, and the ServiceContent, 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 component with short descriptions. Click on the links for further details.

Method List

---

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

Event List

---

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

Config Settings

---

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

ActionCode Property (RNIFReceiver Component)

The code for this action.

Syntax

func (obj *RNIFReceiver) ActionCode() (string, error)
func (obj *RNIFReceiver) SetActionCode(value string) error

Default Value

""

Remarks

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

This property is a field of the service header.

Data Type

string

ActionMessage Property (RNIFReceiver Component)

Whether or not this message is an action message.

Syntax

func (obj *RNIFReceiver) ActionMessage() (bool, error)
func (obj *RNIFReceiver) SetActionMessage(value bool) error

Default Value

false

Remarks

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

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

This property is a field of the service header.

Data Type

bool

ActionMessageStandardName Property (RNIFReceiver Component)

The name of the standard used to create this action.

Syntax

func (obj *RNIFReceiver) ActionMessageStandardName() (string, error)
func (obj *RNIFReceiver) SetActionMessageStandardName(value string) error

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 ActionMessageStandardName and the version in ActionMessageStandardVersion. 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 OriginalMessageStandardName and OriginalMessageStandardVersion when creating or processing replies.

This property is a field of the service header.

Data Type

string

ActionMessageStandardVersion Property (RNIFReceiver Component)

The version of the standard used to create this action.

Syntax

func (obj *RNIFReceiver) ActionMessageStandardVersion() (string, error)
func (obj *RNIFReceiver) SetActionMessageStandardVersion(value string) error

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 ActionMessageStandardName and the version in ActionMessageStandardVersion. 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 OriginalMessageStandardName and OriginalMessageStandardVersion when creating or processing replies.

This property is a field of the service header.

Data Type

string

AttachmentCount Property (RNIFReceiver Component)

The number of records in the Attachment arrays.

Syntax

func (obj *RNIFReceiver) AttachmentCount() (int32, error)
func (obj *RNIFReceiver) SetAttachmentCount(value int32) error

Default Value

0

Remarks

This property controls the size of the following arrays:

• AttachmentData
• AttachmentDescription
• AttachmentFileName
• AttachmentId
• AttachmentMIMEType

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

Data Type

int32

AttachmentData Property (RNIFReceiver Component)

Data contains the raw data of the current attachment.

Syntax

func (obj *RNIFReceiver) AttachmentData(AttachmentIndex int32) ([]byte, error)
func (obj *RNIFReceiver) SetAttachmentData(AttachmentIndex int32, value []byte) error

Default Value

""

Remarks

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

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

Data Type

[]byte

AttachmentDescription Property (RNIFReceiver Component)

Description contains descriptions for this attachment.

Syntax

func (obj *RNIFReceiver) AttachmentDescription(AttachmentIndex int32) (string, error)
func (obj *RNIFReceiver) SetAttachmentDescription(AttachmentIndex int32, value string) error

Default Value

""

Remarks

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

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

Data Type

string

AttachmentFileName Property (RNIFReceiver Component)

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

Syntax

func (obj *RNIFReceiver) AttachmentFileName(AttachmentIndex int32) (string, error)
func (obj *RNIFReceiver) SetAttachmentFileName(AttachmentIndex int32, value string) error

Default Value

""

Remarks

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

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

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

Data Type

string

AttachmentId Property (RNIFReceiver Component)

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

Syntax

func (obj *RNIFReceiver) AttachmentId(AttachmentIndex int32) (string, error)
func (obj *RNIFReceiver) SetAttachmentId(AttachmentIndex int32, value string) error

Default Value

""

Remarks

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

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

Data Type

string

AttachmentMIMEType Property (RNIFReceiver Component)

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

Syntax

func (obj *RNIFReceiver) AttachmentMIMEType(AttachmentIndex int32) (string, error)
func (obj *RNIFReceiver) SetAttachmentMIMEType(AttachmentIndex int32, value string) error

Default Value

""

Remarks

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

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

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

Data Type

string

BusinessActivity Property (RNIFReceiver Component)

This property denotes the type of business activity.

Syntax

func (obj *RNIFReceiver) BusinessActivity() (string, error)
func (obj *RNIFReceiver) SetBusinessActivity(value string) error

Default Value

""

Remarks

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

Data Type

string

CertEffectiveDate Property (RNIFReceiver Component)

The date on which this certificate becomes valid.

Syntax

func (obj *RNIFReceiver) CertEffectiveDate() (string, error)

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

string

CertExpirationDate Property (RNIFReceiver Component)

The date on which the certificate expires.

Syntax

func (obj *RNIFReceiver) CertExpirationDate() (string, error)

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

string

CertExtendedKeyUsage Property (RNIFReceiver Component)

A comma-delimited list of extended key usage identifiers.

Syntax

func (obj *RNIFReceiver) CertExtendedKeyUsage() (string, error)

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

string

CertFingerprint Property (RNIFReceiver Component)

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

Syntax

func (obj *RNIFReceiver) CertFingerprint() (string, error)

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

string

CertFingerprintSHA1 Property (RNIFReceiver Component)

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

Syntax

func (obj *RNIFReceiver) CertFingerprintSHA1() (string, error)

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

string

CertFingerprintSHA256 Property (RNIFReceiver Component)

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

Syntax

func (obj *RNIFReceiver) CertFingerprintSHA256() (string, error)

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

string

CertIssuer Property (RNIFReceiver Component)

The issuer of the certificate.

Syntax

func (obj *RNIFReceiver) CertIssuer() (string, error)

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

string

CertPrivateKey Property (RNIFReceiver Component)

The private key of the certificate (if available).

Syntax

func (obj *RNIFReceiver) CertPrivateKey() (string, error)

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

string

CertPrivateKeyAvailable Property (RNIFReceiver Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

func (obj *RNIFReceiver) CertPrivateKeyAvailable() (bool, error)

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

CertPrivateKeyContainer Property (RNIFReceiver Component)

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

Syntax

func (obj *RNIFReceiver) CertPrivateKeyContainer() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

CertPublicKey Property (RNIFReceiver Component)

The public key of the certificate.

Syntax

func (obj *RNIFReceiver) CertPublicKey() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

CertPublicKeyAlgorithm Property (RNIFReceiver Component)

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

Syntax

func (obj *RNIFReceiver) CertPublicKeyAlgorithm() (string, error)

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

string

CertPublicKeyLength Property (RNIFReceiver Component)

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

Syntax

func (obj *RNIFReceiver) CertPublicKeyLength() (int32, error)

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

int32

CertSerialNumber Property (RNIFReceiver Component)

The serial number of the certificate encoded as a string.

Syntax

func (obj *RNIFReceiver) CertSerialNumber() (string, error)

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

string

CertSignatureAlgorithm Property (RNIFReceiver Component)

The text description of the certificate's signature algorithm.

Syntax

func (obj *RNIFReceiver) CertSignatureAlgorithm() (string, error)

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

string

CertStore Property (RNIFReceiver Component)

The name of the certificate store for the client certificate.

Syntax

func (obj *RNIFReceiver) CertStore() ([]byte, error)
func (obj *RNIFReceiver) SetCertStore(value []byte) error

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The CertStoreType property denotes the type of the certificate store specified by CertStore. If the store is password-protected, specify the password in CertStorePassword.

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

Designations of certificate stores are platform dependent.

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

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

[]byte

CertStorePassword Property (RNIFReceiver Component)

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

Syntax

func (obj *RNIFReceiver) CertStorePassword() (string, error)
func (obj *RNIFReceiver) SetCertStorePassword(value string) error

Default Value

""

Remarks

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

Data Type

string

CertStoreType Property (RNIFReceiver Component)

The type of certificate store for this certificate.

Syntax

func (obj *RNIFReceiver) CertStoreType() (int32, error)
func (obj *RNIFReceiver) SetCertStoreType(value int32) error

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 component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This property can take one of the following values:

Data Type

int32

CertSubjectAltNames Property (RNIFReceiver Component)

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

Syntax

func (obj *RNIFReceiver) CertSubjectAltNames() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

CertThumbprintMD5 Property (RNIFReceiver Component)

The MD5 hash of the certificate.

Syntax

func (obj *RNIFReceiver) CertThumbprintMD5() (string, error)

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

CertThumbprintSHA1 Property (RNIFReceiver Component)

The SHA-1 hash of the certificate.

Syntax

func (obj *RNIFReceiver) CertThumbprintSHA1() (string, error)

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

CertThumbprintSHA256 Property (RNIFReceiver Component)

The SHA-256 hash of the certificate.

Syntax

func (obj *RNIFReceiver) CertThumbprintSHA256() (string, error)

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

CertUsage Property (RNIFReceiver Component)

The text description of UsageFlags .

Syntax

func (obj *RNIFReceiver) CertUsage() (string, error)

Default Value

""

Remarks

The text description of CertUsageFlags.

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

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

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

This property is read-only.

Data Type

string

CertUsageFlags Property (RNIFReceiver Component)

The flags that show intended use for the certificate.

Syntax

func (obj *RNIFReceiver) CertUsageFlags() (int32, error)

Default Value

0

Remarks

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

Please see the CertUsage property for a text representation of CertUsageFlags.

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

This property is read-only.

Data Type

int32

CertVersion Property (RNIFReceiver Component)

The certificate's version number.

Syntax

func (obj *RNIFReceiver) CertVersion() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

CertSubject Property (RNIFReceiver Component)

The subject of the certificate used for client authentication.

Syntax

func (obj *RNIFReceiver) CertSubject() (string, error)
func (obj *RNIFReceiver) SetCertSubject(value string) error

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

Data Type

string

CertEncoded Property (RNIFReceiver Component)

The certificate (PEM/Base64 encoded).

Syntax

func (obj *RNIFReceiver) CertEncoded() ([]byte, error)
func (obj *RNIFReceiver) SetCertEncoded(value []byte) error

Default Value

""

Remarks

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

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

Data Type

[]byte

DeliveryHeaderXML Property (RNIFReceiver Component)

The complete XML data from the Delivery Header.

Syntax

func (obj *RNIFReceiver) DeliveryHeaderXML() (string, error)
func (obj *RNIFReceiver) SetDeliveryHeaderXML(value string) error

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

• SecureTransportRequired
• MessageDateTime
• MessageReceiverId
• MessageReceiverLocation
• MessageSenderId
• MessageSenderLocation
• MessageTrackingId

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

Data Type

string

EncryptionAlgorithm Property (RNIFReceiver Component)

The algorithm used to encrypt the EDI data.

Syntax

func (obj *RNIFReceiver) EncryptionAlgorithm() (string, error)
func (obj *RNIFReceiver) SetEncryptionAlgorithm(value string) error

Default Value

"AESCBC256"

Remarks

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

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

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

Possible values are:

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

Data Type

string

EncryptionType Property (RNIFReceiver Component)

The encryption type for RNIF 2.0.

Syntax

func (obj *RNIFReceiver) EncryptionType() (int32, error)
func (obj *RNIFReceiver) SetEncryptionType(value int32) error

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 EncryptionType property must be specified, even if a certificate is supplied through the certificate properties. See RecipientCert for more information on specifying a certificate for encryption.

Data Type

int32

FromRole Property (RNIFReceiver Component)

The business role of the entity that originated this message.

Syntax

func (obj *RNIFReceiver) FromRole() (string, error)
func (obj *RNIFReceiver) SetFromRole(value string) error

Default Value

""

Remarks

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

This property is a field of the service header.

Data Type

string

FromService Property (RNIFReceiver Component)

The service that originated this message.

Syntax

func (obj *RNIFReceiver) FromService() (string, error)
func (obj *RNIFReceiver) SetFromService(value string) error

Default Value

""

Remarks

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

This property is a field of the service header.

Data Type

string

GlobalUsageCode Property (RNIFReceiver Component)

A universal code describing basic usage for this message.

Syntax

func (obj *RNIFReceiver) GlobalUsageCode() (int32, error)
func (obj *RNIFReceiver) SetGlobalUsageCode(value int32) error

Possible Values

0   // Test
1   // Production

Default Value

0

Remarks

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

• 0 (gucTest)
• 1 (gucProduction)

This property is a field of the service header.

Data Type

int32

MessageDateTime Property (RNIFReceiver Component)

The time at which this message was sent.

Syntax

func (obj *RNIFReceiver) MessageDateTime() (string, error)
func (obj *RNIFReceiver) SetMessageDateTime(value string) error

Default Value

""

Remarks

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

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

This property is a field of the delivery header.

Data Type

string

MessageReceiverId Property (RNIFReceiver Component)

Identity of the entity receiving this message.

Syntax

func (obj *RNIFReceiver) MessageReceiverId() (string, error)
func (obj *RNIFReceiver) SetMessageReceiverId(value string) error

Default Value

""

Remarks

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

This property is a field of the delivery header.

Data Type

string

MessageReceiverLocation Property (RNIFReceiver Component)

Location of the entity receiving this message.

Syntax

func (obj *RNIFReceiver) MessageReceiverLocation() (string, error)
func (obj *RNIFReceiver) SetMessageReceiverLocation(value string) error

Default Value

""

Remarks

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

This property is a field of the delivery header.

Data Type

string

MessageSenderId Property (RNIFReceiver Component)

Identity of the entity that sent this message.

Syntax

func (obj *RNIFReceiver) MessageSenderId() (string, error)
func (obj *RNIFReceiver) SetMessageSenderId(value string) error

Default Value

""

Remarks

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

This property is a field of the delivery header.

Data Type

string

MessageSenderLocation Property (RNIFReceiver Component)

Location of the entity that sent this message.

Syntax

func (obj *RNIFReceiver) MessageSenderLocation() (string, error)
func (obj *RNIFReceiver) SetMessageSenderLocation(value string) error

Default Value

""

Remarks

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

This property is a field of the delivery header.

Data Type

string

MessageTrackingId Property (RNIFReceiver Component)

Unique value that identifies this message.

Syntax

func (obj *RNIFReceiver) MessageTrackingId() (string, error)
func (obj *RNIFReceiver) SetMessageTrackingId(value string) error

Default Value

""

Remarks

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

This property is a field of the delivery header.

Data Type

string

OriginalActionCode Property (RNIFReceiver Component)

The action code of the original message.

Syntax

func (obj *RNIFReceiver) OriginalActionCode() (string, error)
func (obj *RNIFReceiver) SetOriginalActionCode(value string) error

Default Value

""

Remarks

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

This property is a field of the service header.

Data Type

string

OriginalMessageStandardName Property (RNIFReceiver Component)

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

Syntax

func (obj *RNIFReceiver) OriginalMessageStandardName() (string, error)
func (obj *RNIFReceiver) SetOriginalMessageStandardName(value string) error

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 ActionMessageStandardName and the version in ActionMessageStandardVersion. 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 OriginalMessageStandardName and OriginalMessageStandardVersion when creating or processing replies.

This property is a field of the service header.

Data Type

string

OriginalMessageStandardVersion Property (RNIFReceiver Component)

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

Syntax

func (obj *RNIFReceiver) OriginalMessageStandardVersion() (string, error)
func (obj *RNIFReceiver) SetOriginalMessageStandardVersion(value string) error

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 ActionMessageStandardName and the version in ActionMessageStandardVersion. 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 OriginalMessageStandardName and OriginalMessageStandardVersion when creating or processing replies.

This property is a field of the service header.

Data Type

string

OriginalMessageTrackingId Property (RNIFReceiver Component)

Tracking identifier for the original message.

Syntax

func (obj *RNIFReceiver) OriginalMessageTrackingId() (string, error)
func (obj *RNIFReceiver) SetOriginalMessageTrackingId(value string) error

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 MessageTrackingId, this property can be used to retrieve any information relevant to the current business process from an external database.

This property is a field of the service header.

Data Type

string

PartnerId Property (RNIFReceiver Component)

Identity of the partner.

Syntax

func (obj *RNIFReceiver) PartnerId() (string, error)
func (obj *RNIFReceiver) SetPartnerId(value string) error

Default Value

""

Remarks

PartnerKnown 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 PartnerId 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, PartnerLocation can be specified. This property is not an address, but may be a city.

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

This property is a field of the service header.

Data Type

string

PartnerKnown Property (RNIFReceiver Component)

Whether or not the partner is known.

Syntax

func (obj *RNIFReceiver) PartnerKnown() (bool, error)
func (obj *RNIFReceiver) SetPartnerKnown(value bool) error

Default Value

false

Remarks

PartnerKnown 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 PartnerId 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, PartnerLocation can be specified. This property is not an address, but may be a city.

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

This property is a field of the service header.

Data Type

bool

PartnerLocation Property (RNIFReceiver Component)

Location of the partner.

Syntax

func (obj *RNIFReceiver) PartnerLocation() (string, error)
func (obj *RNIFReceiver) SetPartnerLocation(value string) error

Default Value

""

Remarks

PartnerKnown 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 PartnerId 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, PartnerLocation can be specified. This property is not an address, but may be a city.

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

This property is a field of the service header.

Data Type

string

PartnerPIPBindingId Property (RNIFReceiver Component)

The partner-defined PIP payload binding ID.

Syntax

func (obj *RNIFReceiver) PartnerPIPBindingId() (string, error)
func (obj *RNIFReceiver) SetPartnerPIPBindingId(value string) error

Default Value

""

Remarks

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

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

Data Type

string

PartnerURL Property (RNIFReceiver Component)

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

Syntax

func (obj *RNIFReceiver) PartnerURL() (string, error)
func (obj *RNIFReceiver) SetPartnerURL(value string) error

Default Value

""

Remarks

PartnerKnown 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 PartnerId 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, PartnerLocation can be specified. This property is not an address, but may be a city.

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

This property is a field of the service header.

This property is a field of the service header.

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

Data Type

string

PIPCode Property (RNIFReceiver Component)

RosettaNet PIP code of this message.

Syntax

func (obj *RNIFReceiver) PIPCode() (string, error)
func (obj *RNIFReceiver) SetPIPCode(value string) error

Default Value

""

Remarks

The ServiceContent 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 PIPCode and the version in PIPVersion.

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 PIPInstanceId property. It is up to the sending client to ensure that this value is unique. The receiver should respond with an error if it receives a PIP instance id that has already been used.

This property is a field of the service header.

Data Type

string

PIPInstanceId Property (RNIFReceiver Component)

The Id of this PIP instance.

Syntax

func (obj *RNIFReceiver) PIPInstanceId() (string, error)
func (obj *RNIFReceiver) SetPIPInstanceId(value string) error

Default Value

""

Remarks

The ServiceContent 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 PIPCode and the version in PIPVersion.

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 PIPInstanceId property. It is up to the sending client to ensure that this value is unique. The receiver should respond with an error if it receives a PIP instance id that has already been used.

This property is a field of the service header.

Data Type

string

PIPVersion Property (RNIFReceiver Component)

RosettaNet PIP version of this message.

Syntax

func (obj *RNIFReceiver) PIPVersion() (string, error)
func (obj *RNIFReceiver) SetPIPVersion(value string) error

Default Value

""

Remarks

The ServiceContent 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 PIPCode and the version in PIPVersion.

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 PIPInstanceId property. It is up to the sending client to ensure that this value is unique. The receiver should respond with an error if it receives a PIP instance id that has already been used.

This property is a field of the service header.

Data Type

string

PreambleHeaderXML Property (RNIFReceiver Component)

The complete XML data from the Preamble Header.

Syntax

func (obj *RNIFReceiver) PreambleHeaderXML() (string, error)
func (obj *RNIFReceiver) SetPreambleHeaderXML(value string) error

Default Value

""

Remarks

The contents of PreambleHeaderXML 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 component. 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 component 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:

• StandardName
• StandardVersion

Data Type

string

QOSSpecificationCount Property (RNIFReceiver Component)

The number of records in the QOSSpecification arrays.

Syntax

func (obj *RNIFReceiver) QOSSpecificationCount() (int32, error)
func (obj *RNIFReceiver) SetQOSSpecificationCount(value int32) error

Default Value

0

Remarks

This property controls the size of the following arrays:

• QOSSpecificationCode
• QOSSpecificationValue

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

Data Type

int32

QOSSpecificationCode Property (RNIFReceiver Component)

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

Syntax

func (obj *RNIFReceiver) QOSSpecificationCode(QOSIndex int32) (string, error)
func (obj *RNIFReceiver) SetQOSSpecificationCode(QOSIndex int32, value string) error

Default Value

""

Remarks

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

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

Data Type

string

QOSSpecificationValue Property (RNIFReceiver Component)

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

Syntax

func (obj *RNIFReceiver) QOSSpecificationValue(QOSIndex int32) (string, error)
func (obj *RNIFReceiver) SetQOSSpecificationValue(QOSIndex int32, value string) error

Default Value

""

Remarks

QOSSpecificationValue is a string that defines the constraints for the category in QOSSpecificationCode.

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

Data Type

string

RecipientCertEffectiveDate Property (RNIFReceiver Component)

The date on which this certificate becomes valid.

Syntax

func (obj *RNIFReceiver) RecipientCertEffectiveDate() (string, error)

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

string

RecipientCertExpirationDate Property (RNIFReceiver Component)

The date on which the certificate expires.

Syntax

func (obj *RNIFReceiver) RecipientCertExpirationDate() (string, error)

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

string

RecipientCertExtendedKeyUsage Property (RNIFReceiver Component)

A comma-delimited list of extended key usage identifiers.

Syntax

func (obj *RNIFReceiver) RecipientCertExtendedKeyUsage() (string, error)

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

string

RecipientCertFingerprint Property (RNIFReceiver Component)

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

Syntax

func (obj *RNIFReceiver) RecipientCertFingerprint() (string, error)

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

string

RecipientCertFingerprintSHA1 Property (RNIFReceiver Component)

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

Syntax

func (obj *RNIFReceiver) RecipientCertFingerprintSHA1() (string, error)

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

string

RecipientCertFingerprintSHA256 Property (RNIFReceiver Component)

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

Syntax

func (obj *RNIFReceiver) RecipientCertFingerprintSHA256() (string, error)

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

string

RecipientCertIssuer Property (RNIFReceiver Component)

The issuer of the certificate.

Syntax

func (obj *RNIFReceiver) RecipientCertIssuer() (string, error)

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

string

RecipientCertPrivateKey Property (RNIFReceiver Component)

The private key of the certificate (if available).

Syntax

func (obj *RNIFReceiver) RecipientCertPrivateKey() (string, error)

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

string

RecipientCertPrivateKeyAvailable Property (RNIFReceiver Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

func (obj *RNIFReceiver) RecipientCertPrivateKeyAvailable() (bool, error)

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

RecipientCertPrivateKeyContainer Property (RNIFReceiver Component)

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

Syntax

func (obj *RNIFReceiver) RecipientCertPrivateKeyContainer() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

RecipientCertPublicKey Property (RNIFReceiver Component)

The public key of the certificate.

Syntax

func (obj *RNIFReceiver) RecipientCertPublicKey() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

RecipientCertPublicKeyAlgorithm Property (RNIFReceiver Component)

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

Syntax

func (obj *RNIFReceiver) RecipientCertPublicKeyAlgorithm() (string, error)

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

string

RecipientCertPublicKeyLength Property (RNIFReceiver Component)

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

Syntax

func (obj *RNIFReceiver) RecipientCertPublicKeyLength() (int32, error)

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

int32

RecipientCertSerialNumber Property (RNIFReceiver Component)

The serial number of the certificate encoded as a string.

Syntax

func (obj *RNIFReceiver) RecipientCertSerialNumber() (string, error)

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

string

RecipientCertSignatureAlgorithm Property (RNIFReceiver Component)

The text description of the certificate's signature algorithm.

Syntax

func (obj *RNIFReceiver) RecipientCertSignatureAlgorithm() (string, error)

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

string

RecipientCertStore Property (RNIFReceiver Component)

The name of the certificate store for the client certificate.

Syntax

func (obj *RNIFReceiver) RecipientCertStore() ([]byte, error)
func (obj *RNIFReceiver) SetRecipientCertStore(value []byte) error

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The RecipientCertStoreType property denotes the type of the certificate store specified by RecipientCertStore. If the store is password-protected, specify the password in RecipientCertStorePassword.

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

Designations of certificate stores are platform dependent.

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

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

[]byte

RecipientCertStorePassword Property (RNIFReceiver Component)

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

Syntax

func (obj *RNIFReceiver) RecipientCertStorePassword() (string, error)
func (obj *RNIFReceiver) SetRecipientCertStorePassword(value string) error

Default Value

""

Remarks

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

Data Type

string

RecipientCertStoreType Property (RNIFReceiver Component)

The type of certificate store for this certificate.

Syntax

func (obj *RNIFReceiver) RecipientCertStoreType() (int32, error)
func (obj *RNIFReceiver) SetRecipientCertStoreType(value int32) error

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 component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This property can take one of the following values:

Data Type

int32

RecipientCertSubjectAltNames Property (RNIFReceiver Component)

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

Syntax

func (obj *RNIFReceiver) RecipientCertSubjectAltNames() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

RecipientCertThumbprintMD5 Property (RNIFReceiver Component)

The MD5 hash of the certificate.

Syntax

func (obj *RNIFReceiver) RecipientCertThumbprintMD5() (string, error)

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

RecipientCertThumbprintSHA1 Property (RNIFReceiver Component)

The SHA-1 hash of the certificate.

Syntax

func (obj *RNIFReceiver) RecipientCertThumbprintSHA1() (string, error)

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

RecipientCertThumbprintSHA256 Property (RNIFReceiver Component)

The SHA-256 hash of the certificate.

Syntax

func (obj *RNIFReceiver) RecipientCertThumbprintSHA256() (string, error)

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

RecipientCertUsage Property (RNIFReceiver Component)

The text description of UsageFlags .

Syntax

func (obj *RNIFReceiver) RecipientCertUsage() (string, error)

Default Value

""

Remarks

The text description of RecipientCertUsageFlags.

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

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

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

This property is read-only.

Data Type

string

RecipientCertUsageFlags Property (RNIFReceiver Component)

The flags that show intended use for the certificate.

Syntax

func (obj *RNIFReceiver) RecipientCertUsageFlags() (int32, error)

Default Value

0

Remarks

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

Please see the RecipientCertUsage property for a text representation of RecipientCertUsageFlags.

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

This property is read-only.

Data Type

int32

RecipientCertVersion Property (RNIFReceiver Component)

The certificate's version number.

Syntax

func (obj *RNIFReceiver) RecipientCertVersion() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

RecipientCertSubject Property (RNIFReceiver Component)

The subject of the certificate used for client authentication.

Syntax

func (obj *RNIFReceiver) RecipientCertSubject() (string, error)
func (obj *RNIFReceiver) SetRecipientCertSubject(value string) error

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

Data Type

string

RecipientCertEncoded Property (RNIFReceiver Component)

The certificate (PEM/Base64 encoded).

Syntax

func (obj *RNIFReceiver) RecipientCertEncoded() ([]byte, error)
func (obj *RNIFReceiver) SetRecipientCertEncoded(value []byte) error

Default Value

""

Remarks

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

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

Data Type

[]byte

ReplyMessage Property (RNIFReceiver Component)

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

Syntax

func (obj *RNIFReceiver) ReplyMessage() (bool, error)
func (obj *RNIFReceiver) SetReplyMessage(value bool) error

Default Value

false

Remarks

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

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

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

This property is a field of the service header.

Data Type

bool

Request Property (RNIFReceiver Component)

The HTTP request to be processed.

Syntax

func (obj *RNIFReceiver) Request() ([]byte, error)
func (obj *RNIFReceiver) SetRequest(value []byte) error

Default Value

""

Remarks

This property holds the body of the request to be processed. The HTTP headers may be set separately in RequestHeaders 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 ReadRequest is called the contents of Request are overwritten.

Data Type

[]byte

RequestHeaderCount Property (RNIFReceiver Component)

The number of records in the RequestHeader arrays.

Syntax

func (obj *RNIFReceiver) RequestHeaderCount() (int32, error)
func (obj *RNIFReceiver) SetRequestHeaderCount(value int32) error

Default Value

0

Remarks

This property controls the size of the following arrays:

• RequestHeaderField
• RequestHeaderValue

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

Data Type

int32

RequestHeaderField Property (RNIFReceiver Component)

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

Syntax

func (obj *RNIFReceiver) RequestHeaderField(RequestHeaderIndex int32) (string, error)
func (obj *RNIFReceiver) SetRequestHeaderField(RequestHeaderIndex int32, value string) error

Default Value

""

Remarks

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

The RequestHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RequestHeaderCount property.

Data Type

string

RequestHeaderValue Property (RNIFReceiver Component)

This property contains the header contents.

Syntax

func (obj *RNIFReceiver) RequestHeaderValue(RequestHeaderIndex int32) (string, error)
func (obj *RNIFReceiver) SetRequestHeaderValue(RequestHeaderIndex int32, value string) error

Default Value

""

Remarks

This property contains the Header contents.

The RequestHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RequestHeaderCount property.

Data Type

string

RequestHeadersString Property (RNIFReceiver Component)

The HTTP headers in the RNIF request.

Syntax

func (obj *RNIFReceiver) RequestHeadersString() (string, error)
func (obj *RNIFReceiver) SetRequestHeadersString(value string) error

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

When assigning an RNIF request to the component, the headers may be included in Request or specified separately in RequestHeaders or RequestHeadersString. If the headers are included in Request they will be parsed out whenever ReadRequest, ParseRequest, or ProcessRequest is invoked.

Data Type

string

ResponseType Property (RNIFReceiver Component)

Requested response type. Available only in RNIF 2.0.

Syntax

func (obj *RNIFReceiver) ResponseType() (int32, error)

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.

Data Type

int32

RNIFVersion Property (RNIFReceiver Component)

The RNIF Standard Version used to generate this message.

Syntax

func (obj *RNIFReceiver) RNIFVersion() (int32, error)

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.

Data Type

int32

SecureTransportRequired Property (RNIFReceiver Component)

Indicates that security is required when forwarding this message.

Syntax

func (obj *RNIFReceiver) SecureTransportRequired() (bool, error)
func (obj *RNIFReceiver) SetSecureTransportRequired(value bool) error

Default Value

false

Remarks

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

This property is a field of the delivery header.

Data Type

bool

ServiceContent Property (RNIFReceiver Component)

The PIP message data.

Syntax

func (obj *RNIFReceiver) ServiceContent() (string, error)
func (obj *RNIFReceiver) SetServiceContent(value string) error

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 PIPInstanceId property.

Data Type

string

ServiceHeaderXML Property (RNIFReceiver Component)

The complete XML data from the Service Header.

Syntax

func (obj *RNIFReceiver) ServiceHeaderXML() (string, error)
func (obj *RNIFReceiver) SetServiceHeaderXML(value string) error

Default Value

""

Remarks

ServiceHeaderXML 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 component. 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 component 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:

• ActionCode
• ActionMessage
• ActionMessageStandardName
• ActionMessageStandardVersion
• Attachments
• FromRole
• FromService
• OriginalActionCode
• OriginalMessageStandardName
• OriginalMessageStandardVersion
• OriginalMessageTrackingId
• PartnerId
• PartnerKnown
• PartnerLocation
• PartnerPIPBindingId
• PartnerURL
• PIPCode
• PIPInstanceId
• PIPVersion
• QOSSpecifications
• ReplyMessage
• SignalCode
• SignalMessage
• GlobalUsageCode
• SignalVersion
• ToRole
• ToService

Data Type

string

SignalCode Property (RNIFReceiver Component)

The code for this signal.

Syntax

func (obj *RNIFReceiver) SignalCode() (string, error)
func (obj *RNIFReceiver) SetSignalCode(value string) error

Default Value

""

Remarks

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

Data Type

string

SignalMessage Property (RNIFReceiver Component)

Whether or not this message is a signal.

Syntax

func (obj *RNIFReceiver) SignalMessage() (bool, error)
func (obj *RNIFReceiver) SetSignalMessage(value bool) error

Default Value

false

Remarks

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

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

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

This property is a field of the service header.

Data Type

bool

SignalVersion Property (RNIFReceiver Component)

The version of this signal.

Syntax

func (obj *RNIFReceiver) SignalVersion() (string, error)
func (obj *RNIFReceiver) SetSignalVersion(value string) error

Default Value

""

Remarks

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

Data Type

string

SignerCertEffectiveDate Property (RNIFReceiver Component)

The date on which this certificate becomes valid.

Syntax

func (obj *RNIFReceiver) SignerCertEffectiveDate() (string, error)

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

string

SignerCertExpirationDate Property (RNIFReceiver Component)

The date on which the certificate expires.

Syntax

func (obj *RNIFReceiver) SignerCertExpirationDate() (string, error)

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

string

SignerCertExtendedKeyUsage Property (RNIFReceiver Component)

A comma-delimited list of extended key usage identifiers.

Syntax

func (obj *RNIFReceiver) SignerCertExtendedKeyUsage() (string, error)

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

string

SignerCertFingerprint Property (RNIFReceiver Component)

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

Syntax

func (obj *RNIFReceiver) SignerCertFingerprint() (string, error)

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

string

SignerCertFingerprintSHA1 Property (RNIFReceiver Component)

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

Syntax

func (obj *RNIFReceiver) SignerCertFingerprintSHA1() (string, error)

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

string

SignerCertFingerprintSHA256 Property (RNIFReceiver Component)

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

Syntax

func (obj *RNIFReceiver) SignerCertFingerprintSHA256() (string, error)

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

string

SignerCertIssuer Property (RNIFReceiver Component)

The issuer of the certificate.

Syntax

func (obj *RNIFReceiver) SignerCertIssuer() (string, error)

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

string

SignerCertPrivateKey Property (RNIFReceiver Component)

The private key of the certificate (if available).

Syntax

func (obj *RNIFReceiver) SignerCertPrivateKey() (string, error)

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

string

SignerCertPrivateKeyAvailable Property (RNIFReceiver Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

func (obj *RNIFReceiver) SignerCertPrivateKeyAvailable() (bool, error)

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

SignerCertPrivateKeyContainer Property (RNIFReceiver Component)

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

Syntax

func (obj *RNIFReceiver) SignerCertPrivateKeyContainer() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

SignerCertPublicKey Property (RNIFReceiver Component)

The public key of the certificate.

Syntax

func (obj *RNIFReceiver) SignerCertPublicKey() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

SignerCertPublicKeyAlgorithm Property (RNIFReceiver Component)

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

Syntax

func (obj *RNIFReceiver) SignerCertPublicKeyAlgorithm() (string, error)

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

string

SignerCertPublicKeyLength Property (RNIFReceiver Component)

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

Syntax

func (obj *RNIFReceiver) SignerCertPublicKeyLength() (int32, error)

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

int32

SignerCertSerialNumber Property (RNIFReceiver Component)

The serial number of the certificate encoded as a string.

Syntax

func (obj *RNIFReceiver) SignerCertSerialNumber() (string, error)

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

string

SignerCertSignatureAlgorithm Property (RNIFReceiver Component)

The text description of the certificate's signature algorithm.

Syntax

func (obj *RNIFReceiver) SignerCertSignatureAlgorithm() (string, error)

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

string

SignerCertStore Property (RNIFReceiver Component)

The name of the certificate store for the client certificate.

Syntax

func (obj *RNIFReceiver) SignerCertStore() ([]byte, error)
func (obj *RNIFReceiver) SetSignerCertStore(value []byte) error

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SignerCertStoreType property denotes the type of the certificate store specified by SignerCertStore. If the store is password-protected, specify the password in SignerCertStorePassword.

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

Designations of certificate stores are platform dependent.

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

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

[]byte

SignerCertStorePassword Property (RNIFReceiver Component)

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

Syntax

func (obj *RNIFReceiver) SignerCertStorePassword() (string, error)
func (obj *RNIFReceiver) SetSignerCertStorePassword(value string) error

Default Value

""

Remarks

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

Data Type

string

SignerCertStoreType Property (RNIFReceiver Component)

The type of certificate store for this certificate.

Syntax

func (obj *RNIFReceiver) SignerCertStoreType() (int32, error)
func (obj *RNIFReceiver) SetSignerCertStoreType(value int32) error

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 component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This property can take one of the following values:

Data Type

int32

SignerCertSubjectAltNames Property (RNIFReceiver Component)

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

Syntax

func (obj *RNIFReceiver) SignerCertSubjectAltNames() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

SignerCertThumbprintMD5 Property (RNIFReceiver Component)

The MD5 hash of the certificate.

Syntax

func (obj *RNIFReceiver) SignerCertThumbprintMD5() (string, error)

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

SignerCertThumbprintSHA1 Property (RNIFReceiver Component)

The SHA-1 hash of the certificate.

Syntax

func (obj *RNIFReceiver) SignerCertThumbprintSHA1() (string, error)

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

SignerCertThumbprintSHA256 Property (RNIFReceiver Component)

The SHA-256 hash of the certificate.

Syntax

func (obj *RNIFReceiver) SignerCertThumbprintSHA256() (string, error)

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

SignerCertUsage Property (RNIFReceiver Component)

The text description of UsageFlags .

Syntax

func (obj *RNIFReceiver) SignerCertUsage() (string, error)

Default Value

""

Remarks

The text description of SignerCertUsageFlags.

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

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

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

This property is read-only.

Data Type

string

SignerCertUsageFlags Property (RNIFReceiver Component)

The flags that show intended use for the certificate.

Syntax

func (obj *RNIFReceiver) SignerCertUsageFlags() (int32, error)

Default Value

0

Remarks

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

Please see the SignerCertUsage property for a text representation of SignerCertUsageFlags.

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

This property is read-only.

Data Type

int32

SignerCertVersion Property (RNIFReceiver Component)

The certificate's version number.

Syntax

func (obj *RNIFReceiver) SignerCertVersion() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

SignerCertSubject Property (RNIFReceiver Component)

The subject of the certificate used for client authentication.

Syntax

func (obj *RNIFReceiver) SignerCertSubject() (string, error)
func (obj *RNIFReceiver) SetSignerCertSubject(value string) error

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

Data Type

string

SignerCertEncoded Property (RNIFReceiver Component)

The certificate (PEM/Base64 encoded).

Syntax

func (obj *RNIFReceiver) SignerCertEncoded() ([]byte, error)
func (obj *RNIFReceiver) SetSignerCertEncoded(value []byte) error

Default Value

""

Remarks

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

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

Data Type

[]byte

StandardName Property (RNIFReceiver Component)

The name of the standard used to create this message.

Syntax

func (obj *RNIFReceiver) StandardName() (string, error)
func (obj *RNIFReceiver) SetStandardName(value string) error

Default Value

""

Remarks

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

This property is a field of the preamble.

Data Type

string

StandardVersion Property (RNIFReceiver Component)

The version of the standard used to create this message.

Syntax

func (obj *RNIFReceiver) StandardVersion() (string, error)
func (obj *RNIFReceiver) SetStandardVersion(value string) error

Default Value

""

Remarks

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

This property is a field of the preamble.

Data Type

string

ToRole Property (RNIFReceiver Component)

The role of the entity receiving this message.

Syntax

func (obj *RNIFReceiver) ToRole() (string, error)
func (obj *RNIFReceiver) SetToRole(value string) error

Default Value

""

Remarks

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

This property is a field of the service header.

Data Type

string

ToService Property (RNIFReceiver Component)

The service for which this message is bound.

Syntax

func (obj *RNIFReceiver) ToService() (string, error)
func (obj *RNIFReceiver) SetToService(value string) error

Default Value

""

Remarks

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

This property is a field of the service header.

Data Type

string

Config Method (RNIFReceiver Component)

Sets or retrieves a configuration setting.

Syntax

func (obj *RNIFReceiver) Config(ConfigurationString string) (string, error)

Remarks

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

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

ParseHeaders Method (RNIFReceiver Component)

Processes the headers, and populates the appropriate properties.

Syntax

func (obj *RNIFReceiver) ParseHeaders() error

Remarks

When this method is called, the headers are parsed from the HTTP request. Based on the headers, the component will set the RNIFVersion and ResponseType properties. After ParseHeaders is called, these two properties should be polled to determine how the message should be handled.

ParseRequest Method (RNIFReceiver Component)

Parses the MIME message in the Request property.

Syntax

func (obj *RNIFReceiver) ParseRequest() error

Remarks

Once the message is acquired from the sender and the RNIFVersion and ResponseType 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 PreambleHeaderXML, DeliveryHeaderXML, ServiceHeaderXML and ServiceContent 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 ReadRequest.

ReadRequest Method (RNIFReceiver Component)

Reads the RNIF request from the given HTTP servlet request.

Syntax

func (obj *RNIFReceiver) ReadRequest() error

Remarks

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

RequestHeader Method (RNIFReceiver Component)

Gets the specified header from the HTTP request.

Syntax

func (obj *RNIFReceiver) RequestHeader(Header string) (string, error)

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 (RNIFReceiver Component)

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

Syntax

func (obj *RNIFReceiver) Reset() error

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.

SendResponse Method (RNIFReceiver Component)

Optional. Acknowledges the incoming request.

Syntax

func (obj *RNIFReceiver) SendResponse() error

Remarks

This sends a signal to the client. The signal may be a receipt of acknowledgement or a notification of failure. SendResponse 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 ServiceContent, along with setting the headers to valid values, before you calling this method.

Error Event (RNIFReceiver Component)

Fired when information is available about errors during data delivery.

Syntax

// RNIFReceiverErrorEventArgs carries the RNIFReceiver Error event's parameters.
type RNIFReceiverErrorEventArgs struct {...}

func (args *RNIFReceiverErrorEventArgs) ErrorCode() int32
func (args *RNIFReceiverErrorEventArgs) Description() string

// RNIFReceiverErrorEvent defines the signature of the RNIFReceiver Error event's handler function.
type RNIFReceiverErrorEvent func(sender *RNIFReceiver, args *RNIFReceiverErrorEventArgs)

func (obj *RNIFReceiver) GetOnErrorHandler() RNIFReceiverErrorEvent
func (obj *RNIFReceiver) SetOnErrorHandler(handlerFunc RNIFReceiverErrorEvent)

Remarks

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

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Config Settings (RNIFReceiver Component)

The component 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 component, access to these internal properties is provided through the Config method.

RNIFReceiver Config Settings

Base Config Settings

Trappable Errors (RNIFReceiver Component)

SMIME Errors

XML Errors