AS2Receiver Class

Properties   Methods   Events   Config Settings   Errors  

The AS2Receiver class is used to process EDI messages and generate receipts.

Syntax

AS2Receiver

Remarks

The AS2Receiver implements server-side processing of EDI messages, as specified in [AS2] and RFC 3335. It can be used to decrypt and verify incoming messages and to generate receipts including Message Disposition Notifications (MDNs). The class is designed to be easily incorporated into an HTTP server, and features custom functionality for server environments such as ASP.NET.

BASIC OPERATION

When an AS2 request comes in, you should first invoke ReadRequest. This will populate AS2From and AS2To, and based on this information, you may then set the appropriate certificates. You may specify your certificate with the Certificate property, and your trading partner's (signing) certificate with the SignerCert property.

Then, invoke ProcessRequest to process the request and generate the MDN receipt as specified in [AS2] and RFC 3335. If the request was processed successfully, EDIData will contain the transmitted EDI data. If a problem occurred, EDIData will not be populated and an exception will be thrown. In either case MDNReceipt will contain the RFC-compliant receipt, which should be returned to the client.

The MDNReceipt may be returned by invoking SendResponse. The receipt will be returned either synchronously in the HTTP reply, or asynchronously over a separate HTTP, HTTPS, or SMTP connection, as requested by the client.

To create log files, set LogDirectory prior to invoking ProcessRequest. This will log all incoming and outgoing data.

The following example illustrates how to use the class from an ASP.NET page. Note that in Java it will be necessary to provide an HTTPServletRequest as an argument to ReadRequest before processing the request.

EXAMPLE AS2Receiver1.ReadRequest(); // At this point, you should check the values of AS2From and AS2To. AS2Receiver1.Certificate = new Certificate(CertStoreTypes.cstPFXFile, "c:\\my_server_directory\\my_pfx_file.pfx", "my password", "CN=Me"); AS2Receiver1.SignerCert = new Certificate("c:\\my_server_directory\\my_partner_cer_file.cer"); AS2Receiver1.LogDirectory = "c:\\my_server_directory\\my_log_directory"; AS2Receiver1.ProcessRequest(); AS2Receiver1.SendResponse(); Additional functionality allows the user to examine details of the client's request, to permit certain types of errors, or to customize the outgoing MDN.

ADVANCED FUNCTIONALITY

Advanced functionality is provided to allow the user to break down the AS2 process, and to allow finer control over the operation of the server. Where ProcessRequest automates the entire process, additional methods are also provided to handle each step separately.

Parsing Incoming Data

To process an EDI message, invoke ReadRequest to process the headers from the server, or alternatively, manually set Request to the contents of the HTTP request. It may contain both headers and body, or the headers may be specified separately in RequestHeaders. This will provide more information about the client's request, without attempting to read the underlying EDI data.

After invoking ReadRequest, the AS2From, AS2To, and MessageId properties will contain the appropriate values. MDNTo will contain a nonempty string if an MDN is requested; RequestedSignatureProtocol, RequestedMICAlgorithms, and ReceiptDeliveryOption provide more information about the client's request. Finally, RequestHeaders contains the complete list of HTTP/AS2 headers.

Next, invoke ParseRequest. The certificate used to decrypt and sign should be specified with the Certificate property, and your partner's signing certificate should be specified with SignerCert. This will process the headers, decompress and/or decrypt the message (if applicable), and verify the signature (if present). EncryptionType, SignatureType, and CompressionFormat describe whether and how the data was encrypted, signed, and compressed, respectively.

ParseRequest will populate EDIEDIType and EDIData.

Error Handling

If any errors occur an exception will be thrown and EDIData will not be populated. Information about the exception will be provided through the exception's error code and message and also through ScanResult. An MDN receipt reporting the error may still be generated; it is recommended that server software trap the error and invoke CreateMDNReceipt to report the error to the client.

The ErrorProcessingFlags property may be configured to allow predetermined types of errors. If ErrorProcessingFlags is set when ParseRequest (or ProcessRequest) is invoked, the errors specified will be allowed, an exception will not be thrown, and EDIData will still be determined. However, ScanResult will still report the error, as will the receipt generated by CreateMDNReceipt. To avoid reporting the errors in the receipt, set the ErrorReportingFlags property.

Creating an MDN-based Receipt

An MDN-based receipt may be created by invoking CreateMDNReceipt. Regardless of the success or failure of ProcessRequest, the receipt may be created as specified in RFCs 3335 and 2298. If no errors occurred when ProcessRequest was invoked, the receipt will report success and will be suitable for non-repudiation of receipt (NRR) if signed. If errors occurred, the MDN will report that an error occurred and that the EDI data was not processed. It is strongly recommended that server software trap any errors thrown by ProcessRequest and return the receipt in this case as well.

The MDNReceipt will consist of the MDN itself, a human-readable message, MIME headers and footers, and a signature if applicable. The receipt may be generated by invoking CreateMDNReceipt and customized further by setting the parameters to CreateMDNReceipt.

The Message parameter to CreateMDNReceipt may be used to customize the human-readable message in the receipt. If it is set to an empty string, an appropriate message will automatically be written whenever MDNReceipt is regenerated.

The receipt will be signed using the protocol specified by ReceiptSigningProtocol, if any. The certificate used to sign the receipt is specified by Certificate. By default the receipt will be signed if explicitly requested by the client, and unsigned otherwise.

Error reporting may be controlled by configuring ErrorReportingFlags. By default, any errors will cause MDNReceipt to report a failure to process the message (either "failed/Failure" or "processed/Error" will be reported, according to the specification and the type of error). Setting ErrorReportingFlags will cause the MDNReceipt to overlook the chosen types of errors. If all errors are overlooked, the MDNReceipt will report success and calculate a MIC on the original message as usual. A warning may be reported by setting the MDNWarning configuration setting.

Additional Server-Side Functionality

When used in a server environment such as ASP.NET, the class may be used to interface directly with the underlying HTTP context. If Request is not set by the user, ParseRequest and ProcessRequest will first get the request from the underlying HTTP environment, if possible. SendResponse will send the reply in this environment if able; otherwise the reply will be directed to standard out.

ASP.NET Core Notes

The class may be used within any .NET Standard compatible platform, including .NET Core and ASP.NET Core. When using AS2Receiver within an ASP.NET Core MVC application the class can be configured to automatically read from the request context, and send using the response context. To do so pass the HttpContext to the constructor of the AS2Receiver class. For instance:

//Inside HomeController.cs As2receiver as2 = new As2receiver(HttpContext);

Property List

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

Method List

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

Event List

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

Config Settings

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

AS2From Property (AS2Receiver Class)

The AS2 Identifier of the sending system.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAS2From();

Unicode (Windows)
LPWSTR GetAS2From();

char* ipworksedi_as2receiver_getas2from(void* lpObj);

QString GetAS2From();

Default Value

""

Remarks

May be company name, DUNS number, or anything agreed on by trading partners.

This property is read-only.

Data Type

String

AS2To Property (AS2Receiver Class)

The AS2 Identifier of the receiving system.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAS2To();

Unicode (Windows)
LPWSTR GetAS2To();

char* ipworksedi_as2receiver_getas2to(void* lpObj);

QString GetAS2To();

Default Value

""

Remarks

May be company name, DUNS number, or anything agreed on by trading partners.

This property is read-only.

Data Type

String

AttachmentCount Property (AS2Receiver Class)

The number of records in the Attachment arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAttachmentCount();

Unicode (Windows)
INT GetAttachmentCount();

int ipworksedi_as2receiver_getattachmentcount(void* lpObj);

int GetAttachmentCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• AttachmentContentType
• AttachmentData
• AttachmentFilename
• AttachmentHeaders
• AttachmentName

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

This property is read-only and not available at design time.

Data Type

Integer

AttachmentContentType Property (AS2Receiver Class)

The MIME content-type of this ediattachment .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttachmentContentType(int iAttachmentIndex);

Unicode (Windows)
LPWSTR GetAttachmentContentType(INT iAttachmentIndex);

char* ipworksedi_as2receiver_getattachmentcontenttype(void* lpObj, int attachmentindex);

QString GetAttachmentContentType(int iAttachmentIndex);

Default Value

""

Remarks

The MIME content-type of this EDIAttachment.

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

This property is read-only and not available at design time.

Data Type

String

AttachmentData Property (AS2Receiver Class)

This property contains the attachment data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAttachmentData(int iAttachmentIndex, char* &lpAttachmentData, int &lenAttachmentData);

Unicode (Windows)
INT GetAttachmentData(INT iAttachmentIndex, LPSTR &lpAttachmentData, INT &lenAttachmentData);

int ipworksedi_as2receiver_getattachmentdata(void* lpObj, int attachmentindex, char** lpAttachmentData, int* lenAttachmentData);

QByteArray GetAttachmentData(int iAttachmentIndex);

Default Value

""

Remarks

This property contains the attachment data.

In a receiver, the class decodes the attachment to the AttachmentData property when AttachmentData's value is first queried. This property will contain the full decrypted text of the attachment.

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

This property is read-only and not available at design time.

Data Type

Binary String

AttachmentFilename Property (AS2Receiver Class)

The file name of the attachment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttachmentFilename(int iAttachmentIndex);

Unicode (Windows)
LPWSTR GetAttachmentFilename(INT iAttachmentIndex);

char* ipworksedi_as2receiver_getattachmentfilename(void* lpObj, int attachmentindex);

QString GetAttachmentFilename(int iAttachmentIndex);

Default Value

""

Remarks

The file name of the attachment. If IncomingDirectory has been specified, the attachment will be written to the specified directory and the name will be provided by this property. Otherwise, this will contain the name of the attachment as described in the AttachmentHeaders.

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

This property is read-only and not available at design time.

Data Type

String

AttachmentHeaders Property (AS2Receiver Class)

The class fills out Headers each time any of the other properties for that ediattachment are changed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttachmentHeaders(int iAttachmentIndex);

Unicode (Windows)
LPWSTR GetAttachmentHeaders(INT iAttachmentIndex);

char* ipworksedi_as2receiver_getattachmentheaders(void* lpObj, int attachmentindex);

QString GetAttachmentHeaders(int iAttachmentIndex);

Default Value

""

Remarks

The class fills out AttachmentHeaders each time any of the other properties for that EDIAttachment are changed. If additional headers are needed they should be appended after all the other propertys for that EDIAttachment are set.

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

This property is read-only and not available at design time.

