AS4Client Component
Properties Methods Events Configuration Settings Errors
The AS4Client component connects to a server to send or receive files.
Syntax
nsoftware.InEDI.As4client
Remarks
The AS4Client component may be used to send or receive files from a server. The component will connect to a server and either send files (push), or request files to download (pull).
Sending Files
SendFiles sends the files specified by EDIData to URL.
Before calling this method set AgreementRef to the agreement identifier used by both parties. Set AS4From and AS4To. Set EDIData specifies the file(s) to be sent. To encrypt the data set RecipientCerts. To sign the data set SigningCert. The SignerCert property should be set to verify the signed receipt.
When this method is called the file(s) will be sent and any returned receipts will be verified.
To indicate a synchronous receipt is expected set ReceiptReplyMode to rrmSync. The following properties are applicable when calling this method with an agreement specifying a synchronous receipt (a receipt provided in the response):
- AgreementRef
- AS4From
- AS4To
- EDIData
- URL
- RecipientCerts (required to encrypt)
- SignerCert (required to verify signed receipts)
- SigningCert (required to sign files)
- ConversationId (optional)
- EncryptionAlgorithm (optional)
- LogDirectory (optional)
- MessageId (optional)
- MessageProperties (optional)
- Profile (optional)
- ReceiptReplyMode
- Service (optional)
- ServiceType (optional)
- SignatureAlgorithm (optional)
SendFiles Example (synchronous receipt):
client.Profile = As4clientProfiles.ebpfENTSOG; //Specify the agreement and party information client.AgreementRef = "http://agreements.company.com/sign_and_encrypt"; client.AS4From.Role = "Sender"; client.AS4From.Id = "org:b2b:example:company:A"; client.AS4To.Role = "Receiver"; client.AS4To.Id = "org:b2b:example:company:B"; //Configure the component to expect a synchronous receipt. client.ReceiptReplyMode = As4clientReceiptReplyModes.rrmSync; //Company A's private certificate. Used to sign the outgoing message and files. client.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, "C:\\files\\CompanyA.pfx", "password", "*"); //Company B's public certificate. Used to encrypt the outgoing file. client.RecipientCerts.Add(new Certificate("C:\\files\\as4\\CompanyB.cer")); //Company B's public certificate. Used to verify the signed receipt. client.SignerCert = new Certificate("C:\\files\\as4\\CompanyB.cer"); client.URL = "http://www.company.com:9090/msh"; EBData data = new EBData(); data.EDIType = "application/edi-x12"; data.Filename = "C:\\files\\myfile.x12"; data.Name = "myfile.x12"; client.EDIData.Add(data); //Send file(s) and verify the receipt. client.SendFiles();
The component also supports asynchronous receipts. In this configuration a file is sent from the component to another party, but the receipt is not returned in the response. Instead the other party sends the receipt at a later time. The AS4Server component may be used inside a web page to receive the asynchronous receipt. After receiving the receipt either AS4Server or AS4Client may be used to verify the receipt.
Details about the original message must be stored so that the receipt can be correlated with the message and properly verified. The easiest way to do this is to set AsyncReceiptInfoDir before calling SendFiles. The component will automatically store the required information.
See the VerifyReceipt method of AS4Server for details about verifying asynchronous receipts.
To indicate an asynchronous receipt is expected set ReceiptReplyMode to rrmAsync. The following properties are applicable when calling this method with an agreement specifying a synchronous receipt (a receipt provided in the response):
- AgreementRef
- AS4From
- AS4To
- AsyncReceiptInfoDir
- EDIData
- URL
- RecipientCerts (required to encrypt)
- SignerCert (required to verify signed receipts)
- SigningCert (required to sign files)
- ConversationId (optional)
- EncryptionAlgorithm (optional)
- LogDirectory (optional)
- MessageId (optional)
- MessageProperties (optional)
- OriginalSOAPMessage (optional)
- OriginalSOAPMessageId (optional)
- Profile (optional)
- ReceiptReplyMode
- Service (optional)
- ServiceType (optional)
- SignatureAlgorithm (optional)
SendFiles Example (asynchronous receipt):
client.Profile = As4clientProfiles.ebpfENTSOG; //Specify the agreement and party information client.AgreementRef = "http://agreements.company.com/sign_and_encrypt_async"; client.AS4From.Role = "Sender"; client.AS4From.Id = "org:b2b:example:company:A"; client.AS4To.Role = "Receiver"; client.AS4To.Id = "org:b2b:example:company:B"; //Configure the component to expect a synchronous receipt. client.ReceiptReplyMode = As4clientReceiptReplyModes.rrmAsync; client.AsyncReceiptInfoDir = "C:\\async_info"; //Company A's private certificate. Used to sign the outgoing message and files. client.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, "C:\\files\\CompanyA.pfx", "password", "*"); //Company B's public certificate. Used to encrypt the outgoing files. client.RecipientCerts.Add(new Certificate("C:\\files\\as4\\CompanyB.cer")); //Company B's public certificate. Used to verify the signed receipt. client.SignerCert = new Certificate("C:\\files\\as4\\CompanyB.cer"); client.URL = "http://www.company.com:9090/msh"; EBData data = new EBData(); data.EDIType = "application/edi-x12"; data.Filename = "C:\\files\\myfile.x12"; data.Name = "myfile.x12"; client.EDIData.Add(data); //Send file(s). client.SendFiles();
At this point the file(s) have been sent, but a receipt has not yet been received. AS4Server can be used
within a web site to listen for the receipt.
//**** Inside a web site **** As4server server = new As4server; server.ReadRequest(); if (!String.IsNullOrEmpty(server.IncomingReceipt.Content)) { server.AsyncReceiptInfoDir = "C:\\async_info"; server.VerifyReceipt(); //The receipt is now verified }
Receiving Files
ReceiveFiles establishes a connection to the server specified by URL and receives files.
The MPC specifies the Message Partition Channel from which messages will be received. The server will reply with files from this channel. If IncomingDirectory is set before calling this method the files will be written to the specified folder, otherwise inspect EDIData to obtain the received file data. The following properties are applicable when calling this method:
- SigningCert (required to sign the request)
- Certificate (required for decryption)
- SignerCert (required for signature verification)
- URL
- IncomingDirectory (optional)
- LogDirectory
- MPC
- TokenUser
- TokenPassword
- TokenPasswordType
To bundle the receipt with a subsequent ReceiveFiles call the Receipt property must hold the receipt. If the same instance of the component is being used this is already true since Receipt is populated automatically after receiving the file. To use another instance of the component for multiple calls to ReceiveFiles be sure to save the Receipt's Content and RefToMessageId values for later use.
ReceiveFiles Example:
client.Profile = As4clientProfiles.ebpfENTSOG; //Company A's private certificate. Used for signing the request. client.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, "C:\\files\\as4\\CompanyA.pfx", "password", "*"); //Company A's private certificate. Used for decrypting the file. client.Certificate = new Certificate(CertStoreTypes.cstPFXFile, "C:\\files\\as4\\CompanyA.pfx", "password", "*"); //Company B's public certificate. Used for signature verification. client.SignerCert = new Certificate("C:\\files\\as4\\CompanyB.cer"); client.URL = "http://www.company.com:9090/msh"; //Message Channel id client.MPC = "mpc_a"; client.IncomingDirectory = "C:\\incoming_dir"; client.ReceiveFiles(); //Inspect client.AgreementRef and other properties for information about the received files Console.WriteLine(client.AgreementRef); Console.WriteLine(client.AS4From.Id); Console.WriteLine(client.AS4To.Id); Console.WriteLine(client.ConversationId); //Save the receipt for later use string receiptContent = client.Receipt.Content; string receiptRefId = client.Receipt.RefToMessageId;
At this stage the receipt data is saved. Later when making another call to ReceiveFiles and populate the Receipt
property with this receipt data. When ReceiveFiles is called again, the receipt for the previous message
will be included with the request.
client.Receipt = new EBReceipt(receiptRefId, receiptContent); client.ReceiveFiles(); //This will now include the bundled receipt
Sending Asynchronous Receipts
SendReceipt sends an asynchronous receipt to the URL.
This method is typically used in conjunction with AS4Server to send an asynchronous receipt after receiving a message. The receipt will be created at the time of the incoming request, then saved for later use. When the receipt is to be sent populate Receipt and call this method.
//Send an asynchronous receipt client.URL = ""http://www.company.com:9090/msh""; client.Receipt = new EBReceipt(server.Receipt.RefToMessageId, server.Receipt.Content); client.ReceiptReplyMode = As4clientReceiptReplyModes.rrmAsync; client.SendReceipt();
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
AgreementRef | The agreement reference. |
AS4From | Defines information about the originating party. |
AS4To | Defines information about the responding party. |
AsyncReceiptInfoDir | A directory to hold information used for asynchronous receipt verification. |
Certificate | The certificate with private key used for decryption. |
CompressionFormat | The compression format (if any) to use. |
ConversationId | The Conversation Id of the message. |
Cookies | Collection of cookies. |
EDIData | The EDI data. |
EncryptionAlgorithm | The algorithm used to encrypt the EDI data. |
Errors | A collection of errors. |
Firewall | A set of properties related to firewall access. |
IncomingDirectory | The directory to which incoming files are saved. |
LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
LogDirectory | The path to a directory for logging. |
LogFile | The log file written. |
MessageId | The unique Id of the message. |
MessageProperties | A collection of message properties. |
MPC | The MPC (Message Partition Channel) from which to receive files. |
OriginalSOAPMessage | The original SOAP message used to verify the receipt. |
OriginalSOAPMessageId | The original SOAP message Id used to verify the receipt. |
Profile | The AS4 profile. |
Proxy | A set of properties related to proxy access. |
Receipt | The receipt of a message. |
ReceiptReplyMode | The expected receipt reply mode. |
RecipientCerts | The public certificate used to encrypt files when sending. |
RefToMessageId | Specifies the RefToMessageId in the message. |
Service | The service which acts on the message. |
ServiceAction | The action within a service that acts on the message. |
ServiceType | The type of service. |
SignatureAlgorithm | Signature algorithm to be used in the message. |
SignerCert | The public certificate used to verify signatures. |
SigningCert | The certificate with private key used to sign messages and files. |
SSLAcceptServerCert | Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. |
SSLCert | The certificate to be used during SSL negotiation. |
SSLServerCert | The server certificate for the last established connection. |
Timeout | A timeout for the component. |
TokenPassword | The password used in UsernameToken authentication. |
TokenPasswordType | The password type used in UsernameToken authentication. |
TokenUser | The username used in UsernameToken authentication. |
URL | The URL to which the request is made. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
Config | Sets or retrieves a configuration setting . |
DoEvents | Processes events from the internal message queue. |
Interrupt | Interrupt the current method. |
ReceiveFiles | Connects to a server to receive files. |
Reset | Resets the state of the control. |
SendFiles | Sends file(s) to the specified server and verify the receipt (if present). |
SendReceipt | Sends an asynchronous receipt. |
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.
Connected | Fired immediately after a connection completes (or fails). |
Disconnected | Fired when a connection is closed. |
EndTransfer | Fired when a document finishes transferring. |
Error | Information about errors during data delivery. |
Header | Fired every time a header line comes in. |
Log | Provides logging information. |
RecipientInfo | Fired for each recipient certificate of the encrypted message. |
SetCookie | Fired for every cookie set by the server. |
SignerCertInfo | Fired during verification of the signed message. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Shows the progress of the secure connection. |
StartTransfer | Fired when a document starts transferring (after the headers). |
Transfer | Fired while a document transfers (delivers document). |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
AllowWarnings | Whether warnings are interpreted as fatal errors. |
AgreementRefType | The type of AgreementRef. |
AgreementRefPMode | AgreementRef PMode of message. |
AttachXMLFiles | Whether to send XML files as attachments or within the SOAP body. |
CloseStreamAfterProcessing | Whether to close the input or output stream after processing. |
CompressXMLPayloads | Whether to compress XML data. |
DetectDuplicates | Whether to detect duplicate messages when receiving. |
EBPrefix | Specifies the prefix to use for messaging. |
EDIDataPartId[i] | Specified the part Id at the given index. |
EncryptionSecurityTokenFormat | The format to use for the security token when encryption. |
SigningSecurityTokenFormat | The format to use for the security token when signing. |
FilenameProperty | Defines a part property to hold the filename. |
IdRight | A custom Id for the right side of the MessageId. |
FromIdCount | The number of Ids for the party specified by AS4From. |
FromId[i] | The Id of the party specified by AS4From. |
FromIdType[i] | The Id type of the party specified by AS4From. |
LogLevel | The level of information to log. |
LogOptions | The information to be written to log files. |
MessageType | Indicates the type of message received. |
MGF1HashAlgorithm | The MGF1 hash algorithm used when encrypting a key. |
RequireEncryption | Whether encryption is required when processing received messages. |
RequireSignature | Whether a signature is required when processing received messages. |
NormalizeIssuerSubject | Whether to normalize the certificate subject within the X509Data element. |
RSAHashAlgorithm | The RSA hash algorithm used when encrypting a key. |
OAEPParams | The hex encoded OAEP parameters to be used when encrypting a key. |
ToIdCount | The number of Ids for the party specified by AS4To. |
ToId[i] | The Id of the party specified by AS4To. |
ToIdType[i] | The Id type of the party specified by AS4To. |
TransformReceipt | Whether to canonicalize the received receipt. |
UseNonce | Whether to use a nonce in UsernameToken authentication. |
AuthScheme | The authorization scheme to be used when server authorization is to be performed. |
Authorization | The Authorization string to be sent to the server. |
User | A user name if authentication is to be used. |
Password | A password if authentication is to be used. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowIdenticalRedirectURL | Allow redirects to the same URL. |
Append | Whether to append data to LocalFile. |
Authorization | The Authorization string to be sent to the server. |
BytesTransferred | Contains the number of bytes transferred in the response data. |
EncodeURL | If set to true the URL will be encoded by the component. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to true the component will perform a GET on the new location. |
HTTPVersion | The version of HTTP used by the component. |
IfModifiedSince | A date determining the maximum age of the desired document. |
KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
OtherHeaders | Other headers as determined by the user (optional). |
ProxyAuthorization | The authorization string to be sent to the proxy server. |
ProxyAuthScheme | The authorization scheme to be used for the proxy. |
ProxyPassword | A password if authentication is to be used for the proxy. |
ProxyPort | Port for the proxy server (default 80). |
ProxyServer | Name or IP address of a proxy server (optional). |
ProxyUser | A user name if authentication is to be used for the proxy. |
TransferredDataLimit | The maximum number of incoming bytes to be stored by the component. |
TransferredHeaders | The full set of headers as received from the server. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
UserAgent | Information about the user agent (browser). |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the component whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The TCP port in the local host where the component binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
RecordLength | The length of received data records. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
UseIPv6 | Whether to use IPv6. |
TcpNoDelay | Whether or not to delay when sending packets. |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLProvider | The name of the security provider to use. |
SSLSecurityFlags | Flags that control certificate verification. |
OpenSSLCADir | The path to a directory containing CA certificates. |
OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
CodePage | The system code page used for Unicode to Multibyte translations. |