AS3Receiver Class

Properties   Methods   Events   Config Settings   Errors  

The AS3Receiver class is used to process AS3 messages and generate receipts.

Syntax

ipworksedi.as3receiver()

Remarks

The AS3Receiver class allows you to receive AS3 messages over FTP, as specified in [AS3] and RFC 3335. The class can act as a FTP client, decrypt and verify incoming messages, and generate receipts including Message Disposition Notifications (MDNs). The class is designed to interoperate easily with a standard FTP server.

BASIC OPERATION

You should first log in to the FTP server by invoking Logon. If you need to search the FTP server for requests you may set RemotePath, invoke ListDirectory, etc. When you find the desired files you may then download them invoking ReadRequest. Alternatively, if you acquire the AS3 data by other means you may simply set Request.

ReadRequest (or ParseHeaders) will determine information such as AS3From and AS3To, which will allow you to set the appropriate certificates. You may specify your certificate with the Certificate property, and your trading partner's (signing) certificate with the SignerCert property.

Then, invoke ProcessRequest to process the request and generate the MDN receipt as specified in [AS3]. If the request was processed successfully, EDIData will contain the transmitted EDI data. If a problem occurred, EDIData will not be populated and an exception will be thrown. In either case MDNReceipt will contain the RFC-compliant receipt, which should be returned to the client.

The MDNReceipt may be returned over the same FTP connection by invoking SendResponse. If it is necessary to create a new connection or send receipts to a different server you may Logoff and Logon at will.

To create log files, set LogDirectory prior to invoking ProcessRequest. This will log all incoming and outgoing data, and will also write the received EDI files to disk.

EXAMPLE AS3Receiver1.User = "myusername" AS3Receiver1.Password = "mypassword" AS3Receiver1.RemoteHost = "ftp.mytradingpartner.com" AS3Receiver1.Logon() // You may need to search the server for received files at this point AS3Receiver1.ReadRequest("1053-ji094986.as3") // At this point, you should check the values of AS2From and AS2To. AS3Receiver1.Certificate = new Certificate(CertStoreTypes.cstPFXFile, "\\my_server_directory\\my_pfx_file.pfx", "my password", "CN=Me"); AS3Receiver1.SignerCert = (...); AS3Receiver1.LogDirectory = "c:\\my_server_directory\\my_log_directory"; AS3Receiver1.ProcessRequest(); // It will probably be necessary to change the RemotePath or even logon // to a different server here. AS3Receiver1.SendResponse("1053-ji094986-mdn.as3"); Additional functionality allows the user to examine details of the client's request, to permit certain types of errors, or to customize the outgoing MDN. See the property and method list for details.

Property List

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

Method List

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

Event List

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

Config Settings

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

AS3Receiver.AS3From Property

The identity of the sending system.

Syntax

getAS3From(): string;

Default Value

""

Remarks

May be company name, DUNS number, or anything agreed on by trading partners.

This property is read-only.

AS3Receiver.AS3To Property

The identity of the receiving system.

Syntax

getAS3To(): string;

Default Value

""

Remarks

May be company name, DUNS number, or anything agreed on by trading partners.

This property is read-only.

AS3Receiver.AS3VersionIncoming Property

The version of AS3 being used.

Syntax

getAS3VersionIncoming(): string;

Default Value

"1.0"

Remarks

The version of AS3 being used on the incoming transmission. Should be "1.0".

This property is read-only.

AS3Receiver.AS3VersionOutgoing Property

The version of AS3 being used.

Syntax

getAS3VersionOutgoing(): string;
setAS3VersionOutgoing(AS3VersionOutgoing: string): void;

Default Value

"1.0"

Remarks

The version of AS3 being used on the outgoing transmission. Should be "1.0".

AS3Receiver.Attachments Property

Collection of files attached to the current message.

Syntax

getAttachments(): EDIAttachmentList;

Default Value

Remarks

When a message is received, the class will write all of the files attached to the EDIData into temp files. These attachments can be retrieved by walking this collection and retrieving their file names.