Data Type

String

AttachmentName Property (AS2Receiver Class)

Name is the final name to be associated with the contents of either the Data or Filename properties.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttachmentName(int iAttachmentIndex);

Unicode (Windows)
LPWSTR GetAttachmentName(INT iAttachmentIndex);

char* ipworksedi_as2receiver_getattachmentname(void* lpObj, int attachmentindex);

QString GetAttachmentName(int iAttachmentIndex);

Default Value

""

Remarks

AttachmentName is the final name to be associated with the contents of either the AttachmentData or AttachmentFilename properties. This corresponds to the filename attribute of the Content-Disposition header for this attachment.

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

This property is read-only and not available at design time.

Data Type

String

CEMCount Property (AS2Receiver Class)

The number of records in the CEM arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCEMCount();
int SetCEMCount(int iCEMCount);

Unicode (Windows)
INT GetCEMCount();
INT SetCEMCount(INT iCEMCount);

int ipworksedi_as2receiver_getcemcount(void* lpObj);
int ipworksedi_as2receiver_setcemcount(void* lpObj, int iCEMCount);

int GetCEMCount();
int SetCEMCount(int iCEMCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• CEMAccepted
• CEMCertId
• CEMCertIssuer
• CEMCertSerialNumber
• CEMCertStore
• CEMCertStorePassword
• CEMCertStoreType
• CEMCertSubject
• CEMCertUsage
• CEMRejectionReason
• CEMRespondByDate
• CEMResponseURL

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

This property is not available at design time.

Data Type

Integer

CEMAccepted Property (AS2Receiver Class)

Whether the CEM request is accepted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCEMAccepted(int iCEMIndex);
int SetCEMAccepted(int iCEMIndex, int bCEMAccepted);

Unicode (Windows)
BOOL GetCEMAccepted(INT iCEMIndex);
INT SetCEMAccepted(INT iCEMIndex, BOOL bCEMAccepted);

int ipworksedi_as2receiver_getcemaccepted(void* lpObj, int cemindex);
int ipworksedi_as2receiver_setcemaccepted(void* lpObj, int cemindex, int bCEMAccepted);

bool GetCEMAccepted(int iCEMIndex);
int SetCEMAccepted(int iCEMIndex, bool bCEMAccepted);

Default Value

FALSE

Remarks

Whether the CEM request is accepted.

Before calling SendCEMResponse set this to True to accept the CEM request.

When processing a CEM response check this property to determine if the request was accepted.

The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.

This property is not available at design time.

Data Type

Boolean

CEMCertId Property (AS2Receiver Class)

A user defined identifier for the certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCEMCertId(int iCEMIndex);
int SetCEMCertId(int iCEMIndex, const char* lpszCEMCertId);

Unicode (Windows)
LPWSTR GetCEMCertId(INT iCEMIndex);
INT SetCEMCertId(INT iCEMIndex, LPCWSTR lpszCEMCertId);

char* ipworksedi_as2receiver_getcemcertid(void* lpObj, int cemindex);
int ipworksedi_as2receiver_setcemcertid(void* lpObj, int cemindex, const char* lpszCEMCertId);

QString GetCEMCertId(int iCEMIndex);
int SetCEMCertId(int iCEMIndex, QString qsCEMCertId);

Default Value

""

Remarks

A user defined identifier for the certificate.

This property defines a user specified identifier for the certificate. This may be set to a value which helps the recipient identify the certificate. For instance "CompanyA.Encryption.Cert.2014".

This property may be set before calling SendCEMRequest or SendCEMResponse from AS2Sender.

This property may be queried when received a CEM request or response with AS2Receiver.

The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.

This property is not available at design time.

Data Type

String

CEMCertIssuer Property (AS2Receiver Class)

This property holds the issuer of the certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCEMCertIssuer(int iCEMIndex);
int SetCEMCertIssuer(int iCEMIndex, const char* lpszCEMCertIssuer);

Unicode (Windows)
LPWSTR GetCEMCertIssuer(INT iCEMIndex);
INT SetCEMCertIssuer(INT iCEMIndex, LPCWSTR lpszCEMCertIssuer);

char* ipworksedi_as2receiver_getcemcertissuer(void* lpObj, int cemindex);
int ipworksedi_as2receiver_setcemcertissuer(void* lpObj, int cemindex, const char* lpszCEMCertIssuer);

QString GetCEMCertIssuer(int iCEMIndex);
int SetCEMCertIssuer(int iCEMIndex, QString qsCEMCertIssuer);

Default Value

""

Remarks

This property holds the issuer of the certificate. This may be queried when receiving a CEM request with AS2Receiver. This may be set before calling SendCEMResponse with AS2Sender.

The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.

This property is not available at design time.

Data Type

String

CEMCertSerialNumber Property (AS2Receiver Class)

This property holds the serial number of the certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCEMCertSerialNumber(int iCEMIndex);
int SetCEMCertSerialNumber(int iCEMIndex, const char* lpszCEMCertSerialNumber);

Unicode (Windows)
LPWSTR GetCEMCertSerialNumber(INT iCEMIndex);
INT SetCEMCertSerialNumber(INT iCEMIndex, LPCWSTR lpszCEMCertSerialNumber);

char* ipworksedi_as2receiver_getcemcertserialnumber(void* lpObj, int cemindex);
int ipworksedi_as2receiver_setcemcertserialnumber(void* lpObj, int cemindex, const char* lpszCEMCertSerialNumber);

QString GetCEMCertSerialNumber(int iCEMIndex);
int SetCEMCertSerialNumber(int iCEMIndex, QString qsCEMCertSerialNumber);

Default Value

""

Remarks

This property holds the serial number of the certificate. This may be queried when receiving a CEM request with AS2Receiver. This may be set before calling SendCEMResponse with AS2Sender.

The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.

This property is not available at design time.

Data Type

String

CEMCertStore Property (AS2Receiver Class)

The name of the certificate store for the certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCEMCertStore(int iCEMIndex, char* &lpCEMCertStore, int &lenCEMCertStore);
int SetCEMCertStore(int iCEMIndex, const char* lpCEMCertStore, int lenCEMCertStore);

Unicode (Windows)
INT GetCEMCertStore(INT iCEMIndex, LPSTR &lpCEMCertStore, INT &lenCEMCertStore);
INT SetCEMCertStore(INT iCEMIndex, LPCSTR lpCEMCertStore, INT lenCEMCertStore);

int ipworksedi_as2receiver_getcemcertstore(void* lpObj, int cemindex, char** lpCEMCertStore, int* lenCEMCertStore);
int ipworksedi_as2receiver_setcemcertstore(void* lpObj, int cemindex, const char* lpCEMCertStore, int lenCEMCertStore);

QByteArray GetCEMCertStore(int iCEMIndex);
int SetCEMCertStore(int iCEMIndex, QByteArray qbaCEMCertStore);

Default Value

"MY"

Remarks

The name of the certificate store for the certificate.

This property defines the store location for the type specified by CEMCertStoreType.

Designations of certificate stores are platform dependent.

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

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

The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.

This property is not available at design time.

Data Type

Binary String

CEMCertStorePassword Property (AS2Receiver Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCEMCertStorePassword(int iCEMIndex);
int SetCEMCertStorePassword(int iCEMIndex, const char* lpszCEMCertStorePassword);

Unicode (Windows)
LPWSTR GetCEMCertStorePassword(INT iCEMIndex);
INT SetCEMCertStorePassword(INT iCEMIndex, LPCWSTR lpszCEMCertStorePassword);

char* ipworksedi_as2receiver_getcemcertstorepassword(void* lpObj, int cemindex);
int ipworksedi_as2receiver_setcemcertstorepassword(void* lpObj, int cemindex, const char* lpszCEMCertStorePassword);

QString GetCEMCertStorePassword(int iCEMIndex);
int SetCEMCertStorePassword(int iCEMIndex, QString qsCEMCertStorePassword);

Default Value

""

Remarks

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

The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.

This property is not available at design time.

Data Type

String

CEMCertStoreType Property (AS2Receiver Class)

The type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCEMCertStoreType(int iCEMIndex);
int SetCEMCertStoreType(int iCEMIndex, int iCEMCertStoreType);

Unicode (Windows)
INT GetCEMCertStoreType(INT iCEMIndex);
INT SetCEMCertStoreType(INT iCEMIndex, INT iCEMCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int ipworksedi_as2receiver_getcemcertstoretype(void* lpObj, int cemindex);
int ipworksedi_as2receiver_setcemcertstoretype(void* lpObj, int cemindex, int iCEMCertStoreType);

int GetCEMCertStoreType(int iCEMIndex);
int SetCEMCertStoreType(int iCEMIndex, int iCEMCertStoreType);

Default Value

0

Remarks

The type of certificate store for this certificate.

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

The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.

This property is not available at design time.

Data Type

Integer

CEMCertSubject Property (AS2Receiver Class)

The subject of the certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCEMCertSubject(int iCEMIndex);
int SetCEMCertSubject(int iCEMIndex, const char* lpszCEMCertSubject);

Unicode (Windows)
LPWSTR GetCEMCertSubject(INT iCEMIndex);
INT SetCEMCertSubject(INT iCEMIndex, LPCWSTR lpszCEMCertSubject);

char* ipworksedi_as2receiver_getcemcertsubject(void* lpObj, int cemindex);
int ipworksedi_as2receiver_setcemcertsubject(void* lpObj, int cemindex, const char* lpszCEMCertSubject);

QString GetCEMCertSubject(int iCEMIndex);
int SetCEMCertSubject(int iCEMIndex, QString qsCEMCertSubject);

Default Value

""

Remarks

The subject of the certificate.

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

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

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

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

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

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

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

The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.

This property is not available at design time.

Data Type

String

CEMCertUsage Property (AS2Receiver Class)

This property defines which usages are applicable to the certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCEMCertUsage(int iCEMIndex);
int SetCEMCertUsage(int iCEMIndex, int iCEMCertUsage);

Unicode (Windows)
INT GetCEMCertUsage(INT iCEMIndex);
INT SetCEMCertUsage(INT iCEMIndex, INT iCEMCertUsage);

int ipworksedi_as2receiver_getcemcertusage(void* lpObj, int cemindex);
int ipworksedi_as2receiver_setcemcertusage(void* lpObj, int cemindex, int iCEMCertUsage);

int GetCEMCertUsage(int iCEMIndex);
int SetCEMCertUsage(int iCEMIndex, int iCEMCertUsage);

Default Value

15

Remarks

This property defines which usages are applicable to the certificate. This may be set to a binary 'OR' of one or more of the following values:

• 1 (TLS Client)
• 2 (TLS Server)
• 4 (Encryption)
• 8 (Signature)

The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.

This property is not available at design time.

Data Type

Integer

CEMRejectionReason Property (AS2Receiver Class)

If Accepted is False this property specifies the reason a request was rejected.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCEMRejectionReason(int iCEMIndex);
int SetCEMRejectionReason(int iCEMIndex, const char* lpszCEMRejectionReason);

Unicode (Windows)
LPWSTR GetCEMRejectionReason(INT iCEMIndex);
INT SetCEMRejectionReason(INT iCEMIndex, LPCWSTR lpszCEMRejectionReason);

char* ipworksedi_as2receiver_getcemrejectionreason(void* lpObj, int cemindex);
int ipworksedi_as2receiver_setcemrejectionreason(void* lpObj, int cemindex, const char* lpszCEMRejectionReason);

QString GetCEMRejectionReason(int iCEMIndex);
int SetCEMRejectionReason(int iCEMIndex, QString qsCEMRejectionReason);

Default Value

""

Remarks

If CEMAccepted is False this property specifies the reason a request was rejected.

When using AS2Sender this may be set to a string value which the recipient will see.

When using AS2Receiver query this property for details on why the request was rejected.

The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.

This property is not available at design time.

Data Type

String

CEMRespondByDate Property (AS2Receiver Class)

This property specifies the date by which the other party should respond.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCEMRespondByDate(int iCEMIndex);
int SetCEMRespondByDate(int iCEMIndex, const char* lpszCEMRespondByDate);

Unicode (Windows)
LPWSTR GetCEMRespondByDate(INT iCEMIndex);
INT SetCEMRespondByDate(INT iCEMIndex, LPCWSTR lpszCEMRespondByDate);

char* ipworksedi_as2receiver_getcemrespondbydate(void* lpObj, int cemindex);
int ipworksedi_as2receiver_setcemrespondbydate(void* lpObj, int cemindex, const char* lpszCEMRespondByDate);

QString GetCEMRespondByDate(int iCEMIndex);
int SetCEMRespondByDate(int iCEMIndex, QString qsCEMRespondByDate);

Default Value

""

Remarks

This property specifies the date by which the other party should respond. If the other party does not respond the new certificate may be used without any further notice. This property exists to assist the recipient in knowing when they should respond by. It does not guarantee a response by the specified date.

The format is of the XML standard dateTime type expressed in local time with UTC offset. For instance: "2005-08-31T00:21:00-05:00".

When using AS2Sender set this before calling SendCEMRequest.

When using AS2Receiver this property may be queried.

The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.

This property is not available at design time.

Data Type

String

CEMResponseURL Property (AS2Receiver Class)

This property defines the URL to which the response should be sent.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCEMResponseURL(int iCEMIndex);
int SetCEMResponseURL(int iCEMIndex, const char* lpszCEMResponseURL);

Unicode (Windows)
LPWSTR GetCEMResponseURL(INT iCEMIndex);
INT SetCEMResponseURL(INT iCEMIndex, LPCWSTR lpszCEMResponseURL);

char* ipworksedi_as2receiver_getcemresponseurl(void* lpObj, int cemindex);
int ipworksedi_as2receiver_setcemresponseurl(void* lpObj, int cemindex, const char* lpszCEMResponseURL);

QString GetCEMResponseURL(int iCEMIndex);
int SetCEMResponseURL(int iCEMIndex, QString qsCEMResponseURL);

Default Value

""

Remarks

This property defines the URL to which the response should be sent.

When using AS2Sender set this property before calling SendCEMRequest. This tells the recipient where to send the response.

When using AS2Receiver query this property to determine the URL where the response should be sent.

The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.

This property is not available at design time.

Data Type

String

CertEncoded Property (AS2Receiver Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertEncoded(char* &lpCertEncoded, int &lenCertEncoded);
int SetCertEncoded(const char* lpCertEncoded, int lenCertEncoded);

Unicode (Windows)
INT GetCertEncoded(LPSTR &lpCertEncoded, INT &lenCertEncoded);
INT SetCertEncoded(LPCSTR lpCertEncoded, INT lenCertEncoded);

int ipworksedi_as2receiver_getcertencoded(void* lpObj, char** lpCertEncoded, int* lenCertEncoded);
int ipworksedi_as2receiver_setcertencoded(void* lpObj, const char* lpCertEncoded, int lenCertEncoded);

QByteArray GetCertEncoded();
int SetCertEncoded(QByteArray qbaCertEncoded);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

CertStore Property (AS2Receiver Class)

This is the name of the certificate store for the client certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertStore(char* &lpCertStore, int &lenCertStore);
int SetCertStore(const char* lpCertStore, int lenCertStore);

Unicode (Windows)
INT GetCertStore(LPSTR &lpCertStore, INT &lenCertStore);
INT SetCertStore(LPCSTR lpCertStore, INT lenCertStore);

int ipworksedi_as2receiver_getcertstore(void* lpObj, char** lpCertStore, int* lenCertStore);
int ipworksedi_as2receiver_setcertstore(void* lpObj, const char* lpCertStore, int lenCertStore);

QByteArray GetCertStore();
int SetCertStore(QByteArray qbaCertStore);

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Binary String

CertStorePassword Property (AS2Receiver Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertStorePassword();
int SetCertStorePassword(const char* lpszCertStorePassword);

Unicode (Windows)
LPWSTR GetCertStorePassword();
INT SetCertStorePassword(LPCWSTR lpszCertStorePassword);

char* ipworksedi_as2receiver_getcertstorepassword(void* lpObj);
int ipworksedi_as2receiver_setcertstorepassword(void* lpObj, const char* lpszCertStorePassword);

QString GetCertStorePassword();
int SetCertStorePassword(QString qsCertStorePassword);

Default Value

""

Remarks

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

Data Type

String

CertStoreType Property (AS2Receiver Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertStoreType();
int SetCertStoreType(int iCertStoreType);

Unicode (Windows)
INT GetCertStoreType();
INT SetCertStoreType(INT iCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int ipworksedi_as2receiver_getcertstoretype(void* lpObj);
int ipworksedi_as2receiver_setcertstoretype(void* lpObj, int iCertStoreType);

int GetCertStoreType();
int SetCertStoreType(int iCertStoreType);

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

CertSubject Property (AS2Receiver Class)

This is the subject of the certificate used for client authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertSubject();
int SetCertSubject(const char* lpszCertSubject);

Unicode (Windows)
LPWSTR GetCertSubject();
INT SetCertSubject(LPCWSTR lpszCertSubject);

char* ipworksedi_as2receiver_getcertsubject(void* lpObj);
int ipworksedi_as2receiver_setcertsubject(void* lpObj, const char* lpszCertSubject);

QString GetCertSubject();
int SetCertSubject(QString qsCertSubject);

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

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

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

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

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

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

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

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

Data Type

String

CompressionFormat Property (AS2Receiver Class)

The compression format used on the incoming message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCompressionFormat();

Unicode (Windows)
INT GetCompressionFormat();

CF_NONE(0), 
CF_ZLIB(1)

int ipworksedi_as2receiver_getcompressionformat(void* lpObj);

int GetCompressionFormat();

Default Value

0

Remarks

The compression format used on the incoming message, if any. Compressed messages will automatically be decompressed by the class.

This property is read-only.

Data Type

Integer

EDIData Property (AS2Receiver Class)

This property contains the EDI payload of the transmission.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEDIData(char* &lpEDIData, int &lenEDIData);

Unicode (Windows)
INT GetEDIData(LPSTR &lpEDIData, INT &lenEDIData);

int ipworksedi_as2receiver_getedidata(void* lpObj, char** lpEDIData, int* lenEDIData);

QByteArray GetEDIData();

Default Value

""

Remarks

This property contains the EDI payload of the transmission.

In a receiver, this property will only be populated if IncomingDirectory and EDIOutputStream have not been specified and ParseRequest finishes without an error, setting ScanResult to 0. If so, Data will contain the full decrypted text of the EDI message.

This property will only be populated if ParseRequest or ProcessRequest finishes without an error, setting ScanResult to 0. If so, EDIData will contain the processed EDI message.

This property is read-only.

Data Type

Binary String

EDIType Property (AS2Receiver Class)

The Content-Type of the EDI message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEDIType();

Unicode (Windows)
LPWSTR GetEDIType();

char* ipworksedi_as2receiver_geteditype(void* lpObj);

QString GetEDIType();

Default Value

""

Remarks

The Content-Type of the EDI message. Sample values might be "application/edi-x12", "application/edifact" or "application/xml".

This property is read-only.

Data Type

String

EDIFilename Property (AS2Receiver Class)

In a sender, if Filename is specified, the file specified will be used for the EDI payload of the transmission.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEDIFilename();

Unicode (Windows)
LPWSTR GetEDIFilename();

char* ipworksedi_as2receiver_getedifilename(void* lpObj);

QString GetEDIFilename();

Default Value

""

Remarks

In a sender, if EDIFilename is specified, the file specified will be used for the EDI payload of the transmission. EDIName will be populated with the name of the file.

In a receiver, when IncomingDirectory is set, this will be populated with the absolute path of the file which contains the processed message contents.

Note: When EDIOutputStream is set, the data will be written to the stream and this property will not be populated.

This property is read-only.

Data Type

String

EDIName Property (AS2Receiver Class)

Name is the final name to be associated with the contents of either the Data or FileName properties.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEDIName();

Unicode (Windows)
LPWSTR GetEDIName();

char* ipworksedi_as2receiver_getediname(void* lpObj);

QString GetEDIName();

Default Value

"rfc1767.edi"

Remarks

EDIName is the final name to be associated with the contents of either the EDIData or EDIFileName properties. This corresponds to the filename attribute of the Content-Disposition header for the EDI payload.

When constructing EDI data to be sent, EDIName will be set to the same value as EDIFileName, but can be overridden after setting EDIFileName to indicate that another name should be used in the outbound request's Content-Disposition MIME header.

When receiving EDI data, EDIName will be read out of the "filename" attribute of the inbound request's Content-Disposition MIME header.

This property is read-only.

Data Type

String

FirewallAutoDetect Property (AS2Receiver Class)

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallAutoDetect();
int SetFirewallAutoDetect(int bFirewallAutoDetect);

Unicode (Windows)
BOOL GetFirewallAutoDetect();
INT SetFirewallAutoDetect(BOOL bFirewallAutoDetect);

int ipworksedi_as2receiver_getfirewallautodetect(void* lpObj);
int ipworksedi_as2receiver_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect);

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (AS2Receiver Class)

This property determines the type of firewall to connect through.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallType();
int SetFirewallType(int iFirewallType);

Unicode (Windows)
INT GetFirewallType();
INT SetFirewallType(INT iFirewallType);

FW_NONE(0), 
FW_TUNNEL(1), 
FW_SOCKS4(2), 
FW_SOCKS5(3), 
FW_SOCKS4A(10)

int ipworksedi_as2receiver_getfirewalltype(void* lpObj);
int ipworksedi_as2receiver_setfirewalltype(void* lpObj, int iFirewallType);

int GetFirewallType();
int SetFirewallType(int iFirewallType);

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (AS2Receiver Class)

This property contains the name or IP address of firewall (optional).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallHost();
int SetFirewallHost(const char* lpszFirewallHost);

Unicode (Windows)
LPWSTR GetFirewallHost();
INT SetFirewallHost(LPCWSTR lpszFirewallHost);

char* ipworksedi_as2receiver_getfirewallhost(void* lpObj);
int ipworksedi_as2receiver_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost);

Default Value

""

Remarks

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

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

Data Type

String

FirewallPassword Property (AS2Receiver Class)

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallPassword();
int SetFirewallPassword(const char* lpszFirewallPassword);

Unicode (Windows)
LPWSTR GetFirewallPassword();
INT SetFirewallPassword(LPCWSTR lpszFirewallPassword);

char* ipworksedi_as2receiver_getfirewallpassword(void* lpObj);
int ipworksedi_as2receiver_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword);

Default Value

""

Remarks

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

Data Type

String

FirewallPort Property (AS2Receiver Class)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Unicode (Windows)
INT GetFirewallPort();
INT SetFirewallPort(INT iFirewallPort);

int ipworksedi_as2receiver_getfirewallport(void* lpObj);
int ipworksedi_as2receiver_setfirewallport(void* lpObj, int iFirewallPort);

int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

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

Data Type

Integer

FirewallUser Property (AS2Receiver Class)

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallUser();
int SetFirewallUser(const char* lpszFirewallUser);

Unicode (Windows)
LPWSTR GetFirewallUser();
INT SetFirewallUser(LPCWSTR lpszFirewallUser);

char* ipworksedi_as2receiver_getfirewalluser(void* lpObj);
int ipworksedi_as2receiver_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

IncomingDirectory Property (AS2Receiver Class)

The directory to be used to store incoming messages.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetIncomingDirectory();
int SetIncomingDirectory(const char* lpszIncomingDirectory);

Unicode (Windows)
LPWSTR GetIncomingDirectory();
INT SetIncomingDirectory(LPCWSTR lpszIncomingDirectory);

char* ipworksedi_as2receiver_getincomingdirectory(void* lpObj);
int ipworksedi_as2receiver_setincomingdirectory(void* lpObj, const char* lpszIncomingDirectory);

QString GetIncomingDirectory();
int SetIncomingDirectory(QString qsIncomingDirectory);

Default Value

""

Remarks

If IncomingDirectory is set, the received message is stored as a file in that directory. If a filename is specified in the EDI message, the class will write to the specified filename, otherwise, a filename will be automatically generated based on a timestamp of the incoming transmission. In either case, if the filename exists on disk, the data will be written to the same name with a "-duplicate?" appended to the filename, where "?" is the number of duplicates.

Please note that the SetTPInfo method, if used, needs to be invoked before setting this property because it overrides the setting for incoming directory.

Data Type

String

LocalHost Property (AS2Receiver Class)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost);

Unicode (Windows)
LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);

char* ipworksedi_as2receiver_getlocalhost(void* lpObj);
int ipworksedi_as2receiver_setlocalhost(void* lpObj, const char* lpszLocalHost);

QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);

Default Value

""

Remarks

The LocalHost 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 multi-homed 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 classs) only through that interface.

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 multi-homed 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.

