AS4Client Class

Properties   Methods   Events   Config Settings   Errors  

The AS4Client class connects to a server to send or receive files.

Syntax

AS4Client

Remarks

The AS4Client component may be used to send or receive files from a server. The component will connect to a server and either send files (push), or request files to download (pull).

Sending Files

SendFiles sends the files specified by EDIData to URL.

Before calling this method set AgreementRef to the agreement identifier used by both parties. Set AS4From and AS4To. Set EDIData specifies the file(s) to be sent. To encrypt the data set RecipientCerts. To sign the data set SigningCert. The SignerCert property should be set to verify the signed receipt.

When this method is called the file(s) will be sent and any returned receipts will be verified.

To indicate a synchronous receipt is expected set ReceiptReplyMode to rrmSync. The following properties are applicable when calling this method with an agreement specifying a synchronous receipt (a receipt provided in the response):

• AgreementRef
• AS4From
• AS4To
• EDIData
• URL
• RecipientCerts (required to encrypt)
• SignerCert (required to verify signed receipts)
• SigningCert (required to sign files)
• ConversationId (optional)
• EncryptionAlgorithm (optional)
• LogDirectory (optional)
• MessageId (optional)
• MessageProperties (optional)
• Profile (optional)
• ReceiptReplyMode
• Service (optional)
• ServiceType (optional)
• SignatureAlgorithm (optional)

SendFiles Example (synchronous receipt): client.Profile = As4clientProfiles.ebpfENTSOG; //Specify the agreement and party information client.AgreementRef = "http://agreements.company.com/sign_and_encrypt"; client.AS4From.Role = "Sender"; client.AS4From.Id = "org:b2b:example:company:A"; client.AS4To.Role = "Receiver"; client.AS4To.Id = "org:b2b:example:company:B"; //Configure the component to expect a synchronous receipt. client.ReceiptReplyMode = As4clientReceiptReplyModes.rrmSync; //Company A's private certificate. Used to sign the outgoing message and files. client.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, "C:\\files\\CompanyA.pfx", "password", "*"); //Company B's public certificate. Used to encrypt the outgoing file. client.RecipientCerts.Add(new Certificate("C:\\files\\as4\\CompanyB.cer")); //Company B's public certificate. Used to verify the signed receipt. client.SignerCert = new Certificate("C:\\files\\as4\\CompanyB.cer"); client.URL = "http://www.company.com:9090/msh"; EBData data = new EBData(); data.EDIType = "application/edi-x12"; data.Filename = "C:\\files\\myfile.x12"; data.Name = "myfile.x12"; client.EDIData.Add(data); //Send file(s) and verify the receipt. client.SendFiles();

The class also supports asynchronous receipts. In this configuration a file is sent from the class to another party, but the receipt is not returned in the response. Instead the other party sends the receipt at a later time. The AS4Server class may be used inside a web page to receive the asynchronous receipt. After receiving the receipt either AS4Server or AS4Client may be used to verify the receipt.

Details about the original message must be stored so that the receipt can be correlated with the message and properly verified. The easiest way to do this is to set AsyncReceiptInfoDir before calling SendFiles. The class will automatically store the required information.

See the VerifyReceipt method of AS4Server for details about verifying asynchronous receipts.

To indicate an asynchronous receipt is expected set ReceiptReplyMode to rrmAsync. The following properties are applicable when calling this method with an agreement specifying a synchronous receipt (a receipt provided in the response):

• AgreementRef
• AS4From
• AS4To
• AsyncReceiptInfoDir
• EDIData
• URL
• RecipientCerts (required to encrypt)
• SignerCert (required to verify signed receipts)
• SigningCert (required to sign files)
• ConversationId (optional)
• EncryptionAlgorithm (optional)
• LogDirectory (optional)
• MessageId (optional)
• MessageProperties (optional)
• OriginalSOAPMessage (optional)
• OriginalSOAPMessageId (optional)
• Profile (optional)
• ReceiptReplyMode
• Service (optional)
• ServiceType (optional)
• SignatureAlgorithm (optional)

SendFiles Example (asynchronous receipt): client.Profile = As4clientProfiles.ebpfENTSOG; //Specify the agreement and party information client.AgreementRef = "http://agreements.company.com/sign_and_encrypt_async"; client.AS4From.Role = "Sender"; client.AS4From.Id = "org:b2b:example:company:A"; client.AS4To.Role = "Receiver"; client.AS4To.Id = "org:b2b:example:company:B"; //Configure the component to expect a synchronous receipt. client.ReceiptReplyMode = As4clientReceiptReplyModes.rrmAsync; client.AsyncReceiptInfoDir = "C:\\async_info"; //Company A's private certificate. Used to sign the outgoing message and files. client.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, "C:\\files\\CompanyA.pfx", "password", "*"); //Company B's public certificate. Used to encrypt the outgoing files. client.RecipientCerts.Add(new Certificate("C:\\files\\as4\\CompanyB.cer")); //Company B's public certificate. Used to verify the signed receipt. client.SignerCert = new Certificate("C:\\files\\as4\\CompanyB.cer"); client.URL = "http://www.company.com:9090/msh"; EBData data = new EBData(); data.EDIType = "application/edi-x12"; data.Filename = "C:\\files\\myfile.x12"; data.Name = "myfile.x12"; client.EDIData.Add(data); //Send file(s). client.SendFiles();

At this point the file(s) have been sent, but a receipt has not yet been received. AS4Server can be used within a web site to listen for the receipt. //**** Inside a web site **** As4server server = new As4server; server.ReadRequest(); if (!String.IsNullOrEmpty(server.IncomingReceipt.Content)) { server.AsyncReceiptInfoDir = "C:\\async_info"; server.VerifyReceipt(); //The receipt is now verified }

Receiving Files

ReceiveFiles establishes a connection to the server specified by URL and receives files.

The MPC specifies the Message Partition Channel from which messages will be received. The server will reply with files from this channel. If IncomingDirectory is set before calling this method the files will be written to the specified folder, otherwise inspect EDIData to obtain the received file data. The following properties are applicable when calling this method:

• SigningCert (required to sign the request)
• Certificate (required for decryption)
• SignerCert (required for signature verification)
• URL
• IncomingDirectory (optional)
• LogDirectory
• MPC
• TokenUser
• TokenPassword
• TokenPasswordType

• AS4From
• AS4To
• AgreementRef
• ConversationId
• Service
• ServiceAction
• ServiceType
• MessageId
• Receipt

To bundle the receipt with a subsequent ReceiveFiles call the Receipt property must hold the receipt. If the same instance of the class is being used this is already true since Receipt is populated automatically after receiving the file. To use another instance of the class for multiple calls to ReceiveFiles be sure to save the Receipt's Content and RefToMessageId values for later use.

ReceiveFiles Example: client.Profile = As4clientProfiles.ebpfENTSOG; //Company A's private certificate. Used for signing the request. client.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, "C:\\files\\as4\\CompanyA.pfx", "password", "*"); //Company A's private certificate. Used for decrypting the file. client.Certificate = new Certificate(CertStoreTypes.cstPFXFile, "C:\\files\\as4\\CompanyA.pfx", "password", "*"); //Company B's public certificate. Used for signature verification. client.SignerCert = new Certificate("C:\\files\\as4\\CompanyB.cer"); client.URL = "http://www.company.com:9090/msh"; //Message Channel id client.MPC = "mpc_a"; client.IncomingDirectory = "C:\\incoming_dir"; client.ReceiveFiles(); //Inspect client.AgreementRef and other properties for information about the received files Console.WriteLine(client.AgreementRef); Console.WriteLine(client.AS4From.Id); Console.WriteLine(client.AS4To.Id); Console.WriteLine(client.ConversationId); //Save the receipt for later use string receiptContent = client.Receipt.Content; string receiptRefId = client.Receipt.RefToMessageId;

At this stage the receipt data is saved. Later when making another call to ReceiveFiles and populate the Receipt property with this receipt data. When ReceiveFiles is called again, the receipt for the previous message will be included with the request. client.Receipt = new EBReceipt(receiptRefId, receiptContent); client.ReceiveFiles(); //This will now include the bundled receipt

Sending Asynchronous Receipts

SendReceipt sends an asynchronous receipt to the URL.

This method is typically used in conjunction with AS4Server to send an asynchronous receipt after receiving a message. The receipt will be created at the time of the incoming request, then saved for later use. When the receipt is to be sent populate Receipt and call this method.

//Send an asynchronous receipt client.URL = ""http://www.company.com:9090/msh""; client.Receipt = new EBReceipt(server.Receipt.RefToMessageId, server.Receipt.Content); client.ReceiptReplyMode = As4clientReceiptReplyModes.rrmAsync; client.SendReceipt();

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.

AgreementRef Property (AS4Client Class)

The agreement reference.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAgreementRef();
int SetAgreementRef(const char* lpszAgreementRef);

Unicode (Windows)
LPWSTR GetAgreementRef();
INT SetAgreementRef(LPCWSTR lpszAgreementRef);

char* ipworksedi_as4client_getagreementref(void* lpObj);
int ipworksedi_as4client_setagreementref(void* lpObj, const char* lpszAgreementRef);

QString GetAgreementRef();
int SetAgreementRef(QString qsAgreementRef);

Default Value

""

Remarks

This property holds a value identifying the agreement between the two parties. The agreement is made outside the scope of the request and response and governs details about the interaction including reply mode, signing and encryption options, etc.

The value of this property should be set to a mutually agreed upon identifier. Both parties will use this value know what the expected requirements are for a particular request or response.

The format of this value is typically a URI, such as "http://mycompany.com/agreement_01" but can be any unique string that both parties are configured to accept. Another common format is the concatenation of the AS4From and AS4To values.

This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:CollaborationInfo/eb:AgreementRef"

Data Type

String

AS4From Property (AS4Client Class)

Defines information about the originating party.

Syntax

• C++
• C
• Qt

IPWorksEDIEBPartyInfo* GetAS4From();
int SetAS4From(IPWorksEDIEBPartyInfo* val);

char* ipworksedi_as4client_getas4fromid(void* lpObj);
int ipworksedi_as4client_setas4fromid(void* lpObj, const char* lpszAS4FromId);

char* ipworksedi_as4client_getas4fromidtype(void* lpObj);
int ipworksedi_as4client_setas4fromidtype(void* lpObj, const char* lpszAS4FromIdType);

char* ipworksedi_as4client_getas4fromrole(void* lpObj);
int ipworksedi_as4client_setas4fromrole(void* lpObj, const char* lpszAS4FromRole);

QString GetAS4FromId();
int SetAS4FromId(QString qsAS4FromId);

QString GetAS4FromIdType();
int SetAS4FromIdType(QString qsAS4FromIdType);

QString GetAS4FromRole();
int SetAS4FromRole(QString qsAS4FromRole);

Remarks

This property defines information about the party that originates the message.

Data Type

IPWorksEDIEBPartyInfo

AS4To Property (AS4Client Class)

Defines information about the responding party.

Syntax

• C++
• C
• Qt

IPWorksEDIEBPartyInfo* GetAS4To();
int SetAS4To(IPWorksEDIEBPartyInfo* val);

char* ipworksedi_as4client_getas4toid(void* lpObj);
int ipworksedi_as4client_setas4toid(void* lpObj, const char* lpszAS4ToId);

char* ipworksedi_as4client_getas4toidtype(void* lpObj);
int ipworksedi_as4client_setas4toidtype(void* lpObj, const char* lpszAS4ToIdType);

char* ipworksedi_as4client_getas4torole(void* lpObj);
int ipworksedi_as4client_setas4torole(void* lpObj, const char* lpszAS4ToRole);

QString GetAS4ToId();
int SetAS4ToId(QString qsAS4ToId);

QString GetAS4ToIdType();
int SetAS4ToIdType(QString qsAS4ToIdType);

QString GetAS4ToRole();
int SetAS4ToRole(QString qsAS4ToRole);

Remarks

This property defines information about the party that receives the message.

Data Type

IPWorksEDIEBPartyInfo

AsyncReceiptInfoDir Property (AS4Client Class)

A directory to hold information used for asynchronous receipt verification.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAsyncReceiptInfoDir();
int SetAsyncReceiptInfoDir(const char* lpszAsyncReceiptInfoDir);

Unicode (Windows)
LPWSTR GetAsyncReceiptInfoDir();
INT SetAsyncReceiptInfoDir(LPCWSTR lpszAsyncReceiptInfoDir);

char* ipworksedi_as4client_getasyncreceiptinfodir(void* lpObj);
int ipworksedi_as4client_setasyncreceiptinfodir(void* lpObj, const char* lpszAsyncReceiptInfoDir);

QString GetAsyncReceiptInfoDir();
int SetAsyncReceiptInfoDir(QString qsAsyncReceiptInfoDir);

Default Value

""

Remarks

This setting specifies a directory which holds information about the original message that was sent.

When sending files and requesting asynchronous receipts set this directory to a location where data can be stored. When the receipt is later received this property should be set so original message information can be read in order to verify the receipt.

As an alternative the original message information may be manually stored by saving the values of OriginalSOAPMessage and OriginalSOAPMessageId after sending a file. In this case OriginalSOAPMessage and OriginalSOAPMessageId should be populated before verifying the receipt.

See the VerifyReceipt method of AS4Server for more details about verifying asynchronous receipts.

Data Type

String

Certificate Property (AS4Client Class)

The certificate with private key used for decryption.

Syntax

• C++
• C
• Qt

IPWorksEDICertificate* GetCertificate();
int SetCertificate(IPWorksEDICertificate* val);

int ipworksedi_as4client_getcertstore(void* lpObj, char** lpCertStore, int* lenCertStore);
int ipworksedi_as4client_setcertstore(void* lpObj, const char* lpCertStore, int lenCertStore);

char* ipworksedi_as4client_getcertstorepassword(void* lpObj);
int ipworksedi_as4client_setcertstorepassword(void* lpObj, const char* lpszCertStorePassword);

int ipworksedi_as4client_getcertstoretype(void* lpObj);
int ipworksedi_as4client_setcertstoretype(void* lpObj, int iCertStoreType);

char* ipworksedi_as4client_getcertsubject(void* lpObj);
int ipworksedi_as4client_setcertsubject(void* lpObj, const char* lpszCertSubject);

int ipworksedi_as4client_getcertencoded(void* lpObj, char** lpCertEncoded, int* lenCertEncoded);
int ipworksedi_as4client_setcertencoded(void* lpObj, const char* lpCertEncoded, int lenCertEncoded);

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

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

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

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

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

Remarks

This property specifies a certificate with private key. It is used to decrypt received files.

Data Type

IPWorksEDICertificate

CompressionFormat Property (AS4Client Class)

The compression format (if any) to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCompressionFormat();
int SetCompressionFormat(int iCompressionFormat);

Unicode (Windows)
INT GetCompressionFormat();
INT SetCompressionFormat(INT iCompressionFormat);

EBCF_NONE(0), 
EBCF_GZIP(1)

int ipworksedi_as4client_getcompressionformat(void* lpObj);
int ipworksedi_as4client_setcompressionformat(void* lpObj, int iCompressionFormat);

int GetCompressionFormat();
int SetCompressionFormat(int iCompressionFormat);

Default Value

0

Remarks

This setting specifies the compression format to be applied to the parts specified by EDIData. When Profile is set to Standard the default value is 0 (ebcfNone). When Profile is set to ENTSOG or eDelivery the default value is 1 (ebcfGZIP).

Possible values are:

• 0 (ebcfNone - default for Standard)
• 1 (ebcfGZIP - default for ENTSOG and eDelivery)

Note: When Profile is set to Standard the first EDIData part will be included in the SOAP body if the EDIType is "text/xml" or "application/xml". In that case since the data is included in the SOAP body it will not be compressed. When Profile is set to ENTSOG all EDIData parts are compressed.

Data Type

Integer

ConversationId Property (AS4Client Class)

The Conversation Id of the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConversationId();
int SetConversationId(const char* lpszConversationId);

Unicode (Windows)
LPWSTR GetConversationId();
INT SetConversationId(LPCWSTR lpszConversationId);

char* ipworksedi_as4client_getconversationid(void* lpObj);
int ipworksedi_as4client_setconversationid(void* lpObj, const char* lpszConversationId);

QString GetConversationId();
int SetConversationId(QString qsConversationId);

Default Value

""

Remarks

This property specifies an Id that may be used to identify a set of related messages. This is required and if a value is not specified one will automatically be created.

Note: When Profile is set to ebpfENTSOG this value will always be empty.

This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:CollaborationInfo/eb:ConversationId"

Data Type

String

Cookies Property (AS4Client Class)

A collection of cookies.

Syntax

• C++
• C
• Qt

IPWorksEDIList<IPWorksEDIHTTPCookie>* GetCookies();
int SetCookies(IPWorksEDIList<IPWorksEDIHTTPCookie>* val);

int ipworksedi_as4client_getcookiecount(void* lpObj);
int ipworksedi_as4client_setcookiecount(void* lpObj, int iCookieCount);

char* ipworksedi_as4client_getcookiedomain(void* lpObj, int cookieindex);

char* ipworksedi_as4client_getcookieexpiration(void* lpObj, int cookieindex);

char* ipworksedi_as4client_getcookiename(void* lpObj, int cookieindex);
int ipworksedi_as4client_setcookiename(void* lpObj, int cookieindex, const char* lpszCookieName);

char* ipworksedi_as4client_getcookiepath(void* lpObj, int cookieindex);

int ipworksedi_as4client_getcookiesecure(void* lpObj, int cookieindex);

char* ipworksedi_as4client_getcookievalue(void* lpObj, int cookieindex);
int ipworksedi_as4client_setcookievalue(void* lpObj, int cookieindex, const char* lpszCookieValue);

int GetCookieCount();
int SetCookieCount(int iCookieCount);

QString GetCookieDomain(int iCookieIndex);

QString GetCookieExpiration(int iCookieIndex);

QString GetCookieName(int iCookieIndex);
int SetCookieName(int iCookieIndex, QString qsCookieName);

QString GetCookiePath(int iCookieIndex);

bool GetCookieSecure(int iCookieIndex);

QString GetCookieValue(int iCookieIndex);
int SetCookieValue(int iCookieIndex, QString qsCookieValue);

Remarks

This property contains a collection of cookies. To add cookies to outgoing HTTP requests, add cookies (of type HTTPCookie) to this collection.

To see cookies that are set by the server, use the SetCookie event, which displays the cookies and their properties as set by the server. Those cookies also are added to Cookies.

MaxHTTPCookies can be used to control the maximum number of cookies saved.

This property is not available at design time.

Data Type

IPWorksEDIHTTPCookie

EDIData Property (AS4Client Class)

The EDI data.

Syntax

• C++
• C
• Qt

IPWorksEDIList<IPWorksEDIEBData>* GetEDIData();
int SetEDIData(IPWorksEDIList<IPWorksEDIEBData>* val);

int ipworksedi_as4client_getedidatacount(void* lpObj);
int ipworksedi_as4client_setedidatacount(void* lpObj, int iEDIDataCount);

int ipworksedi_as4client_getedidata(void* lpObj, int edidataindex, char** lpEDIData, int* lenEDIData);
int ipworksedi_as4client_setedidata(void* lpObj, int edidataindex, const char* lpEDIData, int lenEDIData);

char* ipworksedi_as4client_getedieditype(void* lpObj, int edidataindex);
int ipworksedi_as4client_setedieditype(void* lpObj, int edidataindex, const char* lpszEDIEDIType);

char* ipworksedi_as4client_getedifilename(void* lpObj, int edidataindex);
int ipworksedi_as4client_setedifilename(void* lpObj, int edidataindex, const char* lpszEDIFileName);

char* ipworksedi_as4client_getediname(void* lpObj, int edidataindex);
int ipworksedi_as4client_setediname(void* lpObj, int edidataindex, const char* lpszEDIName);

int ipworksedi_as4client_getedipropertycount(void* lpObj, int edidataindex);
int ipworksedi_as4client_setedipropertycount(void* lpObj, int edidataindex, int iEDIPropertyCount);

int ipworksedi_as4client_getedipropertyindex(void* lpObj, int edidataindex);
int ipworksedi_as4client_setedipropertyindex(void* lpObj, int edidataindex, int iEDIPropertyIndex);

char* ipworksedi_as4client_getedipropertyname(void* lpObj, int edidataindex);
int ipworksedi_as4client_setedipropertyname(void* lpObj, int edidataindex, const char* lpszEDIPropertyName);

char* ipworksedi_as4client_getedipropertyvalue(void* lpObj, int edidataindex);
int ipworksedi_as4client_setedipropertyvalue(void* lpObj, int edidataindex, const char* lpszEDIPropertyValue);

char* ipworksedi_as4client_getedischemalocation(void* lpObj, int edidataindex);
int ipworksedi_as4client_setedischemalocation(void* lpObj, int edidataindex, const char* lpszEDISchemaLocation);

char* ipworksedi_as4client_getedischemanamespace(void* lpObj, int edidataindex);
int ipworksedi_as4client_setedischemanamespace(void* lpObj, int edidataindex, const char* lpszEDISchemaNamespace);

char* ipworksedi_as4client_getedischemaversion(void* lpObj, int edidataindex);
int ipworksedi_as4client_setedischemaversion(void* lpObj, int edidataindex, const char* lpszEDISchemaVersion);

int GetEDIDataCount();
int SetEDIDataCount(int iEDIDataCount);

QByteArray GetEDIData(int iEDIDataIndex);
int SetEDIData(int iEDIDataIndex, QByteArray qbaEDIData);

QString GetEDIEDIType(int iEDIDataIndex);
int SetEDIEDIType(int iEDIDataIndex, QString qsEDIEDIType);

QString GetEDIFileName(int iEDIDataIndex);
int SetEDIFileName(int iEDIDataIndex, QString qsEDIFileName);

QString GetEDIName(int iEDIDataIndex);
int SetEDIName(int iEDIDataIndex, QString qsEDIName);

int GetEDIPropertyCount(int iEDIDataIndex);
int SetEDIPropertyCount(int iEDIDataIndex, int iEDIPropertyCount);

int GetEDIPropertyIndex(int iEDIDataIndex);
int SetEDIPropertyIndex(int iEDIDataIndex, int iEDIPropertyIndex);

QString GetEDIPropertyName(int iEDIDataIndex);
int SetEDIPropertyName(int iEDIDataIndex, QString qsEDIPropertyName);

QString GetEDIPropertyValue(int iEDIDataIndex);
int SetEDIPropertyValue(int iEDIDataIndex, QString qsEDIPropertyValue);

QString GetEDISchemaLocation(int iEDIDataIndex);
int SetEDISchemaLocation(int iEDIDataIndex, QString qsEDISchemaLocation);

QString GetEDISchemaNamespace(int iEDIDataIndex);
int SetEDISchemaNamespace(int iEDIDataIndex, QString qsEDISchemaNamespace);

QString GetEDISchemaVersion(int iEDIDataIndex);
int SetEDISchemaVersion(int iEDIDataIndex, QString qsEDISchemaVersion);

Remarks

This property defines the EDI data to be sent. This may include multiple files.

This property is not available at design time.

Data Type

IPWorksEDIEBData

EncryptionAlgorithm Property (AS4Client Class)

The algorithm used to encrypt the EDI data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEncryptionAlgorithm();
int SetEncryptionAlgorithm(const char* lpszEncryptionAlgorithm);

Unicode (Windows)
LPWSTR GetEncryptionAlgorithm();
INT SetEncryptionAlgorithm(LPCWSTR lpszEncryptionAlgorithm);

char* ipworksedi_as4client_getencryptionalgorithm(void* lpObj);
int ipworksedi_as4client_setencryptionalgorithm(void* lpObj, const char* lpszEncryptionAlgorithm);

QString GetEncryptionAlgorithm();
int SetEncryptionAlgorithm(QString qsEncryptionAlgorithm);

Default Value

"AES128GCM"

Remarks

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

The class supports "3DES", or industry-standard 168-bit Triple-DES encryption.

The class supports "AES" encryption with a default keysize of 128 bits. You may also set "AESCBC192" or "AESCBC256" for 192- and 256-bit keysizes.

Possible values are:

• 3DES
• DES
• AESCBC128
• AESCBC192
• AESCBC256
• AES128GCM (default)
• AES192GCM
• AES256GCM

Data Type

String

Errors Property (AS4Client Class)

A collection of errors.

Syntax

• C++
• C
• Qt

IPWorksEDIList<IPWorksEDIEBError>* GetErrors();
int SetErrors(IPWorksEDIList<IPWorksEDIEBError>* val);

