AS4Server Component

Properties   Methods   Events   Config Settings   Errors  

The AS4Server component implements an AS4 / ebHandler.

Syntax

TibeAS4Server

Remarks

The AS4Server component 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 component 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 component 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 content of the Request (and optionally the RequestHeadersString) property. Alternatively the request data may be passed directly to the component 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 component 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 component with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

AgreementRef Property (AS4Server Component)

The agreement reference.

Syntax

__property String AgreementRef = { read=FAgreementRef, write=FSetAgreementRef };

Default Value

""

Remarks

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

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

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

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

Data Type

String

AS4FromId Property (AS4Server Component)

The Id of the party.

Syntax

__property String AS4FromId = { read=FAS4FromId, write=FSetAS4FromId };

Default Value

""

Remarks

The Id of the party. This value is required.

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

Data Type

String

AS4FromIdType Property (AS4Server Component)

The optional type of the Id.

Syntax

__property String AS4FromIdType = { read=FAS4FromIdType, write=FSetAS4FromIdType };

Default Value

""

Remarks

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

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

Data Type

String

AS4FromRole Property (AS4Server Component)

This property specifies the role of the party.

Syntax

__property String AS4FromRole = { read=FAS4FromRole, write=FSetAS4FromRole };

Default Value

""

Remarks

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

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

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

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

Data Type

String

AS4ToId Property (AS4Server Component)

The Id of the party.

Syntax

__property String AS4ToId = { read=FAS4ToId, write=FSetAS4ToId };

Default Value

""

Remarks

The Id of the party. This value is required.

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

Data Type

String

AS4ToIdType Property (AS4Server Component)

The optional type of the Id.

Syntax

__property String AS4ToIdType = { read=FAS4ToIdType, write=FSetAS4ToIdType };

Default Value

""

Remarks

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

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

Data Type

String

AS4ToRole Property (AS4Server Component)

This property specifies the role of the party.

Syntax

__property String AS4ToRole = { read=FAS4ToRole, write=FSetAS4ToRole };

Default Value

""

Remarks

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

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

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

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

Data Type

String

AsyncReceiptInfoDir Property (AS4Server Component)

A directory to hold information used for asynchronous receipt verification.

Syntax

__property String AsyncReceiptInfoDir = { read=FAsyncReceiptInfoDir, write=FSetAsyncReceiptInfoDir };

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

CertStore Property (AS4Server Component)

The name of the certificate store for the client certificate.

Syntax

__property String CertStore = { read=FCertStore, write=FSetCertStore };
__property DynamicArray<Byte> CertStoreB = { read=FCertStoreB, write=FSetCertStoreB };

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Byte Array

CertStorePassword Property (AS4Server Component)

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

Syntax

__property String CertStorePassword = { read=FCertStorePassword, write=FSetCertStorePassword };

Default Value

""

Remarks

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

Data Type

String

CertStoreType Property (AS4Server Component)

The type of certificate store for this certificate.

Syntax

__property TibeAS4ServerCertStoreTypes CertStoreType = { read=FCertStoreType, write=FSetCertStoreType };

enum TibeAS4ServerCertStoreTypes {
  cstUser=0,
  cstMachine=1,
  cstPFXFile=2,
  cstPFXBlob=3,
  cstJKSFile=4,
  cstJKSBlob=5,
  cstPEMKeyFile=6,
  cstPEMKeyBlob=7,
  cstPublicKeyFile=8,
  cstPublicKeyBlob=9,
  cstSSHPublicKeyBlob=10,
  cstP7BFile=11,
  cstP7BBlob=12,
  cstSSHPublicKeyFile=13,
  cstPPKFile=14,
  cstPPKBlob=15,
  cstXMLFile=16,
  cstXMLBlob=17,
  cstJWKFile=18,
  cstJWKBlob=19,
  cstSecurityKey=20,
  cstBCFKSFile=21,
  cstBCFKSBlob=22,
  cstPKCS11=23,
  cstAuto=99
};

Default Value

cstUser

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

CertSubject Property (AS4Server Component)

The subject of the certificate used for client authentication.

Syntax

__property String CertSubject = { read=FCertSubject, write=FSetCertSubject };

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

