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

AS4From Property (AS4Server Class)

Defines information about the originating party.

Syntax

• C++
• C
• Qt

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

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

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

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

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

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

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

Remarks

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

Data Type

IPWorksEDIEBPartyInfo

AS4To Property (AS4Server Class)

Defines information about the responding party.

Syntax

• C++
• C
• Qt

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

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

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

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

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

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

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

Remarks

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

Data Type

IPWorksEDIEBPartyInfo

AsyncReceiptInfoDir Property (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

Certificate Property (AS4Server Class)

The certificate with private key used for decryption.

Syntax

• C++
• C
• Qt

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

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

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

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

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

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

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

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

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

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

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

Remarks

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

Data Type

IPWorksEDICertificate

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

EDIData Property (AS4Server Class)

The EDI data.

Syntax

• C++
• C
• Qt

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Remarks

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

This property is not available at design time.

Data Type

IPWorksEDIEBData

EncryptionAlgorithm Property (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

Errors Property (AS4Server Class)

A collection of errors.

Syntax

• C++
• C
• Qt

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Remarks

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

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

Data Type

IPWorksEDIEBError

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

IncomingReceipt Property (AS4Server Class)

The receipt included with the request.

Syntax

• C++
• C
• Qt

IPWorksEDIEBReceipt* GetIncomingReceipt();

char* ipworksedi_as4server_getincomingreceiptcontent(void* lpObj);

char* ipworksedi_as4server_getincomingreceiptreftomessageid(void* lpObj);

QString GetIncomingReceiptContent();

QString GetIncomingReceiptRefToMessageId();

Remarks

This property is populated by ReadRequest if the incoming request contains a receipt. Receipts received in this manner are always asynchronous and must be verified by calling VerifyReceipt.

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

This property is read-only.

Data Type

IPWorksEDIEBReceipt

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

MessageProperties Property (AS4Server Class)

A collection of message properties.

Syntax

• C++
• C
• Qt

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

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

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

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

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

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

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

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

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

Remarks

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

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

Sending

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

Receiving

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

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

Data Type

IPWorksEDIEBProperty

MPC Property (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

Receipt Property (AS4Server Class)

The receipt of a message.

Syntax

• C++
• C
• Qt

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

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

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

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

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

Remarks

This property holds the receipt of a message. When receiving files from a client this property is populated with the receipt to be sent back after calling ParseRequest.

To deliver the receipt in the same connection (synchronously) call SendResponse. To deliver the receipt asynchronously use the SendReceipt method of AS4Client.

Note: This property is only applicable for receipts generated in response to received files. For information on processing incoming asynchronous receipts see IncomingReceipt and VerifyReceipt.

Data Type

IPWorksEDIEBReceipt

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

RecipientCerts Property (AS4Server Class)

The public certificate used to encrypt files when sending.

Syntax

• C++
• C
• Qt

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

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

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

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

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

Remarks

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

This property is not available at design time.

Data Type

IPWorksEDICertificate

RefToMessageId Property (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

RequestHeaders Property (AS4Server Class)

The HTTP headers in the AS4 request.

Syntax

• C++
• C
• Qt

IPWorksEDIList<IPWorksEDIHeader>* GetRequestHeaders();
int SetRequestHeaders(IPWorksEDIList<IPWorksEDIHeader>* val);

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

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

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

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

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

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

Remarks

A collection of headers. These will include all HTTP headers.

When assigning an AS4 request to the class, the headers may be included specified in RequestHeaders or RequestHeadersString.

Data Type

IPWorksEDIHeader

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

SignerCert Property (AS4Server Class)

The public certificate used to verify signatures.

Syntax

• C++
• C
• Qt

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

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

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

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

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

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

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

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

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

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

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

Remarks

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

Data Type

IPWorksEDICertificate

SigningCert Property (AS4Server Class)

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

Syntax

• C++
• C
• Qt

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

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

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

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

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

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

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

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

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

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

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

Remarks

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

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

Data Type

IPWorksEDICertificate

Config Method (AS4Server Class)

This method 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)

This method 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)

This method interrupts 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)

This event is fired for information 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.

ErrorCode contains an error code and Description 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.

Certificate Type

This is the digital certificate being used.

Syntax

IPWorksEDICertificate (declared in ipworksedi.h)

Remarks

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

Fields

Constructors

Certificate()

Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.

Certificate(const char* lpEncoded, int lenEncoded)

Parses Encoded as an X509 public key.

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

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

EBData Type

The EDI payload of the AS4 message.

Syntax

IPWorksEDIEBData (declared in ipworksedi.h)

Remarks

The EDI payload of the AS4 message.

Fields

Constructors

EBData()

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

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

EBError Type

This type defines details of the error.

Syntax

IPWorksEDIEBError (declared in ipworksedi.h)

Remarks

The properties below provide various information about the error.

Fields

Constructors

EBError()

EBError(const char* lpszCode, int iSeverity)

EBError(const char* lpszCode, int iSeverity, const char* lpszDetail, const char* lpszShortDescription)

EBPartyInfo Type

This type defines information about the party.

Syntax

IPWorksEDIEBPartyInfo (declared in ipworksedi.h)

Remarks

The properties define information about the respective party. This is used to define both sending and receiving party information.

Fields

Constructors

EBPartyInfo()

EBPartyInfo(const char* lpszId, const char* lpszRole)

EBPartyInfo(const char* lpszId, const char* lpszRole, const char* lpszIdType)

EBProperty Type

A property of the message.

Syntax

IPWorksEDIEBProperty (declared in ipworksedi.h)

Remarks

This type holds details about the property of the message.

Fields

Constructors

EBProperty()

EBProperty(const char* lpszName, const char* lpszValue)

EBProperty(const char* lpszName, const char* lpszValue, const char* lpszPropertyType)

EBReceipt Type

The receipt.

Syntax

IPWorksEDIEBReceipt (declared in ipworksedi.h)

Remarks

This type contains properties that comprise the receipt.

Fields

Constructors

EBReceipt()

EBReceipt(const char* lpszRefToMessageId, const char* lpszContent)

Header Type

This is an HTTP header as it is received from the server.

Syntax

IPWorksEDIHeader (declared in ipworksedi.h)

Remarks

When a header is received through a Header event, it is parsed into a Header type. This type contains a , and its corresponding .

Fields

Constructors

Header()

Header(const char* lpszField, const char* lpszValue)

IPWorksEDIList Type

Syntax

IPWorksEDIList<T> (declared in ipworksedi.h)

Remarks

IPWorksEDIList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the AS4Server class.

int GetCount() {}

int SetCount() {}

T* Get(int index) {}

T* Set(int index, T* value) {}

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

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings