# RNIFSender Class The RNIFSender class implements a RosettaNet Implementation Framework (RNIF) client. ## Syntax ```text 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](#standardname-property-rnifsender-class) and [StandardVersion](#standardversion-property-rnifsender-class) of the message being sent in the preamble header. In the delivery header, the client must specify the [SecureTransportRequired](#securetransportrequired-property-rnifsender-class), [MessageDateTime](#messagedatetime-property-rnifsender-class), [MessageReceiverId](#messagereceiverid-property-rnifsender-class), [MessageSenderId](#messagesenderid-property-rnifsender-class), and [MessageTrackingId](#messagetrackingid-property-rnifsender-class) 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](#servicecontent-property-rnifsender-class) 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](#rnifattachment-type) to the [Attachments](#attachments-property-rnifsender-class) 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](#certificate-property-rnifsender-class). To encrypt, set [RecipientCert](#recipientcert-property-rnifsender-class). To change which parts of the message, if any, are to be encrypted, set the [EncryptionType](#encryptiontype-property-rnifsender-class) property. The final property to be set is the [URL](#url-property-rnifsender-class) to which the client is posting the request. Once this is done, a call to the [Post](#post-method-rnifsender-class) method causes the class to generate, sign, and encrypt the RosettaNet business document and upload it to the server. NOTE: when the **Post** method is called, the class 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 class throws an exception 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](#responsetype-property-rnifsender-class) before calling [Post](#post-method-rnifsender-class). If a synchronous response is received after the HTTPS post, [ReplyHeaders](#replyheaders-property-rnifsender-class) and [ReplyData](#replydata-property-rnifsender-class) will be populated appropriately. ## Property List *The following is the full list of the properties of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [ActionCode](#actioncode-property-rnifsender-class) | The code for this action. | | [ActionMessage](#actionmessage-property-rnifsender-class) | Whether or not this message is an action message. | | [ActionMessageStandardName](#actionmessagestandardname-property-rnifsender-class) | The name of the standard used to create this action. | | [ActionMessageStandardVersion](#actionmessagestandardversion-property-rnifsender-class) | The version of the standard used to create this action. | | [Attachments](#attachments-property-rnifsender-class) | A collection of files attached to the current RNIF message. | | [BusinessActivity](#businessactivity-property-rnifsender-class) | This property denotes the type of business activity. | | [Certificate](#certificate-property-rnifsender-class) | The encryption certificate of the sender. | | [Cookies](#cookies-property-rnifsender-class) | A collection of cookies. | | [DeliveryHeaderXML](#deliveryheaderxml-property-rnifsender-class) | The complete XML data from the Delivery Header. | | [EncryptionAlgorithm](#encryptionalgorithm-property-rnifsender-class) | The algorithm used to encrypt the EDI data. | | [EncryptionType](#encryptiontype-property-rnifsender-class) | The encryption type for RNIF 2.0. | | [Firewall](#firewall-property-rnifsender-class) | A set of properties related to firewall access. | | [FromRole](#fromrole-property-rnifsender-class) | The business role of the entity that originated this message. | | [FromService](#fromservice-property-rnifsender-class) | The service that originated this message. | | [GlobalUsageCode](#globalusagecode-property-rnifsender-class) | A universal code describing basic usage for this message. | | [LocalHost](#localhost-property-rnifsender-class) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. | | [MessageDateTime](#messagedatetime-property-rnifsender-class) | The time at which this message was sent. | | [MessageReceiverId](#messagereceiverid-property-rnifsender-class) | Identity of the entity receiving this message. | | [MessageReceiverLocation](#messagereceiverlocation-property-rnifsender-class) | Location of the entity receiving this message. | | [MessageSenderId](#messagesenderid-property-rnifsender-class) | Identity of the entity that sent this message. | | [MessageSenderLocation](#messagesenderlocation-property-rnifsender-class) | Location of the entity that sent this message. | | [MessageTrackingId](#messagetrackingid-property-rnifsender-class) | Unique value that identifies this message. | | [OriginalActionCode](#originalactioncode-property-rnifsender-class) | The action code of the original message. | | [OriginalMessageStandardName](#originalmessagestandardname-property-rnifsender-class) | The name of the standard used to create the original message. | | [OriginalMessageStandardVersion](#originalmessagestandardversion-property-rnifsender-class) | The version of the standard used to create the original message. | | [OriginalMessageTrackingId](#originalmessagetrackingid-property-rnifsender-class) | Tracking identifier for the original message. | | [PartnerId](#partnerid-property-rnifsender-class) | Identity of the partner. | | [PartnerKnown](#partnerknown-property-rnifsender-class) | Whether or not the partner is known. | | [PartnerLocation](#partnerlocation-property-rnifsender-class) | Location of the partner. | | [PartnerPIPBindingId](#partnerpipbindingid-property-rnifsender-class) | The partner-defined PIP payload binding ID. | | [PartnerURL](#partnerurl-property-rnifsender-class) | A URL to which replies must be sent if the partner is unknown. | | [PIPCode](#pipcode-property-rnifsender-class) | RosettaNet PIP code of this message. | | [PIPInstanceId](#pipinstanceid-property-rnifsender-class) | The Id of this PIP instance. | | [PIPVersion](#pipversion-property-rnifsender-class) | RosettaNet PIP version of this message. | | [PreambleHeaderXML](#preambleheaderxml-property-rnifsender-class) | The complete XML data from the Preamble Header. | | [Proxy](#proxy-property-rnifsender-class) | A set of properties related to proxy access. | | [QOSSpecifications](#qosspecifications-property-rnifsender-class) | Specifies quality of service constraints for this message. | | [ReceiptSignerCert](#receiptsignercert-property-rnifsender-class) | The public key certificate for the receipt signature. | | [RecipientCert](#recipientcert-property-rnifsender-class) | The encryption certificate of the recipient. | | [ReplyData](#replydata-property-rnifsender-class) | This property is used to retrieve synchronous reply message content. | | [ReplyHeaders](#replyheaders-property-rnifsender-class) | This property is used to retrieve headers from synchronous reply messages. | | [ReplyMessage](#replymessage-property-rnifsender-class) | Whether or not this message is a reply to another message. | | [ResponseType](#responsetype-property-rnifsender-class) | Requested response type. Available only in RNIF 2.0. | | [RNIFVersion](#rnifversion-property-rnifsender-class) | The RNIF Standard Version used to generate this message. | | [SecureTransportRequired](#securetransportrequired-property-rnifsender-class) | Indicates that security is required when forwarding this message. | | [ServiceContent](#servicecontent-property-rnifsender-class) | The PIP message data. | | [ServiceHeaderXML](#serviceheaderxml-property-rnifsender-class) | The complete XML data from the Service Header. | | [SignalCode](#signalcode-property-rnifsender-class) | The code for this signal. | | [SignalMessage](#signalmessage-property-rnifsender-class) | Whether or not this message is a signal. | | [SignalVersion](#signalversion-property-rnifsender-class) | The version of this signal. | | [SignatureAlgorithm](#signaturealgorithm-property-rnifsender-class) | Signature algorithm to be used in outgoing messages. | | [SignerCert](#signercert-property-rnifsender-class) | Contains the certificate to use when signing messages. | | [SSLAcceptServerCert](#sslacceptservercert-property-rnifsender-class) | Instructs the class to unconditionally accept the server certificate that matches the supplied certificate. | | [SSLCert](#sslcert-property-rnifsender-class) | The certificate to be used during Secure Sockets Layer (SSL) negotiation. | | [SSLProvider](#sslprovider-property-rnifsender-class) | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. | | [SSLServerCert](#sslservercert-property-rnifsender-class) | The server certificate for the last established connection. | | [StandardName](#standardname-property-rnifsender-class) | The name of the standard used to create this message. | | [StandardVersion](#standardversion-property-rnifsender-class) | The version of the standard used to create this message. | | [Timeout](#timeout-property-rnifsender-class) | The timeout for the class. | | [ToRole](#torole-property-rnifsender-class) | The role of the entity receiving this message. | | [ToService](#toservice-property-rnifsender-class) | The service for which this message is bound. | | [URL](#url-property-rnifsender-class) | The URL to which requests are sent. | ## Method List *The following is the full list of the methods of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Config](#config-method-rnifsender-class) | Sets or retrieves a configuration setting. | | [Post](#post-method-rnifsender-class) | Posts Message to the RNIF partner. | | [Reset](#reset-method-rnifsender-class) | This property is used to reset all attributes of the Rnifsender instance. | | [ResetHeaders](#resetheaders-method-rnifsender-class) | Resets all HTTP headers, cookies, LocalFile , and AttachedFile . | | [SetRequestHeader](#setrequestheader-method-rnifsender-class) | Allows the user to set or add arbitrary HTTP request headers. | ## Event List *The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Connected](#connected-event-rnifsender-class) | Fired immediately after a connection completes (or fails). | | [Disconnected](#disconnected-event-rnifsender-class) | Fired when a connection is closed. | | [EndTransfer](#endtransfer-event-rnifsender-class) | Fired when a document finishes transferring. | | [Error](#error-event-rnifsender-class) | Fired when information is available about errors during data delivery. | | [Header](#header-event-rnifsender-class) | Fired every time a header line comes in. | | [Redirect](#redirect-event-rnifsender-class) | Fired when a redirection is received from the server. | | [SetCookie](#setcookie-event-rnifsender-class) | Fired for every cookie set by the server. | | [SSLServerAuthentication](#sslserverauthentication-event-rnifsender-class) | Fired after the server presents its certificate to the client. | | [SSLStatus](#sslstatus-event-rnifsender-class) | Fired when secure connection progress messages are available. | | [StartTransfer](#starttransfer-event-rnifsender-class) | Fired when a document starts transferring (after the headers). | | [Transfer](#transfer-event-rnifsender-class) | Fired while a document transfers (delivers document). | ## Config Settings *The following is a list of config settings for the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [ApplyBase64Encoding](#ApplyBase64Encoding) | Allows you to control the base64 encoding of the message body when signing the message. | | [Authorization](#Authorization) | The Authorization string to be sent to the server. | | [AuthScheme](#AuthScheme) | The authorization scheme to be used when server authorization is to be performed. | | [FromPartnerClassificationCode](#FromPartnerClassificationCode) | Code identifying the sending partner's function in the supply chain. | | [GlobalProcessCode](#GlobalProcessCode) | Business process identifier. | | [HTTPStatusLine](#HTTPStatusLine) | Returns the status line of the last response. | | [Password](#Password) | A password if authentication is to be used. | | [RequestBody](#RequestBody) | The full body of the outgoing request. | | [RequestHeaders](#RequestHeaders) | The MIME headers of the outgoing request. | | [ToPartnerClassificationCode](#ToPartnerClassificationCode) | Code identifying the receiving partner's function in the supply chain. | | [TransactionCode](#TransactionCode) | The service transaction code. | | [TransactionId](#TransactionId) | A unique transaction Id. | | [User](#User) | A user name if authentication is to be used. | | [AcceptEncoding](#AcceptEncoding) | Used to tell the server which types of content encodings the client supports. | | [AllowHTTPCompression](#AllowHTTPCompression) | This property enables HTTP compression for receiving data. | | [AllowHTTPFallback](#AllowHTTPFallback) | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. | | [AllowNTLMFallback](#AllowNTLMFallback) | Whether to allow fallback from Negotiate to NTLM when authenticating. | | [Append](#Append) | Whether to append data to LocalFile. | | [Authorization](#Authorization) | The Authorization string to be sent to the server. | | [BytesTransferred](#BytesTransferred) | Contains the number of bytes transferred in the response data. | | [ChunkSize](#ChunkSize) | Specifies the chunk size in bytes when using chunked encoding. | | [CompressHTTPRequest](#CompressHTTPRequest) | Set to true to compress the body of a PUT or POST request. | | [EncodeURL](#EncodeURL) | If set to True the URL will be encoded by the class. | | [FollowRedirects](#FollowRedirects) | Determines what happens when the server issues a redirect. | | [GetOn302Redirect](#GetOn302Redirect) | If set to True the class will perform a GET on the new location. | | [HTTP2HeadersWithoutIndexing](#HTTP2HeadersWithoutIndexing) | HTTP2 headers that should not update the dynamic header table with incremental indexing. | | [HTTPVersion](#HTTPVersion) | The version of HTTP used by the class. | | [IfModifiedSince](#IfModifiedSince) | A date determining the maximum age of the desired document. | | [KeepAlive](#KeepAlive) | Determines whether the HTTP connection is closed after completion of the request. | | [KerberosSPN](#KerberosSPN) | The Service Principal Name for the Kerberos Domain Controller. | | [LogLevel](#LogLevel) | The level of detail that is logged. | | [MaxHeaders](#MaxHeaders) | Instructs class to save the amount of headers specified that are returned by the server after a Header event has been fired. | | [MaxHTTPCookies](#MaxHTTPCookies) | Instructs class to save the amount of cookies specified that are returned by the server when a SetCookie event is fired. | | [MaxRedirectAttempts](#MaxRedirectAttempts) | Limits the number of redirects that are followed in a request. | | [NegotiatedHTTPVersion](#NegotiatedHTTPVersion) | The negotiated HTTP version. | | [OtherHeaders](#OtherHeaders) | Other headers as determined by the user (optional). | | [ProxyAuthorization](#ProxyAuthorization) | The authorization string to be sent to the proxy server. | | [ProxyAuthScheme](#ProxyAuthScheme) | The authorization scheme to be used for the proxy. | | [ProxyPassword](#ProxyPassword) | A password if authentication is to be used for the proxy. | | [ProxyPort](#ProxyPort) | Port for the proxy server (default 80). | | [ProxyServer](#ProxyServer) | Name or IP address of a proxy server (optional). | | [ProxyUser](#ProxyUser) | A user name if authentication is to be used for the proxy. | | [SentHeaders](#SentHeaders) | The full set of headers as sent by the client. | | [StatusCode](#StatusCode) | The status code of the last response from the server. | | [StatusLine](#StatusLine) | The first line of the last response from the server. | | [TransferredData](#TransferredData) | The contents of the last response from the server. | | [TransferredDataLimit](#TransferredDataLimit) | The maximum number of incoming bytes to be stored by the class. | | [TransferredHeaders](#TransferredHeaders) | The full set of headers as received from the server. | | [TransferredRequest](#TransferredRequest) | The full request as sent by the client. | | [UseChunkedEncoding](#UseChunkedEncoding) | Enables or Disables HTTP chunked encoding for transfers. | | [UseIDNs](#UseIDNs) | Whether to encode hostnames to internationalized domain names. | | [UsePlatformDeflate](#UsePlatformDeflate) | Whether to use the platform implementation to decompress compressed responses. | | [UsePlatformHTTPClient](#UsePlatformHTTPClient) | Whether or not to use the platform HTTP client. | | [UseProxyAutoConfigURL](#UseProxyAutoConfigURL) | Whether to use a Proxy auto-config file when attempting a connection. | | [UserAgent](#UserAgent) | Information about the user agent (browser). | | [CloseStreamAfterTransfer](#CloseStreamAfterTransfer) | If true, the class will close the upload or download stream after the transfer. | | [ConnectionTimeout](#ConnectionTimeout) | Sets a separate timeout value for establishing a connection. | | [EnableFallback](#EnableFallback) | Whether to try the other addresses the remote host resolves to when a connection attempt fails. | | [FallbackTimeout](#FallbackTimeout) | The maximum time in milliseconds to spend on connection attempts when EnableFallback is enabled. | | [FirewallAutoDetect](#FirewallAutoDetect) | Tells the class whether or not to automatically detect and use firewall system settings, if available. | | [FirewallHost](#FirewallHost) | Name or IP address of firewall (optional). | | [FirewallHTTPVersion](#FirewallHTTPVersion) | The HTTP version to be used when connecting through a tunneling proxy. | | [FirewallListener](#FirewallListener) | If true, the class binds to a SOCKS firewall as a server (TCPClient only). | | [FirewallPassword](#FirewallPassword) | Password to be used if authentication is to be used when connecting through the firewall. | | [FirewallPort](#FirewallPort) | The TCP port for the FirewallHost;. | | [FirewallType](#FirewallType) | Determines the type of firewall to connect through. | | [FirewallUser](#FirewallUser) | A user name if authentication is to be used connecting through a firewall. | | [KeepAliveInterval](#KeepAliveInterval) | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. | | [KeepAliveTime](#KeepAliveTime) | The inactivity time in milliseconds before a TCP keep-alive packet is sent. | | [Linger](#Linger) | When set to True, connections are terminated gracefully. | | [LingerTime](#LingerTime) | Time in seconds to have the connection linger. | | [LocalHost](#LocalHost) | The name of the local host through which connections are initiated or accepted. | | [LocalPort](#LocalPort) | The port in the local host where the class binds. | | [MaxLineLength](#MaxLineLength) | The maximum amount of data to accumulate when no EOL is found. | | [MaxTransferRate](#MaxTransferRate) | The transfer rate limit in bytes per second. | | [ProxyExceptionsList](#ProxyExceptionsList) | A semicolon separated list of hosts and IPs to bypass when using a proxy. | | [TCPKeepAlive](#TCPKeepAlive) | Determines whether or not the keep alive socket option is enabled. | | [TcpNoDelay](#TcpNoDelay) | Whether or not to delay when sending packets. | | [UseIPv6](#UseIPv6) | Whether to use IPv6. | | [UseNTLMv2](#UseNTLMv2) | Whether to use NTLM V2. | | [LogSSLPackets](#LogSSLPackets) | Controls whether SSL packets are logged when using the internal security API. | | [ReuseSSLSession](#ReuseSSLSession) | Determines if the SSL session is reused. | | [SSLCACerts](#SSLCACerts) | A newline separated list of CA certificates to be included when performing an SSL handshake. | | [SSLCheckCRL](#SSLCheckCRL) | Whether to check the Certificate Revocation List for the server certificate. | | [SSLCheckOCSP](#SSLCheckOCSP) | Whether to use OCSP to check the status of the server certificate. | | [SSLCipherStrength](#SSLCipherStrength) | The minimum cipher strength used for bulk encryption. | | [SSLClientCACerts](#SSLClientCACerts) | A newline separated list of CA certificates to use during SSL client certificate validation. | | [SSLContextProtocol](#SSLContextProtocol) | The protocol used when getting an SSLContext instance. | | [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) | The cipher suite to be used in an SSL negotiation. | | [SSLEnabledProtocols](#SSLEnabledProtocols) | Used to enable/disable the supported security protocols. | | [SSLEnableRenegotiation](#SSLEnableRenegotiation) | Whether the renegotiation_info SSL extension is supported. | | [SSLIncludeCertChain](#SSLIncludeCertChain) | Whether the entire certificate chain is included in the SSLServerAuthentication event. | | [SSLKeyLogFile](#SSLKeyLogFile) | The location of a file where per-session secrets are written for debugging purposes. | | [SSLNegotiatedCipher](#SSLNegotiatedCipher) | Returns the negotiated cipher suite. | | [SSLNegotiatedCipherStrength](#SSLNegotiatedCipherStrength) | Returns the negotiated cipher suite strength. | | [SSLNegotiatedCipherSuite](#SSLNegotiatedCipherSuite) | Returns the negotiated cipher suite. | | [SSLNegotiatedKeyExchange](#SSLNegotiatedKeyExchange) | Returns the negotiated key exchange algorithm. | | [SSLNegotiatedKeyExchangeStrength](#SSLNegotiatedKeyExchangeStrength) | Returns the negotiated key exchange algorithm strength. | | [SSLNegotiatedVersion](#SSLNegotiatedVersion) | Returns the negotiated protocol version. | | [SSLServerCACerts](#SSLServerCACerts) | A newline separated list of CA certificates to use during SSL server certificate validation. | | [SSLTrustManagerFactoryAlgorithm](#SSLTrustManagerFactoryAlgorithm) | The algorithm to be used to create a TrustManager through TrustManagerFactory. | | [TLS12SignatureAlgorithms](#TLS12SignatureAlgorithms) | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. | | [TLS12SupportedGroups](#TLS12SupportedGroups) | The supported groups for ECC. | | [TLS13KeyShareGroups](#TLS13KeyShareGroups) | The groups for which to pregenerate key shares. | | [TLS13SignatureAlgorithms](#TLS13SignatureAlgorithms) | The allowed certificate signature algorithms. | | [TLS13SupportedGroups](#TLS13SupportedGroups) | The supported groups for (EC)DHE key exchange. | | [AbsoluteTimeout](#AbsoluteTimeout) | Determines whether timeouts are inactivity timeouts or absolute timeouts. | | [FirewallData](#FirewallData) | Used to send extra data to the firewall. | | [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. | | [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. | | [BuildInfo](#BuildInfo) | Information about the product's build. | | [GUIAvailable](#GUIAvailable) | Whether or not a message loop is available for processing events. | | [LicenseInfo](#LicenseInfo) | Information about the current license. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. | | [UseDaemonThreads](#UseDaemonThreads) | Whether threads created by the class are daemon threads. | | [UseFIPSCompliantAPI](#UseFIPSCompliantAPI) | Tells the class whether or not to use FIPS certified APIs. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | | [UseVirtualThreads](#UseVirtualThreads) | Whether threads created by the class use virtual threads instead of platform threads. | # ActionCode Property ([RNIFSender](#rnifsender-class) Class) The code for this action. ## Syntax ```text public String getActionCode(); public void setActionCode(String actionCode); ``` ## 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. # ActionMessage Property ([RNIFSender](#rnifsender-class) Class) Whether or not this message is an action message. ## Syntax ```text public boolean isActionMessage(); public void setActionMessage(boolean actionMessage); ``` ## 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. # ActionMessageStandardName Property ([RNIFSender](#rnifsender-class) Class) The name of the standard used to create this action. ## Syntax ```text public String getActionMessageStandardName(); public void setActionMessageStandardName(String actionMessageStandardName); ``` ## 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](#actionmessagestandardversion-property-rnifsender-class). 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](#originalmessagestandardname-property-rnifsender-class) and [OriginalMessageStandardVersion](#originalmessagestandardversion-property-rnifsender-class) when creating or processing replies. This property is a field of the service header. # ActionMessageStandardVersion Property ([RNIFSender](#rnifsender-class) Class) The version of the standard used to create this action. ## Syntax ```text public String getActionMessageStandardVersion(); public void setActionMessageStandardVersion(String actionMessageStandardVersion); ``` ## 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](#actionmessagestandardname-property-rnifsender-class) 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](#originalmessagestandardname-property-rnifsender-class) and [OriginalMessageStandardVersion](#originalmessagestandardversion-property-rnifsender-class) when creating or processing replies. This property is a field of the service header. # Attachments Property ([RNIFSender](#rnifsender-class) Class) A collection of files attached to the current RNIF message. ## Syntax ```text public RNIFAttachmentList getAttachments(); ``` ## Remarks Some RosettaNet PIPs, and potentially any non-RosettaNet standards, allow for extra files or data to be attached to the RosettaNet business document. Since the RosettaNet document is MIME-encoded, there are no specific limitations on the number of attachments. The message attachments are included in the payload container with the [ServiceContent](#servicecontent-property-rnifsender-class), so if [EncryptionType](#encryptiontype-property-rnifsender-class) is set to any non-zero value (i.e., *etEncryptPayloadContainer* or *etEncryptServiceContent*) the attachments will be encrypted as well. The message attachments are described by the [RNIFAttachment](#rnifattachment-type) objects stored within the Attachments property. This property is a field of the service header. This property is not available at design time. Please refer to the [RNIFAttachment](#rnifattachment-type) type for a complete list of fields. # BusinessActivity Property ([RNIFSender](#rnifsender-class) Class) This property denotes the type of business activity. ## Syntax ```text public String getBusinessActivity(); public void setBusinessActivity(String businessActivity); ``` ## 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". # Certificate Property ([RNIFSender](#rnifsender-class) Class) The encryption certificate of the sender. ## Syntax ```text public Certificate getCertificate(); public void setCertificate(Certificate certificate); ``` ## Remarks If this property is specified and the message receipt is encrypted, the receipt content will be decrypted using the Certificate's private key. If set, this property should be a private key instance of [Certificate](#certificate-type). Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # Cookies Property ([RNIFSender](#rnifsender-class) Class) A collection of cookies. ## Syntax ```text public HTTPCookieList getCookies(); ``` ## Remarks This property contains a collection of cookies. To add cookies to outgoing HTTP requests, add cookies (of type [HTTPCookie](#httpcookie-type)) to this collection. To see cookies that are set by the server, use the [SetCookie](#setcookie-event-rnifsender-class) event, which displays the cookies and their properties as set by the server. Those cookies also are added to Cookies. [MaxHTTPCookies](#MaxHTTPCookies) can be used to control the maximum number of cookies saved. This collection is indexed from *0* to *size() - 1*. This property is not available at design time. Please refer to the [HTTPCookie](#httpcookie-type) type for a complete list of fields. # DeliveryHeaderXML Property ([RNIFSender](#rnifsender-class) Class) The complete XML data from the Delivery Header. ## Syntax ```text public String getDeliveryHeaderXML(); public void setDeliveryHeaderXML(String deliveryHeaderXML); ``` ## Default Value "" ## Remarks This property is the full XML data of the RosettaNet message Delivery Header. This header contains information about the sending and receiving business processes, as well as tracking data for the message itself. This header was introduced by RNIF 2.0 to speed the movement of RosettaNet messages through message-forwarding hubs. This property is an aggregate property containing XML either generated from or parsed into various other properties of the class. If the value of a related property changes, this property will be updated the next time it is polled and the current valid XML will be returned. When this property is set directly, the class will automatically parse the XML and validate the content of the header to ensure that all required fields contain appropriate values. Once this property has been set and validated, the following properties will be populated: - [SecureTransportRequired](#securetransportrequired-property-rnifsender-class) - [MessageDateTime](#messagedatetime-property-rnifsender-class) - [MessageReceiverId](#messagereceiverid-property-rnifsender-class) - [MessageReceiverLocation](#messagereceiverlocation-property-rnifsender-class) - [MessageSenderId](#messagesenderid-property-rnifsender-class) - [MessageSenderLocation](#messagesenderlocation-property-rnifsender-class) - [MessageTrackingId](#messagetrackingid-property-rnifsender-class) NOTE: If [RNIFVersion](#rnifversion-property-rnifsender-class) is set to *v1*, the value of this property is ignored when generating messages. # EncryptionAlgorithm Property ([RNIFSender](#rnifsender-class) Class) The algorithm used to encrypt the EDI data. ## Syntax ```text public String getEncryptionAlgorithm(); public void setEncryptionAlgorithm(String encryptionAlgorithm); ``` ## 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 class supports **"AESCBC256"**, or industry-standard 256-bit AES-CBC encryption, by default. The class supports **"AES"** encryption with a default keysize of 128 bits. You may also set "AESCBC192", "AESCBC256", "AESGCM128", "AESGCM192", or "AESGCM256" for other AES modes and keysizes. 3DES and DES remain available for legacy interoperability. Possible values are: - 3DES - DES - AESCBC128 - AESCBC192 - AESCBC256 (default) - AESGCM128 - AESGCM192 - AESGCM256 # EncryptionType Property ([RNIFSender](#rnifsender-class) Class) The encryption type for RNIF 2.0. ## Syntax ```text public int getEncryptionType(); public void setEncryptionType(int encryptionType); Enumerated values: public final static int etNoEncryption = 0; public final static int etEncryptServiceContent = 1; public final static int etEncryptPayloadContainer = 2; ``` ## Default Value 0 ## Remarks RNIF 2.0 allows encryption of a message at three different levels: | | | | --- | --- | | 0 (etNoEncryption) | The entire contents of the RosettaNet message are unencrypted. | | 1 (etEncryptServiceContent) | The service content and attachments are encrypted. | | 2 (etEncryptPayloadContainer) | The service header, content, and attachments are encrypted. | 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](#recipientcert-property-rnifsender-class) for more information on specifying a certificate for encryption. This property is not available at design time. # Firewall Property ([RNIFSender](#rnifsender-class) Class) A set of properties related to firewall access. ## Syntax ```text public Firewall getFirewall(); public void setFirewall(Firewall firewall); ``` ## Remarks This is a [Firewall](#firewall-type)-type property, which contains fields describing the firewall through which the class will attempt to connect. Please refer to the [Firewall](#firewall-type) type for a complete list of fields. # FromRole Property ([RNIFSender](#rnifsender-class) Class) The business role of the entity that originated this message. ## Syntax ```text public String getFromRole(); public void setFromRole(String fromRole); ``` ## 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. # FromService Property ([RNIFSender](#rnifsender-class) Class) The service that originated this message. ## Syntax ```text public String getFromService(); public void setFromService(String fromService); ``` ## 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. # GlobalUsageCode Property ([RNIFSender](#rnifsender-class) Class) A universal code describing basic usage for this message. ## Syntax ```text public int getGlobalUsageCode(); public void setGlobalUsageCode(int globalUsageCode); Enumerated values: public final static int gucTest = 0; public final static int gucProduction = 1; ``` ## 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. # LocalHost Property ([RNIFSender](#rnifsender-class) Class) The name of the local host or user-assigned IP interface through which connections are initiated or accepted. ## Syntax ```text public String getLocalHost(); public void setLocalHost(String localHost); ``` ## Default Value "" ## Remarks This property contains the name of the local host as obtained by the *gethostname()* system call, or if the user has assigned an IP address, the value of that address. In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classes) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used. If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface). NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window. # MessageDateTime Property ([RNIFSender](#rnifsender-class) Class) The time at which this message was sent. ## Syntax ```text public String getMessageDateTime(); public void setMessageDateTime(String messageDateTime); ``` ## 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: | | | | --- | --- | | YYYY | This is the year of the time stamp. | | MM | This is the month of the time stamp. | | DD | This specifies the day of the month. | | T | The 'T' denotes the separation between the date and the time stamps. | | hh | This is the hour, in 24 hour format in which the message was sent. | | mm | This specifies the minutes at which the message was sent. | | ss.sss | This is the seconds at which the message was sent. Everything after the decimal is a fraction of a seconds. | | Z | This is a delimiter for the end of the date/time stamp. | 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. # MessageReceiverId Property ([RNIFSender](#rnifsender-class) Class) Identity of the entity receiving this message. ## Syntax ```text public String getMessageReceiverId(); public void setMessageReceiverId(String messageReceiverId); ``` ## 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. # MessageReceiverLocation Property ([RNIFSender](#rnifsender-class) Class) Location of the entity receiving this message. ## Syntax ```text public String getMessageReceiverLocation(); public void setMessageReceiverLocation(String messageReceiverLocation); ``` ## 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. # MessageSenderId Property ([RNIFSender](#rnifsender-class) Class) Identity of the entity that sent this message. ## Syntax ```text public String getMessageSenderId(); public void setMessageSenderId(String messageSenderId); ``` ## 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. # MessageSenderLocation Property ([RNIFSender](#rnifsender-class) Class) Location of the entity that sent this message. ## Syntax ```text public String getMessageSenderLocation(); public void setMessageSenderLocation(String messageSenderLocation); ``` ## 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. # MessageTrackingId Property ([RNIFSender](#rnifsender-class) Class) Unique value that identifies this message. ## Syntax ```text public String getMessageTrackingId(); public void setMessageTrackingId(String messageTrackingId); ``` ## 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. # OriginalActionCode Property ([RNIFSender](#rnifsender-class) Class) The action code of the original message. ## Syntax ```text public String getOriginalActionCode(); public void setOriginalActionCode(String originalActionCode); ``` ## 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. # OriginalMessageStandardName Property ([RNIFSender](#rnifsender-class) Class) The name of the standard used to create the original message. ## Syntax ```text public String getOriginalMessageStandardName(); public void setOriginalMessageStandardName(String originalMessageStandardName); ``` ## 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](#actionmessagestandardname-property-rnifsender-class) and the version in [ActionMessageStandardVersion](#actionmessagestandardversion-property-rnifsender-class). 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](#originalmessagestandardversion-property-rnifsender-class) when creating or processing replies. This property is a field of the service header. # OriginalMessageStandardVersion Property ([RNIFSender](#rnifsender-class) Class) The version of the standard used to create the original message. ## Syntax ```text public String getOriginalMessageStandardVersion(); public void setOriginalMessageStandardVersion(String originalMessageStandardVersion); ``` ## 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](#actionmessagestandardname-property-rnifsender-class) and the version in [ActionMessageStandardVersion](#actionmessagestandardversion-property-rnifsender-class). 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](#originalmessagestandardname-property-rnifsender-class) and OriginalMessageStandardVersion when creating or processing replies. This property is a field of the service header. # OriginalMessageTrackingId Property ([RNIFSender](#rnifsender-class) Class) Tracking identifier for the original message. ## Syntax ```text public String getOriginalMessageTrackingId(); public void setOriginalMessageTrackingId(String originalMessageTrackingId); ``` ## 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](#messagetrackingid-property-rnifsender-class), 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. # PartnerId Property ([RNIFSender](#rnifsender-class) Class) Identity of the partner. ## Syntax ```text public String getPartnerId(); public void setPartnerId(String partnerId); ``` ## Default Value "" ## Remarks [PartnerKnown](#partnerknown-property-rnifsender-class) 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](#partnerlocation-property-rnifsender-class) can be specified. This property is not an address, but may be a city. NOTE: If the partner is not known, then a [PartnerURL](#partnerurl-property-rnifsender-class) MUST be specified in order for the messages and responses to reach their appropriate destinations. This property is a field of the service header. # PartnerKnown Property ([RNIFSender](#rnifsender-class) Class) Whether or not the partner is known. ## Syntax ```text public boolean isPartnerKnown(); public void setPartnerKnown(boolean partnerKnown); ``` ## 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](#partnerid-property-rnifsender-class) 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](#partnerlocation-property-rnifsender-class) can be specified. This property is not an address, but may be a city. NOTE: If the partner is not known, then a [PartnerURL](#partnerurl-property-rnifsender-class) MUST be specified in order for the messages and responses to reach their appropriate destinations. This property is a field of the service header. # PartnerLocation Property ([RNIFSender](#rnifsender-class) Class) Location of the partner. ## Syntax ```text public String getPartnerLocation(); public void setPartnerLocation(String partnerLocation); ``` ## Default Value "" ## Remarks [PartnerKnown](#partnerknown-property-rnifsender-class) 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](#partnerid-property-rnifsender-class) 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](#partnerurl-property-rnifsender-class) MUST be specified in order for the messages and responses to reach their appropriate destinations. This property is a field of the service header. # PartnerPIPBindingId Property ([RNIFSender](#rnifsender-class) Class) The partner-defined PIP payload binding ID. ## Syntax ```text public String getPartnerPIPBindingId(); public void setPartnerPIPBindingId(String partnerPIPBindingId); ``` ## 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. # PartnerURL Property ([RNIFSender](#rnifsender-class) Class) A URL to which replies must be sent if the partner is unknown. ## Syntax ```text public String getPartnerURL(); public void setPartnerURL(String partnerURL); ``` ## Default Value "" ## Remarks [PartnerKnown](#partnerknown-property-rnifsender-class) 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](#partnerid-property-rnifsender-class) 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](#partnerlocation-property-rnifsender-class) 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. # PIPCode Property ([RNIFSender](#rnifsender-class) Class) RosettaNet PIP code of this message. ## Syntax ```text public String getPIPCode(); public void setPIPCode(String PIPCode); ``` ## Default Value "" ## Remarks The [ServiceContent](#servicecontent-property-rnifsender-class) 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](#pipversion-property-rnifsender-class). 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](#pipinstanceid-property-rnifsender-class) 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. # PIPInstanceId Property ([RNIFSender](#rnifsender-class) Class) The Id of this PIP instance. ## Syntax ```text public String getPIPInstanceId(); public void setPIPInstanceId(String PIPInstanceId); ``` ## Default Value "" ## Remarks The [ServiceContent](#servicecontent-property-rnifsender-class) 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](#pipcode-property-rnifsender-class) and the version in [PIPVersion](#pipversion-property-rnifsender-class). 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. # PIPVersion Property ([RNIFSender](#rnifsender-class) Class) RosettaNet PIP version of this message. ## Syntax ```text public String getPIPVersion(); public void setPIPVersion(String PIPVersion); ``` ## Default Value "" ## Remarks The [ServiceContent](#servicecontent-property-rnifsender-class) 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](#pipcode-property-rnifsender-class) 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](#pipinstanceid-property-rnifsender-class) 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. # PreambleHeaderXML Property ([RNIFSender](#rnifsender-class) Class) The complete XML data from the Preamble Header. ## Syntax ```text public String getPreambleHeaderXML(); public void setPreambleHeaderXML(String preambleHeaderXML); ``` ## 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 class. If the value of a related property changes, this property will be updated the next time it is polled and the current valid XML will be returned. When this property is set directly, the class will automatically parse the XML and validate the content of the header to ensure that all required fields contain appropriate values. Once this property has been set and validated, the following properties will be populated: - [StandardName](#standardname-property-rnifsender-class) - [StandardVersion](#standardversion-property-rnifsender-class) # Proxy Property ([RNIFSender](#rnifsender-class) Class) A set of properties related to proxy access. ## Syntax ```text public Proxy getProxy(); public void setProxy(Proxy proxy); ``` ## Remarks This property contains fields describing the proxy through which the class will attempt to connect. Please refer to the [Proxy](#proxy-type) type for a complete list of fields. # QOSSpecifications Property ([RNIFSender](#rnifsender-class) Class) Specifies quality of service constraints for this message. ## Syntax ```text public QOSSpecificationList getQOSSpecifications(); ``` ## Remarks Version 2.0 of the RosettaNet Implementation Framework introduced a set of Quality of Service (QOS) elements to ensure future backward compatibility. The class supports these future QOS options through the QOSSpecifications collection. This property is a field of the service header. NOTE: there are no valid values for the quality of service parameters at this time, therefore this property may be ignored by the RNIF entity. This property is not available at design time. Please refer to the [QOSSpecification](#qosspecification-type) type for a complete list of fields. # ReceiptSignerCert Property ([RNIFSender](#rnifsender-class) Class) The public key certificate for the receipt signature. ## Syntax ```text public Certificate getReceiptSignerCert(); public void setReceiptSignerCert(Certificate receiptSignerCert); ``` ## Remarks Ordinarily, if your trading partner uses the same certificate for both signing and encryption, the certificate specified in [RecipientCert](#recipientcert-property-rnifsender-class) is used for both encryption and verifying the receipt signature. If your trading partner uses different certificates for signing and encryption, you must set this property to the public key for you partner's signing certificate before invoking [Post](#post-method-rnifsender-class). If set, this property should be a public key instance of [Certificate](#certificate-type). Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # RecipientCert Property ([RNIFSender](#rnifsender-class) Class) The encryption certificate of the recipient. ## Syntax ```text public Certificate getRecipientCert(); public void setRecipientCert(Certificate recipientCert); ``` ## Remarks The encryption certificate of the recipient. If this property is specified, the message content will be encrypted using the algorithm given by [EncryptionAlgorithm](#encryptionalgorithm-property-rnifsender-class). This property will also be used to verifying signed receipts if [ReceiptSignerCert](#receiptsignercert-property-rnifsender-class) is not specified. If your trading partner uses different certificates for signing and encryption, you should set RecipientCert to the encryption certificate and [ReceiptSignerCert](#receiptsignercert-property-rnifsender-class) to the signing certificate. If the class is unable to verify a signature make sure RecipientCert is set appropriately. If set, this property should be a public key instance of [Certificate](#certificate-type). Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # ReplyData Property ([RNIFSender](#rnifsender-class) Class) This property is used to retrieve synchronous reply message content. ## Syntax ```text public byte[] getReplyData(); ``` ## 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. # ReplyHeaders Property ([RNIFSender](#rnifsender-class) Class) This property is used to retrieve headers from synchronous reply messages. ## Syntax ```text public String getReplyHeaders(); ``` ## 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. # ReplyMessage Property ([RNIFSender](#rnifsender-class) Class) Whether or not this message is a reply to another message. ## Syntax ```text public boolean isReplyMessage(); public void setReplyMessage(boolean replyMessage); ``` ## 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. # ResponseType Property ([RNIFSender](#rnifsender-class) Class) Requested response type. Available only in RNIF 2.0. ## Syntax ```text public int getResponseType(); public void setResponseType(int responseType); Enumerated values: public final static int rtSync = 0; public final static int rtAsync = 1; ``` ## Default Value 0 ## Remarks This property tells the receiver which type of response the sender is expecting. The following types of supported responses are: | | | | --- | --- | | rtSync | The response will be received on the same HTTP session as the initial request. | | rtAsync | The response will be received later. | This property is only available in RNIF version 2.0. This property is not available at design time. # RNIFVersion Property ([RNIFSender](#rnifsender-class) Class) The RNIF Standard Version used to generate this message. ## Syntax ```text public int getRNIFVersion(); public void setRNIFVersion(int RNIFVersion); Enumerated values: public final static int v1 = 0; public final static int v2 = 1; ``` ## Default Value 0 ## Remarks This property describes which standard version of RNIF was used to generate this message. Possible values are:: | | | | --- | --- | | v1 | RosettaNet version 1.1 | | v2 | RosettaNet version 2.0 | This property is not available at design time. # SecureTransportRequired Property ([RNIFSender](#rnifsender-class) Class) Indicates that security is required when forwarding this message. ## Syntax ```text public boolean isSecureTransportRequired(); public void setSecureTransportRequired(boolean secureTransportRequired); ``` ## 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](#rnifsender-class) for more information on sending messages over a secure transport. This property is a field of the delivery header. # ServiceContent Property ([RNIFSender](#rnifsender-class) Class) The PIP message data. ## Syntax ```text public String getServiceContent(); public void setServiceContent(String serviceContent); ``` ## 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](#pipinstanceid-property-rnifsender-class) property. # ServiceHeaderXML Property ([RNIFSender](#rnifsender-class) Class) The complete XML data from the Service Header. ## Syntax ```text public String getServiceHeaderXML(); public void setServiceHeaderXML(String serviceHeaderXML); ``` ## 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 class. If the value of a related property changes, this property will be updated the next time it is polled and the current valid XML will be returned. When this property is set directly, the class will automatically parse the XML and validate the content of the header to ensure that all required fields contain appropriate values. Once this property has been set and validated, the following properties will be populated: - [ActionCode](#actioncode-property-rnifsender-class) - [ActionMessage](#actionmessage-property-rnifsender-class) - [ActionMessageStandardName](#actionmessagestandardname-property-rnifsender-class) - [ActionMessageStandardVersion](#actionmessagestandardversion-property-rnifsender-class) - [Attachments](#attachments-property-rnifsender-class) - [FromRole](#fromrole-property-rnifsender-class) - [FromService](#fromservice-property-rnifsender-class) - [OriginalActionCode](#originalactioncode-property-rnifsender-class) - [OriginalMessageStandardName](#originalmessagestandardname-property-rnifsender-class) - [OriginalMessageStandardVersion](#originalmessagestandardversion-property-rnifsender-class) - [OriginalMessageTrackingId](#originalmessagetrackingid-property-rnifsender-class) - [PartnerId](#partnerid-property-rnifsender-class) - [PartnerKnown](#partnerknown-property-rnifsender-class) - [PartnerLocation](#partnerlocation-property-rnifsender-class) - [PartnerPIPBindingId](#partnerpipbindingid-property-rnifsender-class) - [PartnerURL](#partnerurl-property-rnifsender-class) - [PIPCode](#pipcode-property-rnifsender-class) - [PIPInstanceId](#pipinstanceid-property-rnifsender-class) - [PIPVersion](#pipversion-property-rnifsender-class) - [QOSSpecifications](#qosspecifications-property-rnifsender-class) - [ReplyMessage](#replymessage-property-rnifsender-class) - [SignalCode](#signalcode-property-rnifsender-class) - [SignalMessage](#signalmessage-property-rnifsender-class) - [GlobalUsageCode](#globalusagecode-property-rnifsender-class) - [SignalVersion](#signalversion-property-rnifsender-class) - [ToRole](#torole-property-rnifsender-class) - [ToService](#toservice-property-rnifsender-class) # SignalCode Property ([RNIFSender](#rnifsender-class) Class) The code for this signal. ## Syntax ```text public String getSignalCode(); public void setSignalCode(String signalCode); ``` ## 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. # SignalMessage Property ([RNIFSender](#rnifsender-class) Class) Whether or not this message is a signal. ## Syntax ```text public boolean isSignalMessage(); public void setSignalMessage(boolean signalMessage); ``` ## 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. # SignalVersion Property ([RNIFSender](#rnifsender-class) Class) The version of this signal. ## Syntax ```text public String getSignalVersion(); public void setSignalVersion(String signalVersion); ``` ## 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. # SignatureAlgorithm Property ([RNIFSender](#rnifsender-class) Class) Signature algorithm to be used in outgoing messages. ## Syntax ```text public String getSignatureAlgorithm(); public void setSignatureAlgorithm(String signatureAlgorithm); ``` ## 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". # SignerCert Property ([RNIFSender](#rnifsender-class) Class) Contains the certificate to use when signing messages. ## Syntax ```text public Certificate getSignerCert(); public void setSignerCert(Certificate signerCert); ``` ## Remarks This is your signing certificate. If this property is specified, the message content will be signed using the algorithm given by [SignatureAlgorithm](#SignatureAlgorithm). If set, this property should be a private key instance of [Certificate](#certificate-type). This property is not available at design time. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # SSLAcceptServerCert Property ([RNIFSender](#rnifsender-class) Class) Instructs the class to unconditionally accept the server certificate that matches the supplied certificate. ## Syntax ```text public Certificate getSSLAcceptServerCert(); public void setSSLAcceptServerCert(Certificate SSLAcceptServerCert); ``` ## Remarks If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error. You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally. NOTE: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # SSLCert Property ([RNIFSender](#rnifsender-class) Class) The certificate to be used during Secure Sockets Layer (SSL) negotiation. ## Syntax ```text public Certificate getSSLCert(); public void setSSLCert(Certificate SSLCert); ``` ## Remarks This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the [Encoded](#Certificate_f_Encoded) field to the encoded certificate. To select a certificate, use the store and subject fields. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # SSLProvider Property ([RNIFSender](#rnifsender-class) Class) The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. ## Syntax ```text public int getSSLProvider(); public void setSSLProvider(int SSLProvider); Enumerated values: public final static int sslpAutomatic = 0; public final static int sslpPlatform = 1; public final static int sslpInternal = 2; ``` ## 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 class 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: | | | | --- | --- | | 0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. | | 1 (sslpPlatform) | Uses the platform/system implementation. | | 2 (sslpInternal) | Uses the internal implementation. | **Additional Notes** In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform. When Automatic is selected, the platform implementation is used by default. When TLS 1.3 is enabled via [SSLEnabledProtocols](#SSLEnabledProtocols), the class will always try and use the platform implementation. If the platform TLS 1.3 implementation is not available, the internal implementation will be used. # SSLServerCert Property ([RNIFSender](#rnifsender-class) Class) The server certificate for the last established connection. ## Syntax ```text public Certificate getSSLServerCert(); ``` ## Remarks This property contains the server certificate for the last established connection. SSLServerCert is reset every time a new connection is attempted. This property is read-only. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # StandardName Property ([RNIFSender](#rnifsender-class) Class) The name of the standard used to create this message. ## Syntax ```text public String getStandardName(); public void setStandardName(String standardName); ``` ## 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. # StandardVersion Property ([RNIFSender](#rnifsender-class) Class) The version of the standard used to create this message. ## Syntax ```text public String getStandardVersion(); public void setStandardVersion(String standardVersion); ``` ## 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. # Timeout Property ([RNIFSender](#rnifsender-class) Class) The timeout for the class. ## Syntax ```text public int getTimeout(); public void setTimeout(int timeout); ``` ## 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 class will wait for the operation to complete before returning control. The class 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 class throws an exception. 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. 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 class will wait for the operation to complete before returning control. The class 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 class throws an exception. 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. # ToRole Property ([RNIFSender](#rnifsender-class) Class) The role of the entity receiving this message. ## Syntax ```text public String getToRole(); public void setToRole(String toRole); ``` ## 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. # ToService Property ([RNIFSender](#rnifsender-class) Class) The service for which this message is bound. ## Syntax ```text public String getToService(); public void setToService(String toService); ``` ## 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. # URL Property ([RNIFSender](#rnifsender-class) Class) The URL to which requests are sent. ## Syntax ```text public String getURL(); public void setURL(String URL); ``` ## 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. # Config Method ([RNIFSender](#rnifsender-class) Class) Sets or retrieves a configuration setting. ## Syntax ```text public String config(String configurationString); ``` ## Remarks Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-rnifsender-class) for the class. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the Config method. To set a configuration setting named *PROPERTY*, you must call *Config("PROPERTY=VALUE")*, where *VALUE* is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter). To read (query) the value of a [configuration setting](#config-settings-rnifsender-class), you must call *Config("PROPERTY")*. The value will be returned as a string. # Post Method ([RNIFSender](#rnifsender-class) Class) Posts Message to the RNIF partner. ## Syntax ```text public void post(); ``` ## Remarks This method posts the message to the RNIF partner server. When Post is called, the class will generate, encrypt, and sign the RosettaNet message in accordance with the various message settings. NOTE: [URL](#url-property-rnifsender-class) must be set before a call to **Post**. # Reset Method ([RNIFSender](#rnifsender-class) Class) This property is used to reset all attributes of the Rnifsender instance. ## Syntax ```text public void reset(); ``` ## 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](#rnifsender-class) Class) Resets all HTTP headers, cookies, LocalFile , and AttachedFile . ## Syntax ```text public void resetHeaders(); ``` ## Remarks Resets all the HTTP headers to "" (empty string). Also clears the [Cookies](#cookies-property-rnifsender-class) 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](#rnifsender-class) Class) Allows the user to set or add arbitrary HTTP request headers. ## Syntax ```text public void setRequestHeader(String header, String value); ``` ## 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](#rnifsender-class) Class) Fired immediately after a connection completes (or fails). ## Syntax ```text public class DefaultRNIFSenderEventListener implements RNIFSenderEventListener { ... public void connected(RNIFSenderConnectedEvent e) {} ... } public class RNIFSenderConnectedEvent { public int statusCode; public String description; } ``` ## 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](#trappable-errors-rnifsender-class) section for more information. # Disconnected Event ([RNIFSender](#rnifsender-class) Class) Fired when a connection is closed. ## Syntax ```text public class DefaultRNIFSenderEventListener implements RNIFSenderEventListener { ... public void disconnected(RNIFSenderDisconnectedEvent e) {} ... } public class RNIFSenderDisconnectedEvent { public int statusCode; public String description; } ``` ## 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](#trappable-errors-rnifsender-class) section for more information. # EndTransfer Event ([RNIFSender](#rnifsender-class) Class) Fired when a document finishes transferring. ## Syntax ```text public class DefaultRNIFSenderEventListener implements RNIFSenderEventListener { ... public void endTransfer(RNIFSenderEndTransferEvent e) {} ... } public class RNIFSenderEndTransferEvent { public int direction; } ``` ## 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](#rnifsender-class) Class) Fired when information is available about errors during data delivery. ## Syntax ```text public class DefaultRNIFSenderEventListener implements RNIFSenderEventListener { ... public void error(RNIFSenderErrorEvent e) {} ... } public class RNIFSenderErrorEvent { public int errorCode; public String description; } ``` ## Remarks The Error event is fired in case of exceptional conditions during message processing. Normally the class throws an exception. 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](#trappable-errors-rnifsender-class) section. # Header Event ([RNIFSender](#rnifsender-class) Class) Fired every time a header line comes in. ## Syntax ```text public class DefaultRNIFSenderEventListener implements RNIFSenderEventListener { ... public void header(RNIFSenderHeaderEvent e) {} ... } public class RNIFSenderHeaderEvent { public String field; public String value; } ``` ## 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](#rnifsender-class) Class) Fired when a redirection is received from the server. ## Syntax ```text public class DefaultRNIFSenderEventListener implements RNIFSenderEventListener { ... public void redirect(RNIFSenderRedirectEvent e) {} ... } public class RNIFSenderRedirectEvent { public String location; public boolean accept; //read-write } ``` ## 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 class throws an exception. *Location* is the location to which the client is being redirected. Further control over redirection is provided in the FollowRedirects property. # SetCookie Event ([RNIFSender](#rnifsender-class) Class) Fired for every cookie set by the server. ## Syntax ```text public class DefaultRNIFSenderEventListener implements RNIFSenderEventListener { ... public void setCookie(RNIFSenderSetCookieEvent e) {} ... } public class RNIFSenderSetCookieEvent { public String name; public String value; public String expires; public String domain; public String path; public boolean secure; } ``` ## 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](#rnifsender-class) Class) Fired after the server presents its certificate to the client. ## Syntax ```text public class DefaultRNIFSenderEventListener implements RNIFSenderEventListener { ... public void SSLServerAuthentication(RNIFSenderSSLServerAuthenticationEvent e) {} ... } public class RNIFSenderSSLServerAuthenticationEvent { public byte[] certEncoded; public String certSubject; public String certIssuer; public String status; public boolean accept; //read-write } ``` ## 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](#rnifsender-class) Class) Fired when secure connection progress messages are available. ## Syntax ```text public class DefaultRNIFSenderEventListener implements RNIFSenderEventListener { ... public void SSLStatus(RNIFSenderSSLStatusEvent e) {} ... } public class RNIFSenderSSLStatusEvent { public String message; } ``` ## Remarks The event is fired for informational and logging purposes only. This event tracks the progress of the connection. # StartTransfer Event ([RNIFSender](#rnifsender-class) Class) Fired when a document starts transferring (after the headers). ## Syntax ```text public class DefaultRNIFSenderEventListener implements RNIFSenderEventListener { ... public void startTransfer(RNIFSenderStartTransferEvent e) {} ... } public class RNIFSenderStartTransferEvent { public int direction; } ``` ## 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](#rnifsender-class) Class) Fired while a document transfers (delivers document). ## Syntax ```text public class DefaultRNIFSenderEventListener implements RNIFSenderEventListener { ... public void transfer(RNIFSenderTransferEvent e) {} ... } public class RNIFSenderTransferEvent { public int direction; public long bytesTransferred; public int percentDone; public byte[] text; } ``` ## 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. # Certificate Type This is the digital certificate being used. ## Remarks This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates. The following fields are available: - [EffectiveDate](#Certificate_f_EffectiveDate) - [ExpirationDate](#Certificate_f_ExpirationDate) - [ExtendedKeyUsage](#Certificate_f_ExtendedKeyUsage) - [Fingerprint](#Certificate_f_Fingerprint) - [FingerprintSHA1](#Certificate_f_FingerprintSHA1) - [FingerprintSHA256](#Certificate_f_FingerprintSHA256) - [Issuer](#Certificate_f_Issuer) - [KeyPassword](#Certificate_f_KeyPassword) - [PrivateKey](#Certificate_f_PrivateKey) - [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable) - [PrivateKeyContainer](#Certificate_f_PrivateKeyContainer) - [PublicKey](#Certificate_f_PublicKey) - [PublicKeyAlgorithm](#Certificate_f_PublicKeyAlgorithm) - [PublicKeyLength](#Certificate_f_PublicKeyLength) - [SerialNumber](#Certificate_f_SerialNumber) - [SignatureAlgorithm](#Certificate_f_SignatureAlgorithm) - [Store](#Certificate_f_Store) - [StorePassword](#Certificate_f_StorePassword) - [StoreType](#Certificate_f_StoreType) - [SubjectAltNames](#Certificate_f_SubjectAltNames) - [ThumbprintMD5](#Certificate_f_ThumbprintMD5) - [ThumbprintSHA1](#Certificate_f_ThumbprintSHA1) - [ThumbprintSHA256](#Certificate_f_ThumbprintSHA256) - [Usage](#Certificate_f_Usage) - [UsageFlags](#Certificate_f_UsageFlags) - [Version](#Certificate_f_Version) - [Subject](#Certificate_f_Subject) - [Encoded](#Certificate_f_Encoded) ## Fields **EffectiveDate** *String (read-only)* *Default Value: ""* 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. **ExpirationDate** *String (read-only)* *Default Value: ""* 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. **ExtendedKeyUsage** *String (read-only)* *Default Value: ""* A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). **Fingerprint** *String (read-only)* *Default Value: ""* 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* **FingerprintSHA1** *String (read-only)* *Default Value: ""* 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* **FingerprintSHA256** *String (read-only)* *Default Value: ""* 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* **Issuer** *String (read-only)* *Default Value: ""* The issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate. **KeyPassword** *String* *Default Value: ""* The password for the certificate's private key (if any). Some certificate stores may individually protect certificates' private keys, separate from the standard protection offered by the [StorePassword](#Certificate_f_StorePassword). This field can be used to read such password-protected private keys. NOTE: This property defaults to the value of [StorePassword](#Certificate_f_StorePassword). To clear it, you must set the property to the empty string (""). It can be set at any time, but when the private key's password is different from the store's password, then it must be set before calling [PrivateKey](#Certificate_f_PrivateKey). **PrivateKey** *String (read-only)* *Default Value: ""* The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [PrivateKey](#Certificate_f_PrivateKey) may be available but not exportable. In this case, [PrivateKey](#Certificate_f_PrivateKey) returns an empty string. **PrivateKeyAvailable** *boolean (read-only)* *Default Value: False* Whether a [PrivateKey](#Certificate_f_PrivateKey) is available for the selected certificate. If [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable) is True, the certificate may be used for authentication purposes (e.g., server authentication). **PrivateKeyContainer** *String (read-only)* *Default Value: ""* The name of the [PrivateKey](#Certificate_f_PrivateKey) container for the certificate (if available). This functionality is available only on Windows platforms. **PublicKey** *String (read-only)* *Default Value: ""* The public key of the certificate. The key is provided as PEM/Base64-encoded data. **PublicKeyAlgorithm** *String (read-only)* *Default Value: ""* 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. **PublicKeyLength** *int (read-only)* *Default Value: 0* The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. **SerialNumber** *String (read-only)* *Default Value: ""* 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. **SignatureAlgorithm** *String (read-only)* *Default Value: ""* 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. **Store** *String* *Default Value: "MY"* The name of the certificate store for the client certificate. The [StoreType](#Certificate_f_StoreType) field denotes the type of the certificate store specified by [Store](#Certificate_f_Store). If the store is password-protected, specify the password in [StorePassword](#Certificate_f_StorePassword). [Store](#Certificate_f_Store) is used in conjunction with the [Subject](#Certificate_f_Subject) field to specify client certificates. If [Store](#Certificate_f_Store) has a value, and [Subject](#Certificate_f_Subject) or [Encoded](#Certificate_f_Encoded) is set, a search for a certificate is initiated. Please see the [Subject](#Certificate_f_Subject) field for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | In Java, the certificate store normally is a file containing certificates and optional private keys. 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). **StoreB** *byte[]* *Default Value: "MY"* The name of the certificate store for the client certificate. The [StoreType](#Certificate_f_StoreType) field denotes the type of the certificate store specified by [Store](#Certificate_f_Store). If the store is password-protected, specify the password in [StorePassword](#Certificate_f_StorePassword). [Store](#Certificate_f_Store) is used in conjunction with the [Subject](#Certificate_f_Subject) field to specify client certificates. If [Store](#Certificate_f_Store) has a value, and [Subject](#Certificate_f_Subject) or [Encoded](#Certificate_f_Encoded) is set, a search for a certificate is initiated. Please see the [Subject](#Certificate_f_Subject) field for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | In Java, the certificate store normally is a file containing certificates and optional private keys. 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). **StorePassword** *String* *Default Value: ""* If the type of certificate store requires a password, this field is used to specify the password needed to open the certificate store. **StoreType** *int* *Default Value: 0* The type of certificate store for this certificate. The class supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the class will automatically determine the type. This field can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#certificate-type) object and pass cstPKCS11 as the [StoreType](#Certificate_f_StoreType), the full path of the PKCS#11 DLL as the [Store](#Certificate_f_Store), and the PIN as the [StorePassword](#Certificate_f_StorePassword). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](CertMgr.md#CertMgr) class by calling the [ListStoreCertificates](CertMgr.md#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](CertMgr.md#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [Store](#Certificate_f_Store) and set [StorePassword](#Certificate_f_StorePassword) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | **SubjectAltNames** *String (read-only)* *Default Value: ""* Comma-separated lists of alternative subject names for the certificate. **ThumbprintMD5** *String (read-only)* *Default Value: ""* 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. **ThumbprintSHA1** *String (read-only)* *Default Value: ""* 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. **ThumbprintSHA256** *String (read-only)* *Default Value: ""* 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. **Usage** *String (read-only)* *Default Value: ""* The text description of [UsageFlags](#Certificate_f_UsageFlags). 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. **UsageFlags** *int (read-only)* *Default Value: 0* The flags that show intended use for the certificate. The value of [UsageFlags](#Certificate_f_UsageFlags) is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the [Usage](#Certificate_f_Usage) field for a text representation of [UsageFlags](#Certificate_f_UsageFlags). This functionality currently is not available when the provider is OpenSSL. **Version** *String (read-only)* *Default Value: ""* The certificate's version number. The possible values are the strings "V1", "V2", and "V3". **Subject** *String* *Default Value: ""* The subject of the certificate used for client authentication. This field will be populated with the full subject of the loaded certificate. When loading a certificate, the subject is used to locate the certificate in the store. 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: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. **Encoded** *String* *Default Value: ""* The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The [Store](#Certificate_f_Store) and [Subject](#Certificate_f_Subject) fields also may be used to specify a certificate. When [Encoded](#Certificate_f_Encoded) is set, a search is initiated in the current [Store](#Certificate_f_Store) for the private key of the certificate. If the key is found, [Subject](#Certificate_f_Subject) is updated to reflect the full subject of the selected certificate; otherwise, [Subject](#Certificate_f_Subject) is set to an empty string. **EncodedB** *byte[]* *Default Value: ""* The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The [Store](#Certificate_f_Store) and [Subject](#Certificate_f_Subject) fields also may be used to specify a certificate. When [Encoded](#Certificate_f_Encoded) is set, a search is initiated in the current [Store](#Certificate_f_Store) for the private key of the certificate. If the key is found, [Subject](#Certificate_f_Subject) is updated to reflect the full subject of the selected certificate; otherwise, [Subject](#Certificate_f_Subject) is set to an empty string. ## Constructors ```text public Certificate(); ``` Creates a instance whose properties can be set. ```text public Certificate(String certificateFile); ``` Opens * CertificateFile * and reads out the contents as an X.509 public key. ```text public Certificate(byte[] encoded); ``` Parses * Encoded * as an X.509 public key. ```text public Certificate(int storeType, String store, String storePassword, String subject); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(int storeType, String store, String storePassword, String subject, String configurationString); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store. * ConfigurationString * is a newline-separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to the * cstUser * , * cstMachine * , * cstPublicKeyFile * , and * cstPFXFile * store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(int storeType, String store, String storePassword, byte[] encoded); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the class will load * Encoded * as an X.509 certificate and search the opened store for a corresponding private key. ```text public Certificate(int storeType, byte[] store, String storePassword, String subject); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(int storeType, byte[] store, String storePassword, String subject, String configurationString); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(int storeType, byte[] store, String storePassword, byte[] encoded); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the class will load * Encoded * as an X.509 certificate and search the opened store for a corresponding private key. # Firewall Type The firewall the class will connect through. ## Remarks When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall [Host](#Firewall_f_Host) and the [FirewallType](#Firewall_f_FirewallType). The following fields are available: - [AutoDetect](#Firewall_f_AutoDetect) - [FirewallType](#Firewall_f_FirewallType) - [Host](#Firewall_f_Host) - [Password](#Firewall_f_Password) - [Port](#Firewall_f_Port) - [User](#Firewall_f_User) ## Fields **AutoDetect** *boolean* *Default Value: False* Whether to automatically detect and use firewall system settings, if available. Connection information will first be obtained from Java system properties, such as *http.proxyHost* and *https.proxyHost*. Java properties may be set in a variety of ways; please consult the Java documentation for information about how firewall and proxy values can be specified. If no Java system properties define connection information, the class will inspect the Windows registry for connection information that may be present on the system (applicable only on Windows systems). **FirewallType** *int* *Default Value: 0* The type of firewall to connect through. The applicable values are as follows: | | | | --- | --- | | fwNone (0) | No firewall (default setting). | | fwTunnel (1) | Connect through a tunneling proxy. [Port](#Firewall_f_Port) is set to 80. | | fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. [Port](#Firewall_f_Port) is set to 1080. | | fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. [Port](#Firewall_f_Port) is set to 1080. | | fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. [Port](#Firewall_f_Port) is set to 1080. | **Host** *String* *Default Value: ""* The name or IP address of the firewall (optional). If a [Host](#Firewall_f_Host) is given, the requested connections will be authenticated through the specified firewall when connecting. If this field is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this field is set to the corresponding address. If the search is not successful, the class throws an exception. **Password** *String* *Default Value: ""* A password if authentication is to be used when connecting through the firewall. If [Host](#Firewall_f_Host) is specified, the [User](#Firewall_f_User) and [Password](#Firewall_f_Password) fields are used to connect and authenticate to the given firewall. If the authentication fails, the class throws an exception. **Port** *int* *Default Value: 0* The Transmission Control Protocol (TCP) port for the firewall [Host](#Firewall_f_Host). See the description of the [Host](#Firewall_f_Host) field for details. NOTE: This field is set automatically when [FirewallType](#Firewall_f_FirewallType) is set to a valid value. See the description of the [FirewallType](#Firewall_f_FirewallType) field for details. **User** *String* *Default Value: ""* A username if authentication is to be used when connecting through a firewall. If [Host](#Firewall_f_Host) is specified, this field and the [Password](#Firewall_f_Password) field are used to connect and authenticate to the given [Firewall](#firewall-type). If the authentication fails, the class throws an exception. ## Constructors ```text public Firewall(); ``` # HTTPCookie Type An HTTP cookie can be either sent to or received from the server. ## Remarks An HTTP cookie can store the cookies that are to be sent to the server. It also may store the cookies sent by the server. Cookies that are to be sent to the server must have the [Name](#HTTPCookie_f_Name) and [Value](#HTTPCookie_f_Value) fields supplied before submitting the URL. When the SetCookie event is fired, however, all of the fields of an **HTTPCookie** are filled out accordingly. The following fields are available: - [Domain](#HTTPCookie_f_Domain) - [Expiration](#HTTPCookie_f_Expiration) - [Name](#HTTPCookie_f_Name) - [Path](#HTTPCookie_f_Path) - [Secure](#HTTPCookie_f_Secure) - [Value](#HTTPCookie_f_Value) ## Fields **Domain** *String (read-only)* *Default Value: ""* The domain of a received cookie. This field contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, this field will contain an empty string. The convention in this case is to use the server name specified by URLServer as the cookie domain. **Expiration** *String (read-only)* *Default Value: ""* 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 field will contain an empty string. The convention is to drop the cookie at the end of the session. **Name** *String* *Default Value: ""* The name of the cookie. This field, along with [Value](#HTTPCookie_f_Value), stores the cookie that is to be sent to the server. The SetCookie event displays the cookies sent by the server and their properties. **Path** *String (read-only)* *Default Value: ""* A path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the path field will be an empty string. The convention in this case is to use the path specified by URLPath as the cookie path. **Secure** *boolean (read-only)* *Default Value: False* The security flag of the received cookie. This field specifies whether the cookie is secure. If the value of this field is True, the cookie value must be submitted only through a secure (HTTPS) connection. **Value** *String* *Default Value: ""* The value of the cookie. A corresponding value is associated with the cookie specified by [Name](#HTTPCookie_f_Name). This property holds that value. The SetCookie event provides the cookies set by the server. ## Constructors ```text public HTTPCookie(); ``` ```text public HTTPCookie(String name, String value); ``` # Proxy Type The proxy the class will connect to. ## Remarks When connecting through a proxy, this type is used to specify different properties of the proxy, such as the [Server](#Proxy_f_Server) and the [AuthScheme](#Proxy_f_AuthScheme). The following fields are available: - [AuthScheme](#Proxy_f_AuthScheme) - [AutoDetect](#Proxy_f_AutoDetect) - [Password](#Proxy_f_Password) - [Port](#Proxy_f_Port) - [Server](#Proxy_f_Server) - [SSL](#Proxy_f_SSL) - [User](#Proxy_f_User) ## Fields **AuthScheme** *int* *Default Value: 0* The type of authorization to perform when connecting to the proxy. This is used only when the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are set. [AuthScheme](#Proxy_f_AuthScheme) should be set to authNone (3) when no authentication is expected. By default, [AuthScheme](#Proxy_f_AuthScheme) is authBasic (0), and if the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are set, the class will attempt basic authentication. If [AuthScheme](#Proxy_f_AuthScheme) is set to authDigest (1), digest authentication will be attempted instead. If [AuthScheme](#Proxy_f_AuthScheme) is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token. If [AuthScheme](#Proxy_f_AuthScheme) is set to authNtlm (4), NTLM authentication will be used. For security reasons, setting this field will clear the values of [User](#Proxy_f_User) and [Password](#Proxy_f_Password). **AutoDetect** *boolean* *Default Value: False* Whether to automatically detect and use proxy system settings, if available. The default value is *false*. Note: This setting is applicable only in Windows. **Password** *String* *Default Value: ""* A password if authentication is to be used for the proxy. If [AuthScheme](#Proxy_f_AuthScheme) is set to Basic Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*. If [AuthScheme](#Proxy_f_AuthScheme) is set to Digest Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are used to respond to the Digest Authentication challenge from the server. If [AuthScheme](#Proxy_f_AuthScheme) is set to NTLM Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are used to authenticate through NTLM negotiation. **Port** *int* *Default Value: 80* The Transmission Control Protocol (TCP) port for the proxy [Server](#Proxy_f_Server) (default 80). See the description of the [Server](#Proxy_f_Server) field for details. **Server** *String* *Default Value: ""* If a proxy [Server](#Proxy_f_Server) is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. If the [Server](#Proxy_f_Server) field is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the [Server](#Proxy_f_Server) field is set to the corresponding address. If the search is not successful, an error is returned. **SSL** *int* *Default Value: 0* When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows: | | | | --- | --- | | psAutomatic (0) | Default setting. If the URL is an https URL, the class will use the psTunnel option. If the URL is an http URL, the class will use the psNever option. | | psAlways (1) | The connection is always SSL-enabled. | | psNever (2) | The connection is not SSL-enabled. | | psTunnel (3) | The connection is made through a tunneling (HTTP) proxy. | **User** *String* *Default Value: ""* A username if authentication is to be used for the proxy. If [AuthScheme](#Proxy_f_AuthScheme) is set to Basic Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*. If [AuthScheme](#Proxy_f_AuthScheme) is set to Digest Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are used to respond to the Digest Authentication challenge from the server. If [AuthScheme](#Proxy_f_AuthScheme) is set to NTLM Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are used to authenticate through NTLM negotiation. ## Constructors ```text public Proxy(); ``` ```text public Proxy(String server, int port); ``` ```text public Proxy(String server, int port, String user, String password); ``` # QOSSpecification Type A name-value pair defining a quality of service. ## Remarks Version 2.0 of the RosettaNet Implementation Framework introduced a set of Quality of Service (QOS) elements to ensure future backward compatibility. The following fields are available: - [Code](#QOSSpecification_f_Code) - [Value](#QOSSpecification_f_Value) ## Fields **Code** *String* *Default Value: ""* [Code](#QOSSpecification_f_Code) is a string representing a quality of service measurement category. **Value** *String* *Default Value: ""* [Value](#QOSSpecification_f_Value) is a string that defines the constraints for the category in [Code](#QOSSpecification_f_Code). ## Constructors ```text public QOSSpecification(); ``` ```text public QOSSpecification(String code, String value); ``` # RNIFAttachment Type This describes the file being attached. ## Remarks Information about the file's location that is being attached to the message is contained here. The following fields are available: - [Data](#RNIFAttachment_f_Data) - [Description](#RNIFAttachment_f_Description) - [FileName](#RNIFAttachment_f_FileName) - [Id](#RNIFAttachment_f_Id) - [InputStream](#RNIFAttachment_f_InputStream) - [MIMEType](#RNIFAttachment_f_MIMEType) - [OutputStream](#RNIFAttachment_f_OutputStream) ## Fields **Data** *String* *Default Value: ""* [Data](#RNIFAttachment_f_Data) contains the raw data of the current attachment. If [Data](#RNIFAttachment_f_Data) is set, the value in [FileName](#RNIFAttachment_f_FileName) will be used to specify the name of the attachment when generating messages to be sent. When receiving, polling This field will cause the attachment to be parsed out of the transmitted MIME entity to memory rather than being parsed to a file. **DataB** *byte[]* *Default Value: ""* [Data](#RNIFAttachment_f_Data) contains the raw data of the current attachment. If [Data](#RNIFAttachment_f_Data) is set, the value in [FileName](#RNIFAttachment_f_FileName) will be used to specify the name of the attachment when generating messages to be sent. When receiving, polling This field will cause the attachment to be parsed out of the transmitted MIME entity to memory rather than being parsed to a file. **Description** *String* *Default Value: ""* [Description](#RNIFAttachment_f_Description) contains descriptions for this attachment. These descriptions are human-readable strings and may set to any arbitrary value. These descriptions should play no role in how the message is processed or interpreted. **FileName** *String* *Default Value: ""* [FileName](#RNIFAttachment_f_FileName) is the name of the file containing the decoded data of the current attachment. When sending messages, this value tells the class where to find the file and is used in accordance with MIME encoding rules to indicate the filename to be used by the receiving RNIF entity when parsing the attachments. When receiving, polling This field 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. **Id** *String* *Default Value: ""* [Id](#RNIFAttachment_f_Id) is a unique content-identifier used within the RosettaNet message to internally reference the attachments. Because these identifiers are used to reference the attachments, each attachment must have a unique identifier, but they only need to be unique within the scope of the current message. These values may take the form of a URI. **InputStream** *java.io.InputStream* *Default Value: ""* A stream which contains the decoded data of the current attachment. **MIMEType** *String* *Default Value: ""* [MimeType](#RNIFAttachment_f_MimeType) is a value indicating how the [RNIFAttachment](#rnifattachment-type) 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" **OutputStream** *java.io.OutputStream (read-only)* *Default Value: ""* The class decodes the attachment when [OutputStream](#RNIFAttachment_f_OutputStream) is specified. NOTE: It is recommended to use the SetAttachmentOutputStream method instead of setting this field. ## Constructors ```text public RNIFAttachment(); ``` ```text public RNIFAttachment(String fileName); ``` ```text public RNIFAttachment(String fileName, String id); ``` ```text public RNIFAttachment(String fileName, String id, String description); ``` ```text public RNIFAttachment(String fileName, String id, String description, String MIMEType); ``` # Config Settings ([RNIFSender](#rnifsender-class) Class) The class accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the [Config](#config-method-rnifsender-class) method. ### RNIFSender Config Settings **ApplyBase64Encoding**: Allows you to control the base64 encoding of the message body when signing the message. This setting allows you to control the base64 encoding of the message body when signing the message. By default, this value is true, and the body will be base64 encoded when the message is being signed. **Authorization**: The Authorization string to be sent to the server. If the [Authorization](#Authorization) setting contains a non-empty string, an *Authorization* HTTP request header is added to the request. This header conveys Authorization information to the server. This setting is provided so that the class can be extended with other security schemes in addition to the authorization schemes already implemented by the class. The [AuthScheme](#AuthScheme); setting defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time [User](#User) and [Password](#Password) are set, they are Base64 encoded, and the result is put in the **Authorization** setting in the form "Basic [encoded-user-password]". **AuthScheme**: The authorization scheme to be used when server authorization is to be performed. Use the [AuthScheme](#AuthScheme) property to tell the component which type of authorization to perform when the [User](#User) and [Password](#Password) properties are set. Possible values are: | | | | --- | --- | | 0 (default) | Basic | | 1 | Digest | | 2 | Proprietary | | 3 | None | | 4 | NTLM | | 5 | Negotiate | | 6 | OAuth | By default, [AuthScheme](#AuthScheme) is Basic (0), and if the [User](#User) and [Password](#Password) configuration settings are set, the component will attempt basic authentication. If AuthScheme is set to Digest (1), digest authentication will be attempted instead. For security reasons, setting this value will clear the values of [User](#User) and [Password](#Password). **FromPartnerClassificationCode**: Code identifying the sending partner's function in the supply chain.This setting specified the code identifying the sending partner's function in the supply chain. **GlobalProcessCode**: Business process identifier.This setting specifies the business process identifier e.g. 'Manage Product Subscriptions'. This code is the name of a PIP specification document. **HTTPStatusLine**: Returns the status line of the last response.This value may be queried after a call to [Post](#post-method-rnifsender-class). It will return the HTTP status returned by the server such as "HTTP/1.1 200 OK". **Password**: A password if authentication is to be used.If [AuthScheme](#AuthScheme) is set to Basic, the [User](#User) and [Password](#Password) are Base64 encoded and the result is put in the [Authorization](#Authorization) configuration setting in the form "Basic [encoded-user-password]". If [AuthScheme](#AuthScheme) is set to Digest, the [User](#User) and [Password](#Password) properties are used to respond to the HTTP Digest Authentication challenge from the server. The [User](#User) and [Password](#Password) properties must be set only after the [URL](#url-property-rnifsender-class) property is set. When the [URL](#url-property-rnifsender-class) property is set, for security reasons, [User](#User) and [Password](#Password) are immediately cleared. **RequestBody**: The full body of the outgoing request.After calling [Post](#post-method-rnifsender-class) this will contain the full body of the outgoing request. **RequestHeaders**: The MIME headers of the outgoing request.After calling [Post](#post-method-rnifsender-class) this will contain the MIME headers of the outgoing request. **ToPartnerClassificationCode**: Code identifying the receiving partner's function in the supply chain.This setting specifies the code identifying the receiving partner's function in the supply chain. **TransactionCode**: The service transaction code.This setting specifies the service transaction code. The code is the name of the business activity and the transaction dialog in the PIP specification document. **TransactionId**: A unique transaction Id.This property specifies a unique alpha-numeric identifier that represents a specific instance of a business process, business transaction, business action or business signal. The instance identifier must be unique for a particular instance of a business process, business transaction, business action and business signal. **User**: A user name if authentication is to be used.If [AuthScheme](#AuthScheme) is set to Basic, the [User](#User) and [Password](#Password) are Base64 encoded and the result is put in the [Authorization](#Authorization) configuration setting in the form "Basic [encoded-user-password]". If [AuthScheme](#AuthScheme) is set to Digest, the [User](#User) and [Password](#Password) properties are used to respond to the HTTP Digest Authentication challenge from the server. The [User](#User) and [Password](#Password) properties must be set only after the [URL](#url-property-rnifsender-class) property is set. When the [URL](#url-property-rnifsender-class) property is set, for security reasons, [User](#User) and [Password](#Password) are immediately cleared. ### HTTP Config Settings **AcceptEncoding**: Used to tell the server which types of content encodings the client supports.When [AllowHTTPCompression](#AllowHTTPCompression) is True, the class adds an *Accept-Encoding* header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the *Accept-Encoding* header. NOTE: The class only supports gzip and deflate decompression algorithms. **AllowHTTPCompression**: This property enables HTTP compression for receiving data.This configuration setting enables HTTP compression for receiving data. When set to True (default), the class will accept compressed data. It then will uncompress the data it has received. The class will handle data compressed by both gzip and deflate compression algorithms. When True, the class adds an *Accept-Encoding* header to the outgoing request. The value for this header can be controlled by the [AcceptEncoding](#AcceptEncoding) configuration setting. The default value for this header is "gzip, deflate". The default value is True. **AllowHTTPFallback**: Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when HTTPVersion is set to "2.0". If set to True (default), the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class throws an exception if the server does not support HTTP/2. The default value is True. **AllowNTLMFallback**: Whether to allow fallback from Negotiate to NTLM when authenticating.This configuration setting applies only when AuthScheme is set to Negotiate. If set to True, the class will automatically use New Technology LAN Manager (NTLM) if the server does not support Negotiate authentication. NOTE: The server must indicate that it supports NTLM authentication through the WWW-Authenticate header for the fallback from Negotiate to NTLM to take place. The default value is False. **Append**: Whether to append data to LocalFile.This configuration setting determines whether data will be appended when writing to LocalFile. When set to True, downloaded data will be appended to LocalFile. This may be used in conjunction with Range to resume a failed download. This is applicable only when LocalFile is set. The default value is False. **Authorization**: The Authorization string to be sent to the server.If the [Authorization](#Authorization) property contains a nonempty string, an *Authorization* HTTP request header is added to the request. This header conveys Authorization information to the server. This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class. The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]". **BytesTransferred**: Contains the number of bytes transferred in the response data.This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the [Transfer](#transfer-event-rnifsender-class) event, by [BytesTransferred](#BytesTransferred). **ChunkSize**: Specifies the chunk size in bytes when using chunked encoding.This is applicable only when [UseChunkedEncoding](#UseChunkedEncoding) is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384. **CompressHTTPRequest**: Set to true to compress the body of a PUT or POST request.If set to True, the body of a *PUT* or *POST* request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request. The default value is False. **EncodeURL**: If set to True the URL will be encoded by the class.If set to True, the URL passed to the class will be URL encoded. The default value is False. **FollowRedirects**: Determines what happens when the server issues a redirect.This option determines what happens when the server issues a redirect. Normally, the class returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new [URL](#url-property-rnifsender-class) for the object is retrieved automatically every time. If this property is set to 2 (Same Scheme), the new [URL](#url-property-rnifsender-class) is retrieved automatically only if the URL Scheme is the same; otherwise, the class throws an exception. **Note:** Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for *GET* or *HEAD* requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities. Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server. A [Redirect](#redirect-event-rnifsender-class) event is fired for every URL the product is redirected to. In the case of automatic redirections, the [Redirect](#redirect-event-rnifsender-class) event is a good place to set properties related to the new connection (e.g., new authentication parameters). The default value is 0 (Never). In this case, redirects are never followed, and the class throws an exception instead. Following are the valid options: - 0 - Never - 1 - Always - 2 - Same Scheme **GetOn302Redirect**: If set to True the class will perform a GET on the new location.The default value is False. If set to True, the class will perform a *GET* on the new location. Otherwise, it will use the same HTTP method again. **HTTP2HeadersWithoutIndexing**: HTTP2 headers that should not update the dynamic header table with incremental indexing.HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names. **HTTPVersion**: The version of HTTP used by the class.This property specifies the HTTP version used by the class. Possible values are as follows: - "1.0" - "1.1" (default) - "2.0" - "3.0" When using HTTP/2 ("2.0") or HTTP/3 ("3.0"), additional restrictions apply. Please see the following notes for details. **HTTP/2 Notes** When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error. If the server does not support HTTP/2, the class will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check [NegotiatedHTTPVersion](#NegotiatedHTTPVersion) after calling a method. The [AllowHTTPFallback](#AllowHTTPFallback) setting controls whether this behavior is allowed (default) or disallowed. HTTP/2 is supported on all platforms. The class will use the internal security implementation in all cases when connecting. **HTTP/3 Notes** HTTP/3 is supported only in .NET and Java. When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error. **IfModifiedSince**: A date determining the maximum age of the desired document.If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example: ```text Sat, 29 Oct 2017 19:43:31 GMT. ``` **KeepAlive**: Determines whether the HTTP connection is closed after completion of the request.If *true*, the component will not send the *Connection: Close* header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. NOTE: Not all servers support persistent connections. If *false*, the connection will be closed immediately after the server response is received. The default value for [KeepAlive](#KeepAlive) is *false*. **KerberosSPN**: The Service Principal Name for the Kerberos Domain Controller.If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here. **LogLevel**: The level of detail that is logged.This configuration setting controls the level of detail that is logged through the Log event. Possible values are as follows: | | | | --- | --- | | 0 (None) | No events are logged. | | 1 (Info - default) | Informational events are logged. | | 2 (Verbose) | Detailed data are logged. | | 3 (Debug) | Debug data are logged. | The value 1 (Info) logs basic information, including the URL, HTTP version, and status details. The value 2 (Verbose) logs additional information about the request and response. The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any). **MaxHeaders**: Instructs class to save the amount of headers specified that are returned by the server after a Header event has been fired.This configuration setting should be set when the TransferredHeaders collection is to be populated when a [Header](#header-event-rnifsender-class) event has been fired. This value represents the number of headers that are to be saved in the collection. To save all items to the collection, set this configuration setting to -1. If no items are wanted, set this to 0, which will not save any items to the collection. The default for this configuration setting is -1, so all items will be included in the collection. **MaxHTTPCookies**: Instructs class to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.This configuration setting should be set when populating the [Cookies](#cookies-property-rnifsender-class) collection as a result of an HTTP request. This value represents the number of cookies that are to be saved in the collection. To save all items to the collection, set this configuration setting to -1. If no items are wanted, set this to 0, which will not save any items to the collection. The default for this configuration setting is -1, so all items will be included in the collection. **MaxRedirectAttempts**: Limits the number of redirects that are followed in a request.When FollowRedirects is set to any value other than frNever, the class will follow redirects until this maximum number of redirect attempts are made. The default value is 20. **NegotiatedHTTPVersion**: The negotiated HTTP version.This configuration setting may be queried after the request is complete to indicate the HTTP version used. When HTTPVersion is set to "2.0" (if the server does not support "2.0"), then the class will fall back to using "1.1" automatically. This setting will indicate which version was used. **OtherHeaders**: Other headers as determined by the user (optional).This configuration setting can be set to a string of headers to be appended to the HTTP request headers. The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF (*"\r\n"*) . Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail. This configuration setting is useful for extending the functionality of the class beyond what is provided. **ProxyAuthorization**: The authorization string to be sent to the proxy server.This is similar to the [Authorization](#Authorization) configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a *Proxy-Authorization* HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If [User](#Proxy_f_User) and [Password](#Proxy_f_Password) are specified, this value is calculated using the algorithm specified by [AuthScheme](#Proxy_f_AuthScheme). **ProxyAuthScheme**: The authorization scheme to be used for the proxy.This configuration setting is provided for use by classes that do not directly expose Proxy properties. **ProxyPassword**: A password if authentication is to be used for the proxy.This configuration setting is provided for use by classes that do not directly expose Proxy properties. **ProxyPort**: Port for the proxy server (default 80).This configuration setting is provided for use by classes that do not directly expose Proxy properties. **ProxyServer**: Name or IP address of a proxy server (optional).This configuration setting is provided for use by classes that do not directly expose Proxy properties. **ProxyUser**: A user name if authentication is to be used for the proxy.This configuration setting is provided for use by classes that do not directly expose Proxy properties. **SentHeaders**: The full set of headers as sent by the client.This configuration setting returns the complete set of raw headers as sent by the client. **StatusCode**: The status code of the last response from the server.This configuration setting contains the result code of the last response from the server. **StatusLine**: The first line of the last response from the server.This setting contains the first line of the last response from the server. The format of the line will be *[HTTP version] [Result Code] [Description]*. **TransferredData**: The contents of the last response from the server.This configuration setting contains the contents of the last response from the server. **TransferredDataLimit**: The maximum number of incoming bytes to be stored by the class.If [TransferredDataLimit](#TransferredDataLimit) is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the class. **TransferredHeaders**: The full set of headers as received from the server.This configuration setting returns the complete set of raw headers as received from the server. **TransferredRequest**: The full request as sent by the client.This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request: .NET ```text Http http = new Http(); http.Config("TransferredRequest=on"); http.PostData = "body"; http.Post("http://someserver.com"); Console.WriteLine(http.Config("TransferredRequest")); ``` C++ ```text HTTP http; http.Config("TransferredRequest=on"); http.SetPostData("body", 5); http.Post("http://someserver.com"); printf("%s\r\n", http.Config("TransferredRequest")); ``` **UseChunkedEncoding**: Enables or Disables HTTP chunked encoding for transfers.If [UseChunkedEncoding](#UseChunkedEncoding) is set to True, the class will use HTTP-chunked encoding when posting, if possible. HTTP-chunked encoding allows large files to be sent in chunks instead of all at once. If set to False, the class will not use HTTP-chunked encoding. The default value is False. NOTE: Some servers (such as the ASP.NET Development Server) may not support chunked encoding. **UseIDNs**: Whether to encode hostnames to internationalized domain names.This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name). The default value is False and the hostname will always be used exactly as specified. **UsePlatformDeflate**: Whether to use the platform implementation to decompress compressed responses.This configuration setting specifies whether the platform's deflate-algorithm implementation is used to decompress responses that use compression. If set to *True* (default), the platform implementation is used. If set to *False*, an internal implementation is used. **UsePlatformHTTPClient**: Whether or not to use the platform HTTP client.When using this configuration setting, if True, the component will use the default HTTP client for the platform (*URLConnection* in Java, *WebRequest* in .NET, or CFHTTPMessage in Mac/iOS) instead of the internal HTTP implementation. This is important for environments in which direct access to sockets is limited or not allowed (e.g., in the Google AppEngine). **UseProxyAutoConfigURL**: Whether to use a Proxy auto-config file when attempting a connection.This configuration specifies whether the class will attempt to use the Proxy auto-config URL when establishing a connection and [AutoDetect](#Proxy_f_AutoDetect) is set to *True*. When *True* (default), the class will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use. **UserAgent**: Information about the user agent (browser).This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com". Override the default with the name and version of your software. ### TCPClient Config Settings **CloseStreamAfterTransfer**: If true, the component will close the upload or download stream after the transfer.This configuration setting determines whether the input or output stream is closed after the transfer completes. When set to True (default), all streams will be closed after a transfer is completed. To keep streams open after the transfer of data, set this to False. The default value is True. **ConnectionTimeout**: Sets a separate timeout value for establishing a connection.When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use [Timeout](#timeout-property-rnifsender-class) for establishing a connection and transmitting/receiving data. **EnableFallback**: Whether to try the other addresses the remote host resolves to when a connection attempt fails.When set to True and RemoteHost resolves to more than one address, the class will try the remaining addresses in turn if the connection to the first one fails, and only throws an exception once every address has been tried. The error reported is the one from the last attempt. Use [FallbackTimeout](#FallbackTimeout) to limit the total time spent. NOTE: Only addresses of the same IP version as the first one are tried, this setting does not fall back from IPv6 to IPv4. Selecting between IPv6 and IPv4 is done by [UseIPv6](#UseIPv6) when the host is resolved. This setting must be set before the connection is established. The default value for this setting is False. **FallbackTimeout**: The maximum time in milliseconds to spend on connection attempts when EnableFallback is enabled.This setting limits the total time that the class will spend on all of the connection attempts made when [EnableFallback](#EnableFallback) is enabled. The default value is 0, in which case each attempt uses the operating system's own connection timeout. NOTE: This setting only applies when [EnableFallback](#EnableFallback) is True. It is unrelated to [ConnectionTimeout](#ConnectionTimeout), which is specified in seconds and applies to the Connected operation as a whole. **FirewallAutoDetect**: Tells the class whether or not to automatically detect and use firewall system settings, if available.This configuration setting is provided for use by classes that do not directly expose Firewall properties. **FirewallHost**: Name or IP address of firewall (optional).If a [FirewallHost](#FirewallHost) is given, requested connections will be authenticated through the specified firewall when connecting. If the [FirewallHost](#FirewallHost) setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the [FirewallHost](#FirewallHost) setting is set to the corresponding address. If the search is not successful, an error is returned. NOTE: This setting is provided for use by classes that do not directly expose Firewall properties. **FirewallHTTPVersion**: The HTTP version to be used when connecting through a tunneling proxy.When [FirewallType](#FirewallType) is set to a tunneling proxy, this setting dictates which HTTP version is used when connecting. **FirewallListener**: If true, the component binds to a SOCKS firewall as a server (TCPClient only).This entry is for TCPClient only and does not work for other components that descend from TCPClient. If this entry is set, the class acts as a server. RemoteHost and RemotePort are used to tell the SOCKS firewall in which address and port to listen to. The firewall rules may ignore RemoteHost, and it is recommended that RemoteHost be set to empty string in this case. RemotePort is the port in which the firewall will listen to. If set to 0, the firewall will select a random port. The binding (address and port) is provided through the ConnectionStatus event. The connection to the firewall is made by calling the Connect method. **FirewallPassword**: Password to be used if authentication is to be used when connecting through the firewall.If [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the given firewall. If the authentication fails, the class throws an exception. NOTE: This setting is provided for use by classes that do not directly expose Firewall properties. **FirewallPort**: The TCP port for the FirewallHost;.The [FirewallPort](#FirewallPort) is set automatically when [FirewallType](#FirewallType) is set to a valid value. NOTE: This configuration setting is provided for use by classes that do not directly expose Firewall properties. **FirewallType**: Determines the type of firewall to connect through.Possible values are as follows: | | | | --- | --- | | 0 | No firewall (default setting). | | 1 | Connect through a tunneling proxy. [FirewallPort](#FirewallPort) is set to 80. | | 2 | Connect through a SOCKS4 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 3 | Connect through a SOCKS5 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 10 | Connect through a SOCKS4A Proxy. [FirewallPort](#FirewallPort) is set to 1080. | NOTE: This setting is provided for use by classes that do not directly expose Firewall properties. **FirewallUser**: A user name if authentication is to be used connecting through a firewall.If the [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the Firewall. If the authentication fails, the class throws an exception. NOTE: This setting is provided for use by classes that do not directly expose Firewall properties. **KeepAliveInterval**: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by [KeepAliveTime](#KeepAliveTime). If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second. NOTE: This value is not applicable in macOS. **KeepAliveTime**: The inactivity time in milliseconds before a TCP keep-alive packet is sent.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds. **Linger**: When set to True, connections are terminated gracefully.This property controls how a connection is closed. The default is True. In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if [LingerTime](#LingerTime) is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires. In the second scenario, if [LingerTime](#LingerTime) is a positive value, the system will attempt to send pending data until the specified [LingerTime](#LingerTime) is reached. If this attempt fails, then the system will reset the connection. The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes). Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action. **LingerTime**: Time in seconds to have the connection linger. LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout. **LocalHost**: The name of the local host through which connections are initiated or accepted. The [LocalHost](#localhost-property-rnifsender-class) setting contains the name of the local host as obtained by the *gethostname()* system call, or if the user has assigned an IP address, the value of that address. In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classes) only through that interface. If the class is connected, the [LocalHost](#localhost-property-rnifsender-class) setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface). **LocalPort**: The port in the local host where the class binds. This configuration setting must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine. Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established. LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error. This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems. **MaxLineLength**: The maximum amount of data to accumulate when no EOL is found.[MaxLineLength](#MaxLineLength) is the size of an internal buffer, which holds received data while waiting for an EOL string. If an EOL string is found in the input stream before [MaxLineLength](#MaxLineLength) bytes are received, the DataIn event is fired with the *EOL* parameter set to True, and the buffer is reset. If no EOL is found, and [MaxLineLength](#MaxLineLength) bytes are accumulated in the buffer, the DataIn event is fired with the *EOL* parameter set to False, and the buffer is reset. The minimum value for [MaxLineLength](#MaxLineLength) is 256 bytes. The default value is 2048 bytes. **MaxTransferRate**: The transfer rate limit in bytes per second.This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit. **ProxyExceptionsList**: A semicolon separated list of hosts and IPs to bypass when using a proxy.This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance: *www.google.com;www.example.com* **TCPKeepAlive**: Determines whether or not the keep alive socket option is enabled.If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set [KeepAliveTime](#KeepAliveTime) and [KeepAliveInterval](#KeepAliveInterval) to configure the timing of the keep-alive packets. NOTE: This value is not applicable in Java. **TcpNoDelay**: Whether or not to delay when sending packets. When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm. By default, this configuration setting is set to False. **UseIPv6**: Whether to use IPv6.When set to *0* (default), the class will use IPv4 exclusively. When set to *1*, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to *2*. The default value is *0*. Possible values are as follows: | | | | --- | --- | | 0 | IPv4 only | | 1 | IPv6 only | | 2 | IPv6 with IPv4 fallback | **UseNTLMv2**: Whether to use NTLM V2.When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is True and NTLM V2 will be used. Set this to False to use NTLM V1. ### SSL Config Settings **LogSSLPackets**: Controls whether SSL packets are logged when using the internal security API.When [SSLProvider](#sslprovider-property-rnifsender-class) is set to *Internal*, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is *False*, as it is useful only for debugging purposes. When enabled, SSL packet logs are output using the [SSLStatus](#sslstatus-event-rnifsender-class) event, which will fire each time an SSL packet is sent or received. Enabling this configuration setting has no effect if [SSLProvider](#sslprovider-property-rnifsender-class) is set to *Platform*. **ReuseSSLSession**: Determines if the SSL session is reused. If set to True, the class will reuse the context if and only if the following criteria are met: - The target host name is the same. - The system cache entry has not expired (default timeout is 10 hours). - The application process that calls the function is the same. - The logon session is the same. - The instance of the class is the same. **SSLCACerts**: A newline separated list of CA certificates to be included when performing an SSL handshake.When [SSLProvider](#sslprovider-property-rnifsender-class) is set to *Internal*, this configuration setting specifies one or more CA certificates to be included with the [SSLCert](#sslcert-property-rnifsender-class) property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **SSLCheckCRL**: Whether to check the Certificate Revocation List for the server certificate.This configuration setting specifies whether the class will check the Certificate Revocation List (CRL) specified by the server certificate. If set to 1 or 2, the class will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The class will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class throws an exception. When set to 0 (default), the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported. This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems. **SSLCheckOCSP**: Whether to use OCSP to check the status of the server certificate.This configuration setting specifies whether the class will use OCSP to check the validity of the server certificate. If set to 1 or 2, the class will first obtain the Online Certificate Status Protocol (OCSP) URL from the server certificate's OCSP extension. The class will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation, the class throws an exception. When set to 0 (default), the class will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported. This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems. **SSLCipherStrength**: The minimum cipher strength used for bulk encryption. This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated. NOTE: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the [SSLStatus](#sslstatus-event-rnifsender-class) event. Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application. When the provider is OpenSSL, [SSLCipherStrength](#SSLCipherStrength) is currently not supported. This functionality is instead made available through the [OpenSSLCipherList](#OpenSSLCipherList) configuration setting. **SSLClientCACerts**: A newline separated list of CA certificates to use during SSL client certificate validation.This configuration setting is only applicable to server components (e.g., TCPServer) see [SSLServerCACerts](#SSLServerCACerts) for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when SSLAuthenticateClients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **SSLContextProtocol**: The protocol used when getting an SSLContext instance.Possible values are SSL, SSLv2, SSLv3, TLS, and TLSv1. Use this configuration setting only in case your security provider does not support TLS. This is the parameter "protocol" inside the SSLContext.getInstance(protocol) call. **SSLEnabledCipherSuites**: The cipher suite to be used in an SSL negotiation.This configuration setting enables the cipher suites to be used in SSL negotiation. By default, the enabled cipher suites will include all available ciphers ("*"). The special value "*" means that the class will pick all of the supported cipher suites. If [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is set to any other value, only the specified cipher suites will be considered. Multiple cipher suites are separated by semicolons. NOTE: This value must be set after [SSLProvider](#sslprovider-property-rnifsender-class) is set. Example values: ```text obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=SSL_RSA_WITH_RC4_128_SHA"); obj.config("SSLEnabledCipherSuites=SSL_RSA_WITH_RC4_128_SHA; SSL_DHE_RSA_WITH_3DES_EDE_CBC_SHA"); ``` Possible values when [SSLProvider](#sslprovider-property-rnifsender-class) is set to *Platform* include the following: - SSL_DHE_RSA_EXPORT_WITH_DES40_CBC_SHA - SSL_DHE_RSA_WITH_3DES_EDE_CBC_SHA - SSL_RSA_WITH_RC4_128_SHA - SSL_RSA_WITH_DES_CBC_SHA - SSL_RSA_EXPORT_WITH_DES40_CBC_SHA - SSL_DH_anon_WITH_DES_CBC_SHA - SSL_RSA_EXPORT_WITH_RC4_40_MD5 - SSL_DHE_DSS_EXPORT_WITH_DES40_CBC_SHA - SSL_DH_anon_EXPORT_WITH_RC4_40_MD5 - SSL_DHE_DSS_WITH_DES_CBC_SHA - SSL_RSA_WITH_NULL_MD5 - SSL_DH_anon_WITH_3DES_EDE_CBC_SHA - SSL_DHE_RSA_WITH_DES_CBC_SHA - SSL_DH_anon_EXPORT_WITH_DES40_CBC_SHA - SSL_RSA_WITH_NULL_SHA - SSL_DH_anon_WITH_RC4_128_MD5 - SSL_RSA_WITH_RC4_128_MD5 - SSL_DHE_DSS_WITH_3DES_EDE_CBC_SHA - SSL_RSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_ECDSA_WITH_NULL_SHA - TLS_DH_anon_WITH_AES_128_CBC_SHA256 (Not Recommended) - TLS_ECDH_anon_WITH_RC4_128_SHA - TLS_DH_anon_WITH_AES_128_CBC_SHA (Not Recommended) - TLS_DHE_RSA_WITH_AES_128_CBC_SHA - TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA - TLS_KRB5_WITH_3DES_EDE_CBC_SHA - TLS_DHE_DSS_WITH_AES_128_CBC_SHA256 - TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA - TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 - TLS_KRB5_EXPORT_WITH_RC4_40_SHA - TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256 - TLS_ECDHE_RSA_WITH_RC4_128_SHA - TLS_ECDH_ECDSA_WITH_RC4_128_SHA - TLS_ECDH_anon_WITH_NULL_SHA - TLS_ECDHE_ECDSA_WITH_RC4_128_SHA - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA - TLS_RSA_WITH_NULL_SHA256 - TLS_ECDH_anon_WITH_3DES_EDE_CBC_SHA - TLS_KRB5_WITH_RC4_128_MD5 - TLS_ECDHE_ECDSA_WITH_NULL_SHA - TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_RSA_WITH_RC4_128_SHA - TLS_EMPTY_RENEGOTIATION_INFO_SCSV - TLS_KRB5_WITH_3DES_EDE_CBC_MD5 - TLS_KRB5_WITH_RC4_128_SHA - TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_RSA_WITH_NULL_SHA - TLS_ECDH_RSA_WITH_AES_128_CBC_SHA - TLS_KRB5_WITH_DES_CBC_MD5 - TLS_KRB5_EXPORT_WITH_RC4_40_MD5 - TLS_KRB5_EXPORT_WITH_DES_CBC_40_MD5 - TLS_ECDH_anon_WITH_AES_128_CBC_SHA - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 - TLS_KRB5_WITH_DES_CBC_SHA - TLS_RSA_WITH_AES_128_CBC_SHA - TLS_KRB5_EXPORT_WITH_DES_CBC_40_SHA - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 - TLS_ECDHE_RSA_WITH_NULL_SHA - TLS_RSA_WITH_AES_128_CBC_SHA256 - TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA - TLS_DHE_DSS_WITH_AES_128_CBC_SHA Possible values when [SSLProvider](#sslprovider-property-rnifsender-class) is set to *Internal* include the following: - TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_RSA_WITH_AES_256_GCM_SHA384 - TLS_RSA_WITH_AES_128_GCM_SHA256 - TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_DSS_WITH_AES_256_GCM_SHA384 - TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_DSS_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 - TLS_DHE_DSS_WITH_AES_256_CBC_SHA256 - TLS_RSA_WITH_AES_256_CBC_SHA256 - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 - TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384 - TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 - TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 - TLS_RSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256 - TLS_DHE_DSS_WITH_AES_128_CBC_SHA256 - TLS_RSA_WITH_AES_256_CBC_SHA - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA - TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA - TLS_DHE_RSA_WITH_AES_256_CBC_SHA - TLS_ECDH_RSA_WITH_AES_256_CBC_SHA - TLS_DHE_DSS_WITH_AES_256_CBC_SHA - TLS_RSA_WITH_AES_128_CBC_SHA - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA - TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA - TLS_ECDH_RSA_WITH_AES_128_CBC_SHA - TLS_DHE_RSA_WITH_AES_128_CBC_SHA - TLS_DHE_DSS_WITH_AES_128_CBC_SHA - TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA - TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA - TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA - TLS_RSA_WITH_3DES_EDE_CBC_SHA - TLS_RSA_WITH_DES_CBC_SHA - TLS_DHE_RSA_WITH_DES_CBC_SHA - TLS_DHE_DSS_WITH_DES_CBC_SHA - TLS_RSA_WITH_RC4_128_MD5 - TLS_RSA_WITH_RC4_128_SHA When TLS 1.3 is negotiated (see [SSLEnabledProtocols](#SSLEnabledProtocols)), only the following cipher suites are supported: - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 - TLS_AES_128_GCM_SHA256 [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is used together with [SSLCipherStrength](#SSLCipherStrength). **SSLEnabledProtocols**: Used to enable/disable the supported security protocols.This configuration setting is used to enable or disable the supported security protocols. Not all supported protocols are enabled by default. The default value is *4032* for client components, and *3072* for server components. To specify a combination of enabled protocol versions set this config to the binary *OR* of one or more of the following values: | | | | --- | --- | | TLS1.3 | 12288 (Hex 3000) | | TLS1.2 | 3072 (Hex C00) (Default - Client and Server) | | TLS1.1 | 768 (Hex 300) (Default - Client) | | TLS1 | 192 (Hex C0) (Default - Client) | | SSL3 | 48 (Hex 30) | | SSL2 | 12 (Hex 0C) | Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases. **SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:** By default when TLS 1.3 is enabled, the class will first try to use the platform TLS 1.3 implementation when the [SSLProvider](#sslprovider-property-rnifsender-class) is set to Automatic for all editions. If the platform TLS 1.3 implementation is not available, the internal implementation will be used. In editions that are designed to run on Windows, [SSLProvider](#sslprovider-property-rnifsender-class) can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version. If set to *1* (Platform provider), please be aware of the following notes: - The platform provider is available only on Windows 11/Windows Server 2022 and up. - [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) and other similar SSL configuration settings are not supported. - If [SSLEnabledProtocols](#SSLEnabledProtocols) includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions. **SSLEnabledProtocols: SSL2 and SSL3 Notes: ** SSL 2.0 and 3.0 are not supported by the class when the [SSLProvider](#sslprovider-property-rnifsender-class) is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and [SSLProvider](#sslprovider-property-rnifsender-class) needs to be set to platform. **SSLEnableRenegotiation**: Whether the renegotiation_info SSL extension is supported.This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is *false* by default, but it can be set to *true* to enable the extension. This configuration setting is applicable only when [SSLProvider](#sslprovider-property-rnifsender-class) is set to *Internal*. **SSLIncludeCertChain**: Whether the entire certificate chain is included in the SSLServerAuthentication event.This configuration setting specifies whether the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-rnifsender-class) event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-rnifsender-class) event. If set to True, all certificates returned by the server will be present in the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-rnifsender-class) event. This includes the leaf certificate, any intermediate certificate, and the root certificate. Note: When [SSLProvider](#sslprovider-property-rnifsender-class) is set to *Internal* this value is automatically set to *true*. This is needed for proper validation when using the internal provider. **SSLKeyLogFile**: The location of a file where per-session secrets are written for debugging purposes.This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes. When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the class will only append, it will not overwrite previous values. NOTE: This configuration setting is applicable only when [SSLProvider](#sslprovider-property-rnifsender-class) is set to *Internal*. **SSLNegotiatedCipher**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipher[connId]"); ``` **SSLNegotiatedCipherStrength**: Returns the negotiated cipher suite strength.This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherStrength[connId]"); ``` **SSLNegotiatedCipherSuite**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherSuite[connId]"); ``` **SSLNegotiatedKeyExchange**: Returns the negotiated key exchange algorithm.This configuration setting returns the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchange[connId]"); ``` **SSLNegotiatedKeyExchangeStrength**: Returns the negotiated key exchange algorithm strength.This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchangeStrength[connId]"); ``` **SSLNegotiatedVersion**: Returns the negotiated protocol version.This configuration setting returns the protocol version negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedVersion[connId]"); ``` **SSLServerCACerts**: A newline separated list of CA certificates to use during SSL server certificate validation.This configuration setting is only used by client components (e.g., TCPClient) see [SSLClientCACerts](#SSLClientCACerts) for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **SSLTrustManagerFactoryAlgorithm**: The algorithm to be used to create a TrustManager through TrustManagerFactory.Possible values include SunX509. This is the parameter "algorithm" inside the TrustManagerFactory.getInstance(algorithm) call. **TLS12SignatureAlgorithms**: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.This configuration setting specifies the allowed server certificate signature algorithms when [SSLProvider](#sslprovider-property-rnifsender-class) is set to *Internal* and [SSLEnabledProtocols](#SSLEnabledProtocols) is set to allow TLS 1.2. When specified the class will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the class throws an exception. The format of this value is a comma-separated list of hash-signature combinations. For instance: ```csharp component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); ``` The default value for this configuration setting is *sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa*. To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent. **TLS12SupportedGroups**: The supported groups for ECC.This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC. The default value is *ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1*. When using TLS 1.2 and [SSLProvider](#sslprovider-property-rnifsender-class) is set to *Internal*, the values refer to the supported groups for ECC. The following values are supported: - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" (default) **TLS13KeyShareGroups**: The groups for which to pregenerate key shares.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server. The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting. NOTE: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group. In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so. The default value is *ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072* The values are ordered from most preferred to least preferred. The following values are supported: - "ecdhe_x25519" (default) - "ecdhe_x448" - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" - "ffdhe_2048" (default) - "ffdhe_3072" (default) - "ffdhe_4096" - "ffdhe_6144" - "ffdhe_8192" **TLS13SignatureAlgorithms**: The allowed certificate signature algorithms.This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following: - "ed25519" (default) - "ed448" (default) - "ecdsa_secp256r1_sha256" (default) - "ecdsa_secp384r1_sha384" (default) - "ecdsa_secp521r1_sha512" (default) - "rsa_pkcs1_sha256" (default) - "rsa_pkcs1_sha384" (default) - "rsa_pkcs1_sha512" (default) - "rsa_pss_sha256" (default) - "rsa_pss_sha384" (default) - "rsa_pss_sha512" (default) The default value is *rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448*. This configuration setting is applicable only when [SSLEnabledProtocols](#SSLEnabledProtocols) includes TLS 1.3. **TLS13SupportedGroups**: The supported groups for (EC)DHE key exchange.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so. The default value is *ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192,mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768* The values are ordered from most preferred to least preferred. The following values are supported: - "ecdhe_x25519" (default) - "ecdhe_x448" (default) - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" (default) - "ffdhe_2048" (default) - "ffdhe_3072" (default) - "ffdhe_4096" (default) - "ffdhe_6144" (default) - "ffdhe_8192" (default) - "mlkem_512" (default) - "mlkem_768" (default) - "mlkem_1024" (default) - "x25519_mlkem_768" (default) - "secp256r1_mlkem_768" (default) Post-quantum algorithms (*mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*) in our components rely on the operating system's underlying cryptographic primitives. The following platforms are currently supported: - Windows Server 2025 - Windows 11 24H2 - Windows 11 25H2 ### Socket Config Settings **AbsoluteTimeout**: Determines whether timeouts are inactivity timeouts or absolute timeouts.If [AbsoluteTimeout](#AbsoluteTimeout) is set to True, any method that does not complete within [Timeout](#timeout-property-rnifsender-class) seconds will be aborted. By default, *AbsoluteTimeout* is False, and the timeout is an inactivity timeout. NOTE: This option is not valid for User Datagram Protocol (UDP) ports. **FirewallData**: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes). **InBufferSize**: The size in bytes of the incoming queue of the socket.This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the *InBufferSize* setting can provide significant improvements in performance. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the *InBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small. **OutBufferSize**: The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the *OutBufferSize* setting can provide significant improvements in performance. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the *OutBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small. ### Base Config Settings **BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build. **GUIAvailable**: Whether or not a message loop is available for processing events.In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The class will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation. In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting [GUIAvailable](#GUIAvailable) to *false* will ensure that the class does not attempt to process external events. **LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information: - Product: The product the license is for. - Product Key: The key the license was generated from. - License Source: Where the license was found (e.g., RuntimeLicense, License File). - License Type: The type of license installed (e.g., Royalty Free, Single Server). - Last Valid Build: The last valid build number for which the license will work. **MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*. **UseDaemonThreads**: Whether threads created by the class are daemon threads.If set to True (default), when the class creates a thread, the thread's Daemon property will be explicitly set to True. When set to False, the class will not set the Daemon property on the created thread. The default value is True. **UseFIPSCompliantAPI**: Tells the class whether or not to use FIPS certified APIs.When set to *true*, the class will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle Federal Information Processing Standards (FIPS), while all other Windows editions make use of Microsoft security libraries. The Java edition requires installation of the FIPS-certified Bouncy Castle library regardless of the target operating system. This can be downloaded from [https://www.bouncycastle.org/fips-java/](https://www.bouncycastle.org/fips-java/). Only the "Provider" library is needed. The jar file should then be installed in a JRE search path. The following classes must be imported in the application in which the component will be used: ```text import java.security.Security; import org.bouncycastle.jcajce.provider.BouncyCastleFipsProvider; ``` The Bouncy Castle provider must be added as a valid provider and must also be configured to operate in FIPS mode: ```text System.setProperty("org.bouncycastle.fips.approved_only","true"); Security.addProvider(new BouncyCastleFipsProvider()); ``` When [UseFIPSCompliantAPI](#UseFIPSCompliantAPI) is *true*, Secure Sockets Layer (SSL)-enabled classes can optionally be configured to use the Transport Layer Security (TLS) Bouncy Castle library. When [SSLProvider](#sslprovider-property-rnifsender-class) is set to *sslpAutomatic* (default) or *sslpInternal*, an internal TLS implementation is used, but all cryptographic operations are offloaded to the Bouncy Castle FIPS provider to achieve FIPS-compliant operation. If [SSLProvider](#sslprovider-property-rnifsender-class) is set to *sslpPlatform*, the Bouncy Castle JSSE will be used in place of the internal TLS implementation. To enable the use of the Bouncy Castle JSSE take the following steps in addition to the steps above. Both the Bouncy Castle FIPS provider and the Bouncy Castle JSSE must be configured to use the Bouncy Castle TLS library in FIPS mode. Obtain the Bouncy Castle TLS library from [https://www.bouncycastle.org/fips-java/](https://www.bouncycastle.org/fips-java/). The jar file should then be installed in a JRE search path. The following classes must be imported in the application in which the component will be used: ```text import java.security.Security; import org.bouncycastle.jcajce.provider.BouncyCastleFipsProvider; //required to use BCJSSE when SSLProvider is set to sslpPlatform import org.bouncycastle.jsse.provider.BouncyCastleJsseProvider; ``` The Bouncy Castle provider must be added as a valid provider and also must be configured to operate in FIPS mode: ```text System.setProperty("org.bouncycastle.fips.approved_only","true"); Security.addProvider(new BouncyCastleFipsProvider()); //required to use BCJSSE when SSLProvider is set to sslpPlatform Security.addProvider(new BouncyCastleJsseProvider("fips:BCFIPS")); //optional - configure logging level of BCJSSE Logger.getLogger("org.bouncycastle.jsse").setLevel(java.util.logging.Level.OFF); //configure the class to use BCJSSE component.setSSLProvider(1); //platform component.config("UseFIPSCompliantAPI=true"); ``` NOTE: TLS 1.3 support requires the Bouncy Castle TLS library version 1.0.14 or later. FIPS mode can be enabled by setting the *UseFIPSCompliantAPI* configuration setting to *true*. This is a static setting that applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior. For more details, please see the [FIPS 140-2 Compliance](https://www.nsoftware.com/kb/articles/fips.rst) article. NOTE: Enabling FIPS compliance requires a special license; please contact [sales@nsoftware.com](mailto:sales@nsoftware.com) for details. **UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the class will use the system security libraries by default to perform cryptographic functions where applicable. Setting this configuration setting to *true* tells the class to use the internal implementation instead of using the system security libraries. This setting is set to *false* by default on all platforms. **UseVirtualThreads**: Whether threads created by the class use virtual threads instead of platform threads.If set to *true*, when the class creates a thread, it will be created as a virtual thread instead of a platform thread. Virtual threads are lightweight threads managed by the JVM that are multiplexed onto a small pool of carrier threads, significantly reducing memory usage and platform thread count under high-concurrency workloads. Requires Java 24 or later. The default value is *false*. # Trappable Errors ([RNIFSender](#rnifsender-class) Class) ### SMIME Errors | | | | --- | --- | | 10191 | Invalid index (RecipientIndex). | | 10192 | Message decoding error (code). | | 10193 | Unexpected message type. | | 10194 | Unsupported hashing/signing algorithm. | | 10195 | The message does not have any signers. | | 10196 | The message signature could not be verified. | | 10197 | Could not locate a suitable decryption certificate. | | 10198 | The signer certificate could not be found. | | 10199 | No signing certificate was supplied for signing the message. | | 10201 | The specified certificate was not the one required. | | 10202 | The specified certificate could not be found. | | 10221 | Could not acquire CSP. | | 10222 | Type validation error. | | 10223 | Unsupported key size. | | 10224 | Unrecognized Content-Type object identifier. | | 10225 | Unrecognized public key format. | | 10226 | No choices specified. | | 10228 | Must specify output stream. | | 10280 | Invalid part index. | | 10281 | Unknown MIME type. | | 10283 | No MIME-boundary found. | | 10280 | Error decoding certificate. | ### XML Errors | | | | --- | --- | | 101 | Invalid attribute index. | | 102 | No attributes available. | | 103 | Invalid namespace index. | | 104 | No namespaces available. | | 105 | Invalid element index. | | 106 | No elements available. | | 107 | Attribute does not exist. | | 201 | Unbalanced element tag. | | 202 | Unknown element prefix (cannot find namespace). | | 203 | Unknown attribute prefix (cannot find namespace). | | 204 | Invalid XML markup. | | 205 | Invalid end state for parser. | | 206 | Document contains unbalanced elements. | | 207 | Invalid XPath. | | 208 | No such child. | | 209 | Top element does not match start of path. | | 210 | DOM tree unavailable (set BuildDOM to true and reparse). | | 302 | Cannot open file. | | 401 | Invalid XML would be generated. | | 402 | An invalid XML name has been specified. | ### HTTP Errors | | | | --- | --- | | 118 | Firewall error. The error description contains the detailed message. | | 143 | Busy executing current method. | | 151 | HTTP protocol error. The error message has the server response. | | 152 | No server specified in [URL](#url-property-rnifsender-class). | | 153 | Specified URLScheme is invalid. | | 155 | Range operation is not supported by server. | | 156 | Invalid cookie index (out of range). | | 301 | Interrupted. | | 302 | Cannot open AttachedFile. | ### TCPClient Errors | | | | --- | --- | | 100 | You cannot change the RemotePort at this time. A connection is in progress. | | 101 | You cannot change the RemoteHost (Server) at this time. A connection is in progress. | | 102 | The RemoteHost address is invalid (0.0.0.0). | | 104 | Already connected. If you want to reconnect, close the current connection first. | | 106 | You cannot change the LocalPort at this time. A connection is in progress. | | 107 | You cannot change the [LocalHost](#localhost-property-rnifsender-class) at this time. A connection is in progress. | | 112 | You cannot change [MaxLineLength](#MaxLineLength) at this time. A connection is in progress. | | 116 | RemotePort cannot be zero. Please specify a valid service port number. | | 117 | You cannot change the UseConnection option while the class is active. | | 135 | Operation would block. | | 201 | Timeout. | | 211 | Action impossible in control's present state. | | 212 | Action impossible while not connected. | | 213 | Action impossible while listening. | | 301 | Timeout. | | 303 | Could not open file. | | 434 | Unable to convert string to selected CodePage. | | 1105 | Already connecting. If you want to reconnect, close the current connection first. | | 1117 | You need to connect first. | | 1119 | You cannot change the LocalHost at this time. A connection is in progress. | | 1120 | Connection dropped by remote host. | ### TCP/IP Errors | | | | --- | --- | | 10004 | [10004] Interrupted system call. | | 10009 | [10009] Bad file number. | | 10013 | [10013] Access denied. | | 10014 | [10014] Bad address. | | 10022 | [10022] Invalid argument. | | 10024 | [10024] Too many open files. | | 10035 | [10035] Operation would block. | | 10036 | [10036] Operation now in progress. | | 10037 | [10037] Operation already in progress. | | 10038 | [10038] Socket operation on nonsocket. | | 10039 | [10039] Destination address required. | | 10040 | [10040] Message is too long. | | 10041 | [10041] Protocol wrong type for socket. | | 10042 | [10042] Bad protocol option. | | 10043 | [10043] Protocol is not supported. | | 10044 | [10044] Socket type is not supported. | | 10045 | [10045] Operation is not supported on socket. | | 10046 | [10046] Protocol family is not supported. | | 10047 | [10047] Address family is not supported by protocol family. | | 10048 | [10048] Address already in use. | | 10049 | [10049] Cannot assign requested address. | | 10050 | [10050] Network is down. | | 10051 | [10051] Network is unreachable. | | 10052 | [10052] Net dropped connection or reset. | | 10053 | [10053] Software caused connection abort. | | 10054 | [10054] Connection reset by peer. | | 10055 | [10055] No buffer space available. | | 10056 | [10056] Socket is already connected. | | 10057 | [10057] Socket is not connected. | | 10058 | [10058] Cannot send after socket shutdown. | | 10059 | [10059] Too many references, cannot splice. | | 10060 | [10060] Connection timed out. | | 10061 | [10061] Connection refused. | | 10062 | [10062] Too many levels of symbolic links. | | 10063 | [10063] File name is too long. | | 10064 | [10064] Host is down. | | 10065 | [10065] No route to host. | | 10066 | [10066] Directory is not empty | | 10067 | [10067] Too many processes. | | 10068 | [10068] Too many users. | | 10069 | [10069] Disc Quota Exceeded. | | 10070 | [10070] Stale NFS file handle. | | 10071 | [10071] Too many levels of remote in path. | | 10091 | [10091] Network subsystem is unavailable. | | 10092 | [10092] WINSOCK DLL Version out of range. | | 10093 | [10093] Winsock is not loaded yet. | | 11001 | [11001] Host not found. | | 11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). | | 11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. | | 11004 | [11004] Valid name, no data record (check DNS setup). |