Data Type

String

LogDirectory Property (AS2Receiver Class)

The path to a directory for logging.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLogDirectory();
int SetLogDirectory(const char* lpszLogDirectory);

Unicode (Windows)
LPWSTR GetLogDirectory();
INT SetLogDirectory(LPCWSTR lpszLogDirectory);

char* ipworksedi_as2receiver_getlogdirectory(void* lpObj);
int ipworksedi_as2receiver_setlogdirectory(void* lpObj, const char* lpszLogDirectory);

QString GetLogDirectory();
int SetLogDirectory(QString qsLogDirectory);

Default Value

""

Remarks

Setting LogDirectory will instruct the component to log the details of each transmission to unique files in the specified directory. For each request processed, the class will log the complete text of the outgoing request and the incoming response.

The class will write multiple log file for each transmission, with separate extensions for each type of data:

One or more of these logs may be disabled by setting the LogOptions configuration setting.

LogDirectory supports several macros that can be used to specify a unique directory path. If the path specified does not already exist, the class will attempt to create the directory. The following macros are supported:

The filenames will be chosen automatically by the class. Each filename will be the system time, in the format YYYY-MM-DD-HH-MM-SS-MMMM, with extensions "-2", "-3", used in case files of those names already exist. After each transaction is processed LogFile will contain the name of the files just written, minus the extension.