Data Type

String

CertEncoded Property (AS4Server Component)

The certificate (PEM/Base64 encoded).

Syntax

__property String CertEncoded = { read=FCertEncoded, write=FSetCertEncoded };
__property DynamicArray<Byte> CertEncodedB = { read=FCertEncodedB, write=FSetCertEncodedB };

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Byte Array

ConversationId Property (AS4Server Component)

The Conversation Id of the message.

Syntax

__property String ConversationId = { read=FConversationId, write=FSetConversationId };

Default Value

""

Remarks

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

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

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

Data Type

String

EDIDataCount Property (AS4Server Component)

The number of records in the EDI arrays.

Syntax

__property int EDIDataCount = { read=FEDIDataCount, write=FSetEDIDataCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

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

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

This property is not available at design time.

Data Type

Integer

EDIData Property (AS4Server Component)

This property contains the EDI payload of the transmission.

Syntax

__property String EDIData[int EDIDataIndex] = { read=FEDIData, write=FSetEDIData };
__property DynamicArray<Byte> EDIDataB[int EDIDataIndex] = { read=FEDIDataB, write=FSetEDIDataB };

Default Value

""

Remarks

This property contains the EDI payload of the transmission.

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

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

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

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

This property is not available at design time.

Data Type

Byte Array

EDIEDIType Property (AS4Server Component)

The Content-Type of the EDI message.

Syntax

__property String EDIEDIType[int EDIDataIndex] = { read=FEDIEDIType, write=FSetEDIEDIType };

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

EDIFileName Property (AS4Server Component)

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

Syntax

__property String EDIFileName[int EDIDataIndex] = { read=FEDIFileName, write=FSetEDIFileName };

Default Value

""

Remarks

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

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

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

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

This property is not available at design time.

Data Type

String

EDIName Property (AS4Server Component)

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

Syntax

__property String EDIName[int EDIDataIndex] = { read=FEDIName, write=FSetEDIName };

Default Value

"rfc1767.edi"

Remarks

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

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

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

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

This property is not available at design time.

Data Type

String

EDIPropertyCount Property (AS4Server Component)

The number of properties for this file.

Syntax

__property int EDIPropertyCount[int EDIDataIndex] = { read=FEDIPropertyCount, write=FSetEDIPropertyCount };

Default Value

0

Remarks

The number of properties for this file.

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

Sending

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

Receiving

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

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

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

This property is not available at design time.

Data Type

Integer

EDIPropertyIndex Property (AS4Server Component)

Selects a property at the specified index.

Syntax

__property int EDIPropertyIndex[int EDIDataIndex] = { read=FEDIPropertyIndex, write=FSetEDIPropertyIndex };

Default Value

0

Remarks

Selects a property at the specified index.

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

This property is not available at design time.

Data Type

Integer

EDIPropertyName Property (AS4Server Component)

The name of the property.

Syntax

__property String EDIPropertyName[int EDIDataIndex] = { read=FEDIPropertyName, write=FSetEDIPropertyName };

Default Value

""

Remarks

The name of the property.

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

This property is not available at design time.

Data Type

String

EDIPropertyValue Property (AS4Server Component)

The value of the property.

Syntax

__property String EDIPropertyValue[int EDIDataIndex] = { read=FEDIPropertyValue, write=FSetEDIPropertyValue };

Default Value

""

Remarks

The value of the property.

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

This property is not available at design time.

Data Type

String

EDISchemaLocation Property (AS4Server Component)

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

Syntax

__property String EDISchemaLocation[int EDIDataIndex] = { read=FEDISchemaLocation, write=FSetEDISchemaLocation };

Default Value

""

Remarks

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

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

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

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

This property is not available at design time.

Data Type

String

EDISchemaNamespace Property (AS4Server Component)

The namespace of the schema.

Syntax

__property String EDISchemaNamespace[int EDIDataIndex] = { read=FEDISchemaNamespace, write=FSetEDISchemaNamespace };

Default Value

""

Remarks

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

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

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

This property is not available at design time.

Data Type

String

EDISchemaVersion Property (AS4Server Component)

The version of the schema.

Syntax

__property String EDISchemaVersion[int EDIDataIndex] = { read=FEDISchemaVersion, write=FSetEDISchemaVersion };

Default Value

""

Remarks

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

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

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

This property is not available at design time.

Data Type

String

EncryptionAlgorithm Property (AS4Server Component)

The algorithm used to encrypt the EDI data.

Syntax

__property String EncryptionAlgorithm = { read=FEncryptionAlgorithm, write=FSetEncryptionAlgorithm };

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 component supports "3DES", or industry-standard 168-bit Triple-DES encryption.

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

Possible values are:

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

Data Type

String

ErrorCount Property (AS4Server Component)

The number of records in the Error arrays.

Syntax

__property int ErrorCount = { read=FErrorCount, write=FSetErrorCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

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

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

This property is not available at design time.

Data Type

Integer

ErrorCategory Property (AS4Server Component)

The category of error.

Syntax

__property String ErrorCategory[int ErrorIndex] = { read=FErrorCategory, write=FSetErrorCategory };

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

ErrorCode Property (AS4Server Component)

The error code.

Syntax

__property String ErrorCode[int ErrorIndex] = { read=FErrorCode, write=FSetErrorCode };

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

ErrorDescription Property (AS4Server Component)

The description of the error.

Syntax

__property String ErrorDescription[int ErrorIndex] = { read=FErrorDescription, write=FSetErrorDescription };

Default Value

""

Remarks

The description of the error. This value is optional.

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

This property is not available at design time.

Data Type

String

ErrorDetail Property (AS4Server Component)

Additional details about the error.

Syntax

__property String ErrorDetail[int ErrorIndex] = { read=FErrorDetail, write=FSetErrorDetail };

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

ErrorOrigin Property (AS4Server Component)

The module within which the error occurred.

Syntax

__property String ErrorOrigin[int ErrorIndex] = { read=FErrorOrigin, write=FSetErrorOrigin };

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

ErrorRefMessageId Property (AS4Server Component)

The MessageId to which the error applies.

Syntax

__property String ErrorRefMessageId[int ErrorIndex] = { read=FErrorRefMessageId, write=FSetErrorRefMessageId };

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

ErrorSeverity Property (AS4Server Component)

The severity of the error.

Syntax

__property TibeAS4ServerErrorSeverities ErrorSeverity[int ErrorIndex] = { read=FErrorSeverity, write=FSetErrorSeverity };

enum TibeAS4ServerErrorSeverities {
  ebstWarning=0,
  ebstFailure=1
};

Default Value

ebstWarning

Remarks

The severity of the error. Possible values are:

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

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

This property is not available at design time.

Data Type

Integer

ErrorShortDescription Property (AS4Server Component)

A short description of the error.

Syntax

__property String ErrorShortDescription[int ErrorIndex] = { read=FErrorShortDescription, write=FSetErrorShortDescription };

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

IncomingDirectory Property (AS4Server Component)

The directory to which incoming files are saved.

Syntax

__property String IncomingDirectory = { read=FIncomingDirectory, write=FSetIncomingDirectory };

Default Value

""

Remarks

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

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

Data Type

String

IncomingReceiptContent Property (AS4Server Component)

The content of the receipt.

Syntax

__property String IncomingReceiptContent = { read=FIncomingReceiptContent };

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

IncomingReceiptRefToMessageId Property (AS4Server Component)

The Message Id to which this receipt applies.

Syntax

__property String IncomingReceiptRefToMessageId = { read=FIncomingReceiptRefToMessageId };

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

LogDirectory Property (AS4Server Component)

The path to a directory for logging.

Syntax

__property String LogDirectory = { read=FLogDirectory, write=FSetLogDirectory };

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 component will log the complete text of the outgoing request and the incoming response.

The component 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 component will attempt to create the directory. The following macros are supported:

The filenames will be chosen automatically by the component. 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 Component)

The log file written.

Syntax

__property String LogFile = { read=FLogFile };

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 component 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 component will attempt to create the directory. The following macros are supported:

The filenames will be chosen automatically by the component. 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 Component)