This property is read-only and not available at design time.

AS3Receiver.Certificate Property

The decryption and receipt signing certificate.

Syntax

getCertificate(): Certificate;
setCertificate(certificate: Certificate): void;

Default Value

Remarks

The digital certificate that the class will use to decrypt incoming transmissions and sign the MDN receipt (if requested). If a different certificate is required for decryption than for MDN signing, set the decryption certificate before calling ParseRequest, then set the signing certificate before calling CreateMDNReceipt. Certificate must be set to a private key certificate.

AS3Receiver.CompressionFormat Property

The compression format used on the incoming message.

Syntax

getCompressionFormat(): AS3ReceiverCompressionFormats;


enum AS3ReceiverCompressionFormats {
  cfNone,
  cfZLIB
}

Default Value

0

Remarks

The compression format used on the incoming message, if any. Compressed messages will automatically be decompressed by the class.

This property is read-only.

AS3Receiver.Connected Property

Whether the class is connected.

Syntax

isConnected(): boolean;

Default Value

FALSE

Remarks

This property is used to determine whether or not the class is connected to the remote host. Use the Connect and Disconnect methods to manage the connection.

This property is read-only and not available at design time.

AS3Receiver.EDIData Property

The EDI data sent in Request .

Syntax

getEDIData(): EDIData;

Default Value

Remarks

This property will only be populated if ParseRequest or ProcessRequest finishes without an error, setting ScanResult to 0. If so, EDIData will contain the processed EDI message.

This property is read-only.

AS3Receiver.Firewall Property

A set of properties related to firewall access.

Syntax

getFirewall(): Firewall;
setFirewall(firewall: Firewall): void;

Default Value

Remarks

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

AS3Receiver.FTPLastReply Property

The last reply from the FTP server.

Syntax

getFTPLastReply(): string;

Default Value

""

Remarks

The last reply from the FTP server.

This property is read-only.

AS3Receiver.LocalHost Property

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

getLocalHost(): string;
setLocalHost(localHost: string): void;

Default Value

""

Remarks

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

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

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

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

AS3Receiver.LogDirectory Property

The path to a directory for logging.

Syntax

getLogDirectory(): string;
setLogDirectory(logDirectory: string): void;

Default Value

""

Remarks

Setting LogDirectory will instruct the component to log the details of each transmission to unique files in the specified directory. For each request processed, the class will log the original EDI data, the complete text of the outgoing request and the incoming response.

The class will write a file for each transmission, with extension ".log". In case of error an additional file will be written with extension ".err", and the error will be reported in both files. Raw AS3 messages created or downloaded by the class will be written with extension ".as3", and MDNs created or downloaded will be written with extension ".as3-mdn".

The filenames will be chosen automatically by the class. Each filename will be the system time, in the format YYYY-MM-DD-HH-MM-SS-MMMM, with extensions "-2", "-3", used in case files of those names already exist. After each transaction is processed LogFile will contain the name of the files just written, minus the extension ".log" or ".err".

If logs cannot be written an exception will be thrown.

AS3Receiver.LogFile Property

The log file written.

Syntax

getLogFile(): string;

Default Value

""

Remarks

In case LogDirectory is specified two log files will be written in the specified directory and LogFile will contain the path.

LogFile will in fact refer to several files with appropriate extensions. A diagnostic log will be written with filename LogFile + ".log", and any EDI data read will be written with filename LogFile + ".dat". Raw AS3 messages and MDNs will also be written with extensions ".as3" and ".as3-mdn".

This property is read-only.

AS3Receiver.MDNReceipt Property

The MDN-based receipt generated by the class.

Syntax

getMDNReceipt(): MDNReceipt;
setMDNReceipt(MDNReceipt: MDNReceipt): void;

Default Value

Remarks

After invoking CreateMDNReceipt, MDNReceipt will contain the entire text of the receipt to be returned to the client. It will report either success or failure depending on ScanResult; in either case it will be RFC-compliant and suitable for returning to the client.