If logs cannot be written an exception will be thrown.

Data Type

String

LogFile Property (AS2Receiver Class)

The log file written.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLogFile();

Unicode (Windows)
LPWSTR GetLogFile();

char* ipworksedi_as2receiver_getlogfile(void* lpObj);

QString GetLogFile();

Default Value

""

Remarks

In case LogDirectory is specified a log file will be written in the specified directory and LogFile will contain the full path and name of the files just written, minus the extension.

The class will write multiple log files for each transmission, with separate extensions for each type of data:

This property is read-only.

Data Type

String

MDNReceiptContent Property (AS2Receiver Class)

This contains the entire content of the MDN Receipt.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMDNReceiptContent(char* &lpMDNReceiptContent, int &lenMDNReceiptContent);
int SetMDNReceiptContent(const char* lpMDNReceiptContent, int lenMDNReceiptContent);

Unicode (Windows)
INT GetMDNReceiptContent(LPSTR &lpMDNReceiptContent, INT &lenMDNReceiptContent);
INT SetMDNReceiptContent(LPCSTR lpMDNReceiptContent, INT lenMDNReceiptContent);

int ipworksedi_as2receiver_getmdnreceiptcontent(void* lpObj, char** lpMDNReceiptContent, int* lenMDNReceiptContent);
int ipworksedi_as2receiver_setmdnreceiptcontent(void* lpObj, const char* lpMDNReceiptContent, int lenMDNReceiptContent);

QByteArray GetMDNReceiptContent();
int SetMDNReceiptContent(QByteArray qbaMDNReceiptContent);

Default Value

""

Remarks

This contains the entire content of the MDN Receipt. This is a multipart/report entity consisting of a machine readable MDNReceiptMDN (Message Disposition Notification) and a human readable MDNReceiptMessage, which itself may be embedded in a multipart/signed entity if requested by the AS2 sender.

Data Type

Binary String

MDNReceiptHeaderCount Property (AS2Receiver Class)

The number of headers in the MDN.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMDNReceiptHeaderCount();

Unicode (Windows)
INT GetMDNReceiptHeaderCount();

int ipworksedi_as2receiver_getmdnreceiptheadercount(void* lpObj);

int GetMDNReceiptHeaderCount();

Default Value

0

Remarks

The number of headers in the MDN.

This property is read-only and not available at design time.

Data Type

Integer

MDNReceiptHeaderField Property (AS2Receiver Class)

The property name of the MDN header currently selected by HeaderIndex .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMDNReceiptHeaderField();

Unicode (Windows)
LPWSTR GetMDNReceiptHeaderField();

char* ipworksedi_as2receiver_getmdnreceiptheaderfield(void* lpObj);

QString GetMDNReceiptHeaderField();

Default Value

""

Remarks

The field name of the MDN header currently selected by MDNReceiptHeaderIndex.

This property is read-only and not available at design time.

Data Type

String

MDNReceiptHeaderIndex Property (AS2Receiver Class)

Which MDN header is currently selected to populate HeaderField and HeaderValue .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMDNReceiptHeaderIndex();
int SetMDNReceiptHeaderIndex(int iMDNReceiptHeaderIndex);

Unicode (Windows)
INT GetMDNReceiptHeaderIndex();
INT SetMDNReceiptHeaderIndex(INT iMDNReceiptHeaderIndex);

int ipworksedi_as2receiver_getmdnreceiptheaderindex(void* lpObj);
int ipworksedi_as2receiver_setmdnreceiptheaderindex(void* lpObj, int iMDNReceiptHeaderIndex);

int GetMDNReceiptHeaderIndex();
int SetMDNReceiptHeaderIndex(int iMDNReceiptHeaderIndex);

Default Value

0

Remarks

Which MDN header is currently selected to populate MDNReceiptHeaderField and MDNReceiptHeaderValue.

Valid values are 0 to MDNReceiptHeaderCount - 1.

This property is not available at design time.

Data Type

Integer

MDNReceiptHeaders Property (AS2Receiver Class)

Headers contains all of the headers of the AS2 MDN Receipt as a single string.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMDNReceiptHeaders();
int SetMDNReceiptHeaders(const char* lpszMDNReceiptHeaders);

Unicode (Windows)
LPWSTR GetMDNReceiptHeaders();
INT SetMDNReceiptHeaders(LPCWSTR lpszMDNReceiptHeaders);

char* ipworksedi_as2receiver_getmdnreceiptheaders(void* lpObj);
int ipworksedi_as2receiver_setmdnreceiptheaders(void* lpObj, const char* lpszMDNReceiptHeaders);

QString GetMDNReceiptHeaders();
int SetMDNReceiptHeaders(QString qsMDNReceiptHeaders);

Default Value

""

Remarks

Headers contains all of the headers of the AS2 MDN Receipt as a single string. This will include headers such as AS2-From, AS2-To, Date, Content-Type, etc. In an AS2Sender, these will also contain the transport headers of the MDN Receipt (HTTP or SMTP headers, depending on the delivery option).