int ipworksedi_as4client_geterrorcount(void* lpObj);
int ipworksedi_as4client_seterrorcount(void* lpObj, int iErrorCount);

char* ipworksedi_as4client_geterrorcategory(void* lpObj, int errorindex);
int ipworksedi_as4client_seterrorcategory(void* lpObj, int errorindex, const char* lpszErrorCategory);

char* ipworksedi_as4client_geterrorcode(void* lpObj, int errorindex);
int ipworksedi_as4client_seterrorcode(void* lpObj, int errorindex, const char* lpszErrorCode);

char* ipworksedi_as4client_geterrordescription(void* lpObj, int errorindex);
int ipworksedi_as4client_seterrordescription(void* lpObj, int errorindex, const char* lpszErrorDescription);

char* ipworksedi_as4client_geterrordetail(void* lpObj, int errorindex);
int ipworksedi_as4client_seterrordetail(void* lpObj, int errorindex, const char* lpszErrorDetail);

char* ipworksedi_as4client_geterrororigin(void* lpObj, int errorindex);
int ipworksedi_as4client_seterrororigin(void* lpObj, int errorindex, const char* lpszErrorOrigin);

char* ipworksedi_as4client_geterrorrefmessageid(void* lpObj, int errorindex);
int ipworksedi_as4client_seterrorrefmessageid(void* lpObj, int errorindex, const char* lpszErrorRefMessageId);

int ipworksedi_as4client_geterrorseverity(void* lpObj, int errorindex);
int ipworksedi_as4client_seterrorseverity(void* lpObj, int errorindex, int iErrorSeverity);

char* ipworksedi_as4client_geterrorshortdescription(void* lpObj, int errorindex);
int ipworksedi_as4client_seterrorshortdescription(void* lpObj, int errorindex, const char* lpszErrorShortDescription);

int GetErrorCount();
int SetErrorCount(int iErrorCount);

QString GetErrorCategory(int iErrorIndex);
int SetErrorCategory(int iErrorIndex, QString qsErrorCategory);

QString GetErrorCode(int iErrorIndex);
int SetErrorCode(int iErrorIndex, QString qsErrorCode);

QString GetErrorDescription(int iErrorIndex);
int SetErrorDescription(int iErrorIndex, QString qsErrorDescription);

QString GetErrorDetail(int iErrorIndex);
int SetErrorDetail(int iErrorIndex, QString qsErrorDetail);

QString GetErrorOrigin(int iErrorIndex);
int SetErrorOrigin(int iErrorIndex, QString qsErrorOrigin);

QString GetErrorRefMessageId(int iErrorIndex);
int SetErrorRefMessageId(int iErrorIndex, QString qsErrorRefMessageId);

int GetErrorSeverity(int iErrorIndex);
int SetErrorSeverity(int iErrorIndex, int iErrorSeverity);

QString GetErrorShortDescription(int iErrorIndex);
int SetErrorShortDescription(int iErrorIndex, QString qsErrorShortDescription);

Remarks

This property is populated with error information. There may be one or more errors.

Common errors defined in the ebMS specifications are listed below for reference.

Data Type

IPWorksEDIEBError

Firewall Property (AS4Client Class)

A set of properties related to firewall access.

Syntax

• C++
• C
• Qt

IPWorksEDIFirewall* GetFirewall();
int SetFirewall(IPWorksEDIFirewall* val);

int ipworksedi_as4client_getfirewallautodetect(void* lpObj);
int ipworksedi_as4client_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

int ipworksedi_as4client_getfirewalltype(void* lpObj);
int ipworksedi_as4client_setfirewalltype(void* lpObj, int iFirewallType);

char* ipworksedi_as4client_getfirewallhost(void* lpObj);
int ipworksedi_as4client_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

char* ipworksedi_as4client_getfirewallpassword(void* lpObj);
int ipworksedi_as4client_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

int ipworksedi_as4client_getfirewallport(void* lpObj);
int ipworksedi_as4client_setfirewallport(void* lpObj, int iFirewallPort);

char* ipworksedi_as4client_getfirewalluser(void* lpObj);
int ipworksedi_as4client_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

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

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

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

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

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

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

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the class will attempt to connect.

Data Type

IPWorksEDIFirewall

IncomingDirectory Property (AS4Client Class)

The directory to which incoming files are saved.

Syntax

• C++
• C
• Qt

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

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

char* ipworksedi_as4client_getincomingdirectory(void* lpObj);
int ipworksedi_as4client_setincomingdirectory(void* lpObj, const char* lpszIncomingDirectory);

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

Default Value

""

Remarks

If IncomingDirectory is set, the received files will be stored in the specified directory. If a filename is specified in the EDI message, the component 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.

This property is optional, if not set file data will be stored in EDIData.

Data Type

String

LocalHost Property (AS4Client 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_as4client_getlocalhost(void* lpObj);
int ipworksedi_as4client_setlocalhost(void* lpObj, const char* lpszLocalHost);

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

Default Value

""

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

Note: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

LogDirectory Property (AS4Client 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_as4client_getlogdirectory(void* lpObj);
int ipworksedi_as4client_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 files for each transmission, with separate extensions for each type of data:

One or more of these log files 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 (AS4Client Class)

The log file written.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLogFile();

Unicode (Windows)
LPWSTR GetLogFile();

char* ipworksedi_as4client_getlogfile(void* lpObj);

QString GetLogFile();

Default Value

""

Remarks

If 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 written, minus the extension.

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

One or more of these log files 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.

This property is read-only.

Data Type

String

MessageId Property (AS4Client Class)

The unique Id of the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageId();
int SetMessageId(const char* lpszMessageId);

Unicode (Windows)
LPWSTR GetMessageId();
INT SetMessageId(LPCWSTR lpszMessageId);

char* ipworksedi_as4client_getmessageid(void* lpObj);
int ipworksedi_as4client_setmessageid(void* lpObj, const char* lpszMessageId);

QString GetMessageId();
int SetMessageId(QString qsMessageId);

Default Value

""

Remarks

This property defines the unique Id of the message. When sending files the class will automatically generate a value in the format "GUID@nsoftware". When receiving files the Id will be populated with the value read from the message.

In most cases there is no need to set this value, however if a file needs to be retransmitted using the same message Id for reliability this may be set. In AS4Client this may be set before calling SendFiles. In AS4Server this may be set after calling ReadRequest and before calling SendResponse.

This property is not available at design time.

Data Type

String

MessageProperties Property (AS4Client Class)

A collection of message properties.

Syntax

• C++
• C
• Qt

IPWorksEDIList<IPWorksEDIEBProperty>* GetMessageProperties();
int SetMessageProperties(IPWorksEDIList<IPWorksEDIEBProperty>* val);

int ipworksedi_as4client_getmessagepropertycount(void* lpObj);
int ipworksedi_as4client_setmessagepropertycount(void* lpObj, int iMessagePropertyCount);

char* ipworksedi_as4client_getmessagepropertyname(void* lpObj, int messagepropertyindex);
int ipworksedi_as4client_setmessagepropertyname(void* lpObj, int messagepropertyindex, const char* lpszMessagePropertyName);

char* ipworksedi_as4client_getmessagepropertypropertytype(void* lpObj, int messagepropertyindex);
int ipworksedi_as4client_setmessagepropertypropertytype(void* lpObj, int messagepropertyindex, const char* lpszMessagePropertyPropertyType);

char* ipworksedi_as4client_getmessagepropertyvalue(void* lpObj, int messagepropertyindex);
int ipworksedi_as4client_setmessagepropertyvalue(void* lpObj, int messagepropertyindex, const char* lpszMessagePropertyValue);

int GetMessagePropertyCount();
int SetMessagePropertyCount(int iMessagePropertyCount);

QString GetMessagePropertyName(int iMessagePropertyIndex);
int SetMessagePropertyName(int iMessagePropertyIndex, QString qsMessagePropertyName);

QString GetMessagePropertyPropertyType(int iMessagePropertyIndex);
int SetMessagePropertyPropertyType(int iMessagePropertyIndex, QString qsMessagePropertyPropertyType);

QString GetMessagePropertyValue(int iMessagePropertyIndex);
int SetMessagePropertyValue(int iMessagePropertyIndex, QString qsMessagePropertyValue);

Remarks

This collection specifies the message level properties that are sent with the message. This may be used to add additional values. The semantics of the values are beyond the scope of AS4, but this may be used for values that assist with processing, or other user-defined use cases.

These properties may be populated before sending a message, and are populated after parsing an incoming message.

Sending

When sending a message any number of properties may be added. The PropertyType field is optional. For instance: //using fields client.MessageProperties.Add(new EBProperty()); client.MessageProperties[0].Name = "name1"; client.MessageProperties[0].Value = "value1"; client.MessageProperties[0].PropertyType = "string"; //optional //using constructor client.MessageProperties.Add(new EBProperty("name2", "value2"));

Receiving

When receiving a message the properties may be read from this collection. For instance: for (int i = 0; i < server.MessageProperties.Count; i++) { Console.WriteLine(server.MessageProperties[i].Name + ": " + server.MessageProperties[i].Value); }

This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:MessageProperties""

Data Type

IPWorksEDIEBProperty

MPC Property (AS4Client Class)

The MPC (Message Partition Channel) from which to receive files.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMPC();
int SetMPC(const char* lpszMPC);

Unicode (Windows)
LPWSTR GetMPC();
INT SetMPC(LPCWSTR lpszMPC);

char* ipworksedi_as4client_getmpc(void* lpObj);
int ipworksedi_as4client_setmpc(void* lpObj, const char* lpszMPC);

QString GetMPC();
int SetMPC(QString qsMPC);

Default Value

""

Remarks

This property specifies the MPC (Message Partition Channel) from which to receive files. This must be set before calling ReceiveFiles. The value specified here must be known to the other party.

When left unspecified this indicates the default MPC.

This value corresponds to the ebMS element "eb:Messaging/eb:SignalMessage/eb:PullRequest/@mpc"

Data Type

String

OriginalSOAPMessage Property (AS4Client Class)

The original SOAP message used to verify the receipt.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOriginalSOAPMessage();
int SetOriginalSOAPMessage(const char* lpszOriginalSOAPMessage);

Unicode (Windows)
LPWSTR GetOriginalSOAPMessage();
INT SetOriginalSOAPMessage(LPCWSTR lpszOriginalSOAPMessage);

char* ipworksedi_as4client_getoriginalsoapmessage(void* lpObj);
int ipworksedi_as4client_setoriginalsoapmessage(void* lpObj, const char* lpszOriginalSOAPMessage);

QString GetOriginalSOAPMessage();
int SetOriginalSOAPMessage(QString qsOriginalSOAPMessage);

Default Value

""

Remarks

OriginalSOAPMessage and OriginalSOAPMessageId may be used as an alternative to AsyncReceiptInfoDir when verifying receipts.

If AsyncReceiptInfoDir is not set when the original message is sent, these values will be populated after the send and the values should be saved.

Before verifying the receipt set these properties to their original values.

This property is not available at design time.

Data Type

String

OriginalSOAPMessageId Property (AS4Client Class)

The original SOAP message Id used to verify the receipt.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOriginalSOAPMessageId();
int SetOriginalSOAPMessageId(const char* lpszOriginalSOAPMessageId);

Unicode (Windows)
LPWSTR GetOriginalSOAPMessageId();
INT SetOriginalSOAPMessageId(LPCWSTR lpszOriginalSOAPMessageId);

char* ipworksedi_as4client_getoriginalsoapmessageid(void* lpObj);
int ipworksedi_as4client_setoriginalsoapmessageid(void* lpObj, const char* lpszOriginalSOAPMessageId);

QString GetOriginalSOAPMessageId();
int SetOriginalSOAPMessageId(QString qsOriginalSOAPMessageId);

Default Value

""

Remarks

OriginalSOAPMessage and OriginalSOAPMessageId may be used as an alternative to AsyncReceiptInfoDir when verifying receipts.

If AsyncReceiptInfoDir is not set when the original message is sent, these values will be populated after the send and the values should be saved.

Before verifying the receipt set these properties to their original values.

This property is not available at design time.

Data Type

String

Profile Property (AS4Client Class)

The AS4 profile.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProfile();
int SetProfile(int iProfile);

Unicode (Windows)
INT GetProfile();
INT SetProfile(INT iProfile);

EBPF_STANDARD(0), 
EBPF_ENTSOG(1), 
EBPF_EDELIVERY(2), 
EBPF_BDEW(3), 
EBPF_ENTSOG_V4(4), 
EBPF_EDELIVERY_V2(5)

int ipworksedi_as4client_getprofile(void* lpObj);
int ipworksedi_as4client_setprofile(void* lpObj, int iProfile);

int GetProfile();
int SetProfile(int iProfile);

Default Value

0

Remarks

This property specifies the AS4 profile to use. Different profiles may have different requirements and default options. Setting this property to the correct value ensures that the right options are selected in order to conform to the profile. Possible values are:

When Profile is set to ebpfENTSOG the following settings are automatically applied:

When Profile is set to ebpfENTSOG_V4, version 4 of the ENTSOG profile is used and the following settings are automatically applied:

When Profile is set to ebpfEDelivery the following settings are automatically applied:

When Profile is set to ebpfEDelivery_V2, version 2 of the eDelivery profile is used and the following settings are automatically applied:

When Profile is set to ebpfBDEW the following settings are automatically applied:

Data Type

Integer

Proxy Property (AS4Client Class)

A set of properties related to proxy access.

Syntax

• C++
• C
• Qt

IPWorksEDIProxy* GetProxy();
int SetProxy(IPWorksEDIProxy* val);

int ipworksedi_as4client_getproxyauthscheme(void* lpObj);
int ipworksedi_as4client_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);

int ipworksedi_as4client_getproxyautodetect(void* lpObj);
int ipworksedi_as4client_setproxyautodetect(void* lpObj, int bProxyAutoDetect);

char* ipworksedi_as4client_getproxypassword(void* lpObj);
int ipworksedi_as4client_setproxypassword(void* lpObj, const char* lpszProxyPassword);

int ipworksedi_as4client_getproxyport(void* lpObj);
int ipworksedi_as4client_setproxyport(void* lpObj, int iProxyPort);

char* ipworksedi_as4client_getproxyserver(void* lpObj);
int ipworksedi_as4client_setproxyserver(void* lpObj, const char* lpszProxyServer);

int ipworksedi_as4client_getproxyssl(void* lpObj);
int ipworksedi_as4client_setproxyssl(void* lpObj, int iProxySSL);

char* ipworksedi_as4client_getproxyuser(void* lpObj);
int ipworksedi_as4client_setproxyuser(void* lpObj, const char* lpszProxyUser);

int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

bool GetProxyAutoDetect();
int SetProxyAutoDetect(bool bProxyAutoDetect);

QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);