The MDNReceipt will consist of the MDN itself, a human-readable message, MIME headers and footers, and a signature if applicable. The receipt may be generated by invoking CreateMDNReceipt and customized further by setting the parameters to CreateMDNReceipt.

A variety of configuration settings may be used to override the default generation of the outgoing MDN. The MIC algorithm used in the MDN may be set with MDNMICAlgorithm;. MDNReportingUA specifies the reporting agent, and MDNSendingMode may be used to specify the "disposition-mode" field in the MDN.

The signature, if any, will use the protocol specified by the ReceiptSigningProtocol configuration setting, and the certificate specified.

Error reporting may be controlled by configuring ErrorReportingFlags. By default, any errors will cause MDNReceipt to report a failure to process the message (either "failed/Failure" or "processed/Error" will be reported, according to the specification and the type of error). Setting ErrorReportingFlags will cause the MDNReceipt to overlook the chosen types of errors. If all errors are overlooked, the MDNReceipt will report success and calculate a MIC on the original message as usual. A warning may be reported by setting the MDNWarning configuration setting.

MDNReceipt will always be generated by the component; however, if MDNTo is empty, an MDN-based receipt has not been requested. One may be sent anyway at the option of the server. If MDNTo is nonempty, the receipt MUST be returned according to RFC specifications. In AS2, the MDN should be returned in the body of the HTTP reply, or if ReceiptDeliveryOption is nonempty, to the URL specified there instead. In AS3, the MDN should be returned to the URL specified in MDNTo.

AS3Receiver.MDNTo Property

The URL for the Message Disposition Notification (MDN).

Syntax

getMDNTo(): string;
setMDNTo(MDNTo: string): void;

Default Value

""

Remarks

MDNTo corresponds to the Disposition-Notification-To header of RequestHeaders. If nonempty, the client has requested that an MDN-based receipt be returned to the URL specified. This receipt will be generated in a call to ProcessRequest or CreateMDNReceipt, and may be sent by calling SendResponse.

The receipt and headers will be contained in MDNReceipt.

According to RFC specifications, MDNReceipt must be sent if requested by the client.

AS3Receiver.MessageId Property

The message ID of the incoming message.

Syntax

getMessageId(): string;

Default Value

""

Remarks

MessageId corresponds to the Message-Id header of Request, and will be used as the Original-Message-Id header of MDNReceipt.

This property is read-only.

AS3Receiver.Passive Property

This controls whether or not to direct the server into a passive mode. It is recommended if behind a firewall.

Syntax

isPassive(): boolean;
setPassive(passive: boolean): void;

Default Value

TRUE

Remarks

This property controls whether or not to direct the server into a passive mode. Many firewalls will not allow the FTP server to open a connection from outside to the higher ports where the FTP client class expects them to be. If Passive is set to TRUE, the class will use the PASV command instead of the PORT command and thus will direct the server into a passive mode: connections are initiated only by the client.

AS3Receiver.Password Property

This is the password used to log in.

Syntax

getPassword(): string;
setPassword(password: string): void;

Default Value

""

Remarks

This property contains the password used to log in. It must be set before the class connects to the FTP server.

AS3Receiver.RemoteHost Property

This is the domain name or IP address of the FTP server.

Syntax

getRemoteHost(): string;
setRemoteHost(remoteHost: string): void;

Default Value

""

Remarks

This property specifies the IP address (IP number in dotted internet format) or the domain name of the FTP server. It is set before a connection is attempted and cannot be changed once a connection is in progress.

If this property is set to a domain name, a DNS request is initiated and upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, an error is returned.

If the class is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.

AS3Receiver.RemotePort Property

This is the port for the FTP service (default is 21).

Syntax

getRemotePort(): number;
setRemotePort(remotePort: number): void;

Default Value

21

Remarks

This property contains the port for the FTP service, which defaults to 21 if not set. A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.

For an implicit Secure Sockets Layer (SSL), use port 990 (please see the SSLStartMode property for more information).

This property is not available at design time.

AS3Receiver.Request Property

The AS3 request to process.

Syntax

getRequest(): Uint8Array;
setRequest(request: Uint8Array): void;

Default Value

""

Remarks

You may specify the request manually, or you may load the request from the FTP server by invoking ReadRequest.

The request may contain the AS3 headers, or these may be specified separately in RequestHeaders. Any methods which read or process the request will split the request into headers and body and populate Request and RequestHeaders appropriately.

AS3Receiver.RequestHeaders Property

The headers in the AS3 request.

Syntax

getRequestHeaders(): HeaderList;
setRequestHeaders(requestHeaders: HeaderList): void;

Default Value

Remarks

The headers will be parsed from the request by calls to methods such as ParseHeaders, ParseRequest, or ProcessRequest is invoked.

AS3Receiver.RequestHeadersString Property

The headers in the AS3 request.

Syntax

getRequestHeadersString(): string;
setRequestHeadersString(requestHeadersString: string): void;

Default Value

""

Remarks

The headers will be parsed from the request by calls to methods such as ParseHeaders, ParseRequest, or ProcessRequest is invoked.

AS3Receiver.ScanResult Property

The result of invoking ParseRequest .

Syntax

getScanResult(): number;

Default Value

0

Remarks

ScanResult will contain information about any errors that occurred while invoking ParseRequest or ProcessRequest. ScanResult will contain 0 if no errors occurred, otherwise it will contain one or more of the following errors. If multiple errors are reported the results will be OR-ed together.

This property is read-only.

AS3Receiver.SignerCert Property

Your trading partner's certificate.

Syntax

getSignerCert(): Certificate;
setSignerCert(signerCert: Certificate): void;

Default Value

Remarks

You must set your trading partner's certificate before processing any signed messages. This property should be set to a public key certificate.

If the trading partner's identity is unknown, you should first invoke ReadRequest and read the value of AS2To (or for AS3, AS3To). This will allow you to determine the correct certificate to use.

As a special case, you may set AcceptAnySignerCert to true. In this case, the class will attempt to validate the signature without knowing the certificate in advance. This is not recommended for production use, as it poses a security risk.

This property is not available at design time.

AS3Receiver.SSLAcceptServerCert Property

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

Syntax

getSSLAcceptServerCert(): Certificate;
setSSLAcceptServerCert(SSLAcceptServerCert: Certificate): void;

Default Value

Remarks

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

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

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

AS3Receiver.SSLCert Property

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

Syntax

getSSLCert(): Certificate;
setSSLCert(SSLCert: Certificate): void;

Default Value

Remarks

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

AS3Receiver.SSLProvider Property

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

Syntax

getSSLProvider(): AS3ReceiverSSLProviders;
setSSLProvider(SSLProvider: AS3ReceiverSSLProviders): void;

enum AS3ReceiverSSLProviders {
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
}

Default Value

0

Remarks

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

Possible values are as follows:

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

When Automatic is selected, the platform implementation will be used by default in all cases in the JavaScript edition.

Note: The internal provider is not support at this time.

AS3Receiver.SSLServerCert Property

The server certificate for the last established connection.

Syntax

getSSLServerCert(): Certificate;

Default Value

Remarks

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

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

AS3Receiver.SSLStartMode Property

Determines how the class starts the SSL negotiation. By default, SSL will not be used.

Syntax

getSSLStartMode(): AS3ReceiverSSLStartModes;
setSSLStartMode(SSLStartMode: AS3ReceiverSSLStartModes): void;

enum AS3ReceiverSSLStartModes {
  sslAutomatic,
  sslImplicit,
  sslExplicit,
  sslNone
}

Default Value

3

Remarks

The SSLStartMode property may have one of the following values:

AS3Receiver.Timeout Property

The timeout for the class.

Syntax

getTimeout(): number;
setTimeout(timeout: number): void;

Default Value

60

Remarks

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

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

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

If Timeout expires, and the operation is not yet complete, the class .

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

