AS4Server Class

Properties   Methods   Events   Config Settings   Errors  

The AS4Server class implements an AS4 / ebHandler.

Syntax

AS4Server

Remarks

The AS4Server class implements server-side processing of AS4 messages. It may be used to receive files form a client (push), respond to a client's request for files (pull), and also handles generating and verifying receipts.

The class is designed to be easily integrated into a HTTP server, such as ASP.NET, but may also be used outside of a web server. The examples below assume the class is used within an environment where there is an HTTP context.

To begin, when a request is received first call ReadRequest. This reads the AS4 request from the . Alternatively the request data may be passed directly to the class by specifying calling SetRequestStream. After calling ReadRequest the following properties may be checked:

• AgreementRef
• AS4From
• AS4To
• ConversationId
• EDIData
• Errors
• IncomingReceipt
• MessageId
• MessageProperties
• MPC
• Service
• ServiceAction
• ServiceType

The first step after calling ReadRequest is to determine if the client is sending files (push) or requesting files (pull). To determine this check the value of AgreementRef and MPC. For instance: if (server.AgreementRef == "" && server.MPC != "") { //The client is requesting files from the specified MPC //No other relevant properties are populated } else //AgreementRef is not empty, and MPC is empty { //The client is sending files. AgreementRef is populated with the agreement reference. //AS4From, AS4To, ConversationId, etc are populated }

Determining if the request contains an asynchronous receipt from a previous transmission may also be done at this time by checking the IncomingReceipt property's IncomingReceiptContent property. If it is populated a receipt is present. To verify the receipt set AsyncReceiptInfoDir to the directory where information about the message was originally stored and call VerifyReceipt. If the receipt is signed SignerCert must also be set. See the section below and also SendFiles for more details.

Once information about the request is determined the class may then be configured to respond appropriately depending on the operation.

Receiving Files and Sending a Receipt

When receiving files first check the AgreementRef, AS4From, and AS4To properties to determine who is sending the files and with what previously agreed upon configuration. Once this is known, if the request is signed and encrypted set Certificate to the decryption certificate and SignerCert to the public certificate used for signature verification. IncomingDirectory may optionally be set to automatically store the incoming files. //Process incoming files and send a signed receipt server.ReadRequest(); //Inspect values from the request in order to load appropriate certificates etc. //Console.WriteLine(server.AgreementRef); //Console.WriteLine(server.AS4From.Id); //Console.WriteLine(server.AS4To.Id);) server.IncomingDirectory = "..\\MyFiles"; //Our private certificate. Used to decrypt the incoming file server.Certificate = new Certificate(CertStoreTypes.cstPFXFile, Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyB.pfx"), "password", "*"); //Partner's public certificate. Used to verify the signature on the incoming message and files. server.SignerCert = new Certificate(Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyA.cer")); server.ParseRequest(); server.ReceiptReplyMode = As4serverReceiptReplyModes.rrmSync; //Our private certificate. Used to sign the receipt. server.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyB.pfx"), "password", "*"); server.SendResponse(); //Sends the receipt Receiving Files and Sending an Asynchronous Receipt

Receipts may be sent in the response (synchronous) or at a later time (asynchronous). If the agreement specifies that the receipt be sent asynchronously the following steps may be taken to send the receipt.

After calling ReadRequest the ReceiptReplyMode may be set to indicate the receipt will be returned asynchronously. After calling ParseRequest call SendAckResponse to send back a HTTP 200 OK to the client. The receipt may then be returned later.

To send an asynchronous receipt AS4Client may be used. This can be sent to the partner's web site, or bundled with a later response (depending on the agreement made between the parties). In the example below AS4Client is used to send the receipt to the other party's web site.

//Process incoming files and send an asynchronous receipt server.ReadRequest(); //Inspect values from the request in order to load appropriate certificates etc. //Console.WriteLine(server.AgreementRef); //Console.WriteLine(server.AS4From.Id); //Console.WriteLine(server.AS4To.Id);) server.IncomingDirectory = "..\\MyFiles"; //Our private certificate. Used to decrypt the incoming file server.Certificate = new Certificate(CertStoreTypes.cstPFXFile, Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyB.pfx"), "password", "*"); //Partner's public certificate. Used to verify the signature on the incoming message and files. server.SignerCert = new Certificate(Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyA.cer")); server.ParseRequest(); server.ReceiptReplyMode = As4serverReceiptReplyModes.rrmAsync; //Our private certificate. Used to sign the receipt. server.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyB.pfx"), "password", "*"); server.SendAckResponse(); //Sends an ack, but not the receipt At this point Receipt is populated with the receipt to be sent. Store the Receipt's ReceiptContent and ReceiptRefToMessageId values for use when sending the receipt later. Sending a receipt can be done with AS4Client.

//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();

Sending Files

To process a request to send files first check the MPC property. This holds the Message Partition Channel (MPC) from which the client would like to receive files. Next, set AgreementRef, AS4From, AS4To. Check IncomingReceipt to determine if the request has a bundled receipt. If it does VerifyReceipt can be called to verify the receipt.

Note: If the client requests files from the default MPC then MPC may be empty. See MessageType for details.

If the client makes use of UsernameToken authentication the TokenAuthentication event will fire when processing the request.

To send files back to the client simply set EDIData to the files you wish to send. When SendResponse is called the files will be sent back to the client.

//Process a request to send files (pull) //Holds information from the original send so that receipts can be verified later server.AsyncReceiptInfoDir = Path.Combine(Request.PhysicalApplicationPath, "..\\temp\\ReceiptInfoDir") server.Profile = As4serverProfiles.ebpfENTSOG; server.ReadRequest(); //The receipt may be signed depending upon the AgreementRef server.SignerCert = new Certificate(Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyA.cer")); //If the request has a bundled receipt verify it first if (!string.IsNullOrEmpty(server.IncomingReceipt.Content)) { server.VerifyReceipt(); } //If the request is a pull request (MPC is set) if (server.AgreementRef == "" && server.MPC != "") { server.AgreementRef = "http://agreements.company.com/pull_files"; server.AS4From.Id = "org:holodeckb2b:example:company:B"; server.AS4From.Role = "Sender"; server.AS4To.Id = "org:holodeckb2b:example:company:A"; server.AS4To.Role = "Receiver"; server.ReceiptReplyMode = As4serverReceiptReplyModes.rrmAsync; //Our private certificate. Used to sign the message and files. server.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyB.pfx"), "password", "*"); //Partner's public certificate. Used to encrypt files. server.RecipientCerts.Add(new Certificate(Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyA.cer"))); EBData data = new EBData(); data.EDIType = "text/xml"; data.Data = "<test>Hello AS4 World!</test>"; server.EDIData.Add(data); server.SendResponse(); }

Processing Receipts

Any incoming request may potentially include a receipt. The request may be a receipt by itself, or it may be bundled with another type of request (send/receive). When initially sending files AsyncReceiptInfoDir may be set to store data about the original message on disk for use when verifying the receipt. If this is not desired manually store the OriginalSOAPMessage and OriginalSOAPMessageId instead.

To detect if an incoming request contains a receipt simply check the IncomingReceipt property's ReceiptContent property. If it is populated the request includes a receipt. Set AsyncReceiptInfoDir to the same location as when the file was originally sent. Or alternatively set OriginalSOAPMessage and OriginalSOAPMessageId properties to the original values.

If the receipt is signed set SignerCert to the public certificate which will be used to verify the signature. Lastly call VerifyReceipt. This will perform any signature verification and verify the receipt content as well, matching it to the original message values.

server.ReadRequest(); //The receipt may be signed depending upon the AgreementRef server.SignerCert = new Certificate(Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyA.cer")); //If the request contains a receipt verify it if (!string.IsNullOrEmpty(server.IncomingReceipt.Content)) { server.VerifyReceipt(); }

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 (AS4Server 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_as4server_getagreementref(void* lpObj);
int ipworksedi_as4server_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

AS4FromId Property (AS4Server Class)

The Id of the party.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAS4FromId();
int SetAS4FromId(const char* lpszAS4FromId);

Unicode (Windows)
LPWSTR GetAS4FromId();
INT SetAS4FromId(LPCWSTR lpszAS4FromId);

char* ipworksedi_as4server_getas4fromid(void* lpObj);
int ipworksedi_as4server_setas4fromid(void* lpObj, const char* lpszAS4FromId);

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

Default Value

""

Remarks

The Id of the party. This value is required.

This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:PartyInfo/eb:From/eb:PartyId"

Data Type

String

AS4FromIdType Property (AS4Server Class)

The optional type of the Id.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAS4FromIdType();
int SetAS4FromIdType(const char* lpszAS4FromIdType);

Unicode (Windows)
LPWSTR GetAS4FromIdType();
INT SetAS4FromIdType(LPCWSTR lpszAS4FromIdType);

char* ipworksedi_as4server_getas4fromidtype(void* lpObj);
int ipworksedi_as4server_setas4fromidtype(void* lpObj, const char* lpszAS4FromIdType);

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

Default Value

""

Remarks

The optional type of the Id. If specified this value should be the domain to which the Id belongs.

This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:PartyInfo/eb:From/eb:PartyId@type"

Data Type

String

AS4FromRole Property (AS4Server Class)

This property specifies the role of the party.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAS4FromRole();
int SetAS4FromRole(const char* lpszAS4FromRole);

Unicode (Windows)
LPWSTR GetAS4FromRole();
INT SetAS4FromRole(LPCWSTR lpszAS4FromRole);

char* ipworksedi_as4server_getas4fromrole(void* lpObj);
int ipworksedi_as4server_setas4fromrole(void* lpObj, const char* lpszAS4FromRole);

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

Default Value

""

Remarks

This property specifies the role of the party. This may be any value agreed upon by the trading partners.

In AS4From this specified the role of the party sending the document. The default value is "http://docs.oasis-open.org/ebxml-msg/ebms/v3.0/ns/core/200704/initiator".

In AS4To this specifies the role of the party receiving the document. The default value is "http://docs.oasis-open.org/ebxml-msg/ebms/v3.0/ns/core/200704/responder".

This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:PartyInfo/eb:From/eb:Role"

Data Type

String

AS4ToId Property (AS4Server Class)

The Id of the party.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAS4ToId();
int SetAS4ToId(const char* lpszAS4ToId);

Unicode (Windows)
LPWSTR GetAS4ToId();
INT SetAS4ToId(LPCWSTR lpszAS4ToId);

char* ipworksedi_as4server_getas4toid(void* lpObj);
int ipworksedi_as4server_setas4toid(void* lpObj, const char* lpszAS4ToId);

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

Default Value

""

Remarks

The Id of the party. This value is required.

This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:PartyInfo/eb:From/eb:PartyId"

Data Type

String

AS4ToIdType Property (AS4Server Class)

The optional type of the Id.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAS4ToIdType();
int SetAS4ToIdType(const char* lpszAS4ToIdType);

Unicode (Windows)
LPWSTR GetAS4ToIdType();
INT SetAS4ToIdType(LPCWSTR lpszAS4ToIdType);

char* ipworksedi_as4server_getas4toidtype(void* lpObj);
int ipworksedi_as4server_setas4toidtype(void* lpObj, const char* lpszAS4ToIdType);

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

Default Value

""

Remarks

The optional type of the Id. If specified this value should be the domain to which the Id belongs.

This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:PartyInfo/eb:From/eb:PartyId@type"

Data Type

String

AS4ToRole Property (AS4Server Class)

This property specifies the role of the party.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAS4ToRole();
int SetAS4ToRole(const char* lpszAS4ToRole);

Unicode (Windows)
LPWSTR GetAS4ToRole();
INT SetAS4ToRole(LPCWSTR lpszAS4ToRole);

char* ipworksedi_as4server_getas4torole(void* lpObj);
int ipworksedi_as4server_setas4torole(void* lpObj, const char* lpszAS4ToRole);

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

Default Value

""

Remarks

This property specifies the role of the party. This may be any value agreed upon by the trading partners.

In AS4From this specified the role of the party sending the document. The default value is "http://docs.oasis-open.org/ebxml-msg/ebms/v3.0/ns/core/200704/initiator".

In AS4To this specifies the role of the party receiving the document. The default value is "http://docs.oasis-open.org/ebxml-msg/ebms/v3.0/ns/core/200704/responder".

This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:PartyInfo/eb:From/eb:Role"

Data Type

String

AsyncReceiptInfoDir Property (AS4Server 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_as4server_getasyncreceiptinfodir(void* lpObj);
int ipworksedi_as4server_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

CertEncoded Property (AS4Server Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

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

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

int ipworksedi_as4server_getcertencoded(void* lpObj, char** lpCertEncoded, int* lenCertEncoded);
int ipworksedi_as4server_setcertencoded(void* lpObj, const char* lpCertEncoded, int lenCertEncoded);

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

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

CertStore Property (AS4Server Class)

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

Syntax

• C++
• C
• Qt

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

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

int ipworksedi_as4server_getcertstore(void* lpObj, char** lpCertStore, int* lenCertStore);
int ipworksedi_as4server_setcertstore(void* lpObj, const char* lpCertStore, int lenCertStore);

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

Default Value

"MY"

Remarks

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

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

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Binary String

CertStorePassword Property (AS4Server Class)

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

Syntax

• C++
• C
• Qt

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

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

char* ipworksedi_as4server_getcertstorepassword(void* lpObj);
int ipworksedi_as4server_setcertstorepassword(void* lpObj, const char* lpszCertStorePassword);

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

Default Value

""

Remarks

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

Data Type

String

CertStoreType Property (AS4Server Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

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

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

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

int ipworksedi_as4server_getcertstoretype(void* lpObj);
int ipworksedi_as4server_setcertstoretype(void* lpObj, int iCertStoreType);

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

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

CertSubject Property (AS4Server Class)

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

Syntax

• C++
• C
• Qt

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

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

char* ipworksedi_as4server_getcertsubject(void* lpObj);
int ipworksedi_as4server_setcertsubject(void* lpObj, const char* lpszCertSubject);

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

Default Value

""

Remarks

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

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

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

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

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

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

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

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

Data Type

String

ConversationId Property (AS4Server 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_as4server_getconversationid(void* lpObj);
int ipworksedi_as4server_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

EDIDataCount Property (AS4Server Class)

The number of records in the EDI arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEDIDataCount();
int SetEDIDataCount(int iEDIDataCount);

Unicode (Windows)
INT GetEDIDataCount();
INT SetEDIDataCount(INT iEDIDataCount);

int ipworksedi_as4server_getedidatacount(void* lpObj);
int ipworksedi_as4server_setedidatacount(void* lpObj, int iEDIDataCount);

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

Default Value

0

Remarks

This property controls the size of the following arrays:

• EDIData
• EDIEDIType
• EDIFilename
• EDIName
• EDIPropertyCount
• EDIPropertyIndex
• EDIPropertyName
• EDIPropertyValue
• EDISchemaLocation
• EDISchemaNamespace
• EDISchemaVersion

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

This property is not available at design time.

Data Type

Integer

EDIData Property (AS4Server Class)

This property contains the EDI payload of the transmission.

Syntax

• C++
• C
• Qt

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

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

int ipworksedi_as4server_getedidata(void* lpObj, int edidataindex, char** lpEDIData, int* lenEDIData);
int ipworksedi_as4server_setedidata(void* lpObj, int edidataindex, const char* lpEDIData, int lenEDIData);

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

Default Value

""

Remarks

This property contains the EDI payload of the transmission.

When sending files this may be specified to the data to be sent. This can be used as an alternative to setting EDIFilename.

When receiving files this will only be populated if IncomingDirectory and EDIOutputStream have not been specified and ParseRequest finishes without an error. If so, Data will contain the full decrypted text of the EDI message.

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

The EDIDataIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EDIDataCount property.

This property is not available at design time.

Data Type

Binary String

EDIEDIType Property (AS4Server Class)

The Content-Type of the EDI message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEDIEDIType(int iEDIDataIndex);
int SetEDIEDIType(int iEDIDataIndex, const char* lpszEDIEDIType);

Unicode (Windows)
LPWSTR GetEDIEDIType(INT iEDIDataIndex);
INT SetEDIEDIType(INT iEDIDataIndex, LPCWSTR lpszEDIEDIType);

char* ipworksedi_as4server_getedieditype(void* lpObj, int edidataindex);
int ipworksedi_as4server_setedieditype(void* lpObj, int edidataindex, const char* lpszEDIEDIType);

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

Default Value

""

Remarks

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

The EDIDataIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EDIDataCount property.

This property is not available at design time.

Data Type

String

EDIFilename Property (AS4Server Class)

When sending, if Filename is specified, the file specified will be used for the EDI payload of the transmission.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEDIFilename(int iEDIDataIndex);
int SetEDIFilename(int iEDIDataIndex, const char* lpszEDIFilename);

Unicode (Windows)
LPWSTR GetEDIFilename(INT iEDIDataIndex);
INT SetEDIFilename(INT iEDIDataIndex, LPCWSTR lpszEDIFilename);

char* ipworksedi_as4server_getedifilename(void* lpObj, int edidataindex);
int ipworksedi_as4server_setedifilename(void* lpObj, int edidataindex, const char* lpszEDIFilename);

QString GetEDIFilename(int iEDIDataIndex);
int SetEDIFilename(int iEDIDataIndex, QString qsEDIFilename);

Default Value

""

Remarks

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

When receiving, if IncomingDirectory is set, this will be populated with the name of the file which contains the processed message contents.

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

The EDIDataIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EDIDataCount property.

This property is not available at design time.

Data Type

String

EDIName Property (AS4Server Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEDIName(int iEDIDataIndex);
int SetEDIName(int iEDIDataIndex, const char* lpszEDIName);

Unicode (Windows)
LPWSTR GetEDIName(INT iEDIDataIndex);
INT SetEDIName(INT iEDIDataIndex, LPCWSTR lpszEDIName);

char* ipworksedi_as4server_getediname(void* lpObj, int edidataindex);
int ipworksedi_as4server_setediname(void* lpObj, int edidataindex, const char* lpszEDIName);

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

Default Value

"rfc1767.edi"

Remarks

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

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

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

The EDIDataIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EDIDataCount property.

This property is not available at design time.

Data Type

String

EDIPropertyCount Property (AS4Server Class)

The number of properties for this file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEDIPropertyCount(int iEDIDataIndex);
int SetEDIPropertyCount(int iEDIDataIndex, int iEDIPropertyCount);

Unicode (Windows)
INT GetEDIPropertyCount(INT iEDIDataIndex);
INT SetEDIPropertyCount(INT iEDIDataIndex, INT iEDIPropertyCount);

int ipworksedi_as4server_getedipropertycount(void* lpObj, int edidataindex);
int ipworksedi_as4server_setedipropertycount(void* lpObj, int edidataindex, int iEDIPropertyCount);

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

Default Value

0

Remarks

The number of properties for this file.

Each file may contain zero or more properties associated with it. This property, in conjunction with EDIPropertyIndex, EDIPropertyName, and EDIPropertyValue can be used to specify properties when sending and read properties when receiving.

Sending

When sending files to add properties set EDIPropertyCount to specify the number of properties. Then set EDIPropertyIndex to select the property. Set EDIPropertyName and EDIPropertyValue to define the values for the property at EDIPropertyIndex. For instance: data = new EBData(); data.EDIType = "image/jpeg"; data.Filename = "..\\1.jpg"; data.Name = "1.jpg"; data.PropertyCount = 2; //Define two properties data.PropertyIndex = 0; //Select the first property data.PropertyName = "name1"; data.PropertyValue = "value1"; data.PropertyIndex = 1; //Select the second property data.PropertyName = "name2"; data.PropertyValue = "value2";

Receiving

When receiving files these properties may be queried to retrieve the values set by the sender. Inspect EDIPropertyCount to obtain the number of properties. Next set EDIPropertyIndex to select a property and query EDIPropertyName and EDIPropertyValue. For instance:

for (int i = 0; i < server.EDIData[0].PropertyCount;i++) { server.EDIData[0].PropertyIndex = i; Console.WriteLine(server.EDIData[0].PropertyName + ": " + server.EDIData[0].PropertyValue); }

The EDIDataIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EDIDataCount property.

This property is not available at design time.

Data Type

Integer

EDIPropertyIndex Property (AS4Server Class)

Selects a property at the specified index.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEDIPropertyIndex(int iEDIDataIndex);
int SetEDIPropertyIndex(int iEDIDataIndex, int iEDIPropertyIndex);

Unicode (Windows)
INT GetEDIPropertyIndex(INT iEDIDataIndex);
INT SetEDIPropertyIndex(INT iEDIDataIndex, INT iEDIPropertyIndex);

int ipworksedi_as4server_getedipropertyindex(void* lpObj, int edidataindex);
int ipworksedi_as4server_setedipropertyindex(void* lpObj, int edidataindex, int iEDIPropertyIndex);

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

Default Value

0

Remarks

Selects a property at the specified index.

The EDIDataIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EDIDataCount property.

This property is not available at design time.

Data Type

Integer

EDIPropertyName Property (AS4Server Class)

The name of the property.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEDIPropertyName(int iEDIDataIndex);
int SetEDIPropertyName(int iEDIDataIndex, const char* lpszEDIPropertyName);

Unicode (Windows)
LPWSTR GetEDIPropertyName(INT iEDIDataIndex);
INT SetEDIPropertyName(INT iEDIDataIndex, LPCWSTR lpszEDIPropertyName);

char* ipworksedi_as4server_getedipropertyname(void* lpObj, int edidataindex);
int ipworksedi_as4server_setedipropertyname(void* lpObj, int edidataindex, const char* lpszEDIPropertyName);

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

Default Value

""

Remarks

The name of the property.

The EDIDataIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EDIDataCount property.

This property is not available at design time.

Data Type

String

EDIPropertyValue Property (AS4Server Class)

The value of the property.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEDIPropertyValue(int iEDIDataIndex);
int SetEDIPropertyValue(int iEDIDataIndex, const char* lpszEDIPropertyValue);

Unicode (Windows)
LPWSTR GetEDIPropertyValue(INT iEDIDataIndex);
INT SetEDIPropertyValue(INT iEDIDataIndex, LPCWSTR lpszEDIPropertyValue);

char* ipworksedi_as4server_getedipropertyvalue(void* lpObj, int edidataindex);
int ipworksedi_as4server_setedipropertyvalue(void* lpObj, int edidataindex, const char* lpszEDIPropertyValue);

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

Default Value

""

Remarks

The value of the property.

The EDIDataIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EDIDataCount property.

This property is not available at design time.

Data Type

String

EDISchemaLocation Property (AS4Server Class)

The SchemaLocation , SchemaNamespace , and SchemaVersion optionally define the schema that applies to this particular file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEDISchemaLocation(int iEDIDataIndex);
int SetEDISchemaLocation(int iEDIDataIndex, const char* lpszEDISchemaLocation);

Unicode (Windows)
LPWSTR GetEDISchemaLocation(INT iEDIDataIndex);
INT SetEDISchemaLocation(INT iEDIDataIndex, LPCWSTR lpszEDISchemaLocation);

char* ipworksedi_as4server_getedischemalocation(void* lpObj, int edidataindex);
int ipworksedi_as4server_setedischemalocation(void* lpObj, int edidataindex, const char* lpszEDISchemaLocation);

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

Default Value

""

Remarks

The EDISchemaLocation, EDISchemaNamespace, and EDISchemaVersion optionally define the schema that applies to this particular file. This may be used by the receiving party to properly interpret the file data.

Schema information is not required, but if schema information is included EDISchemaLocation is required and must be set to the URI of the schema.

This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:PayloadInfo/eb:PartInfo/eb:Schema@location"

The EDIDataIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EDIDataCount property.

This property is not available at design time.

Data Type

String

EDISchemaNamespace Property (AS4Server Class)

The namespace of the schema.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEDISchemaNamespace(int iEDIDataIndex);
int SetEDISchemaNamespace(int iEDIDataIndex, const char* lpszEDISchemaNamespace);

Unicode (Windows)
LPWSTR GetEDISchemaNamespace(INT iEDIDataIndex);
INT SetEDISchemaNamespace(INT iEDIDataIndex, LPCWSTR lpszEDISchemaNamespace);

char* ipworksedi_as4server_getedischemanamespace(void* lpObj, int edidataindex);
int ipworksedi_as4server_setedischemanamespace(void* lpObj, int edidataindex, const char* lpszEDISchemaNamespace);

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

Default Value

""

Remarks

The namespace of the schema. This property is optional. Refer to EDISchemaLocation for details.

This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:PayloadInfo/eb:PartInfo/eb:Schema@namespace"

The EDIDataIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EDIDataCount property.

This property is not available at design time.

Data Type

String

EDISchemaVersion Property (AS4Server Class)

The version of the schema.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEDISchemaVersion(int iEDIDataIndex);
int SetEDISchemaVersion(int iEDIDataIndex, const char* lpszEDISchemaVersion);

Unicode (Windows)
LPWSTR GetEDISchemaVersion(INT iEDIDataIndex);
INT SetEDISchemaVersion(INT iEDIDataIndex, LPCWSTR lpszEDISchemaVersion);

char* ipworksedi_as4server_getedischemaversion(void* lpObj, int edidataindex);
int ipworksedi_as4server_setedischemaversion(void* lpObj, int edidataindex, const char* lpszEDISchemaVersion);

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

Default Value

""

Remarks

The version of the schema. This property is optional. Refer to EDISchemaLocation for details.

This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:PayloadInfo/eb:PartInfo/eb:Schema@namespace"

The EDIDataIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EDIDataCount property.

This property is not available at design time.

Data Type

String

EncryptionAlgorithm Property (AS4Server 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_as4server_getencryptionalgorithm(void* lpObj);
int ipworksedi_as4server_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

ErrorCount Property (AS4Server Class)

The number of records in the Error arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetErrorCount();
int SetErrorCount(int iErrorCount);

Unicode (Windows)
INT GetErrorCount();
INT SetErrorCount(INT iErrorCount);

int ipworksedi_as4server_geterrorcount(void* lpObj);
int ipworksedi_as4server_seterrorcount(void* lpObj, int iErrorCount);

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

Default Value

0

Remarks

This property controls the size of the following arrays:

• ErrorCategory
• ErrorCode
• ErrorDescription
• ErrorDetail
• ErrorOrigin
• ErrorRefMessageId
• ErrorSeverity
• ErrorShortDescription

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

This property is not available at design time.

Data Type

Integer

ErrorCategory Property (AS4Server Class)

The category of error.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetErrorCategory(int iErrorIndex);
int SetErrorCategory(int iErrorIndex, const char* lpszErrorCategory);

Unicode (Windows)
LPWSTR GetErrorCategory(INT iErrorIndex);
INT SetErrorCategory(INT iErrorIndex, LPCWSTR lpszErrorCategory);

char* ipworksedi_as4server_geterrorcategory(void* lpObj, int errorindex);
int ipworksedi_as4server_seterrorcategory(void* lpObj, int errorindex, const char* lpszErrorCategory);

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

Default Value

""

Remarks

The category of error. Typical values include "Content", "Packaging", "UnPackaging", "Communication", and "InternalProcess". This value is optional.

The ErrorIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ErrorCount property.

This property is not available at design time.

Data Type

String

ErrorCode Property (AS4Server Class)

The error code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetErrorCode(int iErrorIndex);
int SetErrorCode(int iErrorIndex, const char* lpszErrorCode);

Unicode (Windows)
LPWSTR GetErrorCode(INT iErrorIndex);
INT SetErrorCode(INT iErrorIndex, LPCWSTR lpszErrorCode);

char* ipworksedi_as4server_geterrorcode(void* lpObj, int errorindex);
int ipworksedi_as4server_seterrorcode(void* lpObj, int errorindex, const char* lpszErrorCode);

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

Default Value

""

Remarks

The error code. This value is required. The standard format is "EBMS:0001", where "0001" is the numeric code portion.

The ErrorIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ErrorCount property.

This property is not available at design time.

Data Type

String

ErrorDescription Property (AS4Server Class)

The description of the error.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetErrorDescription(int iErrorIndex);
int SetErrorDescription(int iErrorIndex, const char* lpszErrorDescription);

Unicode (Windows)
LPWSTR GetErrorDescription(INT iErrorIndex);
INT SetErrorDescription(INT iErrorIndex, LPCWSTR lpszErrorDescription);

char* ipworksedi_as4server_geterrordescription(void* lpObj, int errorindex);
int ipworksedi_as4server_seterrordescription(void* lpObj, int errorindex, const char* lpszErrorDescription);

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

Default Value

""

Remarks

The description of the error. This value is optional.

The ErrorIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ErrorCount property.

This property is not available at design time.

Data Type

String

ErrorDetail Property (AS4Server Class)

Additional details about the error.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetErrorDetail(int iErrorIndex);
int SetErrorDetail(int iErrorIndex, const char* lpszErrorDetail);

Unicode (Windows)
LPWSTR GetErrorDetail(INT iErrorIndex);
INT SetErrorDetail(INT iErrorIndex, LPCWSTR lpszErrorDetail);

char* ipworksedi_as4server_geterrordetail(void* lpObj, int errorindex);
int ipworksedi_as4server_seterrordetail(void* lpObj, int errorindex, const char* lpszErrorDetail);

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

Default Value

""

Remarks

Additional details about the error. This may include other helpful information such as a stack trace. This value is optional.

The ErrorIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ErrorCount property.

This property is not available at design time.

Data Type

String

ErrorOrigin Property (AS4Server Class)

The module within which the error occurred.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetErrorOrigin(int iErrorIndex);
int SetErrorOrigin(int iErrorIndex, const char* lpszErrorOrigin);

Unicode (Windows)
LPWSTR GetErrorOrigin(INT iErrorIndex);
INT SetErrorOrigin(INT iErrorIndex, LPCWSTR lpszErrorOrigin);

char* ipworksedi_as4server_geterrororigin(void* lpObj, int errorindex);
int ipworksedi_as4server_seterrororigin(void* lpObj, int errorindex, const char* lpszErrorOrigin);

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

Default Value

""

Remarks

The module within which the error occurred. Typical values include "ebMS", "reliability", and "security". This value is optional.

The ErrorIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ErrorCount property.

This property is not available at design time.

Data Type

String

ErrorRefMessageId Property (AS4Server Class)

The MessageId to which the error applies.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetErrorRefMessageId(int iErrorIndex);
int SetErrorRefMessageId(int iErrorIndex, const char* lpszErrorRefMessageId);

Unicode (Windows)
LPWSTR GetErrorRefMessageId(INT iErrorIndex);
INT SetErrorRefMessageId(INT iErrorIndex, LPCWSTR lpszErrorRefMessageId);

char* ipworksedi_as4server_geterrorrefmessageid(void* lpObj, int errorindex);
int ipworksedi_as4server_seterrorrefmessageid(void* lpObj, int errorindex, const char* lpszErrorRefMessageId);

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

Default Value

""

Remarks

The MessageId to which the error applies. This is optional but should be supplied if possible.

The ErrorIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ErrorCount property.

This property is not available at design time.

Data Type

String

ErrorSeverity Property (AS4Server Class)

The severity of the error.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetErrorSeverity(int iErrorIndex);
int SetErrorSeverity(int iErrorIndex, int iErrorSeverity);

Unicode (Windows)
INT GetErrorSeverity(INT iErrorIndex);
INT SetErrorSeverity(INT iErrorIndex, INT iErrorSeverity);

EBST_WARNING(0), 
EBST_FAILURE(1)

int ipworksedi_as4server_geterrorseverity(void* lpObj, int errorindex);
int ipworksedi_as4server_seterrorseverity(void* lpObj, int errorindex, int iErrorSeverity);

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

Default Value

0

Remarks

The severity of the error. Possible values are:

• 0 (ebstWarning - default)
• 1 (ebstFailure)

The ErrorIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ErrorCount property.

This property is not available at design time.

Data Type

Integer

ErrorShortDescription Property (AS4Server Class)

A short description of the error.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetErrorShortDescription(int iErrorIndex);
int SetErrorShortDescription(int iErrorIndex, const char* lpszErrorShortDescription);

Unicode (Windows)
LPWSTR GetErrorShortDescription(INT iErrorIndex);
INT SetErrorShortDescription(INT iErrorIndex, LPCWSTR lpszErrorShortDescription);

char* ipworksedi_as4server_geterrorshortdescription(void* lpObj, int errorindex);
int ipworksedi_as4server_seterrorshortdescription(void* lpObj, int errorindex, const char* lpszErrorShortDescription);

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

Default Value

""

Remarks

A short description of the error. This may be helpful for logging or readability. This value is optional.

The ErrorIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ErrorCount property.

This property is not available at design time.

Data Type

String

IncomingDirectory Property (AS4Server 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_as4server_getincomingdirectory(void* lpObj);
int ipworksedi_as4server_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

IncomingReceiptContent Property (AS4Server Class)

The content of the receipt.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetIncomingReceiptContent();

Unicode (Windows)
LPWSTR GetIncomingReceiptContent();

char* ipworksedi_as4server_getincomingreceiptcontent(void* lpObj);

QString GetIncomingReceiptContent();

Default Value

""

Remarks

The content of the receipt. This is the raw XML of the receipt.

The class will automatically create the receipt, and verify the receipt, depending on the method called. In most cases this is simply informational and may be stored for logging purposes if desired.

This property is read-only.

Data Type

String

IncomingReceiptRefToMessageId Property (AS4Server Class)

The Message Id to which this receipt applies.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetIncomingReceiptRefToMessageId();

Unicode (Windows)
LPWSTR GetIncomingReceiptRefToMessageId();

char* ipworksedi_as4server_getincomingreceiptreftomessageid(void* lpObj);

QString GetIncomingReceiptRefToMessageId();

Default Value

""

Remarks

The Message Id to which this receipt applies. This is the original Message Id from the initial transmission of the file. This allows the receipt to be correlated with the original transmission.

The class will automatically create the receipt, and verify the receipt, depending on the method called. In most cases this is simply informational and may be stored for logging purposes if desired.

This property is read-only.

Data Type

String

LogDirectory Property (AS4Server 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_as4server_getlogdirectory(void* lpObj);
int ipworksedi_as4server_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 (AS4Server Class)

The log file written.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLogFile();

Unicode (Windows)
LPWSTR GetLogFile();

char* ipworksedi_as4server_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 (AS4Server 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_as4server_getmessageid(void* lpObj);
int ipworksedi_as4server_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

MessagePropertyCount Property (AS4Server Class)

The number of records in the MessageProperty arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMessagePropertyCount();
int SetMessagePropertyCount(int iMessagePropertyCount);

Unicode (Windows)
INT GetMessagePropertyCount();
INT SetMessagePropertyCount(INT iMessagePropertyCount);

int ipworksedi_as4server_getmessagepropertycount(void* lpObj);
int ipworksedi_as4server_setmessagepropertycount(void* lpObj, int iMessagePropertyCount);

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

Default Value

0

Remarks

This property controls the size of the following arrays:

• MessagePropertyName
• MessagePropertyPropertyType
• MessagePropertyValue

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

This property is not available at design time.

Data Type

Integer

MessagePropertyName Property (AS4Server Class)

This property defines the name of the message property.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessagePropertyName(int iMessagePropertyIndex);
int SetMessagePropertyName(int iMessagePropertyIndex, const char* lpszMessagePropertyName);

Unicode (Windows)
LPWSTR GetMessagePropertyName(INT iMessagePropertyIndex);
INT SetMessagePropertyName(INT iMessagePropertyIndex, LPCWSTR lpszMessagePropertyName);

char* ipworksedi_as4server_getmessagepropertyname(void* lpObj, int messagepropertyindex);
int ipworksedi_as4server_setmessagepropertyname(void* lpObj, int messagepropertyindex, const char* lpszMessagePropertyName);

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

Default Value

""

Remarks

This property defines the name of the message property. This is required.

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

The MessagePropertyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagePropertyCount property.

This property is not available at design time.

Data Type

String

MessagePropertyPropertyType Property (AS4Server Class)

The optional type of the message property.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessagePropertyPropertyType(int iMessagePropertyIndex);
int SetMessagePropertyPropertyType(int iMessagePropertyIndex, const char* lpszMessagePropertyPropertyType);

Unicode (Windows)
LPWSTR GetMessagePropertyPropertyType(INT iMessagePropertyIndex);
INT SetMessagePropertyPropertyType(INT iMessagePropertyIndex, LPCWSTR lpszMessagePropertyPropertyType);

char* ipworksedi_as4server_getmessagepropertypropertytype(void* lpObj, int messagepropertyindex);
int ipworksedi_as4server_setmessagepropertypropertytype(void* lpObj, int messagepropertyindex, const char* lpszMessagePropertyPropertyType);

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

Default Value

""

Remarks

The optional type of the message property.

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

The MessagePropertyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagePropertyCount property.

This property is not available at design time.

Data Type

String

MessagePropertyValue Property (AS4Server Class)

The value of the message property.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessagePropertyValue(int iMessagePropertyIndex);
int SetMessagePropertyValue(int iMessagePropertyIndex, const char* lpszMessagePropertyValue);

Unicode (Windows)
LPWSTR GetMessagePropertyValue(INT iMessagePropertyIndex);
INT SetMessagePropertyValue(INT iMessagePropertyIndex, LPCWSTR lpszMessagePropertyValue);

char* ipworksedi_as4server_getmessagepropertyvalue(void* lpObj, int messagepropertyindex);
int ipworksedi_as4server_setmessagepropertyvalue(void* lpObj, int messagepropertyindex, const char* lpszMessagePropertyValue);

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

Default Value

""

Remarks

The value of the message property.

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

The MessagePropertyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagePropertyCount property.

This property is not available at design time.

Data Type

String

MPC Property (AS4Server Class)

The MPC (Message Partition Channel) from which files are requested.

Syntax

• C++
• C
• Qt

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

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

char* ipworksedi_as4server_getmpc(void* lpObj);
int ipworksedi_as4server_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"

This property defines the MPC (Message Partition Channel) from which the client requests files. This is populated after calling ReadRequest and is used to determine from which channel to provide files to the client.

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

Data Type

String

OriginalSOAPMessage Property (AS4Server 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_as4server_getoriginalsoapmessage(void* lpObj);
int ipworksedi_as4server_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 (AS4Server 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_as4server_getoriginalsoapmessageid(void* lpObj);
int ipworksedi_as4server_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 (AS4Server 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)

int ipworksedi_as4server_getprofile(void* lpObj);
int ipworksedi_as4server_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 ebpfEDelivery the following settings are automatically applied:

Data Type

Integer

ReceiptContent Property (AS4Server Class)

The content of the receipt.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReceiptContent();
int SetReceiptContent(const char* lpszReceiptContent);

Unicode (Windows)
LPWSTR GetReceiptContent();
INT SetReceiptContent(LPCWSTR lpszReceiptContent);

char* ipworksedi_as4server_getreceiptcontent(void* lpObj);
int ipworksedi_as4server_setreceiptcontent(void* lpObj, const char* lpszReceiptContent);

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

Default Value

""

Remarks

The content of the receipt. This is the raw XML of the receipt.

The class will automatically create the receipt, and verify the receipt, depending on the method called. In most cases this is simply informational and may be stored for logging purposes if desired.

Data Type

String

ReceiptRefToMessageId Property (AS4Server Class)

The Message Id to which this receipt applies.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReceiptRefToMessageId();
int SetReceiptRefToMessageId(const char* lpszReceiptRefToMessageId);

Unicode (Windows)
LPWSTR GetReceiptRefToMessageId();
INT SetReceiptRefToMessageId(LPCWSTR lpszReceiptRefToMessageId);

char* ipworksedi_as4server_getreceiptreftomessageid(void* lpObj);
int ipworksedi_as4server_setreceiptreftomessageid(void* lpObj, const char* lpszReceiptRefToMessageId);

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

Default Value

""

Remarks

The Message Id to which this receipt applies. This is the original Message Id from the initial transmission of the file. This allows the receipt to be correlated with the original transmission.

The class will automatically create the receipt, and verify the receipt, depending on the method called. In most cases this is simply informational and may be stored for logging purposes if desired.

Data Type

String

ReceiptReplyMode Property (AS4Server 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_as4server_getreceiptreplymode(void* lpObj);
int ipworksedi_as4server_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

RecipientCertCount Property (AS4Server Class)

The number of records in the RecipientCert arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRecipientCertCount();
int SetRecipientCertCount(int iRecipientCertCount);

Unicode (Windows)
INT GetRecipientCertCount();
INT SetRecipientCertCount(INT iRecipientCertCount);

int ipworksedi_as4server_getrecipientcertcount(void* lpObj);
int ipworksedi_as4server_setrecipientcertcount(void* lpObj, int iRecipientCertCount);

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

Default Value

0

Remarks

This property controls the size of the following arrays:

• RecipientCertEncoded

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

This property is not available at design time.

Data Type

Integer

RecipientCertEncoded Property (AS4Server Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRecipientCertEncoded(int iRecipientCertIndex, char* &lpRecipientCertEncoded, int &lenRecipientCertEncoded);
int SetRecipientCertEncoded(int iRecipientCertIndex, const char* lpRecipientCertEncoded, int lenRecipientCertEncoded);

Unicode (Windows)
INT GetRecipientCertEncoded(INT iRecipientCertIndex, LPSTR &lpRecipientCertEncoded, INT &lenRecipientCertEncoded);
INT SetRecipientCertEncoded(INT iRecipientCertIndex, LPCSTR lpRecipientCertEncoded, INT lenRecipientCertEncoded);

int ipworksedi_as4server_getrecipientcertencoded(void* lpObj, int recipientcertindex, char** lpRecipientCertEncoded, int* lenRecipientCertEncoded);
int ipworksedi_as4server_setrecipientcertencoded(void* lpObj, int recipientcertindex, const char* lpRecipientCertEncoded, int lenRecipientCertEncoded);

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

Default Value

""

Remarks

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

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

The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.

This property is not available at design time.

Data Type

Binary String

RefToMessageId Property (AS4Server 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_as4server_getreftomessageid(void* lpObj);
int ipworksedi_as4server_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

Request Property (AS4Server Class)

The HTTP request to be processed.

Syntax

• C++
• C
• Qt

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

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

int ipworksedi_as4server_getrequest(void* lpObj, char** lpRequest, int* lenRequest);
int ipworksedi_as4server_setrequest(void* lpObj, const char* lpRequest, int lenRequest);

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

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

Binary String

RequestHeaderCount Property (AS4Server Class)

The number of records in the RequestHeader arrays.

Syntax

• C++
• C
• Qt

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

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

int ipworksedi_as4server_getrequestheadercount(void* lpObj);
int ipworksedi_as4server_setrequestheadercount(void* lpObj, int iRequestHeaderCount);

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

Default Value

0

Remarks

This property controls the size of the following arrays:

• RequestHeaderField
• RequestHeaderValue

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

This property is not available at design time.

Data Type

Integer

RequestHeaderField Property (AS4Server Class)

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

Syntax

• C++
• C
• Qt

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

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

char* ipworksedi_as4server_getrequestheaderfield(void* lpObj, int requestheaderindex);
int ipworksedi_as4server_setrequestheaderfield(void* lpObj, int requestheaderindex, const char* lpszRequestHeaderField);

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

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

RequestHeaderValue Property (AS4Server Class)

This property contains the header contents.

Syntax

• C++
• C
• Qt

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

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

char* ipworksedi_as4server_getrequestheadervalue(void* lpObj, int requestheaderindex);
int ipworksedi_as4server_setrequestheadervalue(void* lpObj, int requestheaderindex, const char* lpszRequestHeaderValue);

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

Default Value

""

Remarks

This property contains the Header contents.

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

This property is not available at design time.

Data Type

String

RequestHeadersString Property (AS4Server Class)

The HTTP headers in the AS4 request.

Syntax

• C++
• C
• Qt

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

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

char* ipworksedi_as4server_getrequestheadersstring(void* lpObj);
int ipworksedi_as4server_setrequestheadersstring(void* lpObj, const char* lpszRequestHeadersString);

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

Default Value

""

Remarks

The entire list of headers, concatenated into a single string. These will include all HTTP headers. Specific headers may be accessed through RequestHeaders.

Data Type

String

Service Property (AS4Server 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_as4server_getservice(void* lpObj);
int ipworksedi_as4server_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 (AS4Server 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_as4server_getserviceaction(void* lpObj);
int ipworksedi_as4server_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 (AS4Server 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_as4server_getservicetype(void* lpObj);
int ipworksedi_as4server_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 (AS4Server 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_as4server_getsignaturealgorithm(void* lpObj);
int ipworksedi_as4server_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

The default value is "SHA-256".

Data Type

String

SignerCertEncoded Property (AS4Server Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

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

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

int ipworksedi_as4server_getsignercertencoded(void* lpObj, char** lpSignerCertEncoded, int* lenSignerCertEncoded);
int ipworksedi_as4server_setsignercertencoded(void* lpObj, const char* lpSignerCertEncoded, int lenSignerCertEncoded);

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

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SignerCertStore Property (AS4Server Class)

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

Syntax

• C++
• C
• Qt

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

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

int ipworksedi_as4server_getsignercertstore(void* lpObj, char** lpSignerCertStore, int* lenSignerCertStore);
int ipworksedi_as4server_setsignercertstore(void* lpObj, const char* lpSignerCertStore, int lenSignerCertStore);

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

Default Value

"MY"

Remarks

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

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

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Binary String

SignerCertStorePassword Property (AS4Server Class)

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

Syntax

• C++
• C
• Qt

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

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

char* ipworksedi_as4server_getsignercertstorepassword(void* lpObj);
int ipworksedi_as4server_setsignercertstorepassword(void* lpObj, const char* lpszSignerCertStorePassword);

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

Default Value

""

Remarks

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

Data Type

String

SignerCertStoreType Property (AS4Server Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

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

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

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

int ipworksedi_as4server_getsignercertstoretype(void* lpObj);
int ipworksedi_as4server_setsignercertstoretype(void* lpObj, int iSignerCertStoreType);

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

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

SignerCertSubject Property (AS4Server Class)

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

Syntax

• C++
• C
• Qt

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

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

char* ipworksedi_as4server_getsignercertsubject(void* lpObj);
int ipworksedi_as4server_setsignercertsubject(void* lpObj, const char* lpszSignerCertSubject);

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

Default Value

""

Remarks

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

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

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

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

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

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

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

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

Data Type

String

SigningCertEncoded Property (AS4Server Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSigningCertEncoded(char* &lpSigningCertEncoded, int &lenSigningCertEncoded);
int SetSigningCertEncoded(const char* lpSigningCertEncoded, int lenSigningCertEncoded);

Unicode (Windows)
INT GetSigningCertEncoded(LPSTR &lpSigningCertEncoded, INT &lenSigningCertEncoded);
INT SetSigningCertEncoded(LPCSTR lpSigningCertEncoded, INT lenSigningCertEncoded);

int ipworksedi_as4server_getsigningcertencoded(void* lpObj, char** lpSigningCertEncoded, int* lenSigningCertEncoded);
int ipworksedi_as4server_setsigningcertencoded(void* lpObj, const char* lpSigningCertEncoded, int lenSigningCertEncoded);

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

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SigningCertStore Property (AS4Server Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSigningCertStore(char* &lpSigningCertStore, int &lenSigningCertStore);
int SetSigningCertStore(const char* lpSigningCertStore, int lenSigningCertStore);

Unicode (Windows)
INT GetSigningCertStore(LPSTR &lpSigningCertStore, INT &lenSigningCertStore);
INT SetSigningCertStore(LPCSTR lpSigningCertStore, INT lenSigningCertStore);

int ipworksedi_as4server_getsigningcertstore(void* lpObj, char** lpSigningCertStore, int* lenSigningCertStore);
int ipworksedi_as4server_setsigningcertstore(void* lpObj, const char* lpSigningCertStore, int lenSigningCertStore);

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

Default Value

"MY"

Remarks

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

The SigningCertStoreType property denotes the type of the certificate store specified by SigningCertStore. If the store is password protected, specify the password in SigningCertStorePassword.

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Binary String

SigningCertStorePassword Property (AS4Server Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSigningCertStorePassword();
int SetSigningCertStorePassword(const char* lpszSigningCertStorePassword);

Unicode (Windows)
LPWSTR GetSigningCertStorePassword();
INT SetSigningCertStorePassword(LPCWSTR lpszSigningCertStorePassword);

char* ipworksedi_as4server_getsigningcertstorepassword(void* lpObj);
int ipworksedi_as4server_setsigningcertstorepassword(void* lpObj, const char* lpszSigningCertStorePassword);

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

Default Value

""

Remarks

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

Data Type

String

SigningCertStoreType Property (AS4Server Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSigningCertStoreType();
int SetSigningCertStoreType(int iSigningCertStoreType);

Unicode (Windows)
INT GetSigningCertStoreType();
INT SetSigningCertStoreType(INT iSigningCertStoreType);

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

int ipworksedi_as4server_getsigningcertstoretype(void* lpObj);
int ipworksedi_as4server_setsigningcertstoretype(void* lpObj, int iSigningCertStoreType);

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

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

SigningCertSubject Property (AS4Server Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSigningCertSubject();
int SetSigningCertSubject(const char* lpszSigningCertSubject);

Unicode (Windows)
LPWSTR GetSigningCertSubject();
INT SetSigningCertSubject(LPCWSTR lpszSigningCertSubject);

char* ipworksedi_as4server_getsigningcertsubject(void* lpObj);
int ipworksedi_as4server_setsigningcertsubject(void* lpObj, const char* lpszSigningCertSubject);

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

Default Value

""

Remarks

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

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

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

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

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

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

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

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

Data Type

String

Config Method (AS4Server 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_as4server_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 (AS4Server Class)

Processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int ipworksedi_as4server_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 (AS4Server Class)

Interrupt the current method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

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

ParseRequest Method (AS4Server Class)

Parses and processes the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ParseRequest();

Unicode (Windows)
INT ParseRequest();

int ipworksedi_as4server_parserequest(void* lpObj);

int ParseRequest();

Remarks

This method processes the message in the request. If the message is encrypted, it will be decrypted. If the message is signed, the signature will be verified. This method should be called after calling ReadRequest and specifying any necessary certificates for the operation to complete successfully.

Receiving Files and Sending a Receipt

When receiving files first check the AgreementRef, AS4From, and AS4To properties to determine who is sending the files and with what previously agreed upon configuration. Once this is known, if the request is signed and encrypted set Certificate to the decryption certificate and SignerCert to the public certificate used for signature verification. IncomingDirectory may optionally be set to automatically store the incoming files. //Process incoming files and send a signed receipt server.ReadRequest(); //Inspect values from the request in order to load appropriate certificates etc. //Console.WriteLine(server.AgreementRef); //Console.WriteLine(server.AS4From.Id); //Console.WriteLine(server.AS4To.Id);) server.IncomingDirectory = "..\\MyFiles"; //Our private certificate. Used to decrypt the incoming file server.Certificate = new Certificate(CertStoreTypes.cstPFXFile, Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyB.pfx"), "password", "*"); //Partner's public certificate. Used to verify the signature on the incoming message and files. server.SignerCert = new Certificate(Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyA.cer")); server.ParseRequest(); server.ReceiptReplyMode = As4serverReceiptReplyModes.rrmSync; //Our private certificate. Used to sign the receipt. server.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyB.pfx"), "password", "*"); server.SendResponse(); //Sends the receipt Receiving Files and Sending an Asynchronous Receipt

Receipts may be sent in the response (synchronous) or at a later time (asynchronous). If the agreement specifies that the receipt be sent asynchronously the following steps may be taken to send the receipt.

After calling ReadRequest the ReceiptReplyMode may be set to indicate the receipt will be returned asynchronously. After calling ParseRequest call SendAckResponse to send back a HTTP 200 OK to the client. The receipt may then be returned later.

To send an asynchronous receipt AS4Client may be used. This can be sent to the partner's web site, or bundled with a later response (depending on the agreement made between the parties). In the example below AS4Client is used to send the receipt to the other party's web site.

//Process incoming files and send an asynchronous receipt server.ReadRequest(); //Inspect values from the request in order to load appropriate certificates etc. //Console.WriteLine(server.AgreementRef); //Console.WriteLine(server.AS4From.Id); //Console.WriteLine(server.AS4To.Id);) server.IncomingDirectory = "..\\MyFiles"; //Our private certificate. Used to decrypt the incoming file server.Certificate = new Certificate(CertStoreTypes.cstPFXFile, Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyB.pfx"), "password", "*"); //Partner's public certificate. Used to verify the signature on the incoming message and files. server.SignerCert = new Certificate(Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyA.cer")); server.ParseRequest(); server.ReceiptReplyMode = As4serverReceiptReplyModes.rrmAsync; //Our private certificate. Used to sign the receipt. server.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyB.pfx"), "password", "*"); server.SendAckResponse(); //Sends an ack, but not the receipt At this point Receipt is populated with the receipt to be sent. Store the Receipt's ReceiptContent and ReceiptRefToMessageId values for use when sending the receipt later. Sending a receipt can be done with AS4Client.

//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();

Sending Files

To process a request to send files first check the MPC property. This holds the Message Partition Channel (MPC) from which the client would like to receive files. Next, set AgreementRef, AS4From, AS4To. Check IncomingReceipt to determine if the request has a bundled receipt. If it does VerifyReceipt can be called to verify the receipt.

Note: If the client requests files from the default MPC then MPC may be empty. See MessageType for details.

If the client makes use of UsernameToken authentication the TokenAuthentication event will fire when processing the request.

To send files back to the client simply set EDIData to the files you wish to send. When SendResponse is called the files will be sent back to the client.

//Process a request to send files (pull) //Holds information from the original send so that receipts can be verified later server.AsyncReceiptInfoDir = Path.Combine(Request.PhysicalApplicationPath, "..\\temp\\ReceiptInfoDir") server.Profile = As4serverProfiles.ebpfENTSOG; server.ReadRequest(); //The receipt may be signed depending upon the AgreementRef server.SignerCert = new Certificate(Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyA.cer")); //If the request has a bundled receipt verify it first if (!string.IsNullOrEmpty(server.IncomingReceipt.Content)) { server.VerifyReceipt(); } //If the request is a pull request (MPC is set) if (server.AgreementRef == "" && server.MPC != "") { server.AgreementRef = "http://agreements.company.com/pull_files"; server.AS4From.Id = "org:holodeckb2b:example:company:B"; server.AS4From.Role = "Sender"; server.AS4To.Id = "org:holodeckb2b:example:company:A"; server.AS4To.Role = "Receiver"; server.ReceiptReplyMode = As4serverReceiptReplyModes.rrmAsync; //Our private certificate. Used to sign the message and files. server.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyB.pfx"), "password", "*"); //Partner's public certificate. Used to encrypt files. server.RecipientCerts.Add(new Certificate(Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyA.cer"))); EBData data = new EBData(); data.EDIType = "text/xml"; data.Data = "<test>Hello AS4 World!</test>"; server.EDIData.Add(data); server.SendResponse(); }

Error Handling (C++)

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

ReadRequest Method (AS4Server Class)

Reads the AS4 request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ReadRequest();

Unicode (Windows)
INT ReadRequest();

int ipworksedi_as4server_readrequest(void* lpObj);

int ReadRequest();

Remarks

To begin, when a request is received first call ReadRequest. This reads the AS4 request from the . Alternatively the request data may be passed directly to the class by specifying calling SetRequestStream. After calling ReadRequest the following properties may be checked:

• AgreementRef
• AS4From
• AS4To
• ConversationId
• EDIData
• Errors
• IncomingReceipt
• MessageId
• MessageProperties
• MPC
• Service
• ServiceAction
• ServiceType

The first step after calling ReadRequest is to determine if the client is sending files (push) or requesting files (pull). To determine this check the value of AgreementRef and MPC. For instance: if (server.AgreementRef == "" && server.MPC != "") { //The client is requesting files from the specified MPC //No other relevant properties are populated } else //AgreementRef is not empty, and MPC is empty { //The client is sending files. AgreementRef is populated with the agreement reference. //AS4From, AS4To, ConversationId, etc are populated }

Determining if the request contains an asynchronous receipt from a previous transmission may also be done at this time by checking the IncomingReceipt property's IncomingReceiptContent property. If it is populated a receipt is present. To verify the receipt set AsyncReceiptInfoDir to the directory where information about the message was originally stored and call VerifyReceipt. If the receipt is signed SignerCert must also be set. See the section below and also SendFiles for more details.

Once information about the request is determined the class may then be configured to respond appropriately depending on the operation.

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

Resets the state of the control.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

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

SendAckResponse Method (AS4Server Class)

Sends an acknowledgement of the request only.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendAckResponse();

Unicode (Windows)
INT SendAckResponse();

int ipworksedi_as4server_sendackresponse(void* lpObj);

int SendAckResponse();

Remarks

This method is used to respond to a client who sends a file and the agreement dictates that the receipt be returned asynchronously. In this case no receipt should be returned to the client. This method will send an acknowledgment only (no receipt) to the client to indicate that the request was received and processed.

This method is only applicable when ReceiptReplyMode is set to rrmAsync.

Error Handling (C++)

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

SendResponse Method (AS4Server Class)

This method sends the response over the current HTTP context.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendResponse();

Unicode (Windows)
INT SendResponse();

int ipworksedi_as4server_sendresponse(void* lpObj);

int SendResponse();

Remarks

This method sends the response. This should be called after ParseRequest to deliver the response to the client.

Receiving Files and Sending a Receipt

When receiving files first check the AgreementRef, AS4From, and AS4To properties to determine who is sending the files and with what previously agreed upon configuration. Once this is known, if the request is signed and encrypted set Certificate to the decryption certificate and SignerCert to the public certificate used for signature verification. IncomingDirectory may optionally be set to automatically store the incoming files. //Process incoming files and send a signed receipt server.ReadRequest(); //Inspect values from the request in order to load appropriate certificates etc. //Console.WriteLine(server.AgreementRef); //Console.WriteLine(server.AS4From.Id); //Console.WriteLine(server.AS4To.Id);) server.IncomingDirectory = "..\\MyFiles"; //Our private certificate. Used to decrypt the incoming file server.Certificate = new Certificate(CertStoreTypes.cstPFXFile, Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyB.pfx"), "password", "*"); //Partner's public certificate. Used to verify the signature on the incoming message and files. server.SignerCert = new Certificate(Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyA.cer")); server.ParseRequest(); server.ReceiptReplyMode = As4serverReceiptReplyModes.rrmSync; //Our private certificate. Used to sign the receipt. server.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyB.pfx"), "password", "*"); server.SendResponse(); //Sends the receipt Receiving Files and Sending an Asynchronous Receipt

Receipts may be sent in the response (synchronous) or at a later time (asynchronous). If the agreement specifies that the receipt be sent asynchronously the following steps may be taken to send the receipt.

After calling ReadRequest the ReceiptReplyMode may be set to indicate the receipt will be returned asynchronously. After calling ParseRequest call SendAckResponse to send back a HTTP 200 OK to the client. The receipt may then be returned later.

To send an asynchronous receipt AS4Client may be used. This can be sent to the partner's web site, or bundled with a later response (depending on the agreement made between the parties). In the example below AS4Client is used to send the receipt to the other party's web site.

//Process incoming files and send an asynchronous receipt server.ReadRequest(); //Inspect values from the request in order to load appropriate certificates etc. //Console.WriteLine(server.AgreementRef); //Console.WriteLine(server.AS4From.Id); //Console.WriteLine(server.AS4To.Id);) server.IncomingDirectory = "..\\MyFiles"; //Our private certificate. Used to decrypt the incoming file server.Certificate = new Certificate(CertStoreTypes.cstPFXFile, Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyB.pfx"), "password", "*"); //Partner's public certificate. Used to verify the signature on the incoming message and files. server.SignerCert = new Certificate(Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyA.cer")); server.ParseRequest(); server.ReceiptReplyMode = As4serverReceiptReplyModes.rrmAsync; //Our private certificate. Used to sign the receipt. server.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyB.pfx"), "password", "*"); server.SendAckResponse(); //Sends an ack, but not the receipt At this point Receipt is populated with the receipt to be sent. Store the Receipt's ReceiptContent and ReceiptRefToMessageId values for use when sending the receipt later. Sending a receipt can be done with AS4Client.

//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();

Sending Files

To process a request to send files first check the MPC property. This holds the Message Partition Channel (MPC) from which the client would like to receive files. Next, set AgreementRef, AS4From, AS4To. Check IncomingReceipt to determine if the request has a bundled receipt. If it does VerifyReceipt can be called to verify the receipt.

Note: If the client requests files from the default MPC then MPC may be empty. See MessageType for details.

If the client makes use of UsernameToken authentication the TokenAuthentication event will fire when processing the request.

To send files back to the client simply set EDIData to the files you wish to send. When SendResponse is called the files will be sent back to the client.

//Process a request to send files (pull) //Holds information from the original send so that receipts can be verified later server.AsyncReceiptInfoDir = Path.Combine(Request.PhysicalApplicationPath, "..\\temp\\ReceiptInfoDir") server.Profile = As4serverProfiles.ebpfENTSOG; server.ReadRequest(); //The receipt may be signed depending upon the AgreementRef server.SignerCert = new Certificate(Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyA.cer")); //If the request has a bundled receipt verify it first if (!string.IsNullOrEmpty(server.IncomingReceipt.Content)) { server.VerifyReceipt(); } //If the request is a pull request (MPC is set) if (server.AgreementRef == "" && server.MPC != "") { server.AgreementRef = "http://agreements.company.com/pull_files"; server.AS4From.Id = "org:holodeckb2b:example:company:B"; server.AS4From.Role = "Sender"; server.AS4To.Id = "org:holodeckb2b:example:company:A"; server.AS4To.Role = "Receiver"; server.ReceiptReplyMode = As4serverReceiptReplyModes.rrmAsync; //Our private certificate. Used to sign the message and files. server.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyB.pfx"), "password", "*"); //Partner's public certificate. Used to encrypt files. server.RecipientCerts.Add(new Certificate(Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyA.cer"))); EBData data = new EBData(); data.EDIType = "text/xml"; data.Data = "<test>Hello AS4 World!</test>"; server.EDIData.Add(data); server.SendResponse(); }

Error Handling (C++)

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

VerifyReceipt Method (AS4Server Class)

Verifies a received receipt.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int VerifyReceipt();

Unicode (Windows)
INT VerifyReceipt();

int ipworksedi_as4server_verifyreceipt(void* lpObj);

int VerifyReceipt();

Remarks

This method is used to verify asynchronous receipts held in IncomingReceipt.

Processing Receipts

Any incoming request may potentially include a receipt. The request may be a receipt by itself, or it may be bundled with another type of request (send/receive). When initially sending files AsyncReceiptInfoDir may be set to store data about the original message on disk for use when verifying the receipt. If this is not desired manually store the OriginalSOAPMessage and OriginalSOAPMessageId instead.

To detect if an incoming request contains a receipt simply check the IncomingReceipt property's ReceiptContent property. If it is populated the request includes a receipt. Set AsyncReceiptInfoDir to the same location as when the file was originally sent. Or alternatively set OriginalSOAPMessage and OriginalSOAPMessageId properties to the original values.

If the receipt is signed set SignerCert to the public certificate which will be used to verify the signature. Lastly call VerifyReceipt. This will perform any signature verification and verify the receipt content as well, matching it to the original message values.

server.ReadRequest(); //The receipt may be signed depending upon the AgreementRef server.SignerCert = new Certificate(Path.Combine(Request.PhysicalApplicationPath, "..\\files\\CompanyA.cer")); //If the request contains a receipt verify it if (!string.IsNullOrEmpty(server.IncomingReceipt.Content)) { server.VerifyReceipt(); }

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

Error Event (AS4Server Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_AS4SERVER_ERROR 1

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

class AS4ServerErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

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

Remarks

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

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

Log Event (AS4Server Class)

Fired with log information while processing a message.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_AS4SERVER_LOG 2

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

class AS4ServerLogEventParams {
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(AS4ServerLogEventParams *e);

// Or, subclass AS4Server and override this emitter function.
virtual int FireLog(AS4ServerLogEventParams *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 (AS4Server Class)

Fired for each recipient certificate of the encrypted message.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_AS4SERVER_RECIPIENTINFO 3

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

class AS4ServerRecipientInfoEventParams {
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(AS4ServerRecipientInfoEventParams *e);

// Or, subclass AS4Server and override this emitter function.
virtual int FireRecipientInfo(AS4ServerRecipientInfoEventParams *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"

SignerCertInfo Event (AS4Server Class)

This event is fired during verification of the signed message.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_AS4SERVER_SIGNERCERTINFO 4

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

class AS4ServerSignerCertInfoEventParams {
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(AS4ServerSignerCertInfoEventParams *e);

// Or, subclass AS4Server and override this emitter function.
virtual int FireSignerCertInfo(AS4ServerSignerCertInfoEventParams *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.

TokenAuthentication Event (AS4Server Class)

Fired when the client makes use of UsernameToken authentication.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_AS4SERVER_TOKENAUTHENTICATION 5

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

class AS4ServerTokenAuthenticationEventParams {
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(AS4ServerTokenAuthenticationEventParams *e);

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

Remarks

This event fires when a client sends a request that includes UsernameToken authentication. This is typically only used by clients initiating a pull request.

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 client by calling SendResponse.

Config Settings (AS4Server Class)

AS4Server Config Settings

<eb3:PartInfo href="cid:_de48eece-d1d8-4823-8a63-d3a8d14dc1a8@nsoftware">

<eb3:PartInfo href="cid:mypart@myhost">

AS4Component.Config("EDIDataPartId[0]=mypart@myhost");

HTTP Config Settings