You can also use MDNReceiptHeaderCount, MDNReceiptHeaderIndex, MDNReceiptHeaderField, and MDNReceiptHeaderValue to easily iterate through each individual header.

Data Type

String

MDNReceiptHeaderValue Property (AS2Receiver Class)

The value of the MDN header currently selected by HeaderIndex .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMDNReceiptHeaderValue();

Unicode (Windows)
LPWSTR GetMDNReceiptHeaderValue();

char* ipworksedi_as2receiver_getmdnreceiptheadervalue(void* lpObj);

QString GetMDNReceiptHeaderValue();

Default Value

""

Remarks

The value of the MDN header currently selected by MDNReceiptHeaderIndex.

This property is read-only and not available at design time.

Data Type

String

MDNReceiptMDN Property (AS2Receiver Class)

MDN will contain the entire machine readable text of the Message Disposition Notification in the receipt.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMDNReceiptMDN();

Unicode (Windows)
LPWSTR GetMDNReceiptMDN();

char* ipworksedi_as2receiver_getmdnreceiptmdn(void* lpObj);

QString GetMDNReceiptMDN();

Default Value

""

Remarks

MDN will contain the entire machine readable text of the Message Disposition Notification in the receipt. It will report either success or failure depending on the processing status of the receiver. In either case, it will be RFC-compliant.

This property is read-only.

Data Type

String

MDNReceiptMessage Property (AS2Receiver Class)

The human-readable portion of the MDN receipt.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMDNReceiptMessage();

Unicode (Windows)
LPWSTR GetMDNReceiptMessage();

char* ipworksedi_as2receiver_getmdnreceiptmessage(void* lpObj);

QString GetMDNReceiptMessage();

Default Value

""

Remarks

The human-readable portion of the MDN receipt.

The human-readable portion of the MDN receipt that indicates the status of the message processing. This can be used to provide the user with a helpful message in the event that an error is encountered.

This property is read-only.

Data Type

String

MDNReceiptMICValue Property (AS2Receiver Class)

The Message Integrity Check(s) (one-way hash) of the original EDI message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMDNReceiptMICValue();

Unicode (Windows)
LPWSTR GetMDNReceiptMICValue();

char* ipworksedi_as2receiver_getmdnreceiptmicvalue(void* lpObj);

QString GetMDNReceiptMICValue();

Default Value

""

Remarks

The Message Integrity Check(s) (one-way hash) of the original EDI message.

An MDN Receipt contains a MIC calculated over the EDI message that the receipt is in response to, to be matched on the sender side against a saved value for the original request to ensure that the integrity of the data that the receiver reports is preserved. When a signed receipt is requested, the MIC is be calculated using the algorithm used on the incoming message's signature, or SHA-1 if the incoming message is not signed.

The MIC will be base64 encoded and reported with the algorithm name as specified in RFC 3335; e.g., "w7AguNJEmhF/qIjJw6LnnA==, md5".

This property is read-only.

Data Type

String

MDNReceiptSigningProtocol Property (AS2Receiver Class)