The default value for the Timeout property is 60 seconds.

AS3Receiver.User Property

This property contains the user identifier to use to log in.

Syntax

getUser(): string;
setUser(user: string): void;

Default Value

""

Remarks

This property contains the user identifier to be used when logging in. It must be set before the class connects to the FTP server.

AS3Receiver.abort Method

The method aborts the current upload or download.

Syntax

async as3receiver.abort(): Promise<void>

Remarks

This method sends an ABOR command to the FTP server. It is used to interrupt file uploads and downloads.

AS3Receiver.changeRemotePath Method

This method changes the current path on the FTP server.

Syntax

async as3receiver.changeRemotePath(remotePath : string): Promise<void>

Remarks

This method changes the current path on the FTP server to the specified RemotePath. When called, the class will issue a command to the server to change the directory. The RemotePath parameter may hold an absolute or relative path.

Absolute Paths

If the path begins with a /, it is considered an absolute path and must specify the entire path from the root of the server. For instance:

component.ChangeRemotePath("/home/testuser/myfolder");

Relative Paths

If the path does not begin with a /, it is considered a relative path and is resolved in relation to the current directory. For instance, a value of myfolder will indicate a subfolder of the current directory. The special value .. refers to the parent directory of the current path. For instance:

//Change to the 'myfolder' sub-directory component.ChangeRemotePath("myfolder"); //Navigate up two levels and then into the 'another/folder' path. component.ChangeRemotePath("../../another/folder");

AS3Receiver.config Method

Sets or retrieves a configuration setting.

Syntax

async as3receiver.config(configurationString : string): Promise<string>

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

AS3Receiver.createMDNReceipt Method

Creates MDNReceipt .

Syntax

async as3receiver.createMDNReceipt(headers : string, MDN : string, message : string): Promise<void>

Remarks

CreateMDNReceipt may be invoked after ParseRequest to create an MDN-based receipt. The receipt will report success or failure depending on ErrorReportingFlags and the success or failure of ParseRequest.

This method populates MDNReceipt with a new MDNReceipt. The Headers, MDN, and Message parameters can be used to further customize the receipt, or empty string ("") parameters may be set to use the class generated defaults. Headers will set additional transport headers to be sent with the receipt (in the HTTP or SMTP headers of the signed receipt). MDN can be used to append additional headers to the Message Disposition Notification portion of the MDN Receipt. If MDN is set to a value prefixed with an at sign ("@"), the at sign will be removed and the specified MDN will be used in the receipt in place of the component generated value. Message will set the human-readable portion of the receipt, and should describe any error conditions that may have occurred.

AS3Receiver.deleteFile Method

This method removes a file specified by FileName from an FTP server.

Syntax

async as3receiver.deleteFile(fileName : string): Promise<void>

Remarks

This method is used to remove a file specified by FileName from an FTP server. The remote file or directory specified by FileName is deleted. FileName is either an absolute path on the server, or a path relative to remote path set by ChangeRemotePath. If no FTP session is in place, one is automatically created by first calling the Logon method.

AS3Receiver.getFileSize Method

Gets the size of a file on the FTP server.

Syntax

async as3receiver.getFileSize(fileName : string): Promise<void>

Remarks

Gets the size of the file specified by FileName and RemotePath on the FTP server.

AS3Receiver.getFileTime Method

Gets the last modification time of a file on the FTP server.

Syntax

async as3receiver.getFileTime(fileName : string): Promise<void>

Remarks

Gets the last modification time of the file specified by FileName and RemotePath on the FTP server.

AS3Receiver.listDirectory Method

List the current directory on an FTP server.

Syntax

async as3receiver.listDirectory(filesToList : string): Promise<void>

Remarks

A listing is requested for the directory or file mask specified in FilesToList. This can be an absolute path on the server, a path relative to RemotePath, or a file mask. The file listing is received through the DirList event.

Similar to ListDirectoryLong, except only file names are returned. If no FTP session is in place, one is automatically created by first calling the Logon method.

AS3Receiver.listDirectoryLong Method

List the current directory on an FTP server.

Syntax

async as3receiver.listDirectoryLong(filesToList : string): Promise<void>

Remarks

A listing is requested for the directory or file mask specified in FilesToList. This can be an absolute path on the server, a path relative to RemotePath, or a file mask. The file listing is received through the DirList event. Extended file information is returned.

If no FTP session is in place, one is automatically created by first calling the Logon method.

AS3Receiver.logoff Method

This method is used to log off from the FTP server by posting a QUIT command.

Syntax

async as3receiver.logoff(): Promise<void>

Remarks

This method is used to log off from the FTP server by posting a QUIT command. If that fails, the connection is terminated by the local host.

AS3Receiver.logon Method

Logon to the FTP RemoteHost using the current User and Password .

Syntax

async as3receiver.logon(): Promise<void>

Remarks

Logon to the FTP server using the current User and Password. If an SSL (TLS) connection is required, you should first set SSLStartMode.

Example (Logging On)

FTPControl.RemoteHost = "ftpserver" FTPControl.User = "username" FTPControl.Password = "password" FTPControl.Logon()

AS3Receiver.parseRequest Method

Parses the EDI message and determines the EDIData .

Syntax

async as3receiver.parseRequest(): Promise<void>

Remarks

Processes the EDI message in the request (either from the HTTP context, or as given by Request and possibly RequestHeadersString). If the message is encrypted, it will be decrypted with the certificate specified in Certificate. If it is signed, the signature will be verified against the certificate specified in SignerCert.

If the message is scanned without difficulty, EDIData will be populated. If a problem occurs, an exception will be thrown. This might occur if the client used or requested unsupported algorithms or data formats. In this case, EDIData will not be determined.

The class may be configured to ignore certain errors by setting ErrorProcessingFlags. This will allow the message to be processed and EDIData to be determined. If any errors occur, an exception will be thrown and the ScanResult property will reflect the error condition.

Whether or not an exception is thrown, an MDNReceipt may be generated by invoking CreateMDNReceipt. In the case of a successful scan MDNReceipt will report the success, otherwise the receipt will provide information to the client about the error.

ProcessRequest may be used to scan and create the receipt in one step. ReadRequest may be used to scan the request headers only to obtain details that can be used to configure the correct settings for the partner.

AS3Receiver.processRequest Method

Processes the EDI data, and generates the receipt.

Syntax

async as3receiver.processRequest(): Promise<void>

Remarks

Invoking ProcessRequest automates the entire AS2 server process. The method scans the request, determines the EDIData, and generates the MDNReceipt. In a server environment the receipt may be returned by invoking SendResponse.

The method's functionality is the same as the combined functionality of ParseRequest and CreateMDNReceipt. The method's operation is controlled by ErrorProcessingFlags and ErrorReportingFlags, and ScanResult will be populated as in ParseRequest.

The method will throw an exception, as ParseRequest does, if a problem is found while processing the request. However, if the problem does not prevent an MDN from being generated, MDNReceipt will still be generated before the exception is thrown. In all cases, the receipt will be suitable for returning to the client. If an exception is thrown, the MDNReceipt will provide more detail on the cause of the error.

The class will populate EDIData if no errors occurred scanning the request, or if ErrorProcessingFlags had been previously configured to allow the error.

AS3Receiver.queryRemotePath Method

This queries the server for the current path.

Syntax

async as3receiver.queryRemotePath(): Promise<string>

Remarks

This method queries the server for the current path. When called, the class will issue a command to the server to retrieve the current path value. The return value of this method is the path returned by the server. For instance:

string remotePath = component.QueryRemotePath();

AS3Receiver.readRequest Method

Reads the AS3 request from the FTP server.

Syntax

async as3receiver.readRequest(fileName : string): Promise<void>

Remarks

Reads the AS3 request from the FTP server. The name of the file should be given by FileName. The request will be parsed into Request and RequestHeaders. The headers will also be parsed and the following properties will be populated:

• AS2From
• AS2To
• AS2Version
• MessageId
• MDNTo
• ReceiptDeliveryOption
• RequestedSignatureProtocol
• RequestedMICAlgorithms

ParseRequest may be used to scan the entire message.

AS3Receiver.reset Method

Resets the state of the control.

Syntax

async as3receiver.reset(): Promise<void>

Remarks

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

AS3Receiver.sendFTPCommand Method

This method sends the exact FTP command directly to the FTP server.

Syntax

async as3receiver.sendFTPCommand(command : string): Promise<void>

Remarks

This method sends the command specified by Command to the server exactly as it is provided. Use this method to send additional or custom commands directly to the server.

After calling this method, check the FTPLastReply property or monitor the PITrail event to obtain the server's response.

AS3Receiver.sendResponse Method

Uploads the MDN receipt.

Syntax

async as3receiver.sendResponse(fileName : string): Promise<void>

Remarks

Uploads the MDN receipt specified by MDNReceipt. You may create this receipt by invoking ProcessRequest or CreateMDNReceipt.

Prior to sending, you may Logon to the FTP server and navigate to the desired RemotePath. If you have not created an FTP connection already then SendResponse will attempt to establish one.

The URL for upload will be specified (by the sender) in MDNTo.

FileName should contain the name of the file that will be written on the AS3/FTP server.

AS3Receiver.ConnectionStatus Event

Fired to indicate changes in the connection state.

Syntax

as3receiver.on('ConnectionStatus', listener: (e: {readonly connectionEvent: string, readonly statusCode: number, readonly description: string}) => void )

Remarks

This event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:

AS3Receiver.DirList Event

This event is fired when a directory entry is received.

Syntax

as3receiver.on('DirList', listener: (e: {readonly dirEntry: string, readonly fileName: string, readonly isDir: boolean, readonly fileSize: number, readonly fileTime: string}) => void )

Remarks

The DirList events are fired when a directory listing is received as a response to a ListDirectory or ListDirectoryLong call.

The StartTransfer and EndTransfer events mark the beginning and end of the event stream.

The DirEntry parameter contains the filename when ListDirectory is called and includes extended file information when ListDirectoryLong is called.

The class tries to fill out the FileName, IsDir, FileSize, and FileTime parameters when calling the ListDirectoryLong method. Except for FileName, these parameters are empty when a short "List Directory" is performed.

In Unix systems, the date is given in two types of formats: If the date is in the past 12 months the exact time is specified and the year is omitted. Otherwise, only the date and the year, but not hours or minutes, are given.

AS3Receiver.EndTransfer Event

This event is fired when a file finishes downloading or uploading.

Syntax

as3receiver.on('EndTransfer', listener: (e: {readonly direction: number}) => void )

Remarks

The EndTransfer event fires when a Data Interface connection is closed. This occurs when the file finishes transferring or a directory listing is finished.

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

AS3Receiver.Error Event

Fired when information is available about errors during data delivery.

Syntax

as3receiver.on('Error', listener: (e: {readonly errorCode: number, readonly description: string}) => void )

Remarks

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

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.

AS3Receiver.Log Event

Fired with log information while processing a message.

Syntax

as3receiver.on('Log', listener: (e: {readonly logType: string, readonly logMessage: string, readonly logMessageB: Uint8Array}) => void )

Remarks

This event fires once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

Log messages available through this event correspond to log files written to LogDirectory. This event provides a way to obtain log messages without relying on files on disk. This event fires regardless of the value of LogDirectory (i.e. when LogDirectory is empty the event will still fire).

The LogMessage event parameter holds the raw log data.

The LogType event parameter indicates the type of log. Possible values are:

AS3Receiver.PITrail Event

This event traces the commands sent to the server, and the respective replies.

Syntax

as3receiver.on('PITrail', listener: (e: {readonly direction: number, readonly message: string}) => void )

Remarks

The PITrail event is useful for debugging purposes. It shows all of the interactions between the client and the server, line by line.

The Message parameter contains the full text of the message. The Direction parameter shows the originator of the message:

AS3Receiver.SignerCertInfo Event

This event is fired during verification of the signed message.

Syntax

as3receiver.on('SignerCertInfo', listener: (e: {readonly issuer: string, readonly serialNumber: string, readonly subjectKeyIdentifier: string, readonly certEncoded: string, readonly certEncodedB: Uint8Array}) => void )

Remarks

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

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

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

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

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

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

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

AS3Receiver.SSLServerAuthentication Event

Fired after the server presents its certificate to the client.

Syntax

as3receiver.on('SSLServerAuthentication', listener: (e: {readonly certEncoded: string, readonly certEncodedB: Uint8Array, readonly certSubject: string, readonly certIssuer: string, readonly status: string, accept: boolean}) => void )

Remarks

This event fires with information about the server certificate. The Status property shows why verification failed (otherwise, Status contains the string OK). To manually accept an untrusted certificate, the SSLAcceptAnyServerCert setting must be set to True before initiating the connection.

AS3Receiver.SSLStatus Event

Fired when secure connection progress messages are available.

Syntax

as3receiver.on('SSLStatus', listener: (e: {readonly message: string}) => void )

Remarks

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

AS3Receiver.StartTransfer Event

This event fires when a file starts downloading or uploading.

Syntax

as3receiver.on('StartTransfer', listener: (e: {readonly direction: number}) => void )

Remarks

The StartTransfer event fires when a Data Interface connection is created. This is when the file starts transferring or a directory listing is started.

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

AS3Receiver.Transfer Event

This event is fired during the file download or upload.

Syntax

as3receiver.on('Transfer', listener: (e: {readonly direction: number, readonly bytesTransferred: number, readonly percentDone: number, readonly text: string, readonly textB: Uint8Array}) => void )

Remarks

One or more Transfer events are fired during file transfer. The BytesTransferred parameter shows the number of bytes transferred since the beginning of the transfer.

Text contains the portion of the file data being delivered.

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

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

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

Certificate Type

This is the digital certificate being used.

Remarks

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

Fields

Constructors

public Certificate();

public Certificate(String certificateFile);

public Certificate(byte[] encoded);

public Certificate(int storeType, String store, String storePassword, String subject);

public Certificate(int storeType, String store, String storePassword, String subject, String configurationString);

public Certificate(int storeType, String store, String storePassword, byte[] encoded);

public Certificate(int storeType, byte[] store, String storePassword, String subject);

public Certificate(int storeType, byte[] store, String storePassword, String subject, String configurationString);

public Certificate(int storeType, byte[] store, String storePassword, byte[] encoded);

EDIAttachment Type

This describes the file being attached.

Remarks

Information about the file's location that is being attached to the message is contained here.

Fields

Constructors

public EDIAttachment();

public EDIAttachment(String fileName);

public EDIAttachment(String fileName, String contentType);

public EDIAttachment(String fileName, String contentType, String headers);

EDIData Type

The EDI payload of the AS2 message.

Remarks

The EDI payload of the AS2 message.

Fields

Constructors

public EDIData();

public EDIData(byte[] data, String EDIType);

public EDIData(String fileName, String EDIType);

Firewall Type

The firewall the class will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall and the .

Fields

Constructors

public Firewall();

Header Type

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

Remarks

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

Fields

Constructors

public Header();

public Header(String field, String value);

MDNReceipt Type

The complete MDN Receipt returned by the receiver.

Remarks

The complete MDN Receipt contains the Message Disposition Notification (MDN) and an optional signature.

Fields

Constructors

public MDNReceipt();

public MDNReceipt(String headers, byte[] content);

Config Settings (class ipworksedi.as3receiver)

AS3Receiver Config Settings

FTP 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 (class ipworksedi.as3receiver)

AS3Receiver Errors

FTP Errors

TCPClient Errors

TCP/IP Errors

SMIME Errors