int GetProxyPort();
int SetProxyPort(int iProxyPort);

QString GetProxyServer();
int SetProxyServer(QString qsProxyServer);

int GetProxySSL();
int SetProxySSL(int iProxySSL);

QString GetProxyUser();
int SetProxyUser(QString qsProxyUser);

Remarks

This property contains fields describing the proxy through which the class will attempt to connect.

Data Type

IPWorksEDIProxy

Receipt Property (AS4Client Class)

The receipt of a message.

Syntax

• C++
• C
• Qt

IPWorksEDIEBReceipt* GetReceipt();
int SetReceipt(IPWorksEDIEBReceipt* val);

char* ipworksedi_as4client_getreceiptcontent(void* lpObj);
int ipworksedi_as4client_setreceiptcontent(void* lpObj, const char* lpszReceiptContent);

char* ipworksedi_as4client_getreceiptreftomessageid(void* lpObj);
int ipworksedi_as4client_setreceiptreftomessageid(void* lpObj, const char* lpszReceiptRefToMessageId);

QString GetReceiptContent();
int SetReceiptContent(QString qsReceiptContent);

QString GetReceiptRefToMessageId();
int SetReceiptRefToMessageId(QString qsReceiptRefToMessageId);

Remarks

This property holds the receipt of a message.

Sending

When sending files if a synchronous receipt is returned in the response it is verified and this property is populated.

Receiving

When receiving files this property is populated with the receipt to send after a file is received. If this property is populated the receipt will be sent in the next request made by calling ReceiveFiles.

If the receipt is not to be bundled with a subsequent call to ReceiveFiles the SendReceipt method may be used to directly send a receipt to the other party.

Data Type

IPWorksEDIEBReceipt

ReceiptReplyMode Property (AS4Client Class)

The expected receipt reply mode.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetReceiptReplyMode();
int SetReceiptReplyMode(int iReceiptReplyMode);

Unicode (Windows)
INT GetReceiptReplyMode();
INT SetReceiptReplyMode(INT iReceiptReplyMode);

RRM_SYNC(0), 
RRM_ASYNC(1), 
RRM_NONE(2)

int ipworksedi_as4client_getreceiptreplymode(void* lpObj);
int ipworksedi_as4client_setreceiptreplymode(void* lpObj, int iReceiptReplyMode);

int GetReceiptReplyMode();
int SetReceiptReplyMode(int iReceiptReplyMode);

Default Value

0

Remarks

This setting tells the class how to expect or deliver a receipt. Possible values are:

It is important to always set this property to the correct value in both AS4Client and AS4Server, whether sending or receiving, so the class can build a valid message. This should be set to the previously agreed upon value between the parties in the agreement identified by AgreementRef

Data Type

Integer

RecipientCerts Property (AS4Client Class)

The public certificate used to encrypt files when sending.

Syntax

• C++
• C
• Qt

IPWorksEDIList<IPWorksEDICertificate>* GetRecipientCerts();
int SetRecipientCerts(IPWorksEDIList<IPWorksEDICertificate>* val);

int ipworksedi_as4client_getrecipientcertcount(void* lpObj);
int ipworksedi_as4client_setrecipientcertcount(void* lpObj, int iRecipientCertCount);

int ipworksedi_as4client_getrecipientcertencoded(void* lpObj, int recipientcertindex, char** lpRecipientCertEncoded, int* lenRecipientCertEncoded);
int ipworksedi_as4client_setrecipientcertencoded(void* lpObj, int recipientcertindex, const char* lpRecipientCertEncoded, int lenRecipientCertEncoded);

int GetRecipientCertCount();
int SetRecipientCertCount(int iRecipientCertCount);

QByteArray GetRecipientCertEncoded(int iRecipientCertIndex);
int SetRecipientCertEncoded(int iRecipientCertIndex, QByteArray qbaRecipientCertEncoded);

Remarks

The encryption certificates of the recipients. If this property is specified, the files being sent will be encrypted using the algorithm given by EncryptionAlgorithm.

This property is not available at design time.

Data Type

IPWorksEDICertificate

RefToMessageId Property (AS4Client Class)

Specifies the RefToMessageId in the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRefToMessageId();
int SetRefToMessageId(const char* lpszRefToMessageId);

Unicode (Windows)
LPWSTR GetRefToMessageId();
INT SetRefToMessageId(LPCWSTR lpszRefToMessageId);

char* ipworksedi_as4client_getreftomessageid(void* lpObj);
int ipworksedi_as4client_setreftomessageid(void* lpObj, const char* lpszRefToMessageId);

QString GetRefToMessageId();
int SetRefToMessageId(QString qsRefToMessageId);

Default Value

""

Remarks

This property specifies the RefToMessageId value in the message being sent.

This property is only applicable when Profile is set to ebpfEDelivery. The eDelivery profile supports the Two-Way/Push-and-Push MEP (Message Exchange Pattern), where sending a file can be in reference to a previously received file. In this case RefToMessageId specifies the Id of the previously received message to which this send is in reference.

When sending with AS4Client this should only be set when using the eDelivery profile and need to explicitly specify the RefToMessageId value as per the Two-Way/Push-And-Push MEP.

When receiving with AS4Server this may be read after receiving a message.

Data Type

String

RolloverCertificate Property (AS4Client Class)

The rollover decryption certificate.

Syntax

• C++
• C
• Qt

IPWorksEDICertificate* GetRolloverCertificate();
int SetRolloverCertificate(IPWorksEDICertificate* val);

int ipworksedi_as4client_getrollovercertstore(void* lpObj, char** lpRolloverCertStore, int* lenRolloverCertStore);
int ipworksedi_as4client_setrollovercertstore(void* lpObj, const char* lpRolloverCertStore, int lenRolloverCertStore);

char* ipworksedi_as4client_getrollovercertstorepassword(void* lpObj);
int ipworksedi_as4client_setrollovercertstorepassword(void* lpObj, const char* lpszRolloverCertStorePassword);

int ipworksedi_as4client_getrollovercertstoretype(void* lpObj);
int ipworksedi_as4client_setrollovercertstoretype(void* lpObj, int iRolloverCertStoreType);

char* ipworksedi_as4client_getrollovercertsubject(void* lpObj);
int ipworksedi_as4client_setrollovercertsubject(void* lpObj, const char* lpszRolloverCertSubject);

int ipworksedi_as4client_getrollovercertencoded(void* lpObj, char** lpRolloverCertEncoded, int* lenRolloverCertEncoded);
int ipworksedi_as4client_setrollovercertencoded(void* lpObj, const char* lpRolloverCertEncoded, int lenRolloverCertEncoded);

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

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

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

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

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

Remarks

The rollover digital certificate that the class will use to decrypt incoming transmissions. This may be used to specify an additional decryption certificate during a period of transition between private certificates in the application.

When specified the class will be able to decrypt messages that were encrypted with the corresponding public certificate of either Certificate or RolloverCertificate.

RolloverCertificate must be set to a private key certificate.

Data Type

IPWorksEDICertificate

RolloverSigningCert Property (AS4Client Class)

Contains the certificate to use when signing messages.

Syntax

• C++
• C
• Qt

IPWorksEDICertificate* GetRolloverSigningCert();
int SetRolloverSigningCert(IPWorksEDICertificate* val);

int ipworksedi_as4client_getrolloversigningcertstore(void* lpObj, char** lpRolloverSigningCertStore, int* lenRolloverSigningCertStore);
int ipworksedi_as4client_setrolloversigningcertstore(void* lpObj, const char* lpRolloverSigningCertStore, int lenRolloverSigningCertStore);

char* ipworksedi_as4client_getrolloversigningcertstorepassword(void* lpObj);
int ipworksedi_as4client_setrolloversigningcertstorepassword(void* lpObj, const char* lpszRolloverSigningCertStorePassword);

int ipworksedi_as4client_getrolloversigningcertstoretype(void* lpObj);
int ipworksedi_as4client_setrolloversigningcertstoretype(void* lpObj, int iRolloverSigningCertStoreType);

char* ipworksedi_as4client_getrolloversigningcertsubject(void* lpObj);
int ipworksedi_as4client_setrolloversigningcertsubject(void* lpObj, const char* lpszRolloverSigningCertSubject);

int ipworksedi_as4client_getrolloversigningcertencoded(void* lpObj, char** lpRolloverSigningCertEncoded, int* lenRolloverSigningCertEncoded);
int ipworksedi_as4client_setrolloversigningcertencoded(void* lpObj, const char* lpRolloverSigningCertEncoded, int lenRolloverSigningCertEncoded);

QByteArray GetRolloverSigningCertStore();
int SetRolloverSigningCertStore(QByteArray qbaRolloverSigningCertStore);

QString GetRolloverSigningCertStorePassword();
int SetRolloverSigningCertStorePassword(QString qsRolloverSigningCertStorePassword);

int GetRolloverSigningCertStoreType();
int SetRolloverSigningCertStoreType(int iRolloverSigningCertStoreType);

QString GetRolloverSigningCertSubject();
int SetRolloverSigningCertSubject(QString qsRolloverSigningCertSubject);

QByteArray GetRolloverSigningCertEncoded();
int SetRolloverSigningCertEncoded(QByteArray qbaRolloverSigningCertEncoded);

Remarks

This is your rollover signing certificate. This may be used to specify an additional signing certificate during a period of transition between private certificates in the application.

If this property is specified, the message content will be signed using both SigningCert and RolloverSigningCert. The recipient will be able to verify the signature with either corresponding public certificate.

If set, this property should be a private key instance of Certificate.

Data Type

IPWorksEDICertificate

Service Property (AS4Client Class)

The service which acts on the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetService();
int SetService(const char* lpszService);

Unicode (Windows)
LPWSTR GetService();
INT SetService(LPCWSTR lpszService);

char* ipworksedi_as4client_getservice(void* lpObj);
int ipworksedi_as4client_setservice(void* lpObj, const char* lpszService);

QString GetService();
int SetService(QString qsService);

Default Value

"http://docs.oasis-open.org/ebxml-msg/as4/200902/service"

Remarks