The unique Id of the message.

Syntax

__property String MessageId = { read=FMessageId, write=FSetMessageId };

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

MessagePropertyCount Property (AS4Server Component)

The number of records in the MessageProperty arrays.

Syntax

__property int MessagePropertyCount = { read=FMessagePropertyCount, write=FSetMessagePropertyCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• MessagePropertyName
• MessagePropertyPropertyType
• MessagePropertyValue

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

This property is not available at design time.

Data Type

Integer

MessagePropertyName Property (AS4Server Component)

This property defines the name of the message property.

Syntax

__property String MessagePropertyName[int MessagePropertyIndex] = { read=FMessagePropertyName, write=FSetMessagePropertyName };

Default Value

""

Remarks

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

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

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

This property is not available at design time.

Data Type

String

MessagePropertyPropertyType Property (AS4Server Component)

The optional type of the message property.

Syntax

__property String MessagePropertyPropertyType[int MessagePropertyIndex] = { read=FMessagePropertyPropertyType, write=FSetMessagePropertyPropertyType };

Default Value

""

Remarks

The optional type of the message property.

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

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

This property is not available at design time.

Data Type

String

MessagePropertyValue Property (AS4Server Component)

The value of the message property.

Syntax

__property String MessagePropertyValue[int MessagePropertyIndex] = { read=FMessagePropertyValue, write=FSetMessagePropertyValue };

Default Value

""

Remarks

The value of the message property.

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

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

This property is not available at design time.

Data Type

String

MPC Property (AS4Server Component)

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

Syntax

__property String MPC = { read=FMPC, write=FSetMPC };

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

The original SOAP message used to verify the receipt.

Syntax

__property String OriginalSOAPMessage = { read=FOriginalSOAPMessage, write=FSetOriginalSOAPMessage };

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

The original SOAP message Id used to verify the receipt.

Syntax

__property String OriginalSOAPMessageId = { read=FOriginalSOAPMessageId, write=FSetOriginalSOAPMessageId };

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

The AS4 profile.

Syntax

__property TibeAS4ServerProfiles Profile = { read=FProfile, write=FSetProfile };

enum TibeAS4ServerProfiles {
  ebpfStandard=0,
  ebpfENTSOG=1,
  ebpfEDelivery=2,
  ebpfBDEW=3,
  ebpfENTSOG_V4=4,
  ebpfEDelivery_V2=5
};

Default Value

ebpfStandard

Remarks

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

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

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

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

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

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

Data Type

Integer

ReceiptContent Property (AS4Server Component)

The content of the receipt.

Syntax

__property String ReceiptContent = { read=FReceiptContent, write=FSetReceiptContent };

Default Value

""

Remarks

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

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

Data Type

String

ReceiptRefToMessageId Property (AS4Server Component)

The Message Id to which this receipt applies.

Syntax

__property String ReceiptRefToMessageId = { read=FReceiptRefToMessageId, write=FSetReceiptRefToMessageId };

Default Value

""

Remarks

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

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

Data Type

String

ReceiptReplyMode Property (AS4Server Component)

The expected receipt reply mode.

Syntax

__property TibeAS4ServerReceiptReplyModes ReceiptReplyMode = { read=FReceiptReplyMode, write=FSetReceiptReplyMode };

enum TibeAS4ServerReceiptReplyModes {
  rrmSync=0,
  rrmAsync=1,
  rrmNone=2
};

Default Value

rrmSync

Remarks

This setting tells the component 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 component can build a valid message. This should be set to the previously agreed upon value between the parties in the agreement identified by AgreementRef

Data Type

Integer

RecipientCertCount Property (AS4Server Component)

The number of records in the RecipientCert arrays.

Syntax

__property int RecipientCertCount = { read=FRecipientCertCount, write=FSetRecipientCertCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• RecipientCertEncoded

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

This property is not available at design time.

Data Type

Integer

RecipientCertEncoded Property (AS4Server Component)

The certificate (PEM/Base64 encoded).

Syntax

__property String RecipientCertEncoded[int RecipientCertIndex] = { read=FRecipientCertEncoded, write=FSetRecipientCertEncoded };
__property DynamicArray<Byte> RecipientCertEncodedB[int RecipientCertIndex] = { read=FRecipientCertEncodedB, write=FSetRecipientCertEncodedB };

Default Value

""

Remarks

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

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

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

This property is not available at design time.

Data Type

Byte Array

RefToMessageId Property (AS4Server Component)

Specifies the RefToMessageId in the message.

Syntax

__property String RefToMessageId = { read=FRefToMessageId, write=FSetRefToMessageId };

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

The HTTP request to be processed.

Syntax

__property String Request = { read=FRequest, write=FSetRequest };
__property DynamicArray<Byte> RequestB = { read=FRequestB, write=FSetRequestB };

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

Byte Array

RequestHeaderCount Property (AS4Server Component)

The number of records in the RequestHeader arrays.

Syntax

__property int RequestHeaderCount = { read=FRequestHeaderCount, write=FSetRequestHeaderCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• RequestHeaderField
• RequestHeaderValue

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

This property is not available at design time.

Data Type

Integer

RequestHeaderField Property (AS4Server Component)

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

Syntax

__property String RequestHeaderField[int RequestHeaderIndex] = { read=FRequestHeaderField, write=FSetRequestHeaderField };

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

RequestHeaderValue Property (AS4Server Component)

This property contains the header contents.

Syntax

__property String RequestHeaderValue[int RequestHeaderIndex] = { read=FRequestHeaderValue, write=FSetRequestHeaderValue };

Default Value

""

Remarks

This property contains the Header contents.

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

This property is not available at design time.

Data Type

String

RequestHeadersString Property (AS4Server Component)

The HTTP headers in the AS4 request.

Syntax

__property String RequestHeadersString = { read=FRequestHeadersString, write=FSetRequestHeadersString };

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

RolloverCertStore Property (AS4Server Component)

The name of the certificate store for the client certificate.

Syntax

__property String RolloverCertStore = { read=FRolloverCertStore, write=FSetRolloverCertStore };
__property DynamicArray<Byte> RolloverCertStoreB = { read=FRolloverCertStoreB, write=FSetRolloverCertStoreB };

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Byte Array

RolloverCertStorePassword Property (AS4Server Component)

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

Syntax

__property String RolloverCertStorePassword = { read=FRolloverCertStorePassword, write=FSetRolloverCertStorePassword };

Default Value

""

Remarks

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

Data Type

String

RolloverCertStoreType Property (AS4Server Component)

The type of certificate store for this certificate.

Syntax

__property TibeAS4ServerRolloverCertStoreTypes RolloverCertStoreType = { read=FRolloverCertStoreType, write=FSetRolloverCertStoreType };

enum TibeAS4ServerRolloverCertStoreTypes {
  cstUser=0,
  cstMachine=1,
  cstPFXFile=2,
  cstPFXBlob=3,
  cstJKSFile=4,
  cstJKSBlob=5,
  cstPEMKeyFile=6,
  cstPEMKeyBlob=7,
  cstPublicKeyFile=8,
  cstPublicKeyBlob=9,
  cstSSHPublicKeyBlob=10,
  cstP7BFile=11,
  cstP7BBlob=12,
  cstSSHPublicKeyFile=13,
  cstPPKFile=14,
  cstPPKBlob=15,
  cstXMLFile=16,
  cstXMLBlob=17,
  cstJWKFile=18,
  cstJWKBlob=19,
  cstSecurityKey=20,
  cstBCFKSFile=21,
  cstBCFKSBlob=22,
  cstPKCS11=23,
  cstAuto=99
};

Default Value

cstUser

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

RolloverCertSubject Property (AS4Server Component)

The subject of the certificate used for client authentication.

Syntax

__property String RolloverCertSubject = { read=FRolloverCertSubject, write=FSetRolloverCertSubject };

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

Data Type

String

RolloverCertEncoded Property (AS4Server Component)

The certificate (PEM/Base64 encoded).

Syntax

__property String RolloverCertEncoded = { read=FRolloverCertEncoded, write=FSetRolloverCertEncoded };
__property DynamicArray<Byte> RolloverCertEncodedB = { read=FRolloverCertEncodedB, write=FSetRolloverCertEncodedB };

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Byte Array

RolloverSigningCertStore Property (AS4Server Component)

The name of the certificate store for the client certificate.

Syntax

__property String RolloverSigningCertStore = { read=FRolloverSigningCertStore, write=FSetRolloverSigningCertStore };
__property DynamicArray<Byte> RolloverSigningCertStoreB = { read=FRolloverSigningCertStoreB, write=FSetRolloverSigningCertStoreB };

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The RolloverSigningCertStoreType property denotes the type of the certificate store specified by RolloverSigningCertStore. If the store is password-protected, specify the password in RolloverSigningCertStorePassword.

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Byte Array

RolloverSigningCertStorePassword Property (AS4Server Component)

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

Syntax

__property String RolloverSigningCertStorePassword = { read=FRolloverSigningCertStorePassword, write=FSetRolloverSigningCertStorePassword };

Default Value

""

Remarks

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

Data Type

String

RolloverSigningCertStoreType Property (AS4Server Component)

The type of certificate store for this certificate.

Syntax

__property TibeAS4ServerRolloverSigningCertStoreTypes RolloverSigningCertStoreType = { read=FRolloverSigningCertStoreType, write=FSetRolloverSigningCertStoreType };

enum TibeAS4ServerRolloverSigningCertStoreTypes {
  cstUser=0,
  cstMachine=1,
  cstPFXFile=2,
  cstPFXBlob=3,
  cstJKSFile=4,
  cstJKSBlob=5,
  cstPEMKeyFile=6,
  cstPEMKeyBlob=7,
  cstPublicKeyFile=8,
  cstPublicKeyBlob=9,
  cstSSHPublicKeyBlob=10,
  cstP7BFile=11,
  cstP7BBlob=12,
  cstSSHPublicKeyFile=13,
  cstPPKFile=14,
  cstPPKBlob=15,
  cstXMLFile=16,
  cstXMLBlob=17,
  cstJWKFile=18,
  cstJWKBlob=19,
  cstSecurityKey=20,
  cstBCFKSFile=21,
  cstBCFKSBlob=22,
  cstPKCS11=23,
  cstAuto=99
};

Default Value

cstUser

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

RolloverSigningCertSubject Property (AS4Server Component)

The subject of the certificate used for client authentication.

Syntax

__property String RolloverSigningCertSubject = { read=FRolloverSigningCertSubject, write=FSetRolloverSigningCertSubject };

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

Data Type

String

RolloverSigningCertEncoded Property (AS4Server Component)

The certificate (PEM/Base64 encoded).

Syntax

__property String RolloverSigningCertEncoded = { read=FRolloverSigningCertEncoded, write=FSetRolloverSigningCertEncoded };
__property DynamicArray<Byte> RolloverSigningCertEncodedB = { read=FRolloverSigningCertEncodedB, write=FSetRolloverSigningCertEncodedB };

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Byte Array

Service Property (AS4Server Component)

The service which acts on the message.

Syntax

__property String Service = { read=FService, write=FSetService };

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

The action within a service that acts on the message.

Syntax

__property String ServiceAction = { read=FServiceAction, write=FSetServiceAction };

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

The type of service.

Syntax

__property String ServiceType = { read=FServiceType, write=FSetServiceType };

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

Signature algorithm to be used in the message.

Syntax

__property String SignatureAlgorithm = { read=FSignatureAlgorithm, write=FSetSignatureAlgorithm };

Default Value

"sha-256"

Remarks

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

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

The default value is "SHA-256".

Data Type

String

SignerCertStore Property (AS4Server Component)

The name of the certificate store for the client certificate.

Syntax

__property String SignerCertStore = { read=FSignerCertStore, write=FSetSignerCertStore };
__property DynamicArray<Byte> SignerCertStoreB = { read=FSignerCertStoreB, write=FSetSignerCertStoreB };

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Byte Array

SignerCertStorePassword Property (AS4Server Component)

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

Syntax

__property String SignerCertStorePassword = { read=FSignerCertStorePassword, write=FSetSignerCertStorePassword };

Default Value

""

Remarks

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

Data Type

String

SignerCertStoreType Property (AS4Server Component)

The type of certificate store for this certificate.

Syntax

__property TibeAS4ServerSignerCertStoreTypes SignerCertStoreType = { read=FSignerCertStoreType, write=FSetSignerCertStoreType };

enum TibeAS4ServerSignerCertStoreTypes {
  cstUser=0,
  cstMachine=1,
  cstPFXFile=2,
  cstPFXBlob=3,
  cstJKSFile=4,
  cstJKSBlob=5,
  cstPEMKeyFile=6,
  cstPEMKeyBlob=7,
  cstPublicKeyFile=8,
  cstPublicKeyBlob=9,
  cstSSHPublicKeyBlob=10,
  cstP7BFile=11,
  cstP7BBlob=12,
  cstSSHPublicKeyFile=13,
  cstPPKFile=14,
  cstPPKBlob=15,
  cstXMLFile=16,
  cstXMLBlob=17,
  cstJWKFile=18,
  cstJWKBlob=19,
  cstSecurityKey=20,
  cstBCFKSFile=21,
  cstBCFKSBlob=22,
  cstPKCS11=23,
  cstAuto=99
};

Default Value

cstUser

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SignerCertSubject Property (AS4Server Component)

The subject of the certificate used for client authentication.

Syntax

__property String SignerCertSubject = { read=FSignerCertSubject, write=FSetSignerCertSubject };

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

Data Type

String

SignerCertEncoded Property (AS4Server Component)

The certificate (PEM/Base64 encoded).

Syntax

__property String SignerCertEncoded = { read=FSignerCertEncoded, write=FSetSignerCertEncoded };
__property DynamicArray<Byte> SignerCertEncodedB = { read=FSignerCertEncodedB, write=FSetSignerCertEncodedB };

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Byte Array

SigningCertStore Property (AS4Server Component)

The name of the certificate store for the client certificate.

Syntax

__property String SigningCertStore = { read=FSigningCertStore, write=FSetSigningCertStore };
__property DynamicArray<Byte> SigningCertStoreB = { read=FSigningCertStoreB, write=FSetSigningCertStoreB };

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Byte Array

SigningCertStorePassword Property (AS4Server Component)

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

Syntax

__property String SigningCertStorePassword = { read=FSigningCertStorePassword, write=FSetSigningCertStorePassword };

Default Value

""

Remarks

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

Data Type

String

SigningCertStoreType Property (AS4Server Component)

The type of certificate store for this certificate.

Syntax

__property TibeAS4ServerSigningCertStoreTypes SigningCertStoreType = { read=FSigningCertStoreType, write=FSetSigningCertStoreType };

enum TibeAS4ServerSigningCertStoreTypes {
  cstUser=0,
  cstMachine=1,
  cstPFXFile=2,
  cstPFXBlob=3,
  cstJKSFile=4,
  cstJKSBlob=5,
  cstPEMKeyFile=6,
  cstPEMKeyBlob=7,
  cstPublicKeyFile=8,
  cstPublicKeyBlob=9,
  cstSSHPublicKeyBlob=10,
  cstP7BFile=11,
  cstP7BBlob=12,
  cstSSHPublicKeyFile=13,
  cstPPKFile=14,
  cstPPKBlob=15,
  cstXMLFile=16,
  cstXMLBlob=17,
  cstJWKFile=18,
  cstJWKBlob=19,
  cstSecurityKey=20,
  cstBCFKSFile=21,
  cstBCFKSBlob=22,
  cstPKCS11=23,
  cstAuto=99
};

Default Value

cstUser

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SigningCertSubject Property (AS4Server Component)

The subject of the certificate used for client authentication.

Syntax

__property String SigningCertSubject = { read=FSigningCertSubject, write=FSetSigningCertSubject };

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

Data Type

String

SigningCertEncoded Property (AS4Server Component)

The certificate (PEM/Base64 encoded).

Syntax

__property String SigningCertEncoded = { read=FSigningCertEncoded, write=FSetSigningCertEncoded };
__property DynamicArray<Byte> SigningCertEncodedB = { read=FSigningCertEncodedB, write=FSetSigningCertEncodedB };

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Byte Array

Config Method (AS4Server Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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.

DoEvents Method (AS4Server Component)

This method processes events from the internal message queue.

Syntax

void __fastcall DoEvents();

Remarks

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

Interrupt Method (AS4Server Component)

This method interrupts the current method.

Syntax

void __fastcall Interrupt();

Remarks

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

ParseRequest Method (AS4Server Component)

Parses and processes the message.

Syntax

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

ReadRequest Method (AS4Server Component)

Reads the AS4 request.

Syntax

void __fastcall ReadRequest();

Remarks

To begin, when a request is received first call ReadRequest. This reads the AS4 request from the content of the Request (and optionally the RequestHeadersString) property. Alternatively the request data may be passed directly to the component 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 component may then be configured to respond appropriately depending on the operation.

Reset Method (AS4Server Component)

Resets the state of the control.

Syntax

void __fastcall Reset();

Remarks

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

SendAckResponse Method (AS4Server Component)

Sends an acknowledgement of the request only.

Syntax

void __fastcall 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.

SendResponse Method (AS4Server Component)

This method sends the response over the current HTTP context.

Syntax

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

VerifyReceipt Method (AS4Server Component)

Verifies a received receipt.

Syntax

void __fastcall 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 Event (AS4Server Component)

Fired when information is available about errors during data delivery.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TibeAS4ServerErrorEventParams;
typedef void __fastcall (__closure *TibeAS4ServerErrorEvent)(System::TObject* Sender, TibeAS4ServerErrorEventParams *e);
__property TibeAS4ServerErrorEvent OnError = { read=FOnError, write=FOnError };

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.

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

Log Event (AS4Server Component)

Fired with log information while processing a message.

Syntax

typedef struct {
  String LogType;
  String LogMessage;
} TibeAS4ServerLogEventParams;
typedef void __fastcall (__closure *TibeAS4ServerLogEvent)(System::TObject* Sender, TibeAS4ServerLogEventParams *e);
__property TibeAS4ServerLogEvent OnLog = { read=FOnLog, write=FOnLog };

Remarks

This event fires once for each log message generated by the component. 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 Component)

Fired for each recipient certificate of the encrypted message.

Syntax

typedef struct {
  String Issuer;
  String SerialNumber;
  String SubjectKeyIdentifier;
  String EncryptionAlgorithm;
} TibeAS4ServerRecipientInfoEventParams;
typedef void __fastcall (__closure *TibeAS4ServerRecipientInfoEvent)(System::TObject* Sender, TibeAS4ServerRecipientInfoEventParams *e);
__property TibeAS4ServerRecipientInfoEvent OnRecipientInfo = { read=FOnRecipientInfo, write=FOnRecipientInfo };

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

This event is fired during verification of the signed message.

Syntax

typedef struct {
  String Issuer;
  String SerialNumber;
  String SubjectKeyIdentifier;
  String CertEncoded;
  DynamicArray<Byte> CertEncodedB;
} TibeAS4ServerSignerCertInfoEventParams;
typedef void __fastcall (__closure *TibeAS4ServerSignerCertInfoEvent)(System::TObject* Sender, TibeAS4ServerSignerCertInfoEventParams *e);
__property TibeAS4ServerSignerCertInfoEvent OnSignerCertInfo = { read=FOnSignerCertInfo, write=FOnSignerCertInfo };

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 component 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 Component)

Fired when the client makes use of UsernameToken authentication.

Syntax

typedef struct {
  String User;
  String Password;
  String PasswordType;
  bool Accept;
} TibeAS4ServerTokenAuthenticationEventParams;
typedef void __fastcall (__closure *TibeAS4ServerTokenAuthenticationEvent)(System::TObject* Sender, TibeAS4ServerTokenAuthenticationEventParams *e);
__property TibeAS4ServerTokenAuthenticationEvent OnTokenAuthentication = { read=FOnTokenAuthentication, write=FOnTokenAuthentication };

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 component will hash the provided password value and compare it to the value in the request. If it matched the component will accept the request. If it does not match the component will populate Errors with an error indicating authentication has failed.

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

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

Config Settings (AS4Server Component)

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
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

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

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

Socket Config Settings

Base Config Settings

Trappable Errors (AS4Server Component)

AS4Server Errors

HTTP Errors

The component may also return one of the following error codes, which are inherited from other components.

TCPClient Errors

TCP/IP Errors