RNIFSender Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

ipworksedi.RNIFSender

Remarks

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

A typical RosettaNet transaction is as follows:

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

When sending a RosettaNet message, the client, at minimum, must specify the StandardName and StandardVersion of the message being sent in the preamble header. In the delivery header, the client must specify the SecureTransportRequired, MessageDateTime, MessageReceiverId, MessageSenderId, and MessageTrackingId properties. For the service header, all properties that are relevant to the action, reply, or signal must be specified. The client, after setting all appropriate header properties, must then set the content of the RosettaNet message body by setting the ServiceContent property.

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

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

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

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

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

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

The code for this action.

Syntax

func (obj *RNIFSender) ActionCode() (string, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

Whether or not this message is an action message.

Syntax

func (obj *RNIFSender) ActionMessage() (bool, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

The name of the standard used to create this action.

Syntax

func (obj *RNIFSender) ActionMessageStandardName() (string, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

The version of the standard used to create this action.

Syntax

func (obj *RNIFSender) ActionMessageStandardVersion() (string, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

The number of records in the Attachment arrays.

Syntax

func (obj *RNIFSender) AttachmentCount() (int32, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

Data contains the raw data of the current attachment.

Syntax

func (obj *RNIFSender) AttachmentData(AttachmentIndex int32) ([]byte, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

Description contains descriptions for this attachment.

Syntax

func (obj *RNIFSender) AttachmentDescription(AttachmentIndex int32) (string, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) AttachmentFileName(AttachmentIndex int32) (string, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) AttachmentId(AttachmentIndex int32) (string, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) AttachmentMIMEType(AttachmentIndex int32) (string, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

This property denotes the type of business activity.

Syntax

func (obj *RNIFSender) BusinessActivity() (string, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

The date on which this certificate becomes valid.

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

The date on which the certificate expires.

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

A comma-delimited list of extended key usage identifiers.

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

The issuer of the certificate.

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

The private key of the certificate (if available).

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

The public key of the certificate.

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

The serial number of the certificate encoded as a string.

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

The text description of the certificate's signature algorithm.

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

The name of the certificate store for the client certificate.

Syntax

func (obj *RNIFSender) CertStore() ([]byte, error)
func (obj *RNIFSender) 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 (RNIFSender 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 *RNIFSender) CertStorePassword() (string, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

The type of certificate store for this certificate.

Syntax

func (obj *RNIFSender) CertStoreType() (int32, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

The MD5 hash of the certificate.

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

The SHA-1 hash of the certificate.

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

The SHA-256 hash of the certificate.

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

The text description of UsageFlags .

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

The flags that show intended use for the certificate.

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

The certificate's version number.

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

The subject of the certificate used for client authentication.

Syntax

func (obj *RNIFSender) CertSubject() (string, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

The certificate (PEM/Base64 encoded).

Syntax

func (obj *RNIFSender) CertEncoded() ([]byte, error)
func (obj *RNIFSender) 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

CookieCount Property (RNIFSender Component)

The number of records in the Cookie arrays.

Syntax

func (obj *RNIFSender) CookieCount() (int32, error)
func (obj *RNIFSender) SetCookieCount(value int32) error

Default Value

0

Remarks

This property controls the size of the following arrays:

• CookieDomain
• CookieExpiration
• CookieName
• CookiePath
• CookieSecure
• CookieValue

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

Data Type

int32

CookieDomain Property (RNIFSender Component)

The domain of a received cookie.

Syntax

func (obj *RNIFSender) CookieDomain(CookieIndex int32) (string, error)

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

string

CookieExpiration Property (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) CookieExpiration(CookieIndex int32) (string, error)

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

string

CookieName Property (RNIFSender Component)

The name of the cookie.

Syntax

func (obj *RNIFSender) CookieName(CookieIndex int32) (string, error)
func (obj *RNIFSender) SetCookieName(CookieIndex int32, value string) error

Default Value

""

Remarks

The name of the cookie.

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

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

Data Type

string

CookiePath Property (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) CookiePath(CookieIndex int32) (string, error)

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

string

CookieSecure Property (RNIFSender Component)

The security flag of the received cookie.

Syntax

func (obj *RNIFSender) CookieSecure(CookieIndex int32) (bool, error)

Default Value

false

Remarks

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

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

This property is read-only.

Data Type

bool

CookieValue Property (RNIFSender Component)

The value of the cookie.

Syntax

func (obj *RNIFSender) CookieValue(CookieIndex int32) (string, error)
func (obj *RNIFSender) SetCookieValue(CookieIndex int32, value string) error

Default Value

""

Remarks

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

The SetCookie event provides the cookies set by the server.

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

Data Type

string

DeliveryHeaderXML Property (RNIFSender Component)

The complete XML data from the Delivery Header.

Syntax

func (obj *RNIFSender) DeliveryHeaderXML() (string, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

The algorithm used to encrypt the EDI data.

Syntax

func (obj *RNIFSender) EncryptionAlgorithm() (string, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

The encryption type for RNIF 2.0.

Syntax

func (obj *RNIFSender) EncryptionType() (int32, error)
func (obj *RNIFSender) 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

FirewallAutoDetect Property (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) FirewallAutoDetect() (bool, error)
func (obj *RNIFSender) SetFirewallAutoDetect(value bool) error

Default Value

false

Remarks

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

Data Type

bool

FirewallType Property (RNIFSender Component)

The type of firewall to connect through.

Syntax

func (obj *RNIFSender) FirewallType() (int32, error)
func (obj *RNIFSender) SetFirewallType(value int32) error

Possible Values

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

Default Value

0

Remarks

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

Data Type

int32

FirewallHost Property (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) FirewallHost() (string, error)
func (obj *RNIFSender) SetFirewallHost(value string) error

Default Value

""

Remarks

The name or IP address of the firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the component fails with an error.

Data Type

string

FirewallPassword Property (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) FirewallPassword() (string, error)
func (obj *RNIFSender) SetFirewallPassword(value string) error

Default Value

""

Remarks

A password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the component fails with an error.

Data Type

string

FirewallPort Property (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) FirewallPort() (int32, error)
func (obj *RNIFSender) SetFirewallPort(value int32) error

Default Value

0

Remarks

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

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

Data Type

int32

FirewallUser Property (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) FirewallUser() (string, error)
func (obj *RNIFSender) SetFirewallUser(value string) error

Default Value

""

Remarks

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

Data Type

string

FromRole Property (RNIFSender Component)

The business role of the entity that originated this message.

Syntax

func (obj *RNIFSender) FromRole() (string, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

The service that originated this message.

Syntax

func (obj *RNIFSender) FromService() (string, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

A universal code describing basic usage for this message.

Syntax

func (obj *RNIFSender) GlobalUsageCode() (int32, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

The time at which this message was sent.

Syntax

func (obj *RNIFSender) MessageDateTime() (string, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

Identity of the entity receiving this message.

Syntax

func (obj *RNIFSender) MessageReceiverId() (string, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

Location of the entity receiving this message.

Syntax

func (obj *RNIFSender) MessageReceiverLocation() (string, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

Identity of the entity that sent this message.

Syntax

func (obj *RNIFSender) MessageSenderId() (string, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

Location of the entity that sent this message.

Syntax

func (obj *RNIFSender) MessageSenderLocation() (string, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

Unique value that identifies this message.

Syntax

func (obj *RNIFSender) MessageTrackingId() (string, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

The action code of the original message.

Syntax

func (obj *RNIFSender) OriginalActionCode() (string, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) OriginalMessageStandardName() (string, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) OriginalMessageStandardVersion() (string, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

Tracking identifier for the original message.

Syntax

func (obj *RNIFSender) OriginalMessageTrackingId() (string, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

Identity of the partner.

Syntax

func (obj *RNIFSender) PartnerId() (string, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

Whether or not the partner is known.

Syntax

func (obj *RNIFSender) PartnerKnown() (bool, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

Location of the partner.

Syntax

func (obj *RNIFSender) PartnerLocation() (string, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

The partner-defined PIP payload binding ID.

Syntax

func (obj *RNIFSender) PartnerPIPBindingId() (string, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) PartnerURL() (string, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

RosettaNet PIP code of this message.

Syntax

func (obj *RNIFSender) PIPCode() (string, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

The Id of this PIP instance.

Syntax

func (obj *RNIFSender) PIPInstanceId() (string, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

RosettaNet PIP version of this message.

Syntax

func (obj *RNIFSender) PIPVersion() (string, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

The complete XML data from the Preamble Header.

Syntax

func (obj *RNIFSender) PreambleHeaderXML() (string, error)
func (obj *RNIFSender) 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

ProxyAuthScheme Property (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) ProxyAuthScheme() (int32, error)
func (obj *RNIFSender) SetProxyAuthScheme(value int32) error

Possible Values

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

Default Value

0

Remarks

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

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

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.

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

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

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

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

int32

ProxyAutoDetect Property (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) ProxyAutoDetect() (bool, error)
func (obj *RNIFSender) SetProxyAutoDetect(value bool) error

Default Value

false

Remarks

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

Data Type

bool

ProxyPassword Property (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) ProxyPassword() (string, error)
func (obj *RNIFSender) SetProxyPassword(value string) error

Default Value

""

Remarks

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

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

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

string

ProxyPort Property (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) ProxyPort() (int32, error)
func (obj *RNIFSender) SetProxyPort(value int32) error

Default Value

80

Remarks

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

Data Type

int32

ProxyServer Property (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) ProxyServer() (string, error)
func (obj *RNIFSender) SetProxyServer(value string) error

Default Value

""

Remarks

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

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

Data Type

string

ProxySSL Property (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) ProxySSL() (int32, error)
func (obj *RNIFSender) SetProxySSL(value int32) error

Possible Values

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

Default Value

0

Remarks

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

Data Type

int32

ProxyUser Property (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) ProxyUser() (string, error)
func (obj *RNIFSender) SetProxyUser(value string) error

Default Value

""

Remarks

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

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

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

string

QOSSpecificationCount Property (RNIFSender Component)

The number of records in the QOSSpecification arrays.

Syntax

func (obj *RNIFSender) QOSSpecificationCount() (int32, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) QOSSpecificationCode(QOSIndex int32) (string, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) QOSSpecificationValue(QOSIndex int32) (string, error)
func (obj *RNIFSender) 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

ReceiptSignerCertEffectiveDate Property (RNIFSender Component)

The date on which this certificate becomes valid.

Syntax

func (obj *RNIFSender) ReceiptSignerCertEffectiveDate() (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

ReceiptSignerCertExpirationDate Property (RNIFSender Component)

The date on which the certificate expires.

Syntax

func (obj *RNIFSender) ReceiptSignerCertExpirationDate() (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

ReceiptSignerCertExtendedKeyUsage Property (RNIFSender Component)

A comma-delimited list of extended key usage identifiers.

Syntax

func (obj *RNIFSender) ReceiptSignerCertExtendedKeyUsage() (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

ReceiptSignerCertFingerprint Property (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) ReceiptSignerCertFingerprint() (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

ReceiptSignerCertFingerprintSHA1 Property (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) ReceiptSignerCertFingerprintSHA1() (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

ReceiptSignerCertFingerprintSHA256 Property (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) ReceiptSignerCertFingerprintSHA256() (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

ReceiptSignerCertIssuer Property (RNIFSender Component)

The issuer of the certificate.

Syntax

func (obj *RNIFSender) ReceiptSignerCertIssuer() (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

ReceiptSignerCertPrivateKey Property (RNIFSender Component)

The private key of the certificate (if available).

Syntax

func (obj *RNIFSender) ReceiptSignerCertPrivateKey() (string, error)

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

string

ReceiptSignerCertPrivateKeyAvailable Property (RNIFSender Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

func (obj *RNIFSender) ReceiptSignerCertPrivateKeyAvailable() (bool, error)

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

ReceiptSignerCertPrivateKeyContainer Property (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) ReceiptSignerCertPrivateKeyContainer() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

ReceiptSignerCertPublicKey Property (RNIFSender Component)

The public key of the certificate.

Syntax

func (obj *RNIFSender) ReceiptSignerCertPublicKey() (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

ReceiptSignerCertPublicKeyAlgorithm Property (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) ReceiptSignerCertPublicKeyAlgorithm() (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

ReceiptSignerCertPublicKeyLength Property (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) ReceiptSignerCertPublicKeyLength() (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

ReceiptSignerCertSerialNumber Property (RNIFSender Component)

The serial number of the certificate encoded as a string.

Syntax

func (obj *RNIFSender) ReceiptSignerCertSerialNumber() (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

ReceiptSignerCertSignatureAlgorithm Property (RNIFSender Component)

The text description of the certificate's signature algorithm.

Syntax

func (obj *RNIFSender) ReceiptSignerCertSignatureAlgorithm() (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

ReceiptSignerCertStore Property (RNIFSender Component)

The name of the certificate store for the client certificate.

Syntax

func (obj *RNIFSender) ReceiptSignerCertStore() ([]byte, error)
func (obj *RNIFSender) SetReceiptSignerCertStore(value []byte) error

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ReceiptSignerCertStoreType property denotes the type of the certificate store specified by ReceiptSignerCertStore. If the store is password-protected, specify the password in ReceiptSignerCertStorePassword.

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

ReceiptSignerCertStorePassword Property (RNIFSender 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 *RNIFSender) ReceiptSignerCertStorePassword() (string, error)
func (obj *RNIFSender) SetReceiptSignerCertStorePassword(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

ReceiptSignerCertStoreType Property (RNIFSender Component)

The type of certificate store for this certificate.

Syntax

func (obj *RNIFSender) ReceiptSignerCertStoreType() (int32, error)
func (obj *RNIFSender) SetReceiptSignerCertStoreType(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

ReceiptSignerCertSubjectAltNames Property (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) ReceiptSignerCertSubjectAltNames() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

ReceiptSignerCertThumbprintMD5 Property (RNIFSender Component)

The MD5 hash of the certificate.

Syntax

func (obj *RNIFSender) ReceiptSignerCertThumbprintMD5() (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

ReceiptSignerCertThumbprintSHA1 Property (RNIFSender Component)

The SHA-1 hash of the certificate.

Syntax

func (obj *RNIFSender) ReceiptSignerCertThumbprintSHA1() (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

ReceiptSignerCertThumbprintSHA256 Property (RNIFSender Component)

The SHA-256 hash of the certificate.

Syntax

func (obj *RNIFSender) ReceiptSignerCertThumbprintSHA256() (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

ReceiptSignerCertUsage Property (RNIFSender Component)

The text description of UsageFlags .

Syntax

func (obj *RNIFSender) ReceiptSignerCertUsage() (string, error)

Default Value

""

Remarks

The text description of ReceiptSignerCertUsageFlags.

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

ReceiptSignerCertUsageFlags Property (RNIFSender Component)

The flags that show intended use for the certificate.

Syntax

func (obj *RNIFSender) ReceiptSignerCertUsageFlags() (int32, error)

Default Value

0

Remarks

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

Please see the ReceiptSignerCertUsage property for a text representation of ReceiptSignerCertUsageFlags.

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

This property is read-only.

Data Type

int32

ReceiptSignerCertVersion Property (RNIFSender Component)

The certificate's version number.

Syntax

func (obj *RNIFSender) ReceiptSignerCertVersion() (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

ReceiptSignerCertSubject Property (RNIFSender Component)

The subject of the certificate used for client authentication.

Syntax

func (obj *RNIFSender) ReceiptSignerCertSubject() (string, error)
func (obj *RNIFSender) SetReceiptSignerCertSubject(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

ReceiptSignerCertEncoded Property (RNIFSender Component)

The certificate (PEM/Base64 encoded).

Syntax

func (obj *RNIFSender) ReceiptSignerCertEncoded() ([]byte, error)
func (obj *RNIFSender) SetReceiptSignerCertEncoded(value []byte) error

Default Value

""

Remarks

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

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

Data Type

[]byte

RecipientCertEffectiveDate Property (RNIFSender Component)

The date on which this certificate becomes valid.

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

The date on which the certificate expires.

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

A comma-delimited list of extended key usage identifiers.

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

The issuer of the certificate.

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

The private key of the certificate (if available).

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

The public key of the certificate.

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

The serial number of the certificate encoded as a string.

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

The text description of the certificate's signature algorithm.

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

The name of the certificate store for the client certificate.

Syntax

func (obj *RNIFSender) RecipientCertStore() ([]byte, error)
func (obj *RNIFSender) 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 (RNIFSender 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 *RNIFSender) RecipientCertStorePassword() (string, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

The type of certificate store for this certificate.

Syntax

func (obj *RNIFSender) RecipientCertStoreType() (int32, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

The MD5 hash of the certificate.

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

The SHA-1 hash of the certificate.

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

The SHA-256 hash of the certificate.

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

The text description of UsageFlags .

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

The flags that show intended use for the certificate.

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

The certificate's version number.

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

The subject of the certificate used for client authentication.

Syntax

func (obj *RNIFSender) RecipientCertSubject() (string, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

The certificate (PEM/Base64 encoded).

Syntax

func (obj *RNIFSender) RecipientCertEncoded() ([]byte, error)
func (obj *RNIFSender) 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

ReplyData Property (RNIFSender Component)

This property is used to retrieve synchronous reply message content.

Syntax

func (obj *RNIFSender) ReplyData() ([]byte, error)

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

[]byte

ReplyHeaders Property (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) ReplyHeaders() (string, error)

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

string

ReplyMessage Property (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) ReplyMessage() (bool, error)
func (obj *RNIFSender) 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

ResponseType Property (RNIFSender Component)

Requested response type. Available only in RNIF 2.0.

Syntax

func (obj *RNIFSender) ResponseType() (int32, error)
func (obj *RNIFSender) SetResponseType(value 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.

Data Type

int32

RNIFVersion Property (RNIFSender Component)

The RNIF Standard Version used to generate this message.

Syntax

func (obj *RNIFSender) RNIFVersion() (int32, error)
func (obj *RNIFSender) SetRNIFVersion(value 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::

Data Type

int32

SecureTransportRequired Property (RNIFSender Component)

Indicates that security is required when forwarding this message.

Syntax

func (obj *RNIFSender) SecureTransportRequired() (bool, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

The PIP message data.

Syntax

func (obj *RNIFSender) ServiceContent() (string, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

The complete XML data from the Service Header.

Syntax

func (obj *RNIFSender) ServiceHeaderXML() (string, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

The code for this signal.

Syntax

func (obj *RNIFSender) SignalCode() (string, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

Whether or not this message is a signal.

Syntax

func (obj *RNIFSender) SignalMessage() (bool, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

The version of this signal.

Syntax

func (obj *RNIFSender) SignalVersion() (string, error)
func (obj *RNIFSender) 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

SignatureAlgorithm Property (RNIFSender Component)

Signature algorithm to be used in outgoing messages.

Syntax

func (obj *RNIFSender) SignatureAlgorithm() (string, error)
func (obj *RNIFSender) SetSignatureAlgorithm(value string) error

Default Value

"sha-256"

Remarks

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

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

The default value is "sha256".

Data Type

string

SignerCertEffectiveDate Property (RNIFSender Component)

The date on which this certificate becomes valid.

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

The date on which the certificate expires.

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

A comma-delimited list of extended key usage identifiers.

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

The issuer of the certificate.

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

The private key of the certificate (if available).

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

The public key of the certificate.

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

The serial number of the certificate encoded as a string.

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

The text description of the certificate's signature algorithm.

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

The name of the certificate store for the client certificate.

Syntax

func (obj *RNIFSender) SignerCertStore() ([]byte, error)
func (obj *RNIFSender) 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 (RNIFSender 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 *RNIFSender) SignerCertStorePassword() (string, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

The type of certificate store for this certificate.

Syntax

func (obj *RNIFSender) SignerCertStoreType() (int32, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

The MD5 hash of the certificate.

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

The SHA-1 hash of the certificate.

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

The SHA-256 hash of the certificate.

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

The text description of UsageFlags .

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

The flags that show intended use for the certificate.

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

The certificate's version number.

Syntax

func (obj *RNIFSender) 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 (RNIFSender Component)

The subject of the certificate used for client authentication.

Syntax

func (obj *RNIFSender) SignerCertSubject() (string, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

The certificate (PEM/Base64 encoded).

Syntax

func (obj *RNIFSender) SignerCertEncoded() ([]byte, error)
func (obj *RNIFSender) 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

SSLAcceptServerCertEffectiveDate Property (RNIFSender Component)

The date on which this certificate becomes valid.

Syntax

func (obj *RNIFSender) SSLAcceptServerCertEffectiveDate() (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

SSLAcceptServerCertExpirationDate Property (RNIFSender Component)

The date on which the certificate expires.

Syntax

func (obj *RNIFSender) SSLAcceptServerCertExpirationDate() (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

SSLAcceptServerCertExtendedKeyUsage Property (RNIFSender Component)

A comma-delimited list of extended key usage identifiers.

Syntax

func (obj *RNIFSender) SSLAcceptServerCertExtendedKeyUsage() (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

SSLAcceptServerCertFingerprint Property (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) SSLAcceptServerCertFingerprint() (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

SSLAcceptServerCertFingerprintSHA1 Property (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) SSLAcceptServerCertFingerprintSHA1() (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

SSLAcceptServerCertFingerprintSHA256 Property (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) SSLAcceptServerCertFingerprintSHA256() (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

SSLAcceptServerCertIssuer Property (RNIFSender Component)

The issuer of the certificate.

Syntax

func (obj *RNIFSender) SSLAcceptServerCertIssuer() (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

SSLAcceptServerCertPrivateKey Property (RNIFSender Component)

The private key of the certificate (if available).

Syntax

func (obj *RNIFSender) SSLAcceptServerCertPrivateKey() (string, error)

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

string

SSLAcceptServerCertPrivateKeyAvailable Property (RNIFSender Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

func (obj *RNIFSender) SSLAcceptServerCertPrivateKeyAvailable() (bool, error)

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

SSLAcceptServerCertPrivateKeyContainer Property (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) SSLAcceptServerCertPrivateKeyContainer() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

SSLAcceptServerCertPublicKey Property (RNIFSender Component)

The public key of the certificate.

Syntax

func (obj *RNIFSender) SSLAcceptServerCertPublicKey() (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

SSLAcceptServerCertPublicKeyAlgorithm Property (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) SSLAcceptServerCertPublicKeyAlgorithm() (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

SSLAcceptServerCertPublicKeyLength Property (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) SSLAcceptServerCertPublicKeyLength() (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

SSLAcceptServerCertSerialNumber Property (RNIFSender Component)

The serial number of the certificate encoded as a string.

Syntax

func (obj *RNIFSender) SSLAcceptServerCertSerialNumber() (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

SSLAcceptServerCertSignatureAlgorithm Property (RNIFSender Component)

The text description of the certificate's signature algorithm.

Syntax

func (obj *RNIFSender) SSLAcceptServerCertSignatureAlgorithm() (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

SSLAcceptServerCertStore Property (RNIFSender Component)

The name of the certificate store for the client certificate.

Syntax

func (obj *RNIFSender) SSLAcceptServerCertStore() ([]byte, error)
func (obj *RNIFSender) SetSSLAcceptServerCertStore(value []byte) error

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

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

Designations of certificate stores are platform dependent.

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

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

SSLAcceptServerCertStorePassword Property (RNIFSender 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 *RNIFSender) SSLAcceptServerCertStorePassword() (string, error)
func (obj *RNIFSender) SetSSLAcceptServerCertStorePassword(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

SSLAcceptServerCertStoreType Property (RNIFSender Component)

The type of certificate store for this certificate.

Syntax

func (obj *RNIFSender) SSLAcceptServerCertStoreType() (int32, error)
func (obj *RNIFSender) SetSSLAcceptServerCertStoreType(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

SSLAcceptServerCertSubjectAltNames Property (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) SSLAcceptServerCertSubjectAltNames() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

SSLAcceptServerCertThumbprintMD5 Property (RNIFSender Component)

The MD5 hash of the certificate.

Syntax

func (obj *RNIFSender) SSLAcceptServerCertThumbprintMD5() (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

SSLAcceptServerCertThumbprintSHA1 Property (RNIFSender Component)

The SHA-1 hash of the certificate.

Syntax

func (obj *RNIFSender) SSLAcceptServerCertThumbprintSHA1() (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

SSLAcceptServerCertThumbprintSHA256 Property (RNIFSender Component)

The SHA-256 hash of the certificate.

Syntax

func (obj *RNIFSender) SSLAcceptServerCertThumbprintSHA256() (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

SSLAcceptServerCertUsage Property (RNIFSender Component)

The text description of UsageFlags .

Syntax

func (obj *RNIFSender) SSLAcceptServerCertUsage() (string, error)

Default Value

""

Remarks

The text description of SSLAcceptServerCertUsageFlags.

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

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

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

This property is read-only.

Data Type

string

SSLAcceptServerCertUsageFlags Property (RNIFSender Component)

The flags that show intended use for the certificate.

Syntax

func (obj *RNIFSender) SSLAcceptServerCertUsageFlags() (int32, error)

Default Value

0

Remarks

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

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

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

This property is read-only.

Data Type

int32

SSLAcceptServerCertVersion Property (RNIFSender Component)

The certificate's version number.

Syntax

func (obj *RNIFSender) SSLAcceptServerCertVersion() (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

SSLAcceptServerCertSubject Property (RNIFSender Component)

The subject of the certificate used for client authentication.

Syntax

func (obj *RNIFSender) SSLAcceptServerCertSubject() (string, error)
func (obj *RNIFSender) SetSSLAcceptServerCertSubject(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

SSLAcceptServerCertEncoded Property (RNIFSender Component)

The certificate (PEM/Base64 encoded).

Syntax

func (obj *RNIFSender) SSLAcceptServerCertEncoded() ([]byte, error)
func (obj *RNIFSender) SetSSLAcceptServerCertEncoded(value []byte) error

Default Value

""

Remarks

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

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

Data Type

[]byte

SSLCertEffectiveDate Property (RNIFSender Component)

The date on which this certificate becomes valid.

Syntax

func (obj *RNIFSender) SSLCertEffectiveDate() (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

SSLCertExpirationDate Property (RNIFSender Component)

The date on which the certificate expires.

Syntax

func (obj *RNIFSender) SSLCertExpirationDate() (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

SSLCertExtendedKeyUsage Property (RNIFSender Component)

A comma-delimited list of extended key usage identifiers.

Syntax

func (obj *RNIFSender) SSLCertExtendedKeyUsage() (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

SSLCertFingerprint Property (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) SSLCertFingerprint() (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

SSLCertFingerprintSHA1 Property (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) SSLCertFingerprintSHA1() (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

SSLCertFingerprintSHA256 Property (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) SSLCertFingerprintSHA256() (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

SSLCertIssuer Property (RNIFSender Component)

The issuer of the certificate.

Syntax

func (obj *RNIFSender) SSLCertIssuer() (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

SSLCertPrivateKey Property (RNIFSender Component)

The private key of the certificate (if available).

Syntax

func (obj *RNIFSender) SSLCertPrivateKey() (string, error)

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

string

SSLCertPrivateKeyAvailable Property (RNIFSender Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

func (obj *RNIFSender) SSLCertPrivateKeyAvailable() (bool, error)

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

SSLCertPrivateKeyContainer Property (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) SSLCertPrivateKeyContainer() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

SSLCertPublicKey Property (RNIFSender Component)

The public key of the certificate.

Syntax

func (obj *RNIFSender) SSLCertPublicKey() (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

SSLCertPublicKeyAlgorithm Property (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) SSLCertPublicKeyAlgorithm() (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

SSLCertPublicKeyLength Property (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) SSLCertPublicKeyLength() (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

SSLCertSerialNumber Property (RNIFSender Component)

The serial number of the certificate encoded as a string.

Syntax

func (obj *RNIFSender) SSLCertSerialNumber() (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

SSLCertSignatureAlgorithm Property (RNIFSender Component)

The text description of the certificate's signature algorithm.

Syntax

func (obj *RNIFSender) SSLCertSignatureAlgorithm() (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

SSLCertStore Property (RNIFSender Component)

The name of the certificate store for the client certificate.

Syntax

func (obj *RNIFSender) SSLCertStore() ([]byte, error)
func (obj *RNIFSender) SetSSLCertStore(value []byte) error

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password-protected, specify the password in SSLCertStorePassword.

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

Designations of certificate stores are platform dependent.

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

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

SSLCertStorePassword Property (RNIFSender 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 *RNIFSender) SSLCertStorePassword() (string, error)
func (obj *RNIFSender) SetSSLCertStorePassword(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

SSLCertStoreType Property (RNIFSender Component)

The type of certificate store for this certificate.

Syntax

func (obj *RNIFSender) SSLCertStoreType() (int32, error)
func (obj *RNIFSender) SetSSLCertStoreType(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

SSLCertSubjectAltNames Property (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) SSLCertSubjectAltNames() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

SSLCertThumbprintMD5 Property (RNIFSender Component)

The MD5 hash of the certificate.

Syntax

func (obj *RNIFSender) SSLCertThumbprintMD5() (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

SSLCertThumbprintSHA1 Property (RNIFSender Component)

The SHA-1 hash of the certificate.

Syntax

func (obj *RNIFSender) SSLCertThumbprintSHA1() (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

SSLCertThumbprintSHA256 Property (RNIFSender Component)

The SHA-256 hash of the certificate.

Syntax

func (obj *RNIFSender) SSLCertThumbprintSHA256() (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

SSLCertUsage Property (RNIFSender Component)

The text description of UsageFlags .

Syntax

func (obj *RNIFSender) SSLCertUsage() (string, error)

Default Value

""

Remarks

The text description of SSLCertUsageFlags.

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

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

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

This property is read-only.

Data Type

string

SSLCertUsageFlags Property (RNIFSender Component)

The flags that show intended use for the certificate.

Syntax

func (obj *RNIFSender) SSLCertUsageFlags() (int32, error)

Default Value

0

Remarks

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

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

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

This property is read-only.

Data Type

int32

SSLCertVersion Property (RNIFSender Component)

The certificate's version number.

Syntax

func (obj *RNIFSender) SSLCertVersion() (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

SSLCertSubject Property (RNIFSender Component)

The subject of the certificate used for client authentication.

Syntax

func (obj *RNIFSender) SSLCertSubject() (string, error)
func (obj *RNIFSender) SetSSLCertSubject(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

SSLCertEncoded Property (RNIFSender Component)

The certificate (PEM/Base64 encoded).

Syntax

func (obj *RNIFSender) SSLCertEncoded() ([]byte, error)
func (obj *RNIFSender) SetSSLCertEncoded(value []byte) error

Default Value

""

Remarks

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

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

Data Type

[]byte

SSLProvider Property (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) SSLProvider() (int32, error)
func (obj *RNIFSender) SetSSLProvider(value int32) error

Possible Values

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

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the component will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

Additional Notes

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

When Automatic is selected, on Windows, the component will use the platform implementation. On Linux/macOS, the component will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the component will always try and use the platform implementation. If the platform TLS 1.3 implementation is not available, the internal implementation will be used.

Data Type

int32

SSLServerCertEffectiveDate Property (RNIFSender Component)

The date on which this certificate becomes valid.

Syntax

func (obj *RNIFSender) SSLServerCertEffectiveDate() (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

SSLServerCertExpirationDate Property (RNIFSender Component)

The date on which the certificate expires.

Syntax

func (obj *RNIFSender) SSLServerCertExpirationDate() (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

SSLServerCertExtendedKeyUsage Property (RNIFSender Component)

A comma-delimited list of extended key usage identifiers.

Syntax

func (obj *RNIFSender) SSLServerCertExtendedKeyUsage() (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

SSLServerCertFingerprint Property (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) SSLServerCertFingerprint() (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

SSLServerCertFingerprintSHA1 Property (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) SSLServerCertFingerprintSHA1() (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

SSLServerCertFingerprintSHA256 Property (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) SSLServerCertFingerprintSHA256() (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

SSLServerCertIssuer Property (RNIFSender Component)

The issuer of the certificate.

Syntax

func (obj *RNIFSender) SSLServerCertIssuer() (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

SSLServerCertPrivateKey Property (RNIFSender Component)

The private key of the certificate (if available).

Syntax

func (obj *RNIFSender) SSLServerCertPrivateKey() (string, error)

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

string

SSLServerCertPrivateKeyAvailable Property (RNIFSender Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

func (obj *RNIFSender) SSLServerCertPrivateKeyAvailable() (bool, error)

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

SSLServerCertPrivateKeyContainer Property (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) SSLServerCertPrivateKeyContainer() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

SSLServerCertPublicKey Property (RNIFSender Component)

The public key of the certificate.

Syntax

func (obj *RNIFSender) SSLServerCertPublicKey() (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

SSLServerCertPublicKeyAlgorithm Property (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) SSLServerCertPublicKeyAlgorithm() (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

SSLServerCertPublicKeyLength Property (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) SSLServerCertPublicKeyLength() (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

SSLServerCertSerialNumber Property (RNIFSender Component)

The serial number of the certificate encoded as a string.

Syntax

func (obj *RNIFSender) SSLServerCertSerialNumber() (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

SSLServerCertSignatureAlgorithm Property (RNIFSender Component)

The text description of the certificate's signature algorithm.

Syntax

func (obj *RNIFSender) SSLServerCertSignatureAlgorithm() (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

SSLServerCertStore Property (RNIFSender Component)

The name of the certificate store for the client certificate.

Syntax

func (obj *RNIFSender) SSLServerCertStore() ([]byte, error)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.

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

Designations of certificate stores are platform dependent.

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

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

This property is read-only.

Data Type

[]byte

SSLServerCertStorePassword Property (RNIFSender 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 *RNIFSender) SSLServerCertStorePassword() (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.

This property is read-only.

Data Type

string

SSLServerCertStoreType Property (RNIFSender Component)

The type of certificate store for this certificate.

Syntax

func (obj *RNIFSender) SSLServerCertStoreType() (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:

This property is read-only.

Data Type

int32

SSLServerCertSubjectAltNames Property (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) SSLServerCertSubjectAltNames() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

SSLServerCertThumbprintMD5 Property (RNIFSender Component)

The MD5 hash of the certificate.

Syntax

func (obj *RNIFSender) SSLServerCertThumbprintMD5() (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

SSLServerCertThumbprintSHA1 Property (RNIFSender Component)

The SHA-1 hash of the certificate.

Syntax

func (obj *RNIFSender) SSLServerCertThumbprintSHA1() (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

SSLServerCertThumbprintSHA256 Property (RNIFSender Component)

The SHA-256 hash of the certificate.

Syntax

func (obj *RNIFSender) SSLServerCertThumbprintSHA256() (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

SSLServerCertUsage Property (RNIFSender Component)

The text description of UsageFlags .

Syntax

func (obj *RNIFSender) SSLServerCertUsage() (string, error)

Default Value

""

Remarks

The text description of SSLServerCertUsageFlags.

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

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

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

This property is read-only.

Data Type

string

SSLServerCertUsageFlags Property (RNIFSender Component)

The flags that show intended use for the certificate.

Syntax

func (obj *RNIFSender) SSLServerCertUsageFlags() (int32, error)

Default Value

0

Remarks

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

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

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

This property is read-only.

Data Type

int32

SSLServerCertVersion Property (RNIFSender Component)

The certificate's version number.

Syntax

func (obj *RNIFSender) SSLServerCertVersion() (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

SSLServerCertSubject Property (RNIFSender Component)

The subject of the certificate used for client authentication.

Syntax

func (obj *RNIFSender) SSLServerCertSubject() (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.

This property is read-only.

Data Type

string

SSLServerCertEncoded Property (RNIFSender Component)

The certificate (PEM/Base64 encoded).

Syntax

func (obj *RNIFSender) SSLServerCertEncoded() ([]byte, error)

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

[]byte

StandardName Property (RNIFSender Component)

The name of the standard used to create this message.

Syntax

func (obj *RNIFSender) StandardName() (string, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

The version of the standard used to create this message.

Syntax

func (obj *RNIFSender) StandardVersion() (string, error)
func (obj *RNIFSender) 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

Timeout Property (RNIFSender Component)

The timeout for the class.

Syntax

func (obj *RNIFSender) Timeout() (int32, error)
func (obj *RNIFSender) SetTimeout(value int32) error

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the component will wait for the operation to complete before returning control.

The component will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If Timeout expires, and the operation is not yet complete, the component fails with an error.

NOTE: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

int32

ToRole Property (RNIFSender Component)

The role of the entity receiving this message.

Syntax

func (obj *RNIFSender) ToRole() (string, error)
func (obj *RNIFSender) 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 (RNIFSender Component)

The service for which this message is bound.

Syntax

func (obj *RNIFSender) ToService() (string, error)
func (obj *RNIFSender) 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

URL Property (RNIFSender Component)

The URL to which requests are sent.

Syntax

func (obj *RNIFSender) URL() (string, error)
func (obj *RNIFSender) SetURL(value string) error

Default Value

""

Remarks

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

Data Type

string

Config Method (RNIFSender Component)

Sets or retrieves a configuration setting.

Syntax

func (obj *RNIFSender) 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.

Post Method (RNIFSender Component)

Posts Message to the RNIF partner.

Syntax

func (obj *RNIFSender) Post() error

Remarks

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

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

Reset Method (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) 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.

ResetHeaders Method (RNIFSender Component)

Resets all HTTP headers and cookies.

Syntax

func (obj *RNIFSender) ResetHeaders() error

Remarks

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

SetRequestHeader Method (RNIFSender Component)

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

Syntax

func (obj *RNIFSender) SetRequestHeader(Header string, Value string) error

Remarks

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

Connected Event (RNIFSender Component)

Fired immediately after a connection completes (or fails).

Syntax

// RNIFSenderConnectedEventArgs carries the RNIFSender Connected event's parameters.
type RNIFSenderConnectedEventArgs struct {...}

func (args *RNIFSenderConnectedEventArgs) StatusCode() int32
func (args *RNIFSenderConnectedEventArgs) Description() string

// RNIFSenderConnectedEvent defines the signature of the RNIFSender Connected event's handler function.
type RNIFSenderConnectedEvent func(sender *RNIFSender, args *RNIFSenderConnectedEventArgs)

func (obj *RNIFSender) GetOnConnectedHandler() RNIFSenderConnectedEvent
func (obj *RNIFSender) SetOnConnectedHandler(handlerFunc RNIFSenderConnectedEvent)

Remarks

If the connection is made normally, StatusCode is 0 and Description is "OK".

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

Please refer to the Error Codes section for more information.

Disconnected Event (RNIFSender Component)

Fired when a connection is closed.

Syntax

// RNIFSenderDisconnectedEventArgs carries the RNIFSender Disconnected event's parameters.
type RNIFSenderDisconnectedEventArgs struct {...}

func (args *RNIFSenderDisconnectedEventArgs) StatusCode() int32
func (args *RNIFSenderDisconnectedEventArgs) Description() string

// RNIFSenderDisconnectedEvent defines the signature of the RNIFSender Disconnected event's handler function.
type RNIFSenderDisconnectedEvent func(sender *RNIFSender, args *RNIFSenderDisconnectedEventArgs)

func (obj *RNIFSender) GetOnDisconnectedHandler() RNIFSenderDisconnectedEvent
func (obj *RNIFSender) SetOnDisconnectedHandler(handlerFunc RNIFSenderDisconnectedEvent)

Remarks

If the connection is broken normally, StatusCode is 0 and Description is "OK".

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

Please refer to the Error Codes section for more information.

EndTransfer Event (RNIFSender Component)

Fired when a document finishes transferring.

Syntax

// RNIFSenderEndTransferEventArgs carries the RNIFSender EndTransfer event's parameters.
type RNIFSenderEndTransferEventArgs struct {...}

func (args *RNIFSenderEndTransferEventArgs) Direction() int32

// RNIFSenderEndTransferEvent defines the signature of the RNIFSender EndTransfer event's handler function.
type RNIFSenderEndTransferEvent func(sender *RNIFSender, args *RNIFSenderEndTransferEventArgs)

func (obj *RNIFSender) GetOnEndTransferHandler() RNIFSenderEndTransferEvent
func (obj *RNIFSender) SetOnEndTransferHandler(handlerFunc RNIFSenderEndTransferEvent)

Remarks

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

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

Error Event (RNIFSender Component)

Fired when information is available about errors during data delivery.

Syntax

// RNIFSenderErrorEventArgs carries the RNIFSender Error event's parameters.
type RNIFSenderErrorEventArgs struct {...}

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

// RNIFSenderErrorEvent defines the signature of the RNIFSender Error event's handler function.
type RNIFSenderErrorEvent func(sender *RNIFSender, args *RNIFSenderErrorEventArgs)

func (obj *RNIFSender) GetOnErrorHandler() RNIFSenderErrorEvent
func (obj *RNIFSender) SetOnErrorHandler(handlerFunc RNIFSenderErrorEvent)

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.

Header Event (RNIFSender Component)

Fired every time a header line comes in.

Syntax

// RNIFSenderHeaderEventArgs carries the RNIFSender Header event's parameters.
type RNIFSenderHeaderEventArgs struct {...}

func (args *RNIFSenderHeaderEventArgs) Field() string
func (args *RNIFSenderHeaderEventArgs) Value() string

// RNIFSenderHeaderEvent defines the signature of the RNIFSender Header event's handler function.
type RNIFSenderHeaderEvent func(sender *RNIFSender, args *RNIFSenderHeaderEventArgs)

func (obj *RNIFSender) GetOnHeaderHandler() RNIFSenderHeaderEvent
func (obj *RNIFSender) SetOnHeaderHandler(handlerFunc RNIFSenderHeaderEvent)

Remarks

The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

Redirect Event (RNIFSender Component)

Fired when a redirection is received from the server.

Syntax

// RNIFSenderRedirectEventArgs carries the RNIFSender Redirect event's parameters.
type RNIFSenderRedirectEventArgs struct {...}

func (args *RNIFSenderRedirectEventArgs) Location() string
func (args *RNIFSenderRedirectEventArgs) Accept() bool
func (args *RNIFSenderRedirectEventArgs) SetAccept(value bool)

// RNIFSenderRedirectEvent defines the signature of the RNIFSender Redirect event's handler function.
type RNIFSenderRedirectEvent func(sender *RNIFSender, args *RNIFSenderRedirectEventArgs)

func (obj *RNIFSender) GetOnRedirectHandler() RNIFSenderRedirectEvent
func (obj *RNIFSender) SetOnRedirectHandler(handlerFunc RNIFSenderRedirectEvent)

Remarks

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

SetCookie Event (RNIFSender Component)

Fired for every cookie set by the server.

Syntax

// RNIFSenderSetCookieEventArgs carries the RNIFSender SetCookie event's parameters.
type RNIFSenderSetCookieEventArgs struct {...}

func (args *RNIFSenderSetCookieEventArgs) Name() string
func (args *RNIFSenderSetCookieEventArgs) Value() string
func (args *RNIFSenderSetCookieEventArgs) Expires() string
func (args *RNIFSenderSetCookieEventArgs) Domain() string
func (args *RNIFSenderSetCookieEventArgs) Path() string
func (args *RNIFSenderSetCookieEventArgs) Secure() bool

// RNIFSenderSetCookieEvent defines the signature of the RNIFSender SetCookie event's handler function.
type RNIFSenderSetCookieEvent func(sender *RNIFSender, args *RNIFSenderSetCookieEventArgs)

func (obj *RNIFSender) GetOnSetCookieHandler() RNIFSenderSetCookieEvent
func (obj *RNIFSender) SetOnSetCookieHandler(handlerFunc RNIFSenderSetCookieEvent)

Remarks

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

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

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

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

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

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

SSLServerAuthentication Event (RNIFSender Component)

Fired after the server presents its certificate to the client.

Syntax

// RNIFSenderSSLServerAuthenticationEventArgs carries the RNIFSender SSLServerAuthentication event's parameters.
type RNIFSenderSSLServerAuthenticationEventArgs struct {...}

func (args *RNIFSenderSSLServerAuthenticationEventArgs) CertEncoded() []byte
func (args *RNIFSenderSSLServerAuthenticationEventArgs) CertSubject() string
func (args *RNIFSenderSSLServerAuthenticationEventArgs) CertIssuer() string
func (args *RNIFSenderSSLServerAuthenticationEventArgs) Status() string
func (args *RNIFSenderSSLServerAuthenticationEventArgs) Accept() bool
func (args *RNIFSenderSSLServerAuthenticationEventArgs) SetAccept(value bool)

// RNIFSenderSSLServerAuthenticationEvent defines the signature of the RNIFSender SSLServerAuthentication event's handler function.
type RNIFSenderSSLServerAuthenticationEvent func(sender *RNIFSender, args *RNIFSenderSSLServerAuthenticationEventArgs)

func (obj *RNIFSender) GetOnSSLServerAuthenticationHandler() RNIFSenderSSLServerAuthenticationEvent
func (obj *RNIFSender) SetOnSSLServerAuthenticationHandler(handlerFunc RNIFSenderSSLServerAuthenticationEvent)

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (RNIFSender Component)

Fired when secure connection progress messages are available.

Syntax

// RNIFSenderSSLStatusEventArgs carries the RNIFSender SSLStatus event's parameters.
type RNIFSenderSSLStatusEventArgs struct {...}

func (args *RNIFSenderSSLStatusEventArgs) Message() string

// RNIFSenderSSLStatusEvent defines the signature of the RNIFSender SSLStatus event's handler function.
type RNIFSenderSSLStatusEvent func(sender *RNIFSender, args *RNIFSenderSSLStatusEventArgs)

func (obj *RNIFSender) GetOnSSLStatusHandler() RNIFSenderSSLStatusEvent
func (obj *RNIFSender) SetOnSSLStatusHandler(handlerFunc RNIFSenderSSLStatusEvent)

Remarks

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

StartTransfer Event (RNIFSender Component)

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

Syntax

// RNIFSenderStartTransferEventArgs carries the RNIFSender StartTransfer event's parameters.
type RNIFSenderStartTransferEventArgs struct {...}

func (args *RNIFSenderStartTransferEventArgs) Direction() int32

// RNIFSenderStartTransferEvent defines the signature of the RNIFSender StartTransfer event's handler function.
type RNIFSenderStartTransferEvent func(sender *RNIFSender, args *RNIFSenderStartTransferEventArgs)

func (obj *RNIFSender) GetOnStartTransferHandler() RNIFSenderStartTransferEvent
func (obj *RNIFSender) SetOnStartTransferHandler(handlerFunc RNIFSenderStartTransferEvent)

Remarks

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

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

Transfer Event (RNIFSender Component)

Fired while a document transfers (delivers document).

Syntax

// RNIFSenderTransferEventArgs carries the RNIFSender Transfer event's parameters.
type RNIFSenderTransferEventArgs struct {...}

func (args *RNIFSenderTransferEventArgs) Direction() int32
func (args *RNIFSenderTransferEventArgs) BytesTransferred() int64
func (args *RNIFSenderTransferEventArgs) PercentDone() int32
func (args *RNIFSenderTransferEventArgs) Text() []byte

// RNIFSenderTransferEvent defines the signature of the RNIFSender Transfer event's handler function.
type RNIFSenderTransferEvent func(sender *RNIFSender, args *RNIFSenderTransferEventArgs)

func (obj *RNIFSender) GetOnTransferHandler() RNIFSenderTransferEvent
func (obj *RNIFSender) SetOnTransferHandler(handlerFunc RNIFSenderTransferEvent)

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

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

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

NOTE: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Config Settings (RNIFSender 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.

RNIFSender Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (RNIFSender Component)

SMIME Errors

XML Errors

HTTP Errors

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

TCPClient Errors

TCP/IP Errors