This property specifies the service which acts on the message. This should only be changed from the default value if there is a specific reason to do so.

This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:CollaborationInfo/eb:Service"

Data Type

String

ServiceAction Property (AS4Client Class)

The action within a service that acts on the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServiceAction();
int SetServiceAction(const char* lpszServiceAction);

Unicode (Windows)
LPWSTR GetServiceAction();
INT SetServiceAction(LPCWSTR lpszServiceAction);

char* ipworksedi_as4client_getserviceaction(void* lpObj);
int ipworksedi_as4client_setserviceaction(void* lpObj, const char* lpszServiceAction);

QString GetServiceAction();
int SetServiceAction(QString qsServiceAction);

Default Value

"http://docs.oasis-open.org/ebxml-msg/as4/200902/action"

Remarks

This property defines the action within a service that acts upon a message. This should only be changed from the default value if there is a specific reason to do so.

This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:CollaborationInfo/eb:Action".

Data Type

String

ServiceType Property (AS4Client Class)

The type of service.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServiceType();
int SetServiceType(const char* lpszServiceType);

Unicode (Windows)
LPWSTR GetServiceType();
INT SetServiceType(LPCWSTR lpszServiceType);

char* ipworksedi_as4client_getservicetype(void* lpObj);
int ipworksedi_as4client_setservicetype(void* lpObj, const char* lpszServiceType);

QString GetServiceType();
int SetServiceType(QString qsServiceType);

Default Value

""

Remarks

This optionally specifies the type of the service. The semantics of this value should be agreed upon by both parties ahead of time. It may be used to tell the other party how to interpret the Service value.

This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:CollaborationInfo/eb:Service@type"

Data Type

String

SignatureAlgorithm Property (AS4Client Class)

Signature algorithm to be used in the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSignatureAlgorithm();
int SetSignatureAlgorithm(const char* lpszSignatureAlgorithm);

Unicode (Windows)
LPWSTR GetSignatureAlgorithm();
INT SetSignatureAlgorithm(LPCWSTR lpszSignatureAlgorithm);

char* ipworksedi_as4client_getsignaturealgorithm(void* lpObj);
int ipworksedi_as4client_setsignaturealgorithm(void* lpObj, const char* lpszSignatureAlgorithm);

QString GetSignatureAlgorithm();
int SetSignatureAlgorithm(QString qsSignatureAlgorithm);

Default Value

"sha-256"

Remarks

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

• SHA1
• MD5
• SHA-256 (or SHA256) (default)
• SHA-384 (or SHA384)
• SHA-512 (or SHA512)
• SHA-224 (or SHA224)
• ECDSA-SHA1
• ECDSA-SHA224
• ECDSA-SHA256
• ECDSA-SHA384
• ECDSA-SHA512
• EDDSA-ED25519
• EDDSA-ED448

The default value is "SHA-256".

Data Type

String

SignerCert Property (AS4Client Class)

The public certificate used to verify signatures.

Syntax

• C++
• C
• Qt

IPWorksEDICertificate* GetSignerCert();
int SetSignerCert(IPWorksEDICertificate* val);

int ipworksedi_as4client_getsignercertstore(void* lpObj, char** lpSignerCertStore, int* lenSignerCertStore);
int ipworksedi_as4client_setsignercertstore(void* lpObj, const char* lpSignerCertStore, int lenSignerCertStore);

char* ipworksedi_as4client_getsignercertstorepassword(void* lpObj);
int ipworksedi_as4client_setsignercertstorepassword(void* lpObj, const char* lpszSignerCertStorePassword);

int ipworksedi_as4client_getsignercertstoretype(void* lpObj);
int ipworksedi_as4client_setsignercertstoretype(void* lpObj, int iSignerCertStoreType);

char* ipworksedi_as4client_getsignercertsubject(void* lpObj);
int ipworksedi_as4client_setsignercertsubject(void* lpObj, const char* lpszSignerCertSubject);

int ipworksedi_as4client_getsignercertencoded(void* lpObj, char** lpSignerCertEncoded, int* lenSignerCertEncoded);
int ipworksedi_as4client_setsignercertencoded(void* lpObj, const char* lpSignerCertEncoded, int lenSignerCertEncoded);

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

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

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

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

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

Remarks

This property specifies a public certificate used to verify signatures on received messages, receipts, and files. If the content is signed by the other party, it is verified using this certificate.

Data Type

IPWorksEDICertificate

SigningCert Property (AS4Client Class)

The certificate with private key used to sign messages and files.

Syntax

• C++
• C
• Qt

IPWorksEDICertificate* GetSigningCert();
int SetSigningCert(IPWorksEDICertificate* val);

int ipworksedi_as4client_getsigningcertstore(void* lpObj, char** lpSigningCertStore, int* lenSigningCertStore);
int ipworksedi_as4client_setsigningcertstore(void* lpObj, const char* lpSigningCertStore, int lenSigningCertStore);

char* ipworksedi_as4client_getsigningcertstorepassword(void* lpObj);
int ipworksedi_as4client_setsigningcertstorepassword(void* lpObj, const char* lpszSigningCertStorePassword);

int ipworksedi_as4client_getsigningcertstoretype(void* lpObj);
int ipworksedi_as4client_setsigningcertstoretype(void* lpObj, int iSigningCertStoreType);

char* ipworksedi_as4client_getsigningcertsubject(void* lpObj);
int ipworksedi_as4client_setsigningcertsubject(void* lpObj, const char* lpszSigningCertSubject);

int ipworksedi_as4client_getsigningcertencoded(void* lpObj, char** lpSigningCertEncoded, int* lenSigningCertEncoded);
int ipworksedi_as4client_setsigningcertencoded(void* lpObj, const char* lpSigningCertEncoded, int lenSigningCertEncoded);

QByteArray GetSigningCertStore();
int SetSigningCertStore(QByteArray qbaSigningCertStore);

QString GetSigningCertStorePassword();
int SetSigningCertStorePassword(QString qsSigningCertStorePassword);

int GetSigningCertStoreType();
int SetSigningCertStoreType(int iSigningCertStoreType);

QString GetSigningCertSubject();
int SetSigningCertSubject(QString qsSigningCertSubject);

QByteArray GetSigningCertEncoded();
int SetSigningCertEncoded(QByteArray qbaSigningCertEncoded);

Remarks

This property specifies a certificate with private key used to sign outgoing messages and files. If this property is specified, the message content will be signed using the algorithm given by SignatureAlgorithm.

Used to sign any outgoing message. This applies to requests made when calling SendFiles and ReceiveFiles.

Data Type

IPWorksEDICertificate

SSLAcceptServerCert Property (AS4Client Class)

Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

• C++
• C
• Qt

IPWorksEDICertificate* GetSSLAcceptServerCert();
int SetSSLAcceptServerCert(IPWorksEDICertificate* val);

char* ipworksedi_as4client_getsslacceptservercerteffectivedate(void* lpObj);

char* ipworksedi_as4client_getsslacceptservercertexpirationdate(void* lpObj);

char* ipworksedi_as4client_getsslacceptservercertextendedkeyusage(void* lpObj);

char* ipworksedi_as4client_getsslacceptservercertfingerprint(void* lpObj);

char* ipworksedi_as4client_getsslacceptservercertfingerprintsha1(void* lpObj);

char* ipworksedi_as4client_getsslacceptservercertfingerprintsha256(void* lpObj);

char* ipworksedi_as4client_getsslacceptservercertissuer(void* lpObj);

char* ipworksedi_as4client_getsslacceptservercertprivatekey(void* lpObj);

int ipworksedi_as4client_getsslacceptservercertprivatekeyavailable(void* lpObj);

char* ipworksedi_as4client_getsslacceptservercertprivatekeycontainer(void* lpObj);

char* ipworksedi_as4client_getsslacceptservercertpublickey(void* lpObj);

char* ipworksedi_as4client_getsslacceptservercertpublickeyalgorithm(void* lpObj);

int ipworksedi_as4client_getsslacceptservercertpublickeylength(void* lpObj);

char* ipworksedi_as4client_getsslacceptservercertserialnumber(void* lpObj);

char* ipworksedi_as4client_getsslacceptservercertsignaturealgorithm(void* lpObj);

int ipworksedi_as4client_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int ipworksedi_as4client_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);

char* ipworksedi_as4client_getsslacceptservercertstorepassword(void* lpObj);
int ipworksedi_as4client_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);

int ipworksedi_as4client_getsslacceptservercertstoretype(void* lpObj);
int ipworksedi_as4client_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);

char* ipworksedi_as4client_getsslacceptservercertsubjectaltnames(void* lpObj);

char* ipworksedi_as4client_getsslacceptservercertthumbprintmd5(void* lpObj);

char* ipworksedi_as4client_getsslacceptservercertthumbprintsha1(void* lpObj);

char* ipworksedi_as4client_getsslacceptservercertthumbprintsha256(void* lpObj);

char* ipworksedi_as4client_getsslacceptservercertusage(void* lpObj);

int ipworksedi_as4client_getsslacceptservercertusageflags(void* lpObj);

char* ipworksedi_as4client_getsslacceptservercertversion(void* lpObj);

char* ipworksedi_as4client_getsslacceptservercertsubject(void* lpObj);
int ipworksedi_as4client_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);

int ipworksedi_as4client_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworksedi_as4client_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QString GetSSLAcceptServerCertEffectiveDate();

QString GetSSLAcceptServerCertExpirationDate();

QString GetSSLAcceptServerCertExtendedKeyUsage();

QString GetSSLAcceptServerCertFingerprint();

QString GetSSLAcceptServerCertFingerprintSHA1();

QString GetSSLAcceptServerCertFingerprintSHA256();

QString GetSSLAcceptServerCertIssuer();

QString GetSSLAcceptServerCertPrivateKey();

bool GetSSLAcceptServerCertPrivateKeyAvailable();

QString GetSSLAcceptServerCertPrivateKeyContainer();

QString GetSSLAcceptServerCertPublicKey();

QString GetSSLAcceptServerCertPublicKeyAlgorithm();

int GetSSLAcceptServerCertPublicKeyLength();

QString GetSSLAcceptServerCertSerialNumber();

QString GetSSLAcceptServerCertSignatureAlgorithm();

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

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

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

QString GetSSLAcceptServerCertSubjectAltNames();

QString GetSSLAcceptServerCertThumbprintMD5();

QString GetSSLAcceptServerCertThumbprintSHA1();

QString GetSSLAcceptServerCertThumbprintSHA256();

QString GetSSLAcceptServerCertUsage();

int GetSSLAcceptServerCertUsageFlags();

QString GetSSLAcceptServerCertVersion();

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

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

Remarks

If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

Data Type

IPWorksEDICertificate

SSLCert Property (AS4Client Class)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

• C++
• C
• Qt

IPWorksEDICertificate* GetSSLCert();
int SetSSLCert(IPWorksEDICertificate* val);

char* ipworksedi_as4client_getsslcerteffectivedate(void* lpObj);

char* ipworksedi_as4client_getsslcertexpirationdate(void* lpObj);

char* ipworksedi_as4client_getsslcertextendedkeyusage(void* lpObj);

char* ipworksedi_as4client_getsslcertfingerprint(void* lpObj);

char* ipworksedi_as4client_getsslcertfingerprintsha1(void* lpObj);

char* ipworksedi_as4client_getsslcertfingerprintsha256(void* lpObj);

char* ipworksedi_as4client_getsslcertissuer(void* lpObj);

char* ipworksedi_as4client_getsslcertprivatekey(void* lpObj);

int ipworksedi_as4client_getsslcertprivatekeyavailable(void* lpObj);

char* ipworksedi_as4client_getsslcertprivatekeycontainer(void* lpObj);

char* ipworksedi_as4client_getsslcertpublickey(void* lpObj);

char* ipworksedi_as4client_getsslcertpublickeyalgorithm(void* lpObj);

int ipworksedi_as4client_getsslcertpublickeylength(void* lpObj);

char* ipworksedi_as4client_getsslcertserialnumber(void* lpObj);

char* ipworksedi_as4client_getsslcertsignaturealgorithm(void* lpObj);

int ipworksedi_as4client_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworksedi_as4client_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

char* ipworksedi_as4client_getsslcertstorepassword(void* lpObj);
int ipworksedi_as4client_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

int ipworksedi_as4client_getsslcertstoretype(void* lpObj);
int ipworksedi_as4client_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

char* ipworksedi_as4client_getsslcertsubjectaltnames(void* lpObj);

char* ipworksedi_as4client_getsslcertthumbprintmd5(void* lpObj);

char* ipworksedi_as4client_getsslcertthumbprintsha1(void* lpObj);

char* ipworksedi_as4client_getsslcertthumbprintsha256(void* lpObj);

char* ipworksedi_as4client_getsslcertusage(void* lpObj);

int ipworksedi_as4client_getsslcertusageflags(void* lpObj);

char* ipworksedi_as4client_getsslcertversion(void* lpObj);

char* ipworksedi_as4client_getsslcertsubject(void* lpObj);
int ipworksedi_as4client_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

int ipworksedi_as4client_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworksedi_as4client_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QString GetSSLCertEffectiveDate();

QString GetSSLCertExpirationDate();

QString GetSSLCertExtendedKeyUsage();

QString GetSSLCertFingerprint();

QString GetSSLCertFingerprintSHA1();

QString GetSSLCertFingerprintSHA256();

QString GetSSLCertIssuer();

QString GetSSLCertPrivateKey();

bool GetSSLCertPrivateKeyAvailable();

QString GetSSLCertPrivateKeyContainer();

QString GetSSLCertPublicKey();

QString GetSSLCertPublicKeyAlgorithm();

int GetSSLCertPublicKeyLength();

QString GetSSLCertSerialNumber();

QString GetSSLCertSignatureAlgorithm();

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

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

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

QString GetSSLCertSubjectAltNames();

QString GetSSLCertThumbprintMD5();

QString GetSSLCertThumbprintSHA1();

QString GetSSLCertThumbprintSHA256();

QString GetSSLCertUsage();

int GetSSLCertUsageFlags();

QString GetSSLCertVersion();

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

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

Remarks

This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

Data Type

IPWorksEDICertificate

SSLProvider Property (AS4Client Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Unicode (Windows)
INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1), 
SSLP_INTERNAL(2)

int ipworksedi_as4client_getsslprovider(void* lpObj);
int ipworksedi_as4client_setsslprovider(void* lpObj, int iSSLProvider);

int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Default Value

0

Remarks

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

Possible values are as follows:

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

When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCert Property (AS4Client Class)

The server certificate for the last established connection.

Syntax

• C++
• C
• Qt

IPWorksEDICertificate* GetSSLServerCert();

char* ipworksedi_as4client_getsslservercerteffectivedate(void* lpObj);

char* ipworksedi_as4client_getsslservercertexpirationdate(void* lpObj);

char* ipworksedi_as4client_getsslservercertextendedkeyusage(void* lpObj);

char* ipworksedi_as4client_getsslservercertfingerprint(void* lpObj);

char* ipworksedi_as4client_getsslservercertfingerprintsha1(void* lpObj);

char* ipworksedi_as4client_getsslservercertfingerprintsha256(void* lpObj);

char* ipworksedi_as4client_getsslservercertissuer(void* lpObj);

char* ipworksedi_as4client_getsslservercertprivatekey(void* lpObj);

int ipworksedi_as4client_getsslservercertprivatekeyavailable(void* lpObj);

char* ipworksedi_as4client_getsslservercertprivatekeycontainer(void* lpObj);

char* ipworksedi_as4client_getsslservercertpublickey(void* lpObj);

char* ipworksedi_as4client_getsslservercertpublickeyalgorithm(void* lpObj);

int ipworksedi_as4client_getsslservercertpublickeylength(void* lpObj);

char* ipworksedi_as4client_getsslservercertserialnumber(void* lpObj);

char* ipworksedi_as4client_getsslservercertsignaturealgorithm(void* lpObj);

int ipworksedi_as4client_getsslservercertstore(void* lpObj, char** lpSSLServerCertStore, int* lenSSLServerCertStore);

char* ipworksedi_as4client_getsslservercertstorepassword(void* lpObj);

int ipworksedi_as4client_getsslservercertstoretype(void* lpObj);

char* ipworksedi_as4client_getsslservercertsubjectaltnames(void* lpObj);

char* ipworksedi_as4client_getsslservercertthumbprintmd5(void* lpObj);

char* ipworksedi_as4client_getsslservercertthumbprintsha1(void* lpObj);

char* ipworksedi_as4client_getsslservercertthumbprintsha256(void* lpObj);

char* ipworksedi_as4client_getsslservercertusage(void* lpObj);

int ipworksedi_as4client_getsslservercertusageflags(void* lpObj);

char* ipworksedi_as4client_getsslservercertversion(void* lpObj);

char* ipworksedi_as4client_getsslservercertsubject(void* lpObj);

int ipworksedi_as4client_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

QString GetSSLServerCertEffectiveDate();

QString GetSSLServerCertExpirationDate();

QString GetSSLServerCertExtendedKeyUsage();

QString GetSSLServerCertFingerprint();

QString GetSSLServerCertFingerprintSHA1();

QString GetSSLServerCertFingerprintSHA256();

QString GetSSLServerCertIssuer();

QString GetSSLServerCertPrivateKey();

bool GetSSLServerCertPrivateKeyAvailable();

QString GetSSLServerCertPrivateKeyContainer();

QString GetSSLServerCertPublicKey();

QString GetSSLServerCertPublicKeyAlgorithm();

int GetSSLServerCertPublicKeyLength();

QString GetSSLServerCertSerialNumber();

QString GetSSLServerCertSignatureAlgorithm();

QByteArray GetSSLServerCertStore();

QString GetSSLServerCertStorePassword();

int GetSSLServerCertStoreType();

QString GetSSLServerCertSubjectAltNames();

QString GetSSLServerCertThumbprintMD5();

QString GetSSLServerCertThumbprintSHA1();

QString GetSSLServerCertThumbprintSHA256();

QString GetSSLServerCertUsage();

int GetSSLServerCertUsageFlags();

QString GetSSLServerCertVersion();

QString GetSSLServerCertSubject();

QByteArray GetSSLServerCertEncoded();

Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Data Type

IPWorksEDICertificate

Timeout Property (AS4Client Class)

The timeout for the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();
INT SetTimeout(INT iTimeout);

int ipworksedi_as4client_gettimeout(void* lpObj);
int ipworksedi_as4client_settimeout(void* lpObj, int iTimeout);

int GetTimeout();
int SetTimeout(int iTimeout);

Default Value

60

Remarks

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

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

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

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

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

The default value for the Timeout property is 60 seconds.

Data Type

Integer

TokenPassword Property (AS4Client Class)

The password used in UsernameToken authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTokenPassword();
int SetTokenPassword(const char* lpszTokenPassword);

Unicode (Windows)
LPWSTR GetTokenPassword();
INT SetTokenPassword(LPCWSTR lpszTokenPassword);

char* ipworksedi_as4client_gettokenpassword(void* lpObj);
int ipworksedi_as4client_settokenpassword(void* lpObj, const char* lpszTokenPassword);

QString GetTokenPassword();
int SetTokenPassword(QString qsTokenPassword);

Default Value

""

Remarks

This property specifies the password used in UsernameToken authentication.

UsernameToken Authentication Notes

If TokenUser and TokenPassword are specified the class will include UsernameToken authentication when ReceiveFiles is called. This functionality is only applicable when calling ReceiveFiles.

TokenPassword should normally be set to the plaintext password that both the client and server know. The class will automatically use SHA-1 to create a hash of the password when TokenPasswordType is set to tptDigest (default). The hashed password is sent in the request, along with a creation date and nonce. The server will validate these values when receiving the request.

client.TokenUser = "User"; client.TokenPassword = "MyPassword"; client.TokenPasswordType = As4clientTokenPasswordTypes.tptDigest; client.ReceiveFiles();

A creation date element is always sent in the request. A nonce is sent by default but can be disabled by setting UseNonce to False.

If TokenPasswordType is set to tptText the class will transmit value provided in TokenPassword exactly as it is provided. The value will not be hashed. This may be useful in cases where an alternative credential mechanism is used between the client and server.

Data Type

String

TokenPasswordType Property (AS4Client Class)

The password type used in UsernameToken authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTokenPasswordType();
int SetTokenPasswordType(int iTokenPasswordType);

Unicode (Windows)
INT GetTokenPasswordType();
INT SetTokenPasswordType(INT iTokenPasswordType);

TPT_DIGEST(0), 
TPT_TEXT(1)

int ipworksedi_as4client_gettokenpasswordtype(void* lpObj);
int ipworksedi_as4client_settokenpasswordtype(void* lpObj, int iTokenPasswordType);

int GetTokenPasswordType();
int SetTokenPasswordType(int iTokenPasswordType);

Default Value

0

Remarks

The type of password to send in the request. Possible values are:

UsernameToken Authentication Notes

If TokenUser and TokenPassword are specified the class will include UsernameToken authentication when ReceiveFiles is called. This functionality is only applicable when calling ReceiveFiles.

TokenPassword should normally be set to the plaintext password that both the client and server know. The class will automatically use SHA-1 to create a hash of the password when TokenPasswordType is set to tptDigest (default). The hashed password is sent in the request, along with a creation date and nonce. The server will validate these values when receiving the request.

client.TokenUser = "User"; client.TokenPassword = "MyPassword"; client.TokenPasswordType = As4clientTokenPasswordTypes.tptDigest; client.ReceiveFiles();

A creation date element is always sent in the request. A nonce is sent by default but can be disabled by setting UseNonce to False.

If TokenPasswordType is set to tptText the class will transmit value provided in TokenPassword exactly as it is provided. The value will not be hashed. This may be useful in cases where an alternative credential mechanism is used between the client and server.

Data Type

Integer

TokenUser Property (AS4Client Class)

The username used in UsernameToken authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTokenUser();
int SetTokenUser(const char* lpszTokenUser);

Unicode (Windows)
LPWSTR GetTokenUser();
INT SetTokenUser(LPCWSTR lpszTokenUser);

char* ipworksedi_as4client_gettokenuser(void* lpObj);
int ipworksedi_as4client_settokenuser(void* lpObj, const char* lpszTokenUser);

QString GetTokenUser();
int SetTokenUser(QString qsTokenUser);

Default Value

""

Remarks

This property specifies the username to be sent for UsernameToken authentication.

UsernameToken Authentication Notes

If TokenUser and TokenPassword are specified the class will include UsernameToken authentication when ReceiveFiles is called. This functionality is only applicable when calling ReceiveFiles.

TokenPassword should normally be set to the plaintext password that both the client and server know. The class will automatically use SHA-1 to create a hash of the password when TokenPasswordType is set to tptDigest (default). The hashed password is sent in the request, along with a creation date and nonce. The server will validate these values when receiving the request.

client.TokenUser = "User"; client.TokenPassword = "MyPassword"; client.TokenPasswordType = As4clientTokenPasswordTypes.tptDigest; client.ReceiveFiles();

A creation date element is always sent in the request. A nonce is sent by default but can be disabled by setting UseNonce to False.

If TokenPasswordType is set to tptText the class will transmit value provided in TokenPassword exactly as it is provided. The value will not be hashed. This may be useful in cases where an alternative credential mechanism is used between the client and server.

Data Type

String

URL Property (AS4Client Class)

The URL to which the request is made.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetURL();
int SetURL(const char* lpszURL);

Unicode (Windows)
LPWSTR GetURL();
INT SetURL(LPCWSTR lpszURL);

char* ipworksedi_as4client_geturl(void* lpObj);
int ipworksedi_as4client_seturl(void* lpObj, const char* lpszURL);

QString GetURL();
int SetURL(QString qsURL);

Default Value

""

Remarks

This property specifies the URL to which the request is made. SSL will be used if and only if the URL scheme is "https".

Data Type

String

Config Method (AS4Client 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_as4client_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.

DoEvents Method (AS4Client Class)

This method processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int ipworksedi_as4client_doevents(void* lpObj);

int DoEvents();

Remarks

When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

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

Interrupt Method (AS4Client Class)

This method interrupts the current method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int ipworksedi_as4client_interrupt(void* lpObj);

int Interrupt();

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

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

ReceiveFiles Method (AS4Client Class)

Connects to a server to receive files.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ReceiveFiles();

Unicode (Windows)
INT ReceiveFiles();

int ipworksedi_as4client_receivefiles(void* lpObj);

int ReceiveFiles();

Remarks

ReceiveFiles establishes a connection to the server specified by URL and receives files.

The MPC specifies the Message Partition Channel from which messages will be received. The server will reply with files from this channel. If IncomingDirectory is set before calling this method the files will be written to the specified folder, otherwise inspect EDIData to obtain the received file data. The following properties are applicable when calling this method:

• SigningCert (required to sign the request)
• Certificate (required for decryption)
• SignerCert (required for signature verification)
• URL
• IncomingDirectory (optional)
• LogDirectory
• MPC
• TokenUser
• TokenPassword
• TokenPasswordType

• AS4From
• AS4To
• AgreementRef
• ConversationId
• Service
• ServiceAction
• ServiceType
• MessageId
• Receipt

To bundle the receipt with a subsequent ReceiveFiles call the Receipt property must hold the receipt. If the same instance of the class is being used this is already true since Receipt is populated automatically after receiving the file. To use another instance of the class for multiple calls to ReceiveFiles be sure to save the Receipt's Content and RefToMessageId values for later use.

ReceiveFiles Example: client.Profile = As4clientProfiles.ebpfENTSOG; //Company A's private certificate. Used for signing the request. client.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, "C:\\files\\as4\\CompanyA.pfx", "password", "*"); //Company A's private certificate. Used for decrypting the file. client.Certificate = new Certificate(CertStoreTypes.cstPFXFile, "C:\\files\\as4\\CompanyA.pfx", "password", "*"); //Company B's public certificate. Used for signature verification. client.SignerCert = new Certificate("C:\\files\\as4\\CompanyB.cer"); client.URL = "http://www.company.com:9090/msh"; //Message Channel id client.MPC = "mpc_a"; client.IncomingDirectory = "C:\\incoming_dir"; client.ReceiveFiles(); //Inspect client.AgreementRef and other properties for information about the received files Console.WriteLine(client.AgreementRef); Console.WriteLine(client.AS4From.Id); Console.WriteLine(client.AS4To.Id); Console.WriteLine(client.ConversationId); //Save the receipt for later use string receiptContent = client.Receipt.Content; string receiptRefId = client.Receipt.RefToMessageId;

At this stage the receipt data is saved. Later when making another call to ReceiveFiles and populate the Receipt property with this receipt data. When ReceiveFiles is called again, the receipt for the previous message will be included with the request. client.Receipt = new EBReceipt(receiptRefId, receiptContent); client.ReceiveFiles(); //This will now include the bundled receipt

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 (AS4Client Class)

Resets the state of the control.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

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

SendFiles Method (AS4Client Class)

Sends file(s) to the specified server and verify the receipt (if present).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendFiles();

Unicode (Windows)
INT SendFiles();

int ipworksedi_as4client_sendfiles(void* lpObj);

int SendFiles();

Remarks

SendFiles sends the files specified by EDIData to URL.

Before calling this method set AgreementRef to the agreement identifier used by both parties. Set AS4From and AS4To. Set EDIData specifies the file(s) to be sent. To encrypt the data set RecipientCerts. To sign the data set SigningCert. The SignerCert property should be set to verify the signed receipt.

When this method is called the file(s) will be sent and any returned receipts will be verified.

To indicate a synchronous receipt is expected set ReceiptReplyMode to rrmSync. The following properties are applicable when calling this method with an agreement specifying a synchronous receipt (a receipt provided in the response):

• AgreementRef
• AS4From
• AS4To
• EDIData
• URL
• RecipientCerts (required to encrypt)
• SignerCert (required to verify signed receipts)
• SigningCert (required to sign files)
• ConversationId (optional)
• EncryptionAlgorithm (optional)
• LogDirectory (optional)
• MessageId (optional)
• MessageProperties (optional)
• Profile (optional)
• ReceiptReplyMode
• Service (optional)
• ServiceType (optional)
• SignatureAlgorithm (optional)

SendFiles Example (synchronous receipt): client.Profile = As4clientProfiles.ebpfENTSOG; //Specify the agreement and party information client.AgreementRef = "http://agreements.company.com/sign_and_encrypt"; client.AS4From.Role = "Sender"; client.AS4From.Id = "org:b2b:example:company:A"; client.AS4To.Role = "Receiver"; client.AS4To.Id = "org:b2b:example:company:B"; //Configure the component to expect a synchronous receipt. client.ReceiptReplyMode = As4clientReceiptReplyModes.rrmSync; //Company A's private certificate. Used to sign the outgoing message and files. client.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, "C:\\files\\CompanyA.pfx", "password", "*"); //Company B's public certificate. Used to encrypt the outgoing file. client.RecipientCerts.Add(new Certificate("C:\\files\\as4\\CompanyB.cer")); //Company B's public certificate. Used to verify the signed receipt. client.SignerCert = new Certificate("C:\\files\\as4\\CompanyB.cer"); client.URL = "http://www.company.com:9090/msh"; EBData data = new EBData(); data.EDIType = "application/edi-x12"; data.Filename = "C:\\files\\myfile.x12"; data.Name = "myfile.x12"; client.EDIData.Add(data); //Send file(s) and verify the receipt. client.SendFiles();

The class also supports asynchronous receipts. In this configuration a file is sent from the class to another party, but the receipt is not returned in the response. Instead the other party sends the receipt at a later time. The AS4Server class may be used inside a web page to receive the asynchronous receipt. After receiving the receipt either AS4Server or AS4Client may be used to verify the receipt.

Details about the original message must be stored so that the receipt can be correlated with the message and properly verified. The easiest way to do this is to set AsyncReceiptInfoDir before calling SendFiles. The class will automatically store the required information.

See the VerifyReceipt method of AS4Server for details about verifying asynchronous receipts.

To indicate an asynchronous receipt is expected set ReceiptReplyMode to rrmAsync. The following properties are applicable when calling this method with an agreement specifying a synchronous receipt (a receipt provided in the response):

• AgreementRef
• AS4From
• AS4To
• AsyncReceiptInfoDir
• EDIData
• URL
• RecipientCerts (required to encrypt)
• SignerCert (required to verify signed receipts)
• SigningCert (required to sign files)
• ConversationId (optional)
• EncryptionAlgorithm (optional)
• LogDirectory (optional)
• MessageId (optional)
• MessageProperties (optional)
• OriginalSOAPMessage (optional)
• OriginalSOAPMessageId (optional)
• Profile (optional)
• ReceiptReplyMode
• Service (optional)
• ServiceType (optional)
• SignatureAlgorithm (optional)

SendFiles Example (asynchronous receipt): client.Profile = As4clientProfiles.ebpfENTSOG; //Specify the agreement and party information client.AgreementRef = "http://agreements.company.com/sign_and_encrypt_async"; client.AS4From.Role = "Sender"; client.AS4From.Id = "org:b2b:example:company:A"; client.AS4To.Role = "Receiver"; client.AS4To.Id = "org:b2b:example:company:B"; //Configure the component to expect a synchronous receipt. client.ReceiptReplyMode = As4clientReceiptReplyModes.rrmAsync; client.AsyncReceiptInfoDir = "C:\\async_info"; //Company A's private certificate. Used to sign the outgoing message and files. client.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, "C:\\files\\CompanyA.pfx", "password", "*"); //Company B's public certificate. Used to encrypt the outgoing files. client.RecipientCerts.Add(new Certificate("C:\\files\\as4\\CompanyB.cer")); //Company B's public certificate. Used to verify the signed receipt. client.SignerCert = new Certificate("C:\\files\\as4\\CompanyB.cer"); client.URL = "http://www.company.com:9090/msh"; EBData data = new EBData(); data.EDIType = "application/edi-x12"; data.Filename = "C:\\files\\myfile.x12"; data.Name = "myfile.x12"; client.EDIData.Add(data); //Send file(s). client.SendFiles();

At this point the file(s) have been sent, but a receipt has not yet been received. AS4Server can be used within a web site to listen for the receipt. //**** Inside a web site **** As4server server = new As4server; server.ReadRequest(); if (!String.IsNullOrEmpty(server.IncomingReceipt.Content)) { server.AsyncReceiptInfoDir = "C:\\async_info"; server.VerifyReceipt(); //The receipt is now verified }

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

SendReceipt Method (AS4Client Class)

Sends an asynchronous receipt.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendReceipt();

Unicode (Windows)
INT SendReceipt();

int ipworksedi_as4client_sendreceipt(void* lpObj);

int SendReceipt();

Remarks

SendReceipt sends an asynchronous receipt to the URL.

This method is typically used in conjunction with AS4Server to send an asynchronous receipt after receiving a message. The receipt will be created at the time of the incoming request, then saved for later use. When the receipt is to be sent populate Receipt and call this method.

//Send an asynchronous receipt client.URL = ""http://www.company.com:9090/msh""; client.Receipt = new EBReceipt(server.Receipt.RefToMessageId, server.Receipt.Content); client.ReceiptReplyMode = As4clientReceiptReplyModes.rrmAsync; client.SendReceipt();

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

Connected Event (AS4Client Class)

Fired immediately after a connection completes (or fails).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnected(AS4ClientConnectedEventParams *e);

typedef struct {
  int StatusCode;
  const char *Description;
  int reserved;
} AS4ClientConnectedEventParams;


Unicode (Windows)
virtual INT FireConnected(AS4ClientConnectedEventParams *e);

typedef struct {
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} AS4ClientConnectedEventParams;

#define EID_AS4CLIENT_CONNECTED 1

virtual INT IPWORKSEDI_CALL FireConnected(INT &iStatusCode, LPSTR &lpszDescription);

class AS4ClientConnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

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

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

// Or, subclass AS4Client and override this emitter function.
virtual int FireConnected(AS4ClientConnectedEventParams *e) {...}

Remarks

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

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

Please refer to the Error Codes section for more information.

Disconnected Event (AS4Client Class)

Fired when a connection is closed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDisconnected(AS4ClientDisconnectedEventParams *e);

typedef struct {
  int StatusCode;
  const char *Description;
  int reserved;
} AS4ClientDisconnectedEventParams;


Unicode (Windows)
virtual INT FireDisconnected(AS4ClientDisconnectedEventParams *e);

typedef struct {
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} AS4ClientDisconnectedEventParams;

#define EID_AS4CLIENT_DISCONNECTED 2

virtual INT IPWORKSEDI_CALL FireDisconnected(INT &iStatusCode, LPSTR &lpszDescription);

class AS4ClientDisconnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

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

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

// Or, subclass AS4Client and override this emitter function.
virtual int FireDisconnected(AS4ClientDisconnectedEventParams *e) {...}

Remarks

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

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

Please refer to the Error Codes section for more information.

EndTransfer Event (AS4Client Class)

Fired when a document finishes transferring.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireEndTransfer(AS4ClientEndTransferEventParams *e);

typedef struct {
  int Direction;
  int reserved;
} AS4ClientEndTransferEventParams;


Unicode (Windows)
virtual INT FireEndTransfer(AS4ClientEndTransferEventParams *e);

typedef struct {
  INT Direction;
  INT reserved;
} AS4ClientEndTransferEventParams;

#define EID_AS4CLIENT_ENDTRANSFER 3

virtual INT IPWORKSEDI_CALL FireEndTransfer(INT &iDirection);

class AS4ClientEndTransferEventParams {
public:
  int Direction();

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

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

// Or, subclass AS4Client and override this emitter function.
virtual int FireEndTransfer(AS4ClientEndTransferEventParams *e) {...}

Remarks

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

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

Error Event (AS4Client Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_AS4CLIENT_ERROR 4

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

class AS4ClientErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

// Or, subclass AS4Client and override this emitter function.
virtual int FireError(AS4ClientErrorEventParams *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.

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.

Header Event (AS4Client Class)

Fired every time a header line comes in.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireHeader(AS4ClientHeaderEventParams *e);

typedef struct {
  const char *Field;
  const char *Value;
  int reserved;
} AS4ClientHeaderEventParams;


Unicode (Windows)
virtual INT FireHeader(AS4ClientHeaderEventParams *e);

typedef struct {
  LPCWSTR Field;
  LPCWSTR Value;
  INT reserved;
} AS4ClientHeaderEventParams;

#define EID_AS4CLIENT_HEADER 5

virtual INT IPWORKSEDI_CALL FireHeader(LPSTR &lpszField, LPSTR &lpszValue);

class AS4ClientHeaderEventParams {
public:
  const QString &Field();

  const QString &Value();

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

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

// Or, subclass AS4Client and override this emitter function.
virtual int FireHeader(AS4ClientHeaderEventParams *e) {...}

Remarks

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

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

Log Event (AS4Client Class)

Fired with log information while processing a message.

Syntax

• C++
• C
• Qt

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

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


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

typedef struct {
  LPCWSTR LogType;
  LPCWSTR LogMessage;
  INT reserved;
} AS4ClientLogEventParams;

#define EID_AS4CLIENT_LOG 6

virtual INT IPWORKSEDI_CALL FireLog(LPSTR &lpszLogType, LPSTR &lpszLogMessage);

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

  const QString &LogMessage();

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

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

// Or, subclass AS4Client and override this emitter function.
virtual int FireLog(AS4ClientLogEventParams *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:

RecipientInfo Event (AS4Client Class)

Fired for each recipient certificate of the encrypted message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireRecipientInfo(AS4ClientRecipientInfoEventParams *e);

typedef struct {
  const char *Issuer;
  const char *SerialNumber;
  const char *SubjectKeyIdentifier;
  const char *EncryptionAlgorithm;
  int reserved;
} AS4ClientRecipientInfoEventParams;


Unicode (Windows)
virtual INT FireRecipientInfo(AS4ClientRecipientInfoEventParams *e);

typedef struct {
  LPCWSTR Issuer;
  LPCWSTR SerialNumber;
  LPCWSTR SubjectKeyIdentifier;
  LPCWSTR EncryptionAlgorithm;
  INT reserved;
} AS4ClientRecipientInfoEventParams;

#define EID_AS4CLIENT_RECIPIENTINFO 7

virtual INT IPWORKSEDI_CALL FireRecipientInfo(LPSTR &lpszIssuer, LPSTR &lpszSerialNumber, LPSTR &lpszSubjectKeyIdentifier, LPSTR &lpszEncryptionAlgorithm);

class AS4ClientRecipientInfoEventParams {
public:
  const QString &Issuer();

  const QString &SerialNumber();

  const QString &SubjectKeyIdentifier();

  const QString &EncryptionAlgorithm();

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

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

// Or, subclass AS4Client and override this emitter function.
virtual int FireRecipientInfo(AS4ClientRecipientInfoEventParams *e) {...}

Remarks

When ParseRequest is called and the file is encrypted, this event will fire for each recipient certificate for which the file was encrypted.

Issuer is the subject of the issuer certificate.

SerialNumber is the serial number of the encryption certificate.

SubjectKeyIdentifier is the X.509 subjectKeyIdentifier extension value of the certificate used to sign the message encoded as a hex string.

EncryptionAlgorithm is the encryption algorithm used to encrypt the message. Possible values are as follows:

• "3DES"
• "DES"
• "RC2CBC40"
• "RC2CBC64"
• "RC2CBC128" or "RC2"
• "AESCBC128" or "AES"
• "AESCBC192"
• "AESCBC256"
• "AESGCM128" or "AESGCM"
• "AESGCM192"
• "AESGCM256"

SetCookie Event (AS4Client Class)

Fired for every cookie set by the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSetCookie(AS4ClientSetCookieEventParams *e);

typedef struct {
  const char *Name;
  const char *Value;
  const char *Expires;
  const char *Domain;
  const char *Path;
  int Secure;
  int reserved;
} AS4ClientSetCookieEventParams;


Unicode (Windows)
virtual INT FireSetCookie(AS4ClientSetCookieEventParams *e);

typedef struct {
  LPCWSTR Name;
  LPCWSTR Value;
  LPCWSTR Expires;
  LPCWSTR Domain;
  LPCWSTR Path;
  BOOL Secure;
  INT reserved;
} AS4ClientSetCookieEventParams;

#define EID_AS4CLIENT_SETCOOKIE 8

virtual INT IPWORKSEDI_CALL FireSetCookie(LPSTR &lpszName, LPSTR &lpszValue, LPSTR &lpszExpires, LPSTR &lpszDomain, LPSTR &lpszPath, BOOL &bSecure);

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

  const QString &Value();

  const QString &Expires();

  const QString &Domain();

  const QString &Path();

  bool Secure();

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

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

// Or, subclass AS4Client and override this emitter function.
virtual int FireSetCookie(AS4ClientSetCookieEventParams *e) {...}

Remarks

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

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

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

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

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

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

SignerCertInfo Event (AS4Client Class)

This event is fired during verification of the signed message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSignerCertInfo(AS4ClientSignerCertInfoEventParams *e);

typedef struct {
  const char *Issuer;
  const char *SerialNumber;
  const char *SubjectKeyIdentifier;
  const char *CertEncoded;
  int lenCertEncoded;
  int reserved;
} AS4ClientSignerCertInfoEventParams;


Unicode (Windows)
virtual INT FireSignerCertInfo(AS4ClientSignerCertInfoEventParams *e);

typedef struct {
  LPCWSTR Issuer;
  LPCWSTR SerialNumber;
  LPCWSTR SubjectKeyIdentifier;
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  INT reserved;
} AS4ClientSignerCertInfoEventParams;

#define EID_AS4CLIENT_SIGNERCERTINFO 9

virtual INT IPWORKSEDI_CALL FireSignerCertInfo(LPSTR &lpszIssuer, LPSTR &lpszSerialNumber, LPSTR &lpszSubjectKeyIdentifier, LPSTR &lpCertEncoded, INT &lenCertEncoded);

class AS4ClientSignerCertInfoEventParams {
public:
  const QString &Issuer();

  const QString &SerialNumber();

  const QString &SubjectKeyIdentifier();

  const QByteArray &CertEncoded();

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

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

// Or, subclass AS4Client and override this emitter function.
virtual int FireSignerCertInfo(AS4ClientSignerCertInfoEventParams *e) {...}

Remarks

During verification, this event will be raised while parsing the signer's certificate information. The parameters that are populated depend on the options used when the message was originally signed. This information may be used to select the correct certificate for SignerCert to verify the signature. The following parameters may be populated:

Issuer specifies the subject of the issuer of the certificate used to sign the message.

SerialNumber is the serial number of the certificate used to sign the message.

SubjectKeyIdentifier is the X.509 subjectKeyIdentifier extension value of the certificate used to sign the message encoded as a hex string.

CertEncoded is the PEM (Base64 encoded) public certificate needed to verify the signature.

Note: When this value is present, the class will automatically use this value to perform signature verification.

The SignerCert property may be set from within this event. In this manner, the decision of which signer certificate to load may be delayed until the parameters of this event are inspected and the correct certificate can be located and loaded.

SSLServerAuthentication Event (AS4Client Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(AS4ClientSSLServerAuthenticationEventParams *e);

typedef struct {
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} AS4ClientSSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(AS4ClientSSLServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} AS4ClientSSLServerAuthenticationEventParams;

#define EID_AS4CLIENT_SSLSERVERAUTHENTICATION 10

virtual INT IPWORKSEDI_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class AS4ClientSSLServerAuthenticationEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

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

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

// Or, subclass AS4Client and override this emitter function.
virtual int FireSSLServerAuthentication(AS4ClientSSLServerAuthenticationEventParams *e) {...}

Remarks

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

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

SSLStatus Event (AS4Client Class)

Fired when secure connection progress messages are available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLStatus(AS4ClientSSLStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} AS4ClientSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(AS4ClientSSLStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} AS4ClientSSLStatusEventParams;

#define EID_AS4CLIENT_SSLSTATUS 11

virtual INT IPWORKSEDI_CALL FireSSLStatus(LPSTR &lpszMessage);

class AS4ClientSSLStatusEventParams {
public:
  const QString &Message();

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

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

// Or, subclass AS4Client and override this emitter function.
virtual int FireSSLStatus(AS4ClientSSLStatusEventParams *e) {...}

Remarks

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

StartTransfer Event (AS4Client Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireStartTransfer(AS4ClientStartTransferEventParams *e);

typedef struct {
  int Direction;
  int reserved;
} AS4ClientStartTransferEventParams;


Unicode (Windows)
virtual INT FireStartTransfer(AS4ClientStartTransferEventParams *e);

typedef struct {
  INT Direction;
  INT reserved;
} AS4ClientStartTransferEventParams;

#define EID_AS4CLIENT_STARTTRANSFER 12

virtual INT IPWORKSEDI_CALL FireStartTransfer(INT &iDirection);

class AS4ClientStartTransferEventParams {
public:
  int Direction();

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

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

// Or, subclass AS4Client and override this emitter function.
virtual int FireStartTransfer(AS4ClientStartTransferEventParams *e) {...}

Remarks

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

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

TokenAuthentication Event (AS4Client Class)

Fired when the server makes use of UsernameToken authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireTokenAuthentication(AS4ClientTokenAuthenticationEventParams *e);

typedef struct {
  const char *User;
  char *Password;
  const char *PasswordType;
  int Accept;
  int reserved;
} AS4ClientTokenAuthenticationEventParams;


Unicode (Windows)
virtual INT FireTokenAuthentication(AS4ClientTokenAuthenticationEventParams *e);

typedef struct {
  LPCWSTR User;
  LPWSTR Password;
  LPCWSTR PasswordType;
  BOOL Accept;
  INT reserved;
} AS4ClientTokenAuthenticationEventParams;

#define EID_AS4CLIENT_TOKENAUTHENTICATION 13

virtual INT IPWORKSEDI_CALL FireTokenAuthentication(LPSTR &lpszUser, LPSTR &lpszPassword, LPSTR &lpszPasswordType, BOOL &bAccept);

class AS4ClientTokenAuthenticationEventParams {
public:
  const QString &User();

  const QString &Password();
  void SetPassword(const QString &qsPassword);

  const QString &PasswordType();

  bool Accept();
  void SetAccept(bool bAccept);

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

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

// Or, subclass AS4Client and override this emitter function.
virtual int FireTokenAuthentication(AS4ClientTokenAuthenticationEventParams *e) {...}

Remarks

This event fires when a server sends a response that includes UsernameToken authentication. This is typically only used by servers when sending a pull response.

User identifies the user.

Password should be set from within the event if PasswordType is 0 (digest). This parameter can be read when PasswordType is 1 (text).

PasswordType specifies the type of password. Possible values are:

• 0 (Digest)
• 1 (Text)

Accept may be set to manually accept the request.

When PasswordType is 0 (Digest) set the Password parameter to the plaintext password. Do not set Accept The class will hash the provided password value and compare it to the value in the request. If it matched the class will accept the request. If it does not match the class will populate Errors with an error indicating authentication has failed.

When PasswordType is 1 (Text) the Password parameter will hold the exact value received in the request. Inspect Password and determine whether to accept the request. To accept the request set Accept to True.

After this event fires if authentication failed Errors will contain an appropriate error. Send the errors back to the server by calling SendResponse.

Transfer Event (AS4Client Class)

Fired while a document transfers (delivers document).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireTransfer(AS4ClientTransferEventParams *e);

typedef struct {
  int Direction;
  int64 BytesTransferred;
  int PercentDone;
  const char *Text;
  int lenText;
  int reserved;
} AS4ClientTransferEventParams;


Unicode (Windows)
virtual INT FireTransfer(AS4ClientTransferEventParams *e);

typedef struct {
  INT Direction;
  LONG64 BytesTransferred;
  INT PercentDone;
  LPCSTR Text;
  INT lenText;
  INT reserved;
} AS4ClientTransferEventParams;

#define EID_AS4CLIENT_TRANSFER 14

virtual INT IPWORKSEDI_CALL FireTransfer(INT &iDirection, LONG64 &lBytesTransferred, INT &iPercentDone, LPSTR &lpText, INT &lenText);

class AS4ClientTransferEventParams {
public:
  int Direction();

  qint64 BytesTransferred();

  int PercentDone();

  const QByteArray &Text();

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

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

// Or, subclass AS4Client and override this emitter function.
virtual int FireTransfer(AS4ClientTransferEventParams *e) {...}

Remarks

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

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

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

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

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

Certificate Type

This is the digital certificate being used.

Syntax

IPWorksEDICertificate (declared in ipworksedi.h)

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

Certificate()

Certificate(const char* lpEncoded, int lenEncoded)

Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject)

EBData Type

The EDI payload of the AS4 message.

Syntax

IPWorksEDIEBData (declared in ipworksedi.h)

Remarks

The EDI payload of the AS4 message.

Fields

Constructors

EBData()

EBData(const char* lpData, int lenData, const char* lpszEDIType)

EBData(const char* lpszFileName, const char* lpszEDIType)

EBError Type

This type defines details of the error.

Syntax

IPWorksEDIEBError (declared in ipworksedi.h)

Remarks

The fields below provide various information about the error.

Fields