OFTPClient Class
Properties Methods Events Config Settings Errors
The OFTPClient class implements the Odette File Transfer Protocol.
Syntax
ipworksedi.oftpclient()
Remarks
The OFTPClient component may be used to send and receive OFTP files to and from an OFTP server.
Receiving Files
The OFTPClient ReceiveFiles function requires certain server properties be set. You must set the RemoteHost property to the remote location of the desired OFTP server. You may also set a RemotePort if the server is not set to the default protocol port. For client authorization, you must set the ClientSSIDCode, ClientSFIDCode, and ClientPassword properties. And, for server authentication, you must set the ServerSSIDCode, ServerSFIDCode, and ServerPassword properties.
The class will connect to the OFTP server and download all files in the server's outgoing queue, and write these files to the directory specified by DownloadDirectory. The class creates a default location on the local machine based on the values of the DownloadDirectory and the Virtual Filename as received from the server. If a different location is preferred, you may set the LocalFile parameter of the StartTransfer event.
Sending Files
The OFTPClient SendFile function requires the same server and authentication properties to be set as the ReceiveFiles function.
The class will connect to the OFTP server and upload the file contained by the LocalFile parameter. It uses the name specified by VirtualFileName when sending to the server. If this is not specified, the filename of the local file is parsed and used as the virtual filename.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
Certificate | The current selected certificate. |
ClientPassword | The client's password. |
ClientSFIDCode | Client's SFID code. |
ClientSSIDCode | The client's SSID code. |
Compress | Whether or not to compress the outgoing file. |
Connected | Shows whether the class is connected. |
DownloadDirectory | Download directory. |
EncryptionAlgorithm | The encryption algorithm. |
Firewall | A set of properties related to firewall access. |
LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
MaxRecordSize | The maximum length of a given record. |
Overwrite | Whether or not the class should overwrite files during transfer. |
RecipientCert | The recipient certificate of the message. |
RemoteHost | The domain name or IP address of the OFTP server. |
RemotePort | The port for the OFTP service (default is 3305). |
SecureAuthentication | Whether or not the class should perform secure Odette authentication. |
ServerPassword | The server's password. |
ServerSFIDCode | Server's SFID code. |
ServerSSIDCode | The server's SSID code. |
SignedReceipt | Whether or not to require signed receipts. |
SSLAcceptServerCert | Instructs the class to unconditionally accept the server certificate that matches the supplied certificate. |
SSLCert | The certificate to be used during SSL negotiation. |
Timeout | A timeout for the class. |
TrustedCerts | A collection of trusted CA certificates. |
UseSSL | Use SSL to access the RemoteHost . |
Version | Which version of the OFTP protocol the class is using. |
VirtualFileDate | The date/time stamp for the virtual file. |
VirtualFileFormat | The structure of the outgoing file. |
VirtualFileSecurityLevel | The level of security for the file. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
ChangeDirection | Sends a Change Direction (CD) command. |
Config | Sets or retrieves a configuration setting. |
Connect | This method connects to the FTP server without logging in. |
Disconnect | This method disconnects from the server without first logging off. |
DoEvents | Processes events from the internal message queue. |
ExchangeCertificate | Exchange a certificate with the remote host. |
ImportTrustedCerts | Imports a list of trusted CA certificates. |
Interrupt | This method interrupts the current action. |
Logoff | Logoff from the OFTP server. |
Logon | Logon to the OFTP RemoteHost using the current client credentials. |
ReceiveFiles | Receive any files queued to be sent from the server. |
Reset | Resets the state of the control. |
SendEndResponse | Sends an EERP/NERP asynchronously. |
SendFile | Send the specified file to the server. |
ValidateCert | Validates the certificate with private key. |
ValidateRecipientCert | Validates the recipient certificate. |
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.
AcceptFile | Fired when the client receives a file. |
CertificateReceived | Fired when a certificate is received from the remote host. |
EndResponse | Fired every time an end response is received from the server. |
EndTransfer | Fired when a file finishes transferring. |
Error | Fired when information is available about errors during data delivery. |
Log | Fires once for each log message. |
PITrail | Fired when any protocol level communication occurs. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Fired when secure connection progress messages are available. |
StartTransfer | Fired when a document starts transferring. |
Transfer | Fired while a document transfers (delivers document). |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
AcceptAnySFIDCode | Indicates that all SFID codes are acceptable. |
AllowRetry | Whether to send a retry indicator when rejecting a file. |
CertificateType | Specifies the type of certificate being supplied. |
ConnectionType | Specifies the type of connection that will be created. |
CreditCount | Specifies the credit value. |
DeleteOnError | Whether received files are deleted when there is an error during processing. |
DisconnectAfterEndSession | Determines if the connection is closed immediately after ending the session. |
EnforceProtocolVersion | Requires the server to support the same OFTP version. |
ExchangeBufferSize | Specifies the data exchange buffer size in bytes. |
ExchangeCertStoreType | Specifies the store type when loading a certificate to be exchanged. |
ExchangeCertSubject | The subject of the certificate being exchanged. |
FailOnUntrustedCert | Whether or not to throw an exception when untrusted certificates are used. |
FileDescription | Additional description information sent with the file. |
FileHashAlgorithm | The hash algorithm to use when sending a file. |
FireEndResponseOnSend | Determines if the EndResponse event is fired for outgoing EERP and NERPs. |
FollowRedirects | Determines behavior when importing trusted certificates and a HTTP redirect is returned. |
FriendlyLogFormat | Determines if a more friendly format is applied to PITrail event out. |
LogLevel | The level of information to log. |
MaskSensitive | Masks passwords in logs. |
ReceiptHashAlgorithm | The receipt hash algorithm to request when sending a file. |
ReceivedFileDateTime | The datetime of the file being received. |
ReceivedFileDescription | Additional description information received with the file. |
ReceivedFileEncryptionAlg | The encryption algorithm used for the file being received. |
ReceivedFileName | Returns the name of the received file. |
ReceivedFileNameFormat | The name format of received files. |
ReceivedFileNameFormat | The name format of received files. |
RecipientCertificateType | Specifies the type of recipient certificate being supplied. |
Retry | Indicates whether the recipient allows the send to be retried. |
SendCDAfterEFPA | Specifies whether a CD is always sent after receiving an EFPA. |
TempPath | The path of a directory where temporary files will be created. |
TrustedCertsData | Specifies the source to be used when importing trusted certificates. |
VirtualFileDateFormat | The DateTime format of received files. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitive | Whether sensitive data is masked in log messages. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
OFTPClient.Certificate Property
The current selected certificate.
Syntax
getCertificate(): Certificate; setCertificate(certificate: Certificate): void;
Default Value
Remarks
This property is populated when a specified certificate is found or loaded by the class. Certificate is used for specifying private keys. Set this property to a valid Certificate object to perform different operations such as session authentication, signing a file or receipt, or decryption. To set a certificate, you may set the field to the encoded certificate. To select a certificate, use the and fields.
Please refer to the Certificate type for a complete list of fields.OFTPClient.ClientPassword Property
The client's password.
Syntax
getClientPassword(): string; setClientPassword(clientPassword: string): void;
Default Value
""
Remarks
The password assigned to the client in the bilateral agreement. This property must be a string of no more than 8 characters long.
OFTPClient.ClientSFIDCode Property
Client's SFID code.
Syntax
getClientSFIDCode(): string; setClientSFIDCode(clientSFIDCode: string): void;
Default Value
""
Remarks
The SFID code identifies the origin or destination party that is sending or receiving a file, while the SSID code identifies the party that a session is established with. If the SFID and SSID codes do not match, then the party the session is established with is acting as an intermediary, and the party identified by the SFID code is either the origin or final destination.
When acting as an intermediary the component will not perform any security services (i.e. sign, verify, encrypt, decrypt). Security services are to be performed by the origin or destination only. Data should simply be passed along by an intermediary.
OFTPClient.ClientSSIDCode Property
The client's SSID code.
Syntax
getClientSSIDCode(): string; setClientSSIDCode(clientSSIDCode: string): void;
Default Value
""
Remarks
The identification code of the client. This code may be less than, but no more than 25 characters long. Generally, SSID codes have the following format as specified in RFC 2204 that is based on ISO 6523:
Code Identifier | 'O' - Indicates ODETTE assigned the Organization Identifier. Other
values can be used for non-ODETTE codes.
NOTE: This field is a fixed length of 1 character. |
International Code | A code forming part of the Organization Identifier.
NOTE: This field may be of variable length up to 4 characters long. |
Organization Code | A code forming part of the Organization Identifier. This field may
contain the letters A to Z, the digits 0 to 9, and space and hyphen
characters.
NOTE: This field may be of variable length up to 14 characters long. |
Computer Sub-Address | A locally assigned address which uniquely identifies a system within
an organization (defined by an Organization Identifier).
NOTE: This field may be of variable length up to 6 characters long. |
OFTPClient.Compress Property
Whether or not to compress the outgoing file.
Syntax
isCompress(): boolean; setCompress(compress: boolean): void;
Default Value
FALSE
Remarks
When sending a file to the trading partner, set this to true for the class to compress the file before sending. The file will first be compressed to a temporary file before being sent.
Note that this is only applicable when Version 2.0 of the protocol is used as indicated by Version.
This property is not available at design time.
OFTPClient.Connected Property
Shows whether the class is connected.
Syntax
isConnected(): boolean;
Default Value
FALSE
Remarks
Use this property to determine whether the class is connected to the remote host or not.
Note: It is recommended to use the Connect or Disconnect method instead of setting this property.
This property is not available at design time.
OFTPClient.DownloadDirectory Property
Download directory.
Syntax
getDownloadDirectory(): string; setDownloadDirectory(downloadDirectory: string): void;
Default Value
"./"
Remarks
This property contains the location on disk of the folder the class will write received files to. The default for this property is "./", which is the current working directory.
Note: If this property is set to empty string data will not be written to disk and instead will be available through the Transfer event.
OFTPClient.EncryptionAlgorithm Property
The encryption algorithm.
Syntax
getEncryptionAlgorithm(): OftpclientEncryptionAlgorithms; setEncryptionAlgorithm(encryptionAlgorithm: OftpclientEncryptionAlgorithms): void;
enum OftpclientEncryptionAlgorithms { encra3DES, encraAES }
Default Value
0
Remarks
In order to use encryption, you must set the VirtualFileSecurityLevel property. The supported algorithms for encryption are:
3DES (0) | Triple Data Encryption Standard. |
AES (1) | Advanced Encryption Standard with key length of 128. |
This property is not available at design time.
OFTPClient.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.
Please refer to the Firewall type for a complete list of fields.OFTPClient.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
The LocalHost 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 multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.
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 multi-homed 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.
OFTPClient.MaxRecordSize Property
The maximum length of a given record.
Syntax
getMaxRecordSize(): number; setMaxRecordSize(maxRecordSize: number): void;
Default Value
0
Remarks
This value determines the maximum length for a record in the outgoing virtual file. When VirtualFileFormat has been set to ffUnstructured or ffText, this value must be zero. When ffFixed or ffVariable, this must be set to a value greater than 0, containing the maximum line length of the outgoing file.
OFTPClient.Overwrite Property
Whether or not the class should overwrite files during transfer.
Syntax
isOverwrite(): boolean; setOverwrite(overwrite: boolean): void;
Default Value
FALSE
Remarks
This property is a value indicating whether or not the class should overwrite downloaded files. If Overwrite is false, an error will be thrown whenever the local file exists before a receive operation.
OFTPClient.RecipientCert Property
The recipient certificate of the message.
Syntax
getRecipientCert(): Certificate; setRecipientCert(recipientCert: Certificate): void;
Default Value
Remarks
This property specifies the certificate to use when verifying signed files and receipts as well as encrypting files to be sent. This property must be set when SecureAuthentication has been set to true, sending a file and VirtualFileSecurityLevel has been set to slEncrypted or slEncryptedAndSigned, SignedReceipt has been set to true, or a signed file is being received and the server has not included the certificate in the signature.
The RecipientCert property must be filled out with a valid public key Certificate type object. To set a certificate, you may set the field to the encoded certificate. To select a certificate, use the and fields.
This property is not available at design time.
Please refer to the Certificate type for a complete list of fields.OFTPClient.RemoteHost Property
The domain name or IP address of the OFTP server.
Syntax
getRemoteHost(): string; setRemoteHost(remoteHost: string): void;
Default Value
""
Remarks
The RemoteHost property specifies the IP address (IP number in dotted internet format) or Domain Name of the OFTP server. It is set before a connection is attempted and cannot be changed once a connection is in progress.
If the RemoteHost property is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, the RemoteHost 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.
OFTPClient.RemotePort Property
The port for the OFTP service (default is 3305).
Syntax
getRemotePort(): number; setRemotePort(remotePort: number): void;
Default Value
3305
Remarks
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.
When UseSSL is set to True this property will be set to 6619.
This property is not available at design time.
OFTPClient.SecureAuthentication Property
Whether or not the class should perform secure Odette authentication.
Syntax
isSecureAuthentication(): boolean; setSecureAuthentication(secureAuthentication: boolean): void;
Default Value
FALSE
Remarks
If true, the class will perform secure authentication when connecting to the server. The secure authentication consists of encrypting and decrypting data sent to and from the server, and verifying that this occurred successfully. Secure authentication may be performed in plaintext or SSL mode.
Both Certificate and RecipientCert properties must be populated when this property is set to true.
This is only valid for version 2.0 of the protocol.
This property is not available at design time.
OFTPClient.ServerPassword Property
The server's password.
Syntax
getServerPassword(): string; setServerPassword(serverPassword: string): void;
Default Value
""
Remarks
The password assigned to the server in the bilateral agreement. This property must be a string of no more than 8 characters long.
OFTPClient.ServerSFIDCode Property
Server's SFID code.
Syntax
getServerSFIDCode(): string; setServerSFIDCode(serverSFIDCode: string): void;
Default Value
""
Remarks
The SFID code identifies the origin or destination party that is sending or receiving a file, while the SSID code identifies the party that a session is established with. If the SFID and SSID codes do not match, then the party the session is established with is acting as an intermediary, and the party identified by the SFID code is either the origin or final destination.
When acting as an intermediary the component will not perform any security services (i.e. sign, verify, encrypt, decrypt). Security services are to be performed by the origin or destination only. Data should simply be passed along by an intermediary.
OFTPClient.ServerSSIDCode Property
The server's SSID code.
Syntax
getServerSSIDCode(): string; setServerSSIDCode(serverSSIDCode: string): void;
Default Value
""
Remarks
The identification code of the server. This code may be less than, but no more than 25 characters long. Generally, SSID codes have the following format as specified in RFC 2204 that is based on ISO 6523:
Code Identifier | 'O' - Indicates ODETTE assigned the Organization Identifier. Other
values can be used for non-ODETTE codes.
NOTE: This field is a fixed length of 1 character. |
International Code | A code forming part of the Organization Identifier.
NOTE: This field may be of variable length up to 4 characters long. |
Organization Code | A code forming part of the Organization Identifier. This field may
contain the letters A to Z, the digits 0 to 9, and space and hyphen
characters.
NOTE: This field may be of variable length up to 14 characters long. |
Computer Sub-Address | A locally assigned address which uniquely identifies a system within
an organization (defined by an Organization Identifier).
NOTE: This field may be of variable length up to 6 characters long. |
OFTPClient.SignedReceipt Property
Whether or not to require signed receipts.
Syntax
isSignedReceipt(): boolean; setSignedReceipt(signedReceipt: boolean): void;
Default Value
FALSE
Remarks
When sending a file to a trading partner, set this to true if the file receipt should be signed by the server. When this receipt is received by the class, it will be verified during processing.
NOTE: If the server does not attach the public certificate in the signed message, the server's public key must be specified in the RecipientCert property in order for verification to succeed.
This property is not available at design time.
OFTPClient.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.
Please note that this functionality is provided only for cases where 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.
Please refer to the Certificate type for a complete list of fields.OFTPClient.SSLCert Property
The certificate to be used during SSL negotiation.
Syntax
getSSLCert(): Certificate; setSSLCert(SSLCert: Certificate): void;
Default Value
Remarks
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.
Please refer to the Certificate type for a complete list of fields.OFTPClient.Timeout Property
A 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 return immediately, potentially failing with a WOULDBLOCK error if data cannot be sent immediately.
If Timeout is set to a positive value, data is sent in a blocking manner and the class will wait for the operation to complete before returning control. The class will handle any potential WOULDBLOCK errors internally and automatically retry the operation for a maximum of Timeout seconds.
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 .
Please note that by default, all timeouts are inactivity timeouts, i.e. 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.
OFTPClient.TrustedCerts Property
A collection of trusted CA certificates.
Syntax
getTrustedCerts(): CertificateList; setTrustedCerts(trustedCerts: CertificateList): void;
Default Value
Remarks
If this collection is populated the class will validate any certificates that are loaded against the CA certificates specified here.
If this collection is not populated no validation will occur. Certificates are imported into this collection by calling the ImportTrustedCerts method.
See also FailOnUntrustedCert and TrustedCertsData.
This property is not available at design time.
Please refer to the Certificate type for a complete list of fields.OFTPClient.UseSSL Property
Use SSL to access the RemoteHost .
Syntax
isUseSSL(): boolean; setUseSSL(useSSL: boolean): void;
Default Value
FALSE
Remarks
Use this property to determine whether the class uses SSL to connect with the RemoteHost.
This property is only valid when using version 2.0 of the protocol.
Note: Setting this property to True will set RemotePort to 6619.
This property is not available at design time.
OFTPClient.Version Property
Which version of the OFTP protocol the class is using.
Syntax
getVersion(): OftpclientVersions; setVersion(version: OftpclientVersions): void;
enum OftpclientVersions { oftpVer12, oftpVer13, oftpVer14, oftpVer20 }
Default Value
3
Remarks
This property specifies which version of the OFTP protocol to use. Possible values are:
0 (oftpVer12) | 1.2 |
1 (oftpVer13) | 1.3 |
2 (oftpVer14) | 1.4 |
3 (oftpVer20 - default) | 2.0 |
Note: Version 2.0 (oftpVer20) of the protocol must be used when using security functions. The following properties are only applicable when using Version 2.0:
OFTPClient.VirtualFileDate Property
The date/time stamp for the virtual file.
Syntax
getVirtualFileDate(): string; setVirtualFileDate(virtualFileDate: string): void;
Default Value
""
Remarks
Set this to the date/time stamp for the virtual file before sending. If this is not set when sending a file, the current date/time will be used. This property will accept various date formats, but will return the following format only: "MM/dd/yyyy HH:mm:ss".
Supported date formats:
- ddd, d MMM yy HH:mm:ss zzz
- ddd, d MMM yyyy HH:mm:ss zzz
- d MMM yy HH:mm:ss zzz
- d MMM yyyy HH:mm:ss zzz
- dd-MMM-yyyy HH:mm:ss
- ddd, d MMM yy HH:mm:ss zz
- ddd, d MMM yyyy HH:mm:ss zz
- ddd, d MMM yy HH:mm:ss zzz
- ddd, d MMM yyyy HH:mm:ss zzz
- ddd, d MMM yy HH:mm:ss z
- ddd, d MMM yyyy HH:mm:ss z
- ddd, dd MMM yyyy HH:mm:ss 'GMT'
- dddd, MMMM dd, yyyy h:mm:ss tt
- dddd, MMMM dd yyyy h:mm tt
- yyMMddHHmmssZ
- yyyyMMddHHmmssZ
- yyMMddHHmmsszzzz
- yyyyMMddHHmmsszzzz
- yyyyMMddHHmmssffff
- MM/dd/yyyy HH:mm:ss
OFTPClient.VirtualFileFormat Property
The structure of the outgoing file.
Syntax
getVirtualFileFormat(): OftpclientVirtualFileFormats; setVirtualFileFormat(virtualFileFormat: OftpclientVirtualFileFormats): void;
enum OftpclientVirtualFileFormats { ffUnstructured, ffText, ffFixed, ffVariable }
Default Value
0
Remarks
The following values are valid file formats for outgoing virtual files:
0 (Unstructured - default) | The outgoing file is binary and has not structure. There are no records in this type of file. |
1 (Text) | The outgoing file is a text file that consists of lines containing no more than 2048 characters terminated by CRLF. This type contains no records. |
2 (Fixed) | The outgoing file is in fixed file format, which means all records are of the same length. For fixed files, the class expects the file to be in text format with each line containing the MaxRecordSize characters terminated by a CRLF. |
3 (Variable) | The outgoing file is a variable file format, meaning all records are of variable length and are no longer than MaxRecordSize. When using this format, the class will parse out each record as a line terminated by CRLF. Thus, this type of file must be a text file, and must contain lines with less than MaxRecordSize characters. |
Note: When either VirtualFileSecurityLevel has been set to a value other than slNone or Compress has been set to true, all files become ffUnstructured except ffVariable files.
This property is not available at design time.
OFTPClient.VirtualFileSecurityLevel Property
The level of security for the file.
Syntax
getVirtualFileSecurityLevel(): OftpclientVirtualFileSecurityLevels; setVirtualFileSecurityLevel(virtualFileSecurityLevel: OftpclientVirtualFileSecurityLevels): void;
enum OftpclientVirtualFileSecurityLevels { slNone, slEncrypted, slSigned, slEncryptedAndSigned }
Default Value
0
Remarks
When sending files, set this value to the level of security for the next virtual file to send. After receiving a file, this will be set to the level of security of the last file received.
When encrypting a file, RecipientCert must be set, and when signing a file, the Certificate must be set.
The file will be processed to a temporary file before being sent.
This is only valid for version 2.0 of the protocol.
This property is not available at design time.
OFTPClient.changeDirection Method
Sends a Change Direction (CD) command.
Syntax
async oftpclient.changeDirection(): Promise<void>
Remarks
This method sends a Change Direction (CD) command to the remote host when called. In normal operation this should not be used. This should only be used if a condition arises where you must manually change the speaker when communicating with the remote host.
OFTPClient.config Method
Sets or retrieves a configuration setting.
Syntax
async oftpclient.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.
OFTPClient.connect Method
This method connects to the FTP server without logging in.
Syntax
async oftpclient.connect(): Promise<void>
Remarks
This method establishes a connection with the RemoteHost but does not log in. In most cases, it is recommended to use the Logon method, which will both establish a connection and log in to the server.
This method may be useful in cases in which it is desirable to separate the connection and logon operations, for instance, confirming that a host is available by first creating the connection.
OFTPClient.disconnect Method
This method disconnects from the server without first logging off.
Syntax
async oftpclient.disconnect(): Promise<void>
Remarks
This method immediately disconnects from the server without first logging off.
In most cases, the Logoff method should be used to log off and disconnect from the server. Call the Disconnect method in cases in which it is desirable to immediately disconnect without first logging off.
OFTPClient.doEvents Method
Processes events from the internal message queue.
Syntax
async oftpclient.doEvents(): Promise<void>
Remarks
When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.
OFTPClient.exchangeCertificate Method
Exchange a certificate with the remote host.
Syntax
async oftpclient.exchangeCertificate(certificateStore : string, certificateExchangeType : number): Promise<void>
Remarks
If the remote host supports the certificate exchange feature of OFTP 2.0 this method may be used to send and/or request certificates.
The CertificateStore parameter specifies the location of the certificate to be exchanged. In most cases this will be the path to a .cer file on disk. If the certificate is in another format or is installed to the Windows certificate store please see ExchangeCertStoreType and ExchangeCertSubject for more information.
The CertificateExchangeType parameter determines the type of request. Possible values are:
0 | Request: The class will send the certificate file specified. The remote host will respond with a certificate of it's own. The response may be in a separate session. |
1 | Replace: The class will send the certificate file specified. No certificate is expected in response. The certificate sent here invalidates any previous certificates the remote host has stored. |
2 | Deliver: The class will send the certificate file specified. This is used to respond to a certificate request. It may also be used to send new additional certificates to the remote host. This will not invalidate previous certificates the remote host has stored. |
OFTPClient.importTrustedCerts Method
Imports a list of trusted CA certificates.
Syntax
async oftpclient.importTrustedCerts(): Promise<void>
Remarks
When ImportTrustedCerts is called the class will import the CA certificates from the source specified by TrustedCertsData into the TrustedCerts collection.
The class will then validate the trust of certificates when they are loaded.
If trusted CA certificates are not imported no validation will occur (default).
See also FailOnUntrustedCert.
OFTPClient.interrupt Method
This method interrupts the current action.
Syntax
async oftpclient.interrupt(): Promise<void>
Remarks
This method interrupts the current action. If you use SendFile to upload a file, the class will run synchronously until the upload is completed. This method will allow you to stop the file from uploading without disconnecting from the host.
OFTPClient.logoff Method
Logoff from the OFTP server.
Syntax
async oftpclient.logoff(): Promise<void>
Remarks
Logoff from the OFTP server. If that fails, the connection is terminated by the local host.
OFTPClient.logon Method
Logon to the OFTP RemoteHost using the current client credentials.
Syntax
async oftpclient.logon(): Promise<void>
Remarks
Logon to the OFTP server using the current ClientSSIDCode, ClientSFIDCode, and ClientPassword. The component will also check the corresponding server credentials, ServerSSIDCode, ServerSFIDCode, and ServerPassword.
OFTPClient.receiveFiles Method
Receive any files queued to be sent from the server.
Syntax
async oftpclient.receiveFiles(): Promise<void>
Remarks
This method connects to the server, and receives any files the server has in its outgoing queue to this particular partner. The files are downloaded to the directory specified by the DownloadDirectory property.
OFTPClient.reset Method
Resets the state of the control.
Syntax
async oftpclient.reset(): Promise<void>
Remarks
Reset resets the state of the class. All properties will be set to their default values.
OFTPClient.sendEndResponse Method
Sends an EERP/NERP asynchronously.
Syntax
async oftpclient.sendEndResponse(virtualFileName : string, virtualFileDate : string, destination : string, originator : string, creator : string, reasonCode : number, reasonText : string, fileHash : string, signature : string): Promise<void>
Remarks
This method sends an EERP/NERP. By default the class will automatically respond with an EERP/NERP when receiving a file. To respond asynchronously instead this method may be used.
To respond asynchronously first set the SendEndResponse parameter of the EndTransfer event to False. This instructs the class to not send a response automatically. Within the EndTransfer event you must also save the values that are required parameters for this method. This includes FileHash, VirtualFileDate, and VirtualFileName. Note: VirtualFileDateFormat must be set to a format that includes the necessary level of accuracy.
Destination should be set to the SFID of the remote host.
Originator should be set to the SFID of the local system. In the case that the class is being used as part of a gateway process to forward traffic to another OFTP host this may be set to the SFID of that host instead.
Creator should be set to the SFID of the local system.
Signature is only applicable if the application is acting as a routing application. In all other cases this should be set to empty string. In the case where the application is acting as a routing application the end response is being forwarded to another entity for processing. The Signature should be set to the value received in the EndResponse event (if populated).
ReasonCode and ReasonText are used to specify error information. If ReasonCode is set to 0 the class will send an EERP. If ReasonCode is set to any non-zero value the class will send a NERP. Common values are:
ReasonCode | ReasonText |
3 | User Code Not Known |
4 | Invalid Password |
9 | Unspecified Reason |
11 | Invalid FileName |
12 | Invalid Destination |
13 | Invalid Origin |
14 | Invalid Storage Record Format |
15 | Maximum Record Length Not Supported |
16 | File Size Too Big |
20 | Invalid Record Count |
21 | Invalid Byte Count |
22 | Access Method Failure |
23 | Duplicate File |
24 | File Direction Refused |
25 | Cipher Suite Not Supported |
26 | Encrypted File Not Allowed |
27 | Unencrypted File Not Allowed |
28 | Compression Not Allowed |
29 | Signed File Not Allowed |
30 | Unsigned File Not Allowed |
31 | File Signature Not Valid |
32 | File Decompression Failed |
33 | File Decryption Failed |
34 | File Processing Failed |
35 | Not Delivered To Recipient |
36 | Not Acknowledged By Recipient |
50 | Transmission Stopped By The Operator |
90 | File Size Incompatible With Recipient's Protocol Version |
99 | Unspecified Reason |
OFTPClient.sendFile Method
Send the specified file to the server.
Syntax
async oftpclient.sendFile(localFile : string, virtualFileName : string): Promise<void>
Remarks
This method connects to the server, and uploads the specified file to the server. The LocalFile parameter contains the path and name of the file to send to the server. The VirtualFileName parameter contains the virtual file name of the file being sent. If this parameter is left as an empty string, the component will use the filename contained in the LocalFile parameter by default.
Note: When SetUploadStream has been called with a valid input stream, the data will be uploaded from there instead of the LocalFile.
OFTPClient.validateCert Method
Validates the certificate with private key.
Syntax
async oftpclient.validateCert(): Promise<boolean>
Remarks
This method optionally validates the certificate specified by Certificate. It is not required to validate the certificate from a technical perspective, but may be desired to ensure the recipient's certificate is valid and issued by a trusted authority.
Before calling this method call ImportTrustedCerts to load the trusted certification information.
When this method is called the class:
- Validates the certificate has not expired
- Validates the certificate was issued by a CA in the TrustedCerts collection. If the certificate is self-signed this step is skipped.
- Validates the certificate has not been revoked. Note that the revocation check will only make use of the CRL distribution point identified in the certificate's extension. If the certificate does not contain a CRL distribution point extension this step is skipped.
OFTPClient.validateRecipientCert Method
Validates the recipient certificate.
Syntax
async oftpclient.validateRecipientCert(): Promise<boolean>
Remarks
This method optionally validates the certificate specified by RecipientCert. It is not required to validate the certificate from a technical perspective, but may be desired to ensure the recipient's certificate is valid and issued by a trusted authority.
Before calling this method call ImportTrustedCerts to load the trusted certification information.
When this method is called the class:
- Validates the certificate has not expired
- Validates the certificate was issued by a CA in the TrustedCerts collection. If the certificate is self-signed this step is skipped.
- Validates the certificate has not been revoked. Note that the revocation check will only make use of the CRL distribution point identified in the certificate's extension. If the certificate does not contain a CRL distribution point extension this step is skipped.
OFTPClient.AcceptFile Event
Fired when the client receives a file.
Syntax
oftpclient.on('AcceptFile', listener: (e: {readonly virtualFileName: string, readonly virtualFileDate: string, readonly destination: string, readonly originator: string, accept: boolean, filename: string, overwrite: boolean, errorCode: number, errorDescription: string}) => void )
Remarks
This event controls the behavior when the client receives a file.
VirtualFileName holds the name of the file being received.
VirtualFileDate holds the date associated with the file in the format specified by VirtualFileDateFormat. The default value is "MM/dd/yyyy HH:mm:ss".
Destination identifies the receiver (SFID) code in the send file request. If the file was intended for this server this will match the value in ServerSFIDCode
Originator identifies the sender (SFID) code in the send file request.
Accept is true by default, and must be set to False in order to reject the file.
Filename will be populated with the full path and filename that will be written. It may be changed within this event to specify a new location. The Filename is determined by combining the path specified in ConnectionsDownloadDirectory and the name received from the client.
Overwrite is false by default, but may be set to true to overwrite existing files on disk.
ErrorCode controls the error returned to the client when Accept is set to False. If this is not set the class will use a value of 99 to indicate a general error.
ErrorDescription may also be set to include an error message. If this is not set the class will automatically include an error message based on the ErrorCode specified. Common error codes and their corresponding error messages are listed below.
ErrorCode | ErrorMessage |
1 | Invalid filename. |
2 | Invalid destination. |
3 | Invalid origin. |
4 | Storage record format not supported. |
5 | Maximum record length not supported. |
6 | File size is too big. |
10 | Invalid record count. |
11 | Invalid byte count. |
12 | Access method failure. |
13 | Duplicate file. |
14 | File direction refused. |
15 | Cipher suite not supported. |
16 | Encrypted file not allowed. |
17 | Unencrypted file not allowed. |
18 | Compression not allowed. |
19 | Signed file not allowed. |
20 | Unsigned file not allowed. |
99 | Unspecified reason. |
OFTPClient.CertificateReceived Event
Fired when a certificate is received from the remote host.
Syntax
oftpclient.on('CertificateReceived', listener: (e: {readonly certificateFileName: string, readonly certificateExchangeType: number}) => void )
Remarks
This event provides information about the certificate file that was sent by the remote host.
When the remote host sends a certificate using the Certificate Exchange feature of OFTP 2.0, this event provides information about it. The certificate file will be written to the DownloadDirectory. After the file is written to DownloadDirectory this event will fire.
The CertificateFilemame parameter holds the filename of the received certificate.
The CertificateExchangeType parameter identifies the type of request associated with the certificate. Possible values are:
0 | Request: The class received a certificate and request from the remote host. Respond using the ExchangeCertificate method using a CertificateExchangeType of 3 (Deliver). The response may be in a separate session. |
1 | Replace: The class received a certificate from the remote host. No response is expected. The certificate received here invalidates any previously stored certificates for this configuration. |
2 | Deliver: The class received a certificate from the remote host. This is either a response to a certificate request, or a new additional certificates from the remote host. This will not invalidate previous certificates stored for this configuration. |
OFTPClient.EndResponse Event
Fired every time an end response is received from the server.
Syntax
oftpclient.on('EndResponse', listener: (e: {readonly virtualFileName: string, readonly virtualFileDate: string, readonly destination: string, readonly originator: string, readonly creator: string, readonly reasonCode: number, readonly reasonText: string, fileHash: string, readonly signature: string, readonly direction: number}) => void )
Remarks
This event contains information received from an either an End-To-End Response or a Negative End Response received from the server.
An End-To-End Response will not contain values for the ReasonCode, ReasonText, or Creator parameters.
VirtualFileName specifies the name of the file.
VirtualFileDate holds the VirtualFileDate value in the format specified by VirtualFileDateFormat. The default value is "MM/dd/yyyy HH:mm:ss".
Destination is the SFID of the destination system (this class).
Originator identifies the system that originated the end response. This is typically the same as Creator and holds the remote system's SFID.
Creator is the SFID of the remote system.
Direction specifies whether the end response is being received or sent. Possible values are:
0 | Received |
1 | Sent |
FileHash is populated if the OFTP Version is 2.0 and a signed receipt was originally requested. FileHash may also be specified with the expected value in the case where an asynchronous EndResponse is received. The expected value may be obtained from the EndTransfer event when initially sending the file.
Signature is only applicable when the OFTP version is 2.0 and the application is acting as a routing application where the end response will be forwarded on to another entity. In this case Signature will be populated if the end response is signed. This should be stored and supplied when forwarding the response with the SendEndResponse method.
ReasonCode and ReasonText identify the error if a Negative End Response (NERP) was received. A value of 0 indicates there was no an error and the response is an End-To-End Response (EERP). Common values are:
ReasonCode | ReasonText |
3 | User Code Not Known |
4 | Invalid Password |
9 | Unspecified Reason |
11 | Invalid FileName |
12 | Invalid Destination |
13 | Invalid Origin |
14 | Invalid Storage Record Format |
15 | Maximum Record Length Not Supported |
16 | File Size Too Big |
20 | Invalid Record Count |
21 | Invalid Byte Count |
22 | Access Method Failure |
23 | Duplicate File |
24 | File Direction Refused |
25 | Cipher Suite Not Supported |
26 | Encrypted File Not Allowed |
27 | Unencrypted File Not Allowed |
28 | Compression Not Allowed |
29 | Signed File Not Allowed |
30 | Unsigned File Not Allowed |
31 | File Signature Not Valid |
32 | File Decompression Failed |
33 | File Decryption Failed |
34 | File Processing Failed |
35 | Not Delivered To Recipient |
36 | Not Acknowledged By Recipient |
50 | Transmission Stopped By The Operator |
90 | File Size Incompatible With Recipient's Protocol Version |
99 | Unspecified Reason |
OFTPClient.EndTransfer Event
Fired when a file finishes transferring.
Syntax
oftpclient.on('EndTransfer', listener: (e: {readonly direction: number, readonly localFile: string, readonly virtualFileName: string, readonly virtualFileDate: string, readonly destination: string, readonly originator: string, readonly reasonCode: number, readonly reasonText: string, readonly fileSize: number, readonly fileHash: string, sendEndResponse: boolean}) => void )
Remarks
The EndTransfer event is fired when a file is sent or received by the class.
The FileSize parameter gives the size of the file that was sent or received.
The Direction parameter shows whether the client or the server is sending the data.
0 (Client) | The file originated from the client. |
1 (Server) | The file originated from the server. |
VirtualFileName holds the filename.
VirtualFileDate holds the date associated with the file in the format specified by VirtualFileDateFormat. The default value is "MM/dd/yyyy HH:mm:ss".
Originator identifies the sender (SFID) code in the send file request.
Destination identifies the receiver (SFID) code in the send file request.
SendEndResponse indicates whether the EERP/NERP for this request should be sent synchronously or asynchronously. When this parameter is True (default) the class will automatically respond with an EERP/NERP synchronously. To respond asynchronously set this parameter to False. You may then use the SendEndResponse method to send the response at a later time. See SendEndResponse for more details. Note: VirtualFileDateFormat must be set to a format that includes the necessary level of accuracy.
FileHash holds the hash of the file being transmitted. This is only applicable when the OFTP version is 2.0 and the sender requested a signed receipt. When receiving files this value should be saved if you wish to respond asynchronously using SendEndResponse. See SendEndResponse for more details.
LocalFile holds the full path to the file that will be written.
ReasonCode and ReasonText identify the error if a Negative End Response (NERP) was received. A value of 0 indicates there was no an error and the response is an End-To-End Response (EERP). Common values are:
ReasonCode | ReasonText |
3 | User Code Not Known |
4 | Invalid Password |
9 | Unspecified Reason |
11 | Invalid FileName |
12 | Invalid Destination |
13 | Invalid Origin |
14 | Invalid Storage Record Format |
15 | Maximum Record Length Not Supported |
16 | File Size Too Big |
20 | Invalid Record Count |
21 | Invalid Byte Count |
22 | Access Method Failure |
23 | Duplicate File |
24 | File Direction Refused |
25 | Cipher Suite Not Supported |
26 | Encrypted File Not Allowed |
27 | Unencrypted File Not Allowed |
28 | Compression Not Allowed |
29 | Signed File Not Allowed |
30 | Unsigned File Not Allowed |
31 | File Signature Not Valid |
32 | File Decompression Failed |
33 | File Decryption Failed |
34 | File Processing Failed |
35 | Not Delivered To Recipient |
36 | Not Acknowledged By Recipient |
50 | Transmission Stopped By The Operator |
90 | File Size Incompatible With Recipient's Protocol Version |
99 | Unspecified Reason |
OFTPClient.Error Event
Fired when information is available about errors during data delivery.
Syntax
oftpclient.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.
OFTPClient.Log Event
Fires once for each log message.
Syntax
oftpclient.on('Log', listener: (e: {readonly logLevel: number, readonly message: string, readonly logType: string}) => void )
Remarks
This event fires once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.
LogLevel indicates the level of message. Possible values are:
0 (None) | No messages are logged. |
1 (Info - Default) | Informational events such as OFTP commands which are sent and received. |
2 (Verbose) | Detailed data such as individual packet information is logged. |
3 (Debug) | Debug data including all relevant sent and received bytes are logged. |
Message is the log entry.
LogType identifies the type of log entry. Possible values are:
- "Info"
- "OFTP"
OFTPClient.PITrail Event
Fired when any protocol level communication occurs.
Syntax
oftpclient.on('PITrail', listener: (e: {readonly direction: number, readonly data: string, readonly dataB: Uint8Array, readonly commandId: number, readonly commandDescription: string}) => void )
Remarks
This event provides information about the protocol level communication between the client and server.
The Direction parameter specifies who sent the command.
0 (Client) | The command originated from the connected client. |
1 (Server) | The command originated from the server. |
The CommandId and CommandDescription parameters specify which command was sent. The table below shows possible values.
CommandId | CommandDescription |
50 | SFPA (Start File Positive Answer) |
51 | SFNA (Start File Negative Answer) |
52 | EFPA (End File Positive Answer) |
53 | EFNA (End File Negative Answer) |
65 | AUCH (Authentication Challenge) |
67 | CDT (Set Credit) |
68 | DATA (Data Exchange Buffer) |
69 | EERP (End to End Response) |
70 | ESID (End Session) |
72 | SFID (Start File) |
73 | SSRM (Start Session Ready Message) |
74 | SECD (Security Change Direction) |
78 | NERP (Negative End Response) |
80 | RTR (Ready To Receive) |
82 | CD (Change Direction) |
83 | AURP (Authentication Response) |
84 | EFID (End File) |
88 | SSID (Start Session) |
The Data parameter contains the raw OFTP packet.
OFTPClient.SSLServerAuthentication Event
Fired after the server presents its certificate to the client.
Syntax
oftpclient.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.
OFTPClient.SSLStatus Event
Fired when secure connection progress messages are available.
Syntax
oftpclient.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.
OFTPClient.StartTransfer Event
Fired when a document starts transferring.
Syntax
oftpclient.on('StartTransfer', listener: (e: {readonly direction: number, localFile: string, readonly virtualFileName: string, readonly virtualFileDate: string, readonly destination: string, readonly originator: string}) => void )
Remarks
This event fires when a file transfer begins.
Direction specifies if the client or server sent the file.
0 (Client) | The file originated from the client. |
1 (Server) | The file originated from the server. |
VirtualFileName holds the filename.
VirtualFileDate holds the date associated with the file in the format "MM/dd/yyyy HH:mm:ss".
Originator identifies the sender (SFID) code in the send file request.
Destination identifies the receiver (SFID) code in the send file request.
LocalFile holds the full path to the file that will be written.
OFTPClient.Transfer Event
Fired while a document transfers (delivers document).
Syntax
oftpclient.on('Transfer', listener: (e: {readonly direction: number, readonly localFile: string, readonly virtualFileName: string, readonly virtualFileDate: string, readonly destination: string, readonly originator: string, readonly bytesTransferred: number, readonly text: string, readonly textB: Uint8Array}) => void )
Remarks
The Text parameter contains the portion of the document text being retrieved. It is empty if data is being posted to the server.
The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text.
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
VirtualFileName holds the filename.
VirtualFileDate holds the date associated with the file in the format specified by VirtualFileDateFormat. The default value is "MM/dd/yyyy HH:mm:ss".
Originator identifies the sender (SFID) code in the send file request.
Destination identifies the receiver (SFID) code in the send file request.
LocalFile holds the full path to the file that will be written.
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
EffectiveDate
string (read-only)
Default Value: ""
This is the date on which this certificate becomes valid. Before this date, it is not valid. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
Encoded
string
Default Value: ""
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The and properties also may be used to specify a certificate.
When is set, a search is initiated in the current for the private key of the certificate. If the key is found, is updated to reflect the full subject of the selected certificate; otherwise, is set to an empty string.
EncodedB
Uint8Array
Default Value: ""
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The and properties also may be used to specify a certificate.
When is set, a search is initiated in the current for the private key of the certificate. If the key is found, is updated to reflect the full subject of the selected certificate; otherwise, is set to an empty string.
ExpirationDate
string (read-only)
Default Value: ""
This is the date the certificate expires. After this date, the certificate will no longer be valid. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
ExtendedKeyUsage
string
Default Value: ""
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
Fingerprint
string (read-only)
Default Value: ""
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
FingerprintSHA1
string (read-only)
Default Value: ""
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
FingerprintSHA256
string (read-only)
Default Value: ""
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
Issuer
string (read-only)
Default Value: ""
This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
KeyPassword
string
Default Value: ""
This is the password for the certificate's private key (if any).
Some certificate stores may individually protect certificates' private keys, separate from the standard protection offered by the . . This field can be used to read such password-protected private keys.
Note: this property defaults to the value of . To clear it, you must set the property to the empty string (""). It can be set at any time, but when the private key's password is different from the store's password, then it must be set before calling .
PrivateKey
string (read-only)
Default Value: ""
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The may be available but not exportable. In this case, returns an empty string.
PrivateKeyAvailable
boolean (read-only)
Default Value: False
This property shows whether a is available for the selected certificate. If is True, the certificate may be used for authentication purposes (e.g., server authentication).
PrivateKeyContainer
string (read-only)
Default Value: ""
This is the name of the container for the certificate (if available). This functionality is available only on Windows platforms.
PublicKey
string (read-only)
Default Value: ""
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
PublicKeyAlgorithm
string
Default Value: ""
This property contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
PublicKeyLength
number (read-only)
Default Value: 0
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
SerialNumber
string (read-only)
Default Value: ""
This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
SignatureAlgorithm
string (read-only)
Default Value: ""
The property contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
Store
string
Default Value: "MY"
This is the name of the certificate store for the client certificate.
The property denotes the type of the certificate store specified by . If the store is password protected, specify the password in .
is used in conjunction with the property to specify client certificates. If has a value, and or is set, a search for a certificate is initiated. Please see the property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
StoreB
Uint8Array
Default Value: "MY"
This is the name of the certificate store for the client certificate.
The property denotes the type of the certificate store specified by . If the store is password protected, specify the password in .
is used in conjunction with the property to specify client certificates. If has a value, and or is set, a search for a certificate is initiated. Please see the property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
StorePassword
string
Default Value: ""
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
StoreType
CertStoreTypes
Default Value: 0
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the and set to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
Subject
string
Default Value: ""
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
SubjectAltNames
string (read-only)
Default Value: ""
This property contains comma-separated lists of alternative subject names for the certificate.
ThumbprintMD5
string (read-only)
Default Value: ""
This property contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
ThumbprintSHA1
string (read-only)
Default Value: ""
This property contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
ThumbprintSHA256
string (read-only)
Default Value: ""
This property contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
Usage
string
Default Value: ""
This property contains the text description of .
This value will be of one or more of the following strings and will be separated by commas:
- Digital Signatures
- Key Authentication
- Key Encryption
- Data Encryption
- Key Agreement
- Certificate Signing
- Key Signing
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
UsageFlags
number
Default Value: 0
This property contains the flags that show intended use for the certificate. The value of is a combination of the following flags:
0x80 | Digital Signatures |
0x40 | Key Authentication (Non-Repudiation) |
0x20 | Key Encryption |
0x10 | Data Encryption |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | Key Signing |
Please see the property for a text representation of .
This functionality currently is not available when the provider is OpenSSL.
Version
string (read-only)
Default Value: ""
This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
Constructors
public Certificate();
Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.
public Certificate(String certificateFile);
Opens CertificateFile and reads out the contents as an X.509 public key.
public Certificate(byte[] certificateData);
Parses CertificateData as an X.509 public key.
public Certificate(int certStoreType, String store, String storePassword, String subject);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).
public Certificate(int certStoreType, String store, String storePassword, String subject, String configurationString);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).
public Certificate(int certStoreType, String store, String storePassword, byte[] encoded);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.
public Certificate(int certStoreType, byte[] storeBlob, String storePassword, String subject);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).
public Certificate(int certStoreType, byte[] storeBlob, String storePassword, String subject, String configurationString);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).
public Certificate(int certStoreType, byte[] storeBlob, String storePassword, byte[] encoded);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.
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
AutoDetect
boolean
Default Value: False
This property tells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallType
FirewallTypes
Default Value: 0
This property determines the type of firewall to connect through. The applicable values are as follows:
Host
string
Default Value: ""
This property contains the name or IP address of firewall (optional). If a is given, the requested connections will be authenticated through the specified firewall when connecting.
If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class .
Password
string
Default Value: ""
This property contains a password if authentication is to be used when connecting through the firewall. If is specified, the and properties are used to connect and authenticate to the given firewall. If the authentication fails, the class .
Port
number
Default Value: 0
This property contains the transmission control protocol (TCP) port for the firewall . See the description of the property for details.
Note: This property is set automatically when is set to a valid value. See the description of the property for details.
User
string
Default Value: ""
This property contains a user name if authentication is to be used connecting through a firewall. If the is specified, this property and properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class .
Constructors
public Firewall();
Config Settings (class ipworksedi.oftpclient)
The class accepts one or more of the following configuration settings. Configuration 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.OFTPClient Config Settings
When set to False (default) the component will send a value indicating the server should not retry the send operation.
component.Config("CertificateType=3");
component.Certificate = mySigningCertificate;
Possible values are:
0 (default) | All Operations |
1 | Session Authentication |
2 | Decryption |
3 | Signing |
4 | Receipt Signing |
0 | Both (Default) |
1 | Send Only |
2 | Receive Only |
When this is set to True (default) and there is an error during processing the original unprocessed file will be deleted and no files will be placed in DownloadDirectory.
When set to True, if the server's OFTP version does not match the client's Version, the class . When set to False (default), if the server's OFTP version does not match the client's Version, the class will use the lowest mutually supported version.
For a list of possible values please see CertificateStoreType. Also see ExchangeCertSubject.
0 | sha1 |
1 | sha256 (Default) |
2 | sha512 |
0 (default) | Never follow redirects. An exception will be thrown. |
1 | Always follow redirects. The redirect will be automatically followed. |
2 | Follow same scheme redirects. Follow the redirect if it matches the same scheme (http:// or https://). |
0 (None) | No messages are logged. |
1 (Info - Default) | Informational events such as OFTP commands which are sent and received. |
2 (Verbose) | Detailed data such as individual packet information is logged. |
3 (Debug) | Debug data including all relevant sent and received bytes are logged. |
0 | sha1 (Default) |
1 | sha256 |
2 | sha512 |
0 | 3DES (Triple Data Encryption Standard). |
1 | AES (Advanced Encryption Standard with key length of 128). |
- %VirtualFileName%
- %VirtualFileDate%
- %Originator%
- %Destination%
- %UserData%
- %CurrentTime%
- %GUID%
The '%VirtualFileDate%' macro also supports date formatting through the use of an optional DateTime format string. The format of the macro with the date format string included is:
- %VirtualFileDate:CustomFormat%
- %VirtualFileName%
- %VirtualFileDate%
- %Originator%
- %Destination%
- %UserData%
- %CurrentTime%
- %GUID%
The '%VirtualFileDate%' macro also supports date formatting through the use of an optional DateTime format string. The format of the macro with the date format string included is:
- %VirtualFileDate:CustomFormat%
- %VirtualFileName%
- %VirtualFileDate%
- %Originator%
- %Destination%
- %UserData%
- %CurrentTime%
- %GUID%
The '%VirtualFileDate%' macro also supports date formatting through the use of an optional DateTime format string. The format of the macro with the date format string included is:
- %VirtualFileDate:CustomFormat%
- %VirtualFileName%
- %VirtualFileDate%
- %Originator%
- %Destination%
- %UserData%
- %CurrentTime%
- %GUID%
The '%VirtualFileDate%' macro also supports date formatting through the use of an optional DateTime format string. The format of the macro with the date format string included is:
- %VirtualFileDate:CustomFormat%
component.Config("RecipientCertificateType=3");
component.RecipientCert = mySignatureVerificationCertificate;
Possible values are:
0 (default) | All Operations |
1 | Session Authentication |
2 | Encryption |
3 | Signature Verification |
4 | Receipt Signature Verification |
When set to True, this overrides the default behavior and will always send a CD command regardless of whether the indicator is set in the EFPA.
This should only be set if there is a specific reason to do so. In most cases it is not necessary.
- Compress is true
- VirtualFileSecurityLevel is set to slEncrypted
- VirtualFileSecurityLevel is set to slSigned
- VirtualFileSecurityLevel is set to slEncryptedAndSigned
Note that VirtualFileSecurityLevel is only applicable when Version is set to oftpVer20.
When using OFTP v2.0 If the class is configured to respond to EERP and NERP messages asynchronously this should be set to the value "yyyyMMddHHmmssffff" or a similar format that includes the same level of accuracy. This is required to ensure that when calling SendEndResponse the value saved from within the EndTransfer event has the necessary data when sending a response.
Base Config Settings
The following is a list of valid code page identifiers:
Identifier | Name |
037 | IBM EBCDIC - U.S./Canada |
437 | OEM - United States |
500 | IBM EBCDIC - International |
708 | Arabic - ASMO 708 |
709 | Arabic - ASMO 449+, BCON V4 |
710 | Arabic - Transparent Arabic |
720 | Arabic - Transparent ASMO |
737 | OEM - Greek (formerly 437G) |
775 | OEM - Baltic |
850 | OEM - Multilingual Latin I |
852 | OEM - Latin II |
855 | OEM - Cyrillic (primarily Russian) |
857 | OEM - Turkish |
858 | OEM - Multilingual Latin I + Euro symbol |
860 | OEM - Portuguese |
861 | OEM - Icelandic |
862 | OEM - Hebrew |
863 | OEM - Canadian-French |
864 | OEM - Arabic |
865 | OEM - Nordic |
866 | OEM - Russian |
869 | OEM - Modern Greek |
870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
875 | IBM EBCDIC - Modern Greek |
932 | ANSI/OEM - Japanese, Shift-JIS |
936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
949 | ANSI/OEM - Korean (Unified Hangul Code) |
950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
1026 | IBM EBCDIC - Turkish (Latin-5) |
1047 | IBM EBCDIC - Latin 1/Open System |
1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
1147 | IBM EBCDIC - France (20297 + Euro symbol) |
1148 | IBM EBCDIC - International (500 + Euro symbol) |
1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
1201 | Unicode UCS-2 Big-Endian |
1250 | ANSI - Central European |
1251 | ANSI - Cyrillic |
1252 | ANSI - Latin I |
1253 | ANSI - Greek |
1254 | ANSI - Turkish |
1255 | ANSI - Hebrew |
1256 | ANSI - Arabic |
1257 | ANSI - Baltic |
1258 | ANSI/OEM - Vietnamese |
1361 | Korean (Johab) |
10000 | MAC - Roman |
10001 | MAC - Japanese |
10002 | MAC - Traditional Chinese (Big5) |
10003 | MAC - Korean |
10004 | MAC - Arabic |
10005 | MAC - Hebrew |
10006 | MAC - Greek I |
10007 | MAC - Cyrillic |
10008 | MAC - Simplified Chinese (GB 2312) |
10010 | MAC - Romania |
10017 | MAC - Ukraine |
10021 | MAC - Thai |
10029 | MAC - Latin II |
10079 | MAC - Icelandic |
10081 | MAC - Turkish |
10082 | MAC - Croatia |
12000 | Unicode UCS-4 Little-Endian |
12001 | Unicode UCS-4 Big-Endian |
20000 | CNS - Taiwan |
20001 | TCA - Taiwan |
20002 | Eten - Taiwan |
20003 | IBM5550 - Taiwan |
20004 | TeleText - Taiwan |
20005 | Wang - Taiwan |
20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
20106 | IA5 German (7-bit) |
20107 | IA5 Swedish (7-bit) |
20108 | IA5 Norwegian (7-bit) |
20127 | US-ASCII (7-bit) |
20261 | T.61 |
20269 | ISO 6937 Non-Spacing Accent |
20273 | IBM EBCDIC - Germany |
20277 | IBM EBCDIC - Denmark/Norway |
20278 | IBM EBCDIC - Finland/Sweden |
20280 | IBM EBCDIC - Italy |
20284 | IBM EBCDIC - Latin America/Spain |
20285 | IBM EBCDIC - United Kingdom |
20290 | IBM EBCDIC - Japanese Katakana Extended |
20297 | IBM EBCDIC - France |
20420 | IBM EBCDIC - Arabic |
20423 | IBM EBCDIC - Greek |
20424 | IBM EBCDIC - Hebrew |
20833 | IBM EBCDIC - Korean Extended |
20838 | IBM EBCDIC - Thai |
20866 | Russian - KOI8-R |
20871 | IBM EBCDIC - Icelandic |
20880 | IBM EBCDIC - Cyrillic (Russian) |
20905 | IBM EBCDIC - Turkish |
20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
20932 | JIS X 0208-1990 & 0121-1990 |
20936 | Simplified Chinese (GB2312) |
21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
21027 | Extended Alpha Lowercase |
21866 | Ukrainian (KOI8-U) |
28591 | ISO 8859-1 Latin I |
28592 | ISO 8859-2 Central Europe |
28593 | ISO 8859-3 Latin 3 |
28594 | ISO 8859-4 Baltic |
28595 | ISO 8859-5 Cyrillic |
28596 | ISO 8859-6 Arabic |
28597 | ISO 8859-7 Greek |
28598 | ISO 8859-8 Hebrew |
28599 | ISO 8859-9 Latin 5 |
28605 | ISO 8859-15 Latin 9 |
29001 | Europa 3 |
38598 | ISO 8859-8 Hebrew |
50220 | ISO 2022 Japanese with no halfwidth Katakana |
50221 | ISO 2022 Japanese with halfwidth Katakana |
50222 | ISO 2022 Japanese JIS X 0201-1989 |
50225 | ISO 2022 Korean |
50227 | ISO 2022 Simplified Chinese |
50229 | ISO 2022 Traditional Chinese |
50930 | Japanese (Katakana) Extended |
50931 | US/Canada and Japanese |
50933 | Korean Extended and Korean |
50935 | Simplified Chinese Extended and Simplified Chinese |
50936 | Simplified Chinese |
50937 | US/Canada and Traditional Chinese |
50939 | Japanese (Latin) Extended and Japanese |
51932 | EUC - Japanese |
51936 | EUC - Simplified Chinese |
51949 | EUC - Korean |
51950 | EUC - Traditional Chinese |
52936 | HZ-GB2312 Simplified Chinese |
54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
57002 | ISCII Devanagari |
57003 | ISCII Bengali |
57004 | ISCII Tamil |
57005 | ISCII Telugu |
57006 | ISCII Assamese |
57007 | ISCII Oriya |
57008 | ISCII Kannada |
57009 | ISCII Malayalam |
57010 | ISCII Gujarati |
57011 | ISCII Punjabi |
65000 | Unicode UTF-7 |
65001 | Unicode UTF-8 |
Identifier | Name |
1 | ASCII |
2 | NEXTSTEP |
3 | JapaneseEUC |
4 | UTF8 |
5 | ISOLatin1 |
6 | Symbol |
7 | NonLossyASCII |
8 | ShiftJIS |
9 | ISOLatin2 |
10 | Unicode |
11 | WindowsCP1251 |
12 | WindowsCP1252 |
13 | WindowsCP1253 |
14 | WindowsCP1254 |
15 | WindowsCP1250 |
21 | ISO2022JP |
30 | MacOSRoman |
10 | UTF16String |
0x90000100 | UTF16BigEndian |
0x94000100 | UTF16LittleEndian |
0x8c000100 | UTF32String |
0x98000100 | UTF32BigEndian |
0x9c000100 | UTF32LittleEndian |
65536 | Proprietary |
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.
This setting is set to false by default on all platforms.
Trappable Errors (class ipworksedi.oftpclient)
OFTPClient Errors
671 OFTP protocol error. | |
672 Server supplied an invalid SSID code. | |
673 Server supplied an invalid SFID code. | |
674 Server supplied an invalid password. | |
675 Server returned an invalid client SSID code. | |
676 Server returned an invalid client SFID code. | |
677 Server returned an invalid client password. | |
678 "Error building packet to send." | |
679 Error reading files specified. | |
680 Invalid date timestamp. | |
681 Local file exists and overwrite is set to false. | |
682 Invalid hash value. | |
683 Invalid signature. | |
684 Cryptographic operation failed. | |
685 No encryption certificate was specified. | |
686 No signing certificate was specified. | |
687 Send failed. Check the description for more details. | |
688 The requested feature is only supported in OFTP Version 2.0. Check the description for more details. | |
689 A required certificate was not provided. The error descriptions indicates which property must be set. | |
690 Invalid Certificate. | |
691 Failed to import trusted certificates. |
TCPClient Errors
100 You cannot change the RemotePort at this time. A connection is in progress. | |
101 You cannot change the RemoteHost (Server) at this time. A connection is in progress. | |
102 The RemoteHost address is invalid (0.0.0.0). | |
104 Already connected. If you want to reconnect, close the current connection first. | |
106 You cannot change the LocalPort at this time. A connection is in progress. | |
107 You cannot change the LocalHost at this time. A connection is in progress. | |
112 You cannot change MaxLineLength at this time. A connection is in progress. | |
116 RemotePort cannot be zero. Please specify a valid service port number. | |
117 You cannot change the UseConnection option while the class is active. | |
135 Operation would block. | |
201 Timeout. | |
211 Action impossible in control's present state. | |
212 Action impossible while not connected. | |
213 Action impossible while listening. | |
301 Timeout. | |
302 Could not open file. | |
434 Unable to convert string to selected CodePage. | |
1105 Already connecting. If you want to reconnect, close the current connection first. | |
1117 You need to connect first. | |
1119 You cannot change the LocalHost at this time. A connection is in progress. | |
1120 Connection dropped by remote host. |
TCP/IP Errors
10004 [10004] Interrupted system call. | |
10009 [10009] Bad file number. | |
10013 [10013] Access denied. | |
10014 [10014] Bad address. | |
10022 [10022] Invalid argument. | |
10024 [10024] Too many open files. | |
10035 [10035] Operation would block. | |
10036 [10036] Operation now in progress. | |
10037 [10037] Operation already in progress. | |
10038 [10038] Socket operation on non-socket. | |
10039 [10039] Destination address required. | |
10040 [10040] Message too long. | |
10041 [10041] Protocol wrong type for socket. | |
10042 [10042] Bad protocol option. | |
10043 [10043] Protocol not supported. | |
10044 [10044] Socket type not supported. | |
10045 [10045] Operation not supported on socket. | |
10046 [10046] Protocol family not supported. | |
10047 [10047] Address family not supported by protocol family. | |
10048 [10048] Address already in use. | |
10049 [10049] Can't assign requested address. | |
10050 [10050] Network is down. | |
10051 [10051] Network is unreachable. | |
10052 [10052] Net dropped connection or reset. | |
10053 [10053] Software caused connection abort. | |
10054 [10054] Connection reset by peer. | |
10055 [10055] No buffer space available. | |
10056 [10056] Socket is already connected. | |
10057 [10057] Socket is not connected. | |
10058 [10058] Can't send after socket shutdown. | |
10059 [10059] Too many references, can't splice. | |
10060 [10060] Connection timed out. | |
10061 [10061] Connection refused. | |
10062 [10062] Too many levels of symbolic links. | |
10063 [10063] File name too long. | |
10064 [10064] Host is down. | |
10065 [10065] No route to host. | |
10066 [10066] Directory not empty | |
10067 [10067] Too many processes. | |
10068 [10068] Too many users. | |
10069 [10069] Disc Quota Exceeded. | |
10070 [10070] Stale NFS file handle. | |
10071 [10071] Too many levels of remote in path. | |
10091 [10091] Network subsystem is unavailable. | |
10092 [10092] WINSOCK DLL Version out of range. | |
10093 [10093] Winsock not loaded yet. | |
11001 [11001] Host not found. | |
11002 [11002] Non-authoritative 'Host not found' (try again or check DNS setup). | |
11003 [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP. | |
11004 [11004] Valid name, no data record (check DNS setup). |