This property contains the MIME type of the signature used, if any (i.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMDNReceiptSigningProtocol();

Unicode (Windows)
LPWSTR GetMDNReceiptSigningProtocol();

char* ipworksedi_as2receiver_getmdnreceiptsigningprotocol(void* lpObj);

QString GetMDNReceiptSigningProtocol();

Default Value

""

Remarks

This property contains the MIME type of the signature used, if any (i.e., "application/pkcs7-signature"), to create this MDNReceipt. It will contain an empty string if the receipt is unsigned.

This property is read-only.

Data Type

String

MDNTo Property (AS2Receiver Class)

The recipient for the Message Disposition Notification (MDN).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMDNTo();

Unicode (Windows)
LPWSTR GetMDNTo();

char* ipworksedi_as2receiver_getmdnto(void* lpObj);

QString GetMDNTo();

Default Value

""

Remarks

MDNTo corresponds to the Disposition-Notification-To header of RequestHeaders. If nonempty, the client has requested an MDN receipt (typically the actual value is irrelevant). This receipt will be generated in a call to ProcessRequest or CreateMDNReceipt, and may be sent by calling SendResponse.

The receipt will be contained in MDNReceipt. If ReceiptDeliveryOption is empty, the receipt should be synchronously delivered in the HTTP response; otherwise, it should be delivered asynchronously to the URL specified. In either case, SendResponse will send the response as appropriate.

According to RFC specifications, MDNReceipt must be sent if requested by the client. If MDNTo is empty the MDN may be sent or not at the option of the server.

This property is read-only.

Data Type

String

MessageId Property (AS2Receiver Class)

The message ID of the incoming message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageId();

Unicode (Windows)
LPWSTR GetMessageId();

char* ipworksedi_as2receiver_getmessageid(void* lpObj);

QString GetMessageId();

Default Value

""

Remarks

MessageId corresponds to the Message-Id header of Request, and will be used as the Original-Message-Id header of MDNReceipt.

This property is read-only.

Data Type

String

ReceiptDeliveryOption Property (AS2Receiver Class)

A URL indicating how the receipt is to be delivered.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReceiptDeliveryOption();

Unicode (Windows)
LPWSTR GetReceiptDeliveryOption();

char* ipworksedi_as2receiver_getreceiptdeliveryoption(void* lpObj);

QString GetReceiptDeliveryOption();

Default Value

""

Remarks

This property corresponds to the Receipt-delivery-option header in Request. If nonempty, the client has requested that the receipt be sent to the URL specified asynchronously. If empty, the receipt is to be delivered synchronously in the HTTP reply. In either case the receipt may be delivered by invoking SendResponse.

ReceiptDeliveryOption does not indicate whether or not a receipt was actually requested. If an MDN was requested, that information is given in MDNTo.

This property is read-only.

Data Type

String

Request Property (AS2Receiver Class)

The HTTP request to be processed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRequest(char* &lpRequest, int &lenRequest);
int SetRequest(const char* lpRequest, int lenRequest);

Unicode (Windows)
INT GetRequest(LPSTR &lpRequest, INT &lenRequest);
INT SetRequest(LPCSTR lpRequest, INT lenRequest);

int ipworksedi_as2receiver_getrequest(void* lpObj, char** lpRequest, int* lenRequest);
int ipworksedi_as2receiver_setrequest(void* lpObj, const char* lpRequest, int lenRequest);

QByteArray GetRequest();
int SetRequest(QByteArray qbaRequest);

Default Value

""

Remarks

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

When ParseRequest or ProcessRequest is invoked, the contents of Request are lost and you can read the processed data in EDIData.

This property is not available at design time.

Data Type

Binary String

RequestHeaderCount Property (AS2Receiver Class)

The number of records in the RequestHeader arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRequestHeaderCount();
int SetRequestHeaderCount(int iRequestHeaderCount);

Unicode (Windows)
INT GetRequestHeaderCount();
INT SetRequestHeaderCount(INT iRequestHeaderCount);

int ipworksedi_as2receiver_getrequestheadercount(void* lpObj);
int ipworksedi_as2receiver_setrequestheadercount(void* lpObj, int iRequestHeaderCount);

int GetRequestHeaderCount();
int SetRequestHeaderCount(int iRequestHeaderCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• RequestHeaderField
• RequestHeaderValue

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

This property is not available at design time.

Data Type

Integer

RequestHeaderField Property (AS2Receiver Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRequestHeaderField(int iRequestHeaderIndex);
int SetRequestHeaderField(int iRequestHeaderIndex, const char* lpszRequestHeaderField);

Unicode (Windows)
LPWSTR GetRequestHeaderField(INT iRequestHeaderIndex);
INT SetRequestHeaderField(INT iRequestHeaderIndex, LPCWSTR lpszRequestHeaderField);

char* ipworksedi_as2receiver_getrequestheaderfield(void* lpObj, int requestheaderindex);
int ipworksedi_as2receiver_setrequestheaderfield(void* lpObj, int requestheaderindex, const char* lpszRequestHeaderField);

QString GetRequestHeaderField(int iRequestHeaderIndex);
int SetRequestHeaderField(int iRequestHeaderIndex, QString qsRequestHeaderField);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

RequestHeaderValue Property (AS2Receiver Class)

This property contains the header contents.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRequestHeaderValue(int iRequestHeaderIndex);
int SetRequestHeaderValue(int iRequestHeaderIndex, const char* lpszRequestHeaderValue);

Unicode (Windows)
LPWSTR GetRequestHeaderValue(INT iRequestHeaderIndex);
INT SetRequestHeaderValue(INT iRequestHeaderIndex, LPCWSTR lpszRequestHeaderValue);

char* ipworksedi_as2receiver_getrequestheadervalue(void* lpObj, int requestheaderindex);
int ipworksedi_as2receiver_setrequestheadervalue(void* lpObj, int requestheaderindex, const char* lpszRequestHeaderValue);

QString GetRequestHeaderValue(int iRequestHeaderIndex);
int SetRequestHeaderValue(int iRequestHeaderIndex, QString qsRequestHeaderValue);

Default Value

""

Remarks

This property contains the Header contents.

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

This property is not available at design time.

Data Type

String

RequestHeadersString Property (AS2Receiver Class)

The HTTP headers in the AS2 request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRequestHeadersString();
int SetRequestHeadersString(const char* lpszRequestHeadersString);

Unicode (Windows)
LPWSTR GetRequestHeadersString();
INT SetRequestHeadersString(LPCWSTR lpszRequestHeadersString);

char* ipworksedi_as2receiver_getrequestheadersstring(void* lpObj);
int ipworksedi_as2receiver_setrequestheadersstring(void* lpObj, const char* lpszRequestHeadersString);

QString GetRequestHeadersString();
int SetRequestHeadersString(QString qsRequestHeadersString);

Default Value

""

Remarks

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

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

Data Type

String

RestartDirectory Property (AS2Receiver Class)

The directory to log cached files when using AS2 restart functionality.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRestartDirectory();
int SetRestartDirectory(const char* lpszRestartDirectory);

Unicode (Windows)
LPWSTR GetRestartDirectory();
INT SetRestartDirectory(LPCWSTR lpszRestartDirectory);

char* ipworksedi_as2receiver_getrestartdirectory(void* lpObj);
int ipworksedi_as2receiver_setrestartdirectory(void* lpObj, const char* lpszRestartDirectory);

QString GetRestartDirectory();
int SetRestartDirectory(QString qsRestartDirectory);

Default Value

""

Remarks

If this property is set, the class will cache all received files to the RestartDirectory. Thus, when receiving a file is interrupted, the client can restart the transmission of the file starting where it was interrupted.

To use this functionality, HTTP HEAD requests must be processed using the ProcessRestartRequest method.

When using restart functionality, the data is processed after the entire file contents are received.

NOTE: This directory will not automatically be cleaned up.

Data Type

String

RolloverCertEncoded Property (AS2Receiver Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRolloverCertEncoded(char* &lpRolloverCertEncoded, int &lenRolloverCertEncoded);
int SetRolloverCertEncoded(const char* lpRolloverCertEncoded, int lenRolloverCertEncoded);

Unicode (Windows)
INT GetRolloverCertEncoded(LPSTR &lpRolloverCertEncoded, INT &lenRolloverCertEncoded);
INT SetRolloverCertEncoded(LPCSTR lpRolloverCertEncoded, INT lenRolloverCertEncoded);

int ipworksedi_as2receiver_getrollovercertencoded(void* lpObj, char** lpRolloverCertEncoded, int* lenRolloverCertEncoded);
int ipworksedi_as2receiver_setrollovercertencoded(void* lpObj, const char* lpRolloverCertEncoded, int lenRolloverCertEncoded);

QByteArray GetRolloverCertEncoded();
int SetRolloverCertEncoded(QByteArray qbaRolloverCertEncoded);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

RolloverCertStore Property (AS2Receiver Class)

This is the name of the certificate store for the client certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRolloverCertStore(char* &lpRolloverCertStore, int &lenRolloverCertStore);
int SetRolloverCertStore(const char* lpRolloverCertStore, int lenRolloverCertStore);

Unicode (Windows)
INT GetRolloverCertStore(LPSTR &lpRolloverCertStore, INT &lenRolloverCertStore);
INT SetRolloverCertStore(LPCSTR lpRolloverCertStore, INT lenRolloverCertStore);

int ipworksedi_as2receiver_getrollovercertstore(void* lpObj, char** lpRolloverCertStore, int* lenRolloverCertStore);
int ipworksedi_as2receiver_setrollovercertstore(void* lpObj, const char* lpRolloverCertStore, int lenRolloverCertStore);

QByteArray GetRolloverCertStore();
int SetRolloverCertStore(QByteArray qbaRolloverCertStore);

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The RolloverCertStoreType property denotes the type of the certificate store specified by RolloverCertStore. If the store is password protected, specify the password in RolloverCertStorePassword.

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Binary String

RolloverCertStorePassword Property (AS2Receiver Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRolloverCertStorePassword();
int SetRolloverCertStorePassword(const char* lpszRolloverCertStorePassword);

Unicode (Windows)
LPWSTR GetRolloverCertStorePassword();
INT SetRolloverCertStorePassword(LPCWSTR lpszRolloverCertStorePassword);

char* ipworksedi_as2receiver_getrollovercertstorepassword(void* lpObj);
int ipworksedi_as2receiver_setrollovercertstorepassword(void* lpObj, const char* lpszRolloverCertStorePassword);

QString GetRolloverCertStorePassword();
int SetRolloverCertStorePassword(QString qsRolloverCertStorePassword);

Default Value

""

Remarks

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

Data Type

String

RolloverCertStoreType Property (AS2Receiver Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRolloverCertStoreType();
int SetRolloverCertStoreType(int iRolloverCertStoreType);

Unicode (Windows)
INT GetRolloverCertStoreType();
INT SetRolloverCertStoreType(INT iRolloverCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int ipworksedi_as2receiver_getrollovercertstoretype(void* lpObj);
int ipworksedi_as2receiver_setrollovercertstoretype(void* lpObj, int iRolloverCertStoreType);

int GetRolloverCertStoreType();
int SetRolloverCertStoreType(int iRolloverCertStoreType);

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

RolloverCertSubject Property (AS2Receiver Class)

This is the subject of the certificate used for client authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRolloverCertSubject();
int SetRolloverCertSubject(const char* lpszRolloverCertSubject);

Unicode (Windows)
LPWSTR GetRolloverCertSubject();
INT SetRolloverCertSubject(LPCWSTR lpszRolloverCertSubject);

char* ipworksedi_as2receiver_getrollovercertsubject(void* lpObj);
int ipworksedi_as2receiver_setrollovercertsubject(void* lpObj, const char* lpszRolloverCertSubject);

QString GetRolloverCertSubject();
int SetRolloverCertSubject(QString qsRolloverCertSubject);

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

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

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

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

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

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

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

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

Data Type

String

ScanResult Property (AS2Receiver Class)

The result of invoking ParseRequest .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetScanResult();

Unicode (Windows)
INT GetScanResult();

int ipworksedi_as2receiver_getscanresult(void* lpObj);

int GetScanResult();

Default Value

0

Remarks

ScanResult will contain information about any errors that occurred while invoking ParseRequest or ProcessRequest. ScanResult will contain 0 if no errors occurred, otherwise it will contain one or more of the following errors. If multiple errors are reported the results will be OR-ed together.

This property is read-only.

Data Type

Integer

SignerCertEncoded Property (AS2Receiver Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignerCertEncoded(char* &lpSignerCertEncoded, int &lenSignerCertEncoded);
int SetSignerCertEncoded(const char* lpSignerCertEncoded, int lenSignerCertEncoded);

Unicode (Windows)
INT GetSignerCertEncoded(LPSTR &lpSignerCertEncoded, INT &lenSignerCertEncoded);
INT SetSignerCertEncoded(LPCSTR lpSignerCertEncoded, INT lenSignerCertEncoded);

int ipworksedi_as2receiver_getsignercertencoded(void* lpObj, char** lpSignerCertEncoded, int* lenSignerCertEncoded);
int ipworksedi_as2receiver_setsignercertencoded(void* lpObj, const char* lpSignerCertEncoded, int lenSignerCertEncoded);

QByteArray GetSignerCertEncoded();
int SetSignerCertEncoded(QByteArray qbaSignerCertEncoded);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SignerCertStore Property (AS2Receiver Class)

This is the name of the certificate store for the client certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignerCertStore(char* &lpSignerCertStore, int &lenSignerCertStore);
int SetSignerCertStore(const char* lpSignerCertStore, int lenSignerCertStore);

Unicode (Windows)
INT GetSignerCertStore(LPSTR &lpSignerCertStore, INT &lenSignerCertStore);
INT SetSignerCertStore(LPCSTR lpSignerCertStore, INT lenSignerCertStore);

int ipworksedi_as2receiver_getsignercertstore(void* lpObj, char** lpSignerCertStore, int* lenSignerCertStore);
int ipworksedi_as2receiver_setsignercertstore(void* lpObj, const char* lpSignerCertStore, int lenSignerCertStore);

QByteArray GetSignerCertStore();
int SetSignerCertStore(QByteArray qbaSignerCertStore);

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

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

This property is not available at design time.

Data Type

Binary String

SignerCertStorePassword Property (AS2Receiver Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSignerCertStorePassword();
int SetSignerCertStorePassword(const char* lpszSignerCertStorePassword);

Unicode (Windows)
LPWSTR GetSignerCertStorePassword();
INT SetSignerCertStorePassword(LPCWSTR lpszSignerCertStorePassword);

char* ipworksedi_as2receiver_getsignercertstorepassword(void* lpObj);
int ipworksedi_as2receiver_setsignercertstorepassword(void* lpObj, const char* lpszSignerCertStorePassword);

QString GetSignerCertStorePassword();
int SetSignerCertStorePassword(QString qsSignerCertStorePassword);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

SignerCertStoreType Property (AS2Receiver Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignerCertStoreType();
int SetSignerCertStoreType(int iSignerCertStoreType);

Unicode (Windows)
INT GetSignerCertStoreType();
INT SetSignerCertStoreType(INT iSignerCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int ipworksedi_as2receiver_getsignercertstoretype(void* lpObj);
int ipworksedi_as2receiver_setsignercertstoretype(void* lpObj, int iSignerCertStoreType);

int GetSignerCertStoreType();
int SetSignerCertStoreType(int iSignerCertStoreType);

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

This property is not available at design time.

Data Type

Integer

SignerCertSubject Property (AS2Receiver Class)

This is the subject of the certificate used for client authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSignerCertSubject();
int SetSignerCertSubject(const char* lpszSignerCertSubject);

Unicode (Windows)
LPWSTR GetSignerCertSubject();
INT SetSignerCertSubject(LPCWSTR lpszSignerCertSubject);

char* ipworksedi_as2receiver_getsignercertsubject(void* lpObj);
int ipworksedi_as2receiver_setsignercertsubject(void* lpObj, const char* lpszSignerCertSubject);

QString GetSignerCertSubject();
int SetSignerCertSubject(QString qsSignerCertSubject);

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

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

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

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

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

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

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

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

This property is not available at design time.

Data Type

String

SSLAcceptServerCertEncoded Property (AS2Receiver Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLAcceptServerCertEncoded(char* &lpSSLAcceptServerCertEncoded, int &lenSSLAcceptServerCertEncoded);
int SetSSLAcceptServerCertEncoded(const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

Unicode (Windows)
INT GetSSLAcceptServerCertEncoded(LPSTR &lpSSLAcceptServerCertEncoded, INT &lenSSLAcceptServerCertEncoded);
INT SetSSLAcceptServerCertEncoded(LPCSTR lpSSLAcceptServerCertEncoded, INT lenSSLAcceptServerCertEncoded);

int ipworksedi_as2receiver_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworksedi_as2receiver_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLAcceptServerCertStore Property (AS2Receiver Class)

This is the name of the certificate store for the client certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLAcceptServerCertStore(char* &lpSSLAcceptServerCertStore, int &lenSSLAcceptServerCertStore);
int SetSSLAcceptServerCertStore(const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);

Unicode (Windows)
INT GetSSLAcceptServerCertStore(LPSTR &lpSSLAcceptServerCertStore, INT &lenSSLAcceptServerCertStore);
INT SetSSLAcceptServerCertStore(LPCSTR lpSSLAcceptServerCertStore, INT lenSSLAcceptServerCertStore);

int ipworksedi_as2receiver_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int ipworksedi_as2receiver_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);

QByteArray GetSSLAcceptServerCertStore();
int SetSSLAcceptServerCertStore(QByteArray qbaSSLAcceptServerCertStore);

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (AS2Receiver Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLAcceptServerCertStorePassword();
int SetSSLAcceptServerCertStorePassword(const char* lpszSSLAcceptServerCertStorePassword);

Unicode (Windows)
LPWSTR GetSSLAcceptServerCertStorePassword();
INT SetSSLAcceptServerCertStorePassword(LPCWSTR lpszSSLAcceptServerCertStorePassword);

char* ipworksedi_as2receiver_getsslacceptservercertstorepassword(void* lpObj);
int ipworksedi_as2receiver_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);

QString GetSSLAcceptServerCertStorePassword();
int SetSSLAcceptServerCertStorePassword(QString qsSSLAcceptServerCertStorePassword);

Default Value

""

Remarks

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

Data Type

String

SSLAcceptServerCertStoreType Property (AS2Receiver Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLAcceptServerCertStoreType();
int SetSSLAcceptServerCertStoreType(int iSSLAcceptServerCertStoreType);

Unicode (Windows)
INT GetSSLAcceptServerCertStoreType();
INT SetSSLAcceptServerCertStoreType(INT iSSLAcceptServerCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int ipworksedi_as2receiver_getsslacceptservercertstoretype(void* lpObj);
int ipworksedi_as2receiver_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);

int GetSSLAcceptServerCertStoreType();
int SetSSLAcceptServerCertStoreType(int iSSLAcceptServerCertStoreType);

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

SSLAcceptServerCertSubject Property (AS2Receiver Class)

This is the subject of the certificate used for client authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLAcceptServerCertSubject();
int SetSSLAcceptServerCertSubject(const char* lpszSSLAcceptServerCertSubject);

Unicode (Windows)
LPWSTR GetSSLAcceptServerCertSubject();
INT SetSSLAcceptServerCertSubject(LPCWSTR lpszSSLAcceptServerCertSubject);

char* ipworksedi_as2receiver_getsslacceptservercertsubject(void* lpObj);
int ipworksedi_as2receiver_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);

QString GetSSLAcceptServerCertSubject();
int SetSSLAcceptServerCertSubject(QString qsSSLAcceptServerCertSubject);

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

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

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

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

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

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

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

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

Data Type

String

SSLCertEncoded Property (AS2Receiver Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded);

Unicode (Windows)
INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);

int ipworksedi_as2receiver_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworksedi_as2receiver_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (AS2Receiver Class)

This is the name of the certificate store for the client certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore);

Unicode (Windows)
INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);

int ipworksedi_as2receiver_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworksedi_as2receiver_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Binary String

SSLCertStorePassword Property (AS2Receiver Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword);

Unicode (Windows)
LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);

char* ipworksedi_as2receiver_getsslcertstorepassword(void* lpObj);
int ipworksedi_as2receiver_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

Default Value

""

Remarks

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

Data Type

String

SSLCertStoreType Property (AS2Receiver Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Unicode (Windows)
INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int ipworksedi_as2receiver_getsslcertstoretype(void* lpObj);
int ipworksedi_as2receiver_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubject Property (AS2Receiver Class)

This is the subject of the certificate used for client authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject);

Unicode (Windows)
LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);

char* ipworksedi_as2receiver_getsslcertsubject(void* lpObj);
int ipworksedi_as2receiver_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

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

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

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

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

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

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

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

Data Type

String

UsePSS Property (AS2Receiver Class)

This property specifies whether or not RSA-PSS will be used during signing and verification.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUsePSS();
int SetUsePSS(int bUsePSS);

Unicode (Windows)
BOOL GetUsePSS();
INT SetUsePSS(BOOL bUsePSS);

int ipworksedi_as2receiver_getusepss(void* lpObj);
int ipworksedi_as2receiver_setusepss(void* lpObj, int bUsePSS);

bool GetUsePSS();
int SetUsePSS(bool bUsePSS);

Default Value

FALSE

Remarks

This property specifies whether or not RSA-PSS will be used when signing and verifying messages. The default value is False.

Data Type

Boolean

AckRequest Method (AS2Receiver Class)

Optional. Acknowledges the incoming request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AckRequest();

Unicode (Windows)
INT AckRequest();

int ipworksedi_as2receiver_ackrequest(void* lpObj);

int AckRequest();

Remarks

When called from within a server environment, AckRequest will acknowledge the client request with a 200 OK. This may be useful if the client has posted a lot of data, and has requested an asynchronous receipt.

If an acknowledgement is not expected (i.e., the client is expecting an MDN in the response), then invoking this method will do nothing. Servers may safely call this method immediately after ParseRequest for both synchronous and asynchronous MDN requests.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (AS2Receiver Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworksedi_as2receiver_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

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

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

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

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

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

CreateMDNReceipt Method (AS2Receiver Class)

Creates MDNReceipt .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CreateMDNReceipt(const char* lpszHeaders, const char* lpszMDN, const char* lpszMessage);

Unicode (Windows)
INT CreateMDNReceipt(LPCWSTR lpszHeaders, LPCWSTR lpszMDN, LPCWSTR lpszMessage);

int ipworksedi_as2receiver_createmdnreceipt(void* lpObj, const char* lpszHeaders, const char* lpszMDN, const char* lpszMessage);

int CreateMDNReceipt(const QString& qsHeaders, const QString& qsMDN, const QString& qsMessage);

Remarks

CreateMDNReceipt may be invoked after ParseRequest to create an MDN-based receipt. The receipt will report success or failure depending on ErrorReportingFlags and the success or failure of ParseRequest.

This method populates MDNReceipt with a new MDNReceipt. The Headers, MDN, and Message parameters can be used to further customize the receipt, or empty string ("") parameters may be set to use the class generated defaults. Headers will set additional transport headers to be sent with the receipt (in the HTTP or SMTP headers of the signed receipt). MDN can be used to append additional headers to the Message Disposition Notification portion of the MDN Receipt. If MDN is set to a value prefixed with an at sign ("@"), the at sign will be removed and the specified MDN will be used in the receipt in place of the component generated value. Message will set the human-readable portion of the receipt, and should describe any error conditions that may have occurred.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ParseRequest Method (AS2Receiver Class)

Parses the EDI message and determines the EDIData .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ParseRequest();

Unicode (Windows)
INT ParseRequest();

int ipworksedi_as2receiver_parserequest(void* lpObj);

int ParseRequest();

Remarks

Processes the EDI message in the request (either from the HTTP context, or as given by Request and possibly RequestHeadersString). If the message is encrypted, it will be decrypted with the certificate specified in Certificate. If it is signed, the signature will be verified against the certificate specified in SignerCert.

If the message is scanned without difficulty, EDIData will be populated. If a problem occurs, an exception will be thrown. This might occur if the client used or requested unsupported algorithms or data formats. In this case, EDIData will not be determined.

The class may be configured to ignore certain errors by setting ErrorProcessingFlags. This will allow the message to be processed and EDIData to be determined. If any errors occur, an exception will be thrown and the ScanResult property will reflect the error condition.

Whether or not an exception is thrown, an MDNReceipt may be generated by invoking CreateMDNReceipt. In the case of a successful scan MDNReceipt will report the success, otherwise the receipt will provide information to the client about the error.

ProcessRequest may be used to scan and create the receipt in one step. ReadRequest may be used to scan the request headers only to obtain details that can be used to configure the correct settings for the partner.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ProcessRequest Method (AS2Receiver Class)

Processes the EDI data, and generates the receipt.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ProcessRequest();

Unicode (Windows)
INT ProcessRequest();

int ipworksedi_as2receiver_processrequest(void* lpObj);

int ProcessRequest();

Remarks

Invoking ProcessRequest automates the entire AS2 server process. The method scans the request, determines the EDIData, and generates the MDNReceipt. In a server environment the receipt may be returned by invoking SendResponse.

The method's functionality is the same as the combined functionality of ParseRequest and CreateMDNReceipt. The method's operation is controlled by ErrorProcessingFlags and ErrorReportingFlags, and ScanResult will be populated as in ParseRequest.

The method will throw an exception, as ParseRequest does, if a problem is found while processing the request. However, if the problem does not prevent an MDN from being generated, MDNReceipt will still be generated before the exception is thrown. In all cases, the receipt will be suitable for returning to the client. If an exception is thrown, the MDNReceipt will provide more detail on the cause of the error.

The class will populate EDIData if no errors occurred scanning the request, or if ErrorProcessingFlags had been previously configured to allow the error.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ProcessRestartRequest Method (AS2Receiver Class)

Processes the AS2 restart request, and sends a response to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ProcessRestartRequest();

Unicode (Windows)
INT ProcessRestartRequest();

int ipworksedi_as2receiver_processrestartrequest(void* lpObj);

int ProcessRestartRequest();

Remarks

Invoking ProcessRestartRequest automates the restart AS2 server process. The method should be invoked when the HTTP HEAD request is received. The class will then parse the request, and respond to the client with the number of bytes (if any) the class received during a previous connection. The class will look for unfinished files in the RestartDirectory when processing these requests.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ReadRequest Method (AS2Receiver Class)

Reads the AS2 request from the HTTP session.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ReadRequest();

Unicode (Windows)
INT ReadRequest();

int ipworksedi_as2receiver_readrequest(void* lpObj);

int ReadRequest();

Remarks

ReadRequest reads the AS2 request from the content of the Request (and optionally the RequestHeadersString) property. The class will parse the request from Request. The headers will be read into RequestHeaders. Finally, the class will parse the headers and populate the following properties:

• AS2From
• AS2To
• AS2VersionIncoming
• MessageId
• MDNTo
• ReceiptDeliveryOption
• RequestedSignatureProtocol
• RequestedMICAlgorithms

ParseRequest may be used to scan the entire message.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (AS2Receiver Class)

Resets the state of the control.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworksedi_as2receiver_reset(void* lpObj);

int Reset();

Remarks

Reset resets the state of the class. All properties will be set to their default values.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SendAsyncMDN Method (AS2Receiver Class)

Sends the MDNReceipt to the RemoteURL specified.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendAsyncMDN(const char* lpszRemoteURL, const char* lpMDNReceipt, int lenMDNReceipt, const char* lpszMDNReceiptHeaders);

Unicode (Windows)
INT SendAsyncMDN(LPCWSTR lpszRemoteURL, LPCSTR lpMDNReceipt, INT lenMDNReceipt, LPCWSTR lpszMDNReceiptHeaders);

int ipworksedi_as2receiver_sendasyncmdn(void* lpObj, const char* lpszRemoteURL, const char* lpMDNReceipt, int lenMDNReceipt, const char* lpszMDNReceiptHeaders);

int SendAsyncMDN(const QString& qsRemoteURL, QByteArray qbaMDNReceipt, const QString& qsMDNReceiptHeaders);

Remarks

This method sends the asynchronous MDNReceipt to the RemoteURL specified. It need not be invoked if the prior call to SendResponse was successful. The RemoteURL, MDNReceipt, and MDNReceiptHeaders parameters should be the ones that were retrieved from ReceiptDeliveryOption and MDNReceipt's Content and Headers properties respectively.

If the RemoteURL requires SMTP transfer, the appropriate SMTP settings should be set using Config.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SendResponse Method (AS2Receiver Class)

In a server environment, responds to the requesting client with MDNReceipt .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendResponse();

Unicode (Windows)
INT SendResponse();

int ipworksedi_as2receiver_sendresponse(void* lpObj);

int SendResponse();

Remarks

When called from within a server environment, SendResponse will respond to the requesting client. If an MDN was requested, then MDNReceipt will be returned to the client, either in the HTTP response or in a separate transmission, depending on the client request. In case it is returned in a separate transmission, a simple acknowledgement of "200 OK" will also be sent in the HTTP response, unless this was sent previously using AckRequest.

The AS2 headers will be taken from MDNReceipt and will be merged with HTTP headers as appropriate. Note that if ReceiptDeliveryOption indicates a "mailto:" URL, the appropriate SMTP settings should be set using Config.

The exact behavior of the method is specific to the environment. In ASP.NET, the receipt will be sent within the current HTTP context. In Java, the receipt will be sent within the provided HttpServletResponse. Otherwise, the receipt will be directed to stdout. If this is impossible, an exception will be thrown.

Optionally, if an asynchronous MDN is requested, the MDNReceipt and ReceiptDeliveryOption may be saved so that the MDN may be sent later through the SendAsyncMDN method.

This method should only be invoked after MDNReceipt has been generated by CreateMDNReceipt or ProcessRequest.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetTPInfo Method (AS2Receiver Class)

A convenient way to set AS2 communication parameters using XML strings.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetTPInfo(const char* lpszProfile);

Unicode (Windows)
INT SetTPInfo(LPCWSTR lpszProfile);

int ipworksedi_as2receiver_settpinfo(void* lpObj, const char* lpszProfile);

int SetTPInfo(const QString& qsProfile);

Remarks

SetTPInfo offers a convenient way to set AS2 communication parameters using XML strings. The format of the XML is the same as provided by the method GetTPInfo of AS2ProfileMgr.

An example usage scenario is shown below. AS2Receiver as2receiver = new AS2Receiver(); AS2Profilemgr mgr = new AS2Profilemgr(); mgr.DataDir = "C:\as2data"; as2receiver.setTPInfo(mgr.getTPInfo("self")); as2receiver.readRequest(); as2sender.setTPInfo(mgr.getTPInfo(as2receiver.getAS2From())); as2receiver.processRequest(); as2receiver.sendResponse();

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

CEMRequest Event (AS2Receiver Class)

Fired when a Certificate Exchange Messaging (CEM) request is received.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireCEMRequest(AS2ReceiverCEMRequestEventParams *e);

typedef struct {
  const char *RequestId;
  const char *As2From;
  int reserved;
} AS2ReceiverCEMRequestEventParams;


Unicode (Windows)
virtual INT FireCEMRequest(AS2ReceiverCEMRequestEventParams *e);

typedef struct {
  LPCWSTR RequestId;
  LPCWSTR As2From;
  INT reserved;
} AS2ReceiverCEMRequestEventParams;

#define EID_AS2RECEIVER_CEMREQUEST 1

virtual INT IPWORKSEDI_CALL FireCEMRequest(LPSTR &lpszRequestId, LPSTR &lpszAs2From);

class AS2ReceiverCEMRequestEventParams {
public:
  const QString &RequestId();

  const QString &As2From();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void CEMRequest(AS2ReceiverCEMRequestEventParams *e);

// Or, subclass AS2Receiver and override this emitter function.
virtual int FireCEMRequest(AS2ReceiverCEMRequestEventParams *e) {...}

Remarks

This event fires when a Certificate Exchange Messaging (CEM) request is received.

RequestId is the CEM request Id. This must be saved and will be used when sending the CEM response.

As2From identifies the sender of the CEM request.

If CEMCertDir is set the received certificates will be written to the specified location. If CEMCertDir is not set the certificates will be held in memory and may be accessed by inspecting CEMDetails.

The CEM request also populates CEMRespondByDate and CEMResponseURL. CEMRespondByDate specifies the date by which the sender expects a response. CEMResponseURL specifies the URL to which the CEM response should be sent.

When this event fires the following CEMDetails properties are applicable:

• CEMCertStoreType
• CEMCertStore
• CEMCertSubject
• CEMCertUsage
• CEMCertIssuer
• CEMCertSerialNumber
• CEMCertId
• CEMRespondByDate
• CEMResponseURL

To send a CEM response save the CEMDetails values and call SendCEMResponse with the AS2Sender class.

CEMResponse Event (AS2Receiver Class)

Fired when a Certificate Exchange Messaging (CEM) response is received.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireCEMResponse(AS2ReceiverCEMResponseEventParams *e);

typedef struct {
  const char *RequestId;
  const char *As2From;
  int reserved;
} AS2ReceiverCEMResponseEventParams;


Unicode (Windows)
virtual INT FireCEMResponse(AS2ReceiverCEMResponseEventParams *e);

typedef struct {
  LPCWSTR RequestId;
  LPCWSTR As2From;
  INT reserved;
} AS2ReceiverCEMResponseEventParams;

#define EID_AS2RECEIVER_CEMRESPONSE 2

virtual INT IPWORKSEDI_CALL FireCEMResponse(LPSTR &lpszRequestId, LPSTR &lpszAs2From);

class AS2ReceiverCEMResponseEventParams {
public:
  const QString &RequestId();

  const QString &As2From();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void CEMResponse(AS2ReceiverCEMResponseEventParams *e);

// Or, subclass AS2Receiver and override this emitter function.
virtual int FireCEMResponse(AS2ReceiverCEMResponseEventParams *e) {...}

Remarks

This event fires when a Certificate Exchange Messaging (CEM) response is received.

RequestId is the CEM request Id. Match this to the request Id from the original request.

As2From identifies the sender of the CEM request.

When this event fires the CEMDetails property will be populated. Inspect the CEMAccepted property to determine whether each CEM request was accepted. If the request was rejected, check CEMRejectionReason for details.

When this event fires the following CEMDetails properties are applicable:

• CEMCertIssuer
• CEMCertSerialNumber
• CEMAccepted
• CEMRejectionReason

EDIDataInfo Event (AS2Receiver Class)

Fired when processing an incoming message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireEDIDataInfo(AS2ReceiverEDIDataInfoEventParams *e);

typedef struct {
  const char *Name;
  const char *DataType;
  int Duplicate;
  int reserved;
} AS2ReceiverEDIDataInfoEventParams;


Unicode (Windows)
virtual INT FireEDIDataInfo(AS2ReceiverEDIDataInfoEventParams *e);

typedef struct {
  LPCWSTR Name;
  LPCWSTR DataType;
  BOOL Duplicate;
  INT reserved;
} AS2ReceiverEDIDataInfoEventParams;

#define EID_AS2RECEIVER_EDIDATAINFO 3

virtual INT IPWORKSEDI_CALL FireEDIDataInfo(LPSTR &lpszName, LPSTR &lpszDataType, BOOL &bDuplicate);

class AS2ReceiverEDIDataInfoEventParams {
public:
  const QString &Name();

  const QString &DataType();

  bool Duplicate();
  void SetDuplicate(bool bDuplicate);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void EDIDataInfo(AS2ReceiverEDIDataInfoEventParams *e);

// Or, subclass AS2Receiver and override this emitter function.
virtual int FireEDIDataInfo(AS2ReceiverEDIDataInfoEventParams *e) {...}

Remarks

When ParseRequest or ProcessRequest has been called this event will fire and provide the filename of the incoming data via the Name parameter. DataType will be the EDI type specified in the message, such as "application/edi-x12".

Duplicate is used in conjunction with the InvalidFilenameMDNAction configuration setting when Filename Preservation with an Associated MDN Response is implemented in the receiving agent to support MDN responses for duplicate filenames. If IncomingDirectory is specified, the Duplicate parameter will return True if the filename specified in the request exists on disk. Additionally, the Duplicate parameter may be set to True before the event exits so that checking for duplicate filenames may be extended to the application logic.

Error Event (AS2Receiver Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(AS2ReceiverErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} AS2ReceiverErrorEventParams;


Unicode (Windows)
virtual INT FireError(AS2ReceiverErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} AS2ReceiverErrorEventParams;

#define EID_AS2RECEIVER_ERROR 4

virtual INT IPWORKSEDI_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class AS2ReceiverErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(AS2ReceiverErrorEventParams *e);

// Or, subclass AS2Receiver and override this emitter function.
virtual int FireError(AS2ReceiverErrorEventParams *e) {...}

Remarks

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

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

Log Event (AS2Receiver Class)

Fired with log information while processing a message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireLog(AS2ReceiverLogEventParams *e);

typedef struct {
  const char *LogType;
  const char *LogMessage;
  int lenLogMessage;
  int reserved;
} AS2ReceiverLogEventParams;


Unicode (Windows)
virtual INT FireLog(AS2ReceiverLogEventParams *e);

typedef struct {
  LPCWSTR LogType;
  LPCSTR LogMessage;
  INT lenLogMessage;
  INT reserved;
} AS2ReceiverLogEventParams;

#define EID_AS2RECEIVER_LOG 5

virtual INT IPWORKSEDI_CALL FireLog(LPSTR &lpszLogType, LPSTR &lpLogMessage, INT &lenLogMessage);

class AS2ReceiverLogEventParams {
public:
  const QString &LogType();

  const QByteArray &LogMessage();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Log(AS2ReceiverLogEventParams *e);

// Or, subclass AS2Receiver and override this emitter function.
virtual int FireLog(AS2ReceiverLogEventParams *e) {...}

Remarks

This event fires once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

Log messages available through this event correspond to log files written to LogDirectory. This event provides a way to obtain log messages without relying on files on disk. This event fires regardless of the value of LogDirectory (i.e. when LogDirectory is empty the event will still fire).

The LogMessage event parameter holds the raw log data.

The LogType event parameter indicates the type of log. Possible values are: