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 Secure Sockets Layer (SSL) negotiation.
Timeout	This property includes the 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	This method 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.
SetDownloadStream	Sets the stream to which the downloaded file is written.
SetUploadStream	Sets the stream to be uploaded 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.
MaskSensitiveData	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.
GUIAvailable	Whether or not a message loop is available for processing events.
LicenseInfo	Information about the current license.
MaskSensitiveData	Whether sensitive data is masked in log messages.
UseDaemonThreads	Whether threads created by the class are daemon threads.
UseFIPSCompliantAPI	Tells the class whether or not to use FIPS certified APIs.
UseInternalSecurityAPI	Whether or not to use the system security libraries or an internal implementation.

Certificate Property (OFTPClient Class)

The current selected certificate.

Syntax

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

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 Encoded 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.

ClientPassword Property (OFTPClient Class)

The client's password.

Syntax

public String getClientPassword();
public void setClientPassword(String clientPassword);

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.

ClientSFIDCode Property (OFTPClient Class)

Client's SFID code.

Syntax

public String getClientSFIDCode();
public void setClientSFIDCode(String clientSFIDCode);

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.

ClientSSIDCode Property (OFTPClient Class)

The client's SSID code.

Syntax

public String getClientSSIDCode();
public void setClientSSIDCode(String clientSSIDCode);

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.

Compress Property (OFTPClient Class)

Whether or not to compress the outgoing file.

Syntax

public boolean isCompress();
public void setCompress(boolean compress);

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.

Connected Property (OFTPClient Class)

Shows whether the class is connected.

Syntax

public boolean isConnected();

Default Value

False

Remarks

Use this property to determine whether the class is connected to the remote host or not.

Use the Connect and Disconnect methods to manage the connection.

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

DownloadDirectory Property (OFTPClient Class)

Download directory.

Syntax

public String getDownloadDirectory();
public void setDownloadDirectory(String downloadDirectory);

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.

EncryptionAlgorithm Property (OFTPClient Class)

The encryption algorithm.

Syntax

public int getEncryptionAlgorithm();
public void setEncryptionAlgorithm(int encryptionAlgorithm);

Enumerated values:
  public final static int encra3DES = 0;
  public final static int encraAES = 1;

Default Value

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.

Firewall Property (OFTPClient Class)

A set of properties related to firewall access.

Syntax

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

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.

LocalHost Property (OFTPClient Class)

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

Syntax

public String getLocalHost();
public void setLocalHost(String localHost);

Default Value

Remarks

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

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

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

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

MaxRecordSize Property (OFTPClient Class)

The maximum length of a given record.

Syntax

public int getMaxRecordSize();
public void setMaxRecordSize(int maxRecordSize);

Default Value

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.

Overwrite Property (OFTPClient Class)

Whether or not the class should overwrite files during transfer.

Syntax

public boolean isOverwrite();
public void setOverwrite(boolean overwrite);

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.

RecipientCert Property (OFTPClient Class)

The recipient certificate of the message.

Syntax

public Certificate getRecipientCert();
public void setRecipientCert(Certificate recipientCert);

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 Encoded field to the encoded certificate. To select a certificate, use the Store and Subject fields.

This property is not available at design time.

Please refer to the Certificate type for a complete list of fields.

RemoteHost Property (OFTPClient Class)

The domain name or IP address of the OFTP server.

Syntax

public String getRemoteHost();
public void setRemoteHost(String remoteHost);

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.

RemotePort Property (OFTPClient Class)

The port for the OFTP service (default is 3305).

Syntax

public int getRemotePort();
public void setRemotePort(int remotePort);

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.

SecureAuthentication Property (OFTPClient Class)

Whether or not the class should perform secure Odette authentication.

Syntax

public boolean isSecureAuthentication();
public void setSecureAuthentication(boolean secureAuthentication);

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.

ServerPassword Property (OFTPClient Class)

The server's password.

Syntax

public String getServerPassword();
public void setServerPassword(String serverPassword);

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.

ServerSFIDCode Property (OFTPClient Class)

Server's SFID code.

Syntax

public String getServerSFIDCode();
public void setServerSFIDCode(String serverSFIDCode);

Default Value

Remarks

ServerSSIDCode Property (OFTPClient Class)

The server's SSID code.

Syntax

public String getServerSSIDCode();
public void setServerSSIDCode(String serverSSIDCode);

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.

SignedReceipt Property (OFTPClient Class)

Whether or not to require signed receipts.

Syntax

public boolean isSignedReceipt();
public void setSignedReceipt(boolean signedReceipt);

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.

SSLAcceptServerCert Property (OFTPClient Class)

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

Syntax

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

Remarks

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

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

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

Please refer to the Certificate type for a complete list of fields.

SSLCert Property (OFTPClient Class)

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

Syntax

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

Remarks

This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded 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.

Timeout Property (OFTPClient Class)

This property includes the timeout for the class.

Syntax

public int getTimeout();
public void setTimeout(int timeout);

Default Value

Remarks

This property defines the timeout when sending data. When SSLEnabled is False a value of 0 means data will be sent asynchronously and a positive value means data is sent synchronously. When SSLEnabled is True all data is sent synchronously regardless of the Timeout value. Please see the notes below for details.

Plaintext

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.

SSL

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

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

Additional Notes

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 throws an exception.

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

The default value for the Timeout property is 60 seconds.

TrustedCerts Property (OFTPClient Class)

A collection of trusted CA certificates.

Syntax

public CertificateList getTrustedCerts();
public void setTrustedCerts(CertificateList trustedCerts);

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.

This property is not available at design time.

Please refer to the Certificate type for a complete list of fields.

UseSSL Property (OFTPClient Class)

Use SSL to access the RemoteHost .

Syntax

public boolean isUseSSL();
public void setUseSSL(boolean useSSL);

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.

Version Property (OFTPClient Class)

Which version of the OFTP protocol the class is using.

Syntax

public int getVersion();
public void setVersion(int version);

Enumerated values:
  public final static int oftpVer12 = 0;
  public final static int oftpVer13 = 1;
  public final static int oftpVer14 = 2;
  public final static int oftpVer20 = 3;

Default Value

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

The default value is oftpVer20 (Version 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:

UseSSL
SecureAuthentication
VirtualFileSecurityLevel
Compress

VirtualFileDate Property (OFTPClient Class)

The date/time stamp for the virtual file.

Syntax

public String getVirtualFileDate();
public void setVirtualFileDate(String virtualFileDate);

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

VirtualFileFormat Property (OFTPClient Class)

The structure of the outgoing file.

Syntax

public int getVirtualFileFormat();
public void setVirtualFileFormat(int virtualFileFormat);

Enumerated values:
  public final static int ffUnstructured = 0;
  public final static int ffText = 1;
  public final static int ffFixed = 2;
  public final static int ffVariable = 3;

Default Value

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.

VirtualFileSecurityLevel Property (OFTPClient Class)

The level of security for the file.

Syntax

public int getVirtualFileSecurityLevel();
public void setVirtualFileSecurityLevel(int virtualFileSecurityLevel);

Enumerated values:
  public final static int slNone = 0;
  public final static int slEncrypted = 1;
  public final static int slSigned = 2;
  public final static int slEncryptedAndSigned = 3;

Default Value

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.

ChangeDirection Method (OFTPClient Class)

Sends a Change Direction (CD) command.

Syntax

public void changeDirection();

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.

Config Method (OFTPClient Class)

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

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.

Connect Method (OFTPClient Class)

This method connects to the FTP server without logging in.

Syntax

public void connect();

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.

Disconnect Method (OFTPClient Class)

This method disconnects from the server without first logging off.

Syntax

public void disconnect();

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.

DoEvents Method (OFTPClient Class)

This method processes events from the internal message queue.

Syntax

public void doEvents();

Remarks

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

ExchangeCertificate Method (OFTPClient Class)

Exchange a certificate with the remote host.

Syntax

public void exchangeCertificate(String certificateStore, int certificateExchangeType);

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.

When the remote host sends a certificate to the class the received certificate will be provided through the CertificateReceived event.

ImportTrustedCerts Method (OFTPClient Class)

Imports a list of trusted CA certificates.

Syntax

public void importTrustedCerts();

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

Interrupt Method (OFTPClient Class)

This method interrupts the current action.

Syntax

public void interrupt();

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.

Logoff Method (OFTPClient Class)

Logoff from the OFTP server.

Syntax

public void logoff();

Remarks

Logoff from the OFTP server. If that fails, the connection is terminated by the local host.

Logon Method (OFTPClient Class)

Logon to the OFTP RemoteHost using the current client credentials.

Syntax

public void logon();

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.

ReceiveFiles Method (OFTPClient Class)

Receive any files queued to be sent from the server.

Syntax

public void receiveFiles();

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.

Reset Method (OFTPClient Class)

Resets the state of the control.

Syntax

public void reset();

Remarks

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

SendEndResponse Method (OFTPClient Class)

Sends an EERP/NERP asynchronously.

Syntax

public void sendEndResponse(String virtualFileName, String virtualFileDate, String destination, String originator, String creator, int reasonCode, String reasonText, String fileHash, String signature);

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

SendFile Method (OFTPClient Class)

Send the specified file to the server.

Syntax

public void sendFile(String localFile, String virtualFileName);

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.

SetDownloadStream Method (OFTPClient Class)

Sets the stream to which the downloaded file is written.

Syntax

public void setDownloadStream(java.io.OutputStream downloadStream);

Remarks

When set, the file data will be written to the stream when downloaded from the server. The stream should be open and normally set to position 0.

The class will automatically close this stream if CloseStreamAfterTransfer is true (default).

It is recommended to call this method from within the AcceptFile event to ensure each received file is set to the intended stream object.

SetUploadStream Method (OFTPClient Class)

Sets the stream to be uploaded to the server.

Syntax

public void setUploadStream(java.io.InputStream uploadStream);

Remarks

When set, the data will be read from the stream when uploaded to the server. The stream should be open and normally set to position 0.

The class will automatically close this stream if CloseStreamAfterTransfer is true (default). If the stream is closed, you will need to call SetUploadStream again before the next send.

The content of the stream will be read from the current position all the way to the end.

ValidateCert Method (OFTPClient Class)

Validates the certificate with private key.

Syntax

public boolean validateCert();

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.

ValidateRecipientCert Method (OFTPClient Class)

Validates the recipient certificate.

Syntax

public boolean validateRecipientCert();

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.

AcceptFile Event (OFTPClient Class)

Fired when the client receives a file.

Syntax

public class DefaultOFTPClientEventListener implements OFTPClientEventListener {
  ...
  public void acceptFile(OFTPClientAcceptFileEvent e) {}
  ...
}

public class OFTPClientAcceptFileEvent {
  public String virtualFileName;
  public String virtualFileDate;
  public String destination;
  public String originator;
  public boolean accept; //read-write
  public String fileName; //read-write
  public boolean overwrite; //read-write
  public int errorCode; //read-write
  public String errorDescription; //read-write
}

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 DownloadDirectory 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.

CertificateReceived Event (OFTPClient Class)

Fired when a certificate is received from the remote host.

Syntax

public class DefaultOFTPClientEventListener implements OFTPClientEventListener {
  ...
  public void certificateReceived(OFTPClientCertificateReceivedEvent e) {}
  ...
}

public class OFTPClientCertificateReceivedEvent {
  public String certificateFileName;
  public int certificateExchangeType;
}

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.

EndResponse Event (OFTPClient Class)

Fired every time an end response is received from the server.

Syntax

public class DefaultOFTPClientEventListener implements OFTPClientEventListener {
  ...
  public void endResponse(OFTPClientEndResponseEvent e) {}
  ...
}

public class OFTPClientEndResponseEvent {
  public String virtualFileName;
  public String virtualFileDate;
  public String destination;
  public String originator;
  public String creator;
  public int reasonCode;
  public String reasonText;
  public String fileHash; //read-write
  public String signature;
  public int direction;
}

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

By default the class will only fire this event for received end responses. To configure the class to fire the event for both send and received end responses set FireEndResponseOnSend to True.

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

EndTransfer Event (OFTPClient Class)

Fired when a file finishes transferring.

Syntax

public class DefaultOFTPClientEventListener implements OFTPClientEventListener {
  ...
  public void endTransfer(OFTPClientEndTransferEvent e) {}
  ...
}

public class OFTPClientEndTransferEvent {
  public int direction;
  public String localFile;
  public String virtualFileName;
  public String virtualFileDate;
  public String destination;
  public String originator;
  public int reasonCode;
  public String reasonText;
  public long fileSize;
  public String fileHash;
  public boolean sendEndResponse; //read-write
}

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

Error Event (OFTPClient Class)

Fired when information is available about errors during data delivery.

Syntax

public class DefaultOFTPClientEventListener implements OFTPClientEventListener {
  ...
  public void error(OFTPClientErrorEvent e) {}
  ...
}

public class OFTPClientErrorEvent {
  public int errorCode;
  public String description;
}

Remarks

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

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

Log Event (OFTPClient Class)

Fires once for each log message.

Syntax

public class DefaultOFTPClientEventListener implements OFTPClientEventListener {
  ...
  public void log(OFTPClientLogEvent e) {}
  ...
}

public class OFTPClientLogEvent {
  public int logLevel;
  public String message;
  public String logType;
}

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"

PITrail Event (OFTPClient Class)

Fired when any protocol level communication occurs.

Syntax

public class DefaultOFTPClientEventListener implements OFTPClientEventListener {
  ...
  public void PITrail(OFTPClientPITrailEvent e) {}
  ...
}

public class OFTPClientPITrailEvent {
  public int direction;
  public byte[] data;
  public int commandId;
  public String commandDescription;
}

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.

SSLServerAuthentication Event (OFTPClient Class)

Fired after the server presents its certificate to the client.

Syntax

public class DefaultOFTPClientEventListener implements OFTPClientEventListener {
  ...
  public void SSLServerAuthentication(OFTPClientSSLServerAuthenticationEvent e) {}
  ...
}

public class OFTPClientSSLServerAuthenticationEvent {
  public byte[] certEncoded;
  public String certSubject;
  public String certIssuer;
  public String status;
  public boolean accept; //read-write
}

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (OFTPClient Class)

Fired when secure connection progress messages are available.

Syntax

public class DefaultOFTPClientEventListener implements OFTPClientEventListener {
  ...
  public void SSLStatus(OFTPClientSSLStatusEvent e) {}
  ...
}

public class OFTPClientSSLStatusEvent {
  public String message;
}

Remarks

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

StartTransfer Event (OFTPClient Class)

Fired when a document starts transferring.

Syntax

public class DefaultOFTPClientEventListener implements OFTPClientEventListener {
  ...
  public void startTransfer(OFTPClientStartTransferEvent e) {}
  ...
}

public class OFTPClientStartTransferEvent {
  public int direction;
  public String localFile; //read-write
  public String virtualFileName;
  public String virtualFileDate;
  public String destination;
  public String originator;
}

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.

Transfer Event (OFTPClient Class)

Fired while a document transfers (delivers document).

Syntax

public class DefaultOFTPClientEventListener implements OFTPClientEventListener {
  ...
  public void transfer(OFTPClientTransferEvent e) {}
  ...
}

public class OFTPClientTransferEvent {
  public int direction;
  public String localFile;
  public String virtualFileName;
  public String virtualFileDate;
  public String destination;
  public String originator;
  public long bytesTransferred;
  public byte[] text;
}

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.

The following fields are available:

Fields

EffectiveDate
String (read-only)
Default Value: ""

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

ExpirationDate
String (read-only)
Default Value: ""

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

ExtendedKeyUsage
String (read-only)
Default Value: ""

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: ""

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: ""

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: ""

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: ""

The issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate.

KeyPassword
String
Default Value: ""

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 StorePassword. This field can be used to read such password-protected private keys.

Note: This property defaults to the value of StorePassword. 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.

PrivateKey
String (read-only)
Default Value: ""

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The PrivateKey may be available but not exportable. In this case, PrivateKey returns an empty string.

PrivateKeyAvailable
boolean (read-only)
Default Value: False

Whether a PrivateKey is available for the selected certificate. If PrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

PrivateKeyContainer
String (read-only)
Default Value: ""

The name of the PrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

PublicKey
String (read-only)
Default Value: ""

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

PublicKeyAlgorithm
String (read-only)
Default Value: ""

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
int (read-only)
Default Value: 0

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

SerialNumber
String (read-only)
Default Value: ""

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 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"

The name of the certificate store for the client certificate.

The StoreType field denotes the type of the certificate store specified by Store. If the store is password-protected, specify the password in StorePassword.

Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field 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.

In Java, the certificate store normally is a file containing certificates and optional private keys.

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

StoreB
byte[]
Default Value: "MY"

The name of the certificate store for the client certificate.

The StoreType field denotes the type of the certificate store specified by Store. If the store is password-protected, specify the password in StorePassword.

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.

In Java, the certificate store normally is a file containing certificates and optional private keys.

StorePassword
String
Default Value: ""

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

StoreType
int
Default Value: 0

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 field 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 Store and set StorePassword to the PIN. Code Example. SSH Authentication with Security Key: `certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
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.

SubjectAltNames
String (read-only)
Default Value: ""

Comma-separated lists of alternative subject names for the certificate.

ThumbprintMD5
String (read-only)
Default Value: ""

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: ""

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: ""

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 (read-only)
Default Value: ""

The text description of UsageFlags.

This value will be one or more of the following strings and will be separated by commas:

Digital Signature
Non-Repudiation
Key Encipherment
Data Encipherment
Key Agreement
Certificate Signing
CRL Signing
Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

UsageFlags
int (read-only)
Default Value: 0

The flags that show intended use for the certificate. The value of UsageFlags is a combination of the following flags:


0x80	Digital Signature
0x40	Non-Repudiation
0x20	Key Encipherment
0x10	Data Encipherment
0x08	Key Agreement
0x04	Certificate Signing
0x02	CRL Signing
0x01	Encipher Only

Please see the Usage field for a text representation of UsageFlags.

This functionality currently is not available when the provider is OpenSSL.

Version
String (read-only)
Default Value: ""

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

Subject
String
Default Value: ""

The subject of the certificate used for client authentication.

This field will be populated with the full subject of the loaded certificate. When loading a certificate, the subject is used to locate the certificate in the store.

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.

Encoded
String
Default Value: ""

The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.

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

EncodedB
byte[]
Default Value: ""

The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.

Constructors

public Certificate();

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

public Certificate( certificateFile);

Opens CertificateFile and reads out the contents as an X.509 public key.

public Certificate( encoded);

Parses Encoded as an X.509 public key.

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

StoreType identifies the type of certificate store to use. See 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). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

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

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 the 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.

public Certificate( storeType,  store,  storePassword,  encoded);

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( storeType,  store,  storePassword,  subject);

StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a byte array containing the certificate data. StorePassword is the password used to protect the store.

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

public Certificate( storeType,  store,  storePassword,  encoded);

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 Host and the FirewallType.

The following fields are available:

Fields

AutoDetect
boolean
Default Value: False

Whether to automatically detect and use firewall system settings, if available.

Connection information will first be obtained from Java system properties, such as http.proxyHost and https.proxyHost. Java properties may be set in a variety of ways; please consult the Java documentation for information about how firewall and proxy values can be specified.

If no Java system properties define connection information, the class will inspect the Windows registry for connection information that may be present on the system (applicable only on Windows systems).

FirewallType
int
Default Value: 0

The type of firewall to connect through. The applicable values are as follows:


fwNone (0)	No firewall (default setting).
fwTunnel (1)	Connect through a tunneling proxy. Port is set to 80.
fwSOCKS4 (2)	Connect through a SOCKS4 Proxy. Port is set to 1080.
fwSOCKS5 (3)	Connect through a SOCKS5 Proxy. Port is set to 1080.
fwSOCKS4A (10)	Connect through a SOCKS4A Proxy. Port is set to 1080.

Host
String
Default Value: ""

The name or IP address of the firewall (optional). If a Host is given, the requested connections will be authenticated through the specified firewall when connecting.

If this field is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this field is set to the corresponding address. If the search is not successful, the class throws an exception.

Password
String
Default Value: ""

A password if authentication is to be used when connecting through the firewall. If Host is specified, the User and Password fields are used to connect and authenticate to the given firewall. If the authentication fails, the class throws an exception.

Port
int
Default Value: 0

The Transmission Control Protocol (TCP) port for the firewall Host. See the description of the Host field for details.

Note: This field is set automatically when FirewallType is set to a valid value. See the description of the FirewallType field for details.

User
String
Default Value: ""

A username if authentication is to be used when connecting through a firewall. If Host is specified, this field and the Password field are used to connect and authenticate to the given Firewall. If the authentication fails, the class throws an exception.

Constructors

public Firewall();

Config Settings (OFTPClient Class)

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

AcceptAnySFIDCode: Indicates that all SFID codes are acceptable.

This setting controls whether the class checks the SFID codes when receiving files. When set to False (Default) and a file is received the class will check the client and server SFID codes sent by the server against the values specified in ClientSFIDCode and ServerSFIDCode. If they do not match an error is returned. In some situations it is necessary to consider any SFID code valid. To disable checking the SFID codes sent by the server set this to True.

AllowRetry: Whether to send a retry indicator when rejecting a file.

When the server sends a file and it is rejected for any reason, if this setting is set to True the class will send a retry indicator value to the server to specify the file may be retried later.

When set to False (default) the component will send a value indicating the server should not retry the send operation.

CertificateType: Specifies the type of certificate being supplied.

By default the class will use the certificate set in the Certificate property for all operations that require a certificate. This setting allows for different certificates to be set for specific operations. First, specify the CertificateType via this setting and then set the Certificate property. For instance: component.Config("CertificateType=3"); component.Certificate = mySigningCertificate; Possible values are:


0 (default)	All Operations
1	Session Authentication
2	Decryption
3	Signing
4	Receipt Signing

ConnectionType: Specifies the type of connection that will be created.

Use the ConnectionType setting to tell the class which type of connection to create. The default value is 0 (Both) in which the class can both send and receive files. However you can limit the class to only be able to send or receive files by specifying a value of 1 (Send Only) or 2 (Receive Only). Valid values are:


0	Both (Default)
1	Send Only
2	Receive Only

CreditCount: Specifies the credit value.

This setting defines the maximum credit value to be sent in the initial connection (SSID command). The default value is 99 and the maximum value is 999. When connecting, the server will also indicate the value it wishes to use for the credit count. The smaller of the two values will be used. This setting may be queried after connecting to determine the negotiated value.

DeleteOnError: Whether received files are deleted when there is an error during processing.

By default this value is True. When set to False and receiving a file, if the file is encrypted, signed, or compressed the file will be decrypted, verified, or decompressed. If there is an error during processing the original unprocessed file will be placed in DownloadDirectory. In that case you may choose what to do with the file based on the error reported during processing.

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.

DisconnectAfterEndSession: Determines if the connection is closed immediately after ending the session.

By default when Logoff is called the class will close the TCP connection after ending the session (the ESID command is sent). To let the other side close the connection after it has received the end session command (ESID), set this to False.

EnforceProtocolVersion: Requires the server to support the same OFTP version.

This settings controls the behavior when the server's OFTP version is different from the requested version. During the logon process the class will supply its OFTP Version to the server. The server will respond with the OFTP version it is using for the connection. If the version is not the same, the action of the class depends on this setting.

When set to True, if the server's OFTP version does not match the client's Version, the class throws an exception. 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.

ExchangeBufferSize: Specifies the data exchange buffer size in bytes.

This setting defines the data exchange buffer size to be sent in the initial connection (SSID command) in bytes. The default value is 2048. When connecting, the server will also indicate the value it wishes to use for the data exchange buffer size. The smaller of the two values will be used. This setting may be queried after connecting to determine the negotiated value.

ExchangeCertStoreType: Specifies the store type when loading a certificate to be exchanged.

This specifies the certificate store type when loading a certificate that will be sent to the remote party. This is only applicable when calling ExchangeCertificate. The default value is "8" which indicates the certificate will be loaded from a file on disk. When the certificate is not in a .cer format or is located in the Windows certificate store this setting should be set to the appropriate value before calling ExchangeCertificate.

For a list of possible values please see StoreType. Also see ExchangeCertSubject.

ExchangeCertSubject: The subject of the certificate being exchanged.

This specifies the subject of the certificate being exchanged. This will be used to load the appropriate certificate when ExchangeCertificate is called. This is used in conjunction with ExchangeCertStoreType and is only necessary when loading a certificate from a store that may hold more than one certificate (such as a Windows certificate store).

FailOnUntrustedCert: Whether or not to throw an exception when untrusted certificates are used.

When TrustedCerts is populated the class will validate that loaded certificates were issued by a trusted CA in TrustedCerts. This setting controls the behavior when an untrusted certificate is found. By default this value is True and the class will throw an exception. If this is set to False the class will fire the Error event but the error will not be fatal and the operation will be allowed to continue.

FileDescription: Additional description information sent with the file.

When sending a file this setting may be set to specify additional information. There is no restriction on the type of data supplied here. It may be set to a longer filename, or simply additional text data that you wish to pass to the receiver. The data supplied will be UTF-8 encoded by the class. The maximum length is 999 bytes (after UTF-8 encoding).

FileHashAlgorithm: The hash algorithm to use when sending a file.

The file hash algorithm specified in this setting is used to calculate the hash sent along with an outgoing file. Possible values are:


0	sha1
1	sha256 (Default)
2	sha512

FireEndResponseOnSend: Determines if the EndResponse event is fired for outgoing EERP and NERPs.

If set to True (default) the class will fire the EndResponse event for both sent and received end responses. If set to False the EndResponse event will fire only for received (incoming) end responses. The Direction parameter of EndResponse determines if the end response is being sent or received. The default value is True.

FollowRedirects: Determines behavior when importing trusted certificates and a HTTP redirect is returned.

When TrustedCertsData holds a URL and ImportTrustedCerts is called the class makes a HTTP request to obtain the trusted certificates. If the server returns a HTTP redirect this setting specifies how the class will handle it. Possible values are:


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://).

FriendlyLogFormat: Determines if a more friendly format is applied to PITrail event out.

This setting effects the content of the Data parameter of the PITrail event. By default this setting is true and a format designed to be more easily read is used. If set to false the Data parameter will hold the raw unformatted protocol level content.

LogLevel: The level of information to log.

This setting specifies the level of detail that is logged to the Log event. 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.

MaskSensitiveData: Masks passwords in logs.

The default value is True. When set to True, the class will mask passwords that otherwise would appear in its logs.

ReceiptHashAlgorithm: The receipt hash algorithm to request when sending a file.

The receipt hash algorithm specified in this setting is sent to the receiving party when a file is sent, and the receiving party should use this value when calculating the hash returned in the EERP or NERP receipt. Possible values are:


0	sha1 (Default)
1	sha256
2	sha512

ReceivedFileDateTime: The datetime of the file being received.

This setting may be queried to obtain the datetime of the received file.

ReceivedFileDescription: Additional description information received with the file.

Query this setting after receiving a file to obtain any additional information provided by the server. The data will be UTF-8 decoded by the class.

ReceivedFileEncryptionAlg: The encryption algorithm used for the file being received.

This setting may be queried to obtain the encryption algorithm used for encryption of the file being received. The possible values are:


0	3DES (Triple Data Encryption Standard).
1	AES (Advanced Encryption Standard with key length of 128).

ReceivedFileName: Returns the name of the received file.

This setting may be queried inside the EndTransfer event to obtain the name of the received file on disk. This includes the full path to the file on disk.

ReceivedFileNameFormat: The name format of received files.

This setting specifies the format used when determining the local filename of a received file. The use of macros is supported to provide flexibility. This setting may include one or more of the following values:

%VirtualFileName%
%VirtualFileDate%
%Originator%
%Destination%
%UserData%
%CurrentTime%
%GUID%

An example value is "%VirtualFileName%_%VirtualFileDate%_%Destination%". The default value is "%VirtualFileName%".

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%

For example: "%VirtualFileDate:yyyyMMddHHmmssffff%"

The name format of received files.

%VirtualFileName%
%VirtualFileDate%
%Originator%
%Destination%
%UserData%
%CurrentTime%
%GUID%

An example value is "%VirtualFileName%_%VirtualFileDate%_%Destination%". The default value is "%VirtualFileName%".

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%

For example: "%VirtualFileDate:yyyyMMddHHmmssffff%"

ReceivedFileNameFormat: The name format of received files.

%VirtualFileName%
%VirtualFileDate%
%Originator%
%Destination%
%UserData%
%CurrentTime%
%GUID%

An example value is "%VirtualFileName%_%VirtualFileDate%_%Destination%". The default value is "%VirtualFileName%".

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%

For example: "%VirtualFileDate:yyyyMMddHHmmssffff%"

The name format of received files.

%VirtualFileName%
%VirtualFileDate%
%Originator%
%Destination%
%UserData%
%CurrentTime%
%GUID%

An example value is "%VirtualFileName%_%VirtualFileDate%_%Destination%". The default value is "%VirtualFileName%".

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%

For example: "%VirtualFileDate:yyyyMMddHHmmssffff%"

RecipientCertificateType: Specifies the type of recipient certificate being supplied.

By default the class will use the certificate set in the RecipientCert property for all operations that require a certificate. This setting allows for different certificates to be set for specific operations. First, specify the RecipientCertificateType via this setting and then set the RecipientCert property. For instance: 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

Retry: Indicates whether the recipient allows the send to be retried.

When sending files the recipient may reject the file for a number of reasons. The recipient may indicate that the operation can be re-attempted later. Query this setting after a send attempt was rejected to determine if the recipient allows retries. This setting will return either True or False.

SendCDAfterEFPA: Specifies whether a CD is always sent after receiving an EFPA.

When sending a file the recipient will respond with an EFPA once the file is received. Within this response is an indicator which tells the sender whether to issue a CD (Change Direction) command. The indicator is read by the class and a CD command is sent if requested. If a CD is not requested then no CD is sent.

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.

TempPath: The path of a directory where temporary files will be created.

Under certain conditions, the class will create temporary files before processing a file. The location of the temporary files is determined by this setting. Temporary files are created if any of the following conditions are true.

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.

TrustedCertsData: Specifies the source to be used when importing trusted certificates.

When ImportTrustedCerts is called it will attempt to import certificates from the location specified here. By default this is the URL provided by Odette (http://www.odette.org/TSL/TSL_OFTP2.XML). This is the live list of CA certificates hosted by Odette. This may also be set to an absolute file path to load certificates from an offline source, or a string value containing the trusted CA certificates.

VirtualFileDateFormat: The DateTime format of received files.

This setting specifies the DateTime format used by the class when reporting the VirtualFileDate of received files. The default format is "MM/dd/yyyy HH:mm:ss".

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

BuildInfo: Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

GUIAvailable: Whether or not a message loop is available for processing events.

In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The class will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.

In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the class does not attempt to process external events.

LicenseInfo: Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

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.

MaskSensitiveData: Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.

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.

UseDaemonThreads: Whether threads created by the class are daemon threads.

If set to True (default), when the class creates a thread, the thread's Daemon property will be explicitly set to True. When set to False, the class will not set the Daemon property on the created thread. The default value is True.

UseFIPSCompliantAPI: Tells the class whether or not to use FIPS certified APIs.

When set to true, the class will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle Federal Information Processing Standards (FIPS), while all other Windows editions make use of Microsoft security libraries.

The Java edition requires installation of the FIPS-certified Bouncy Castle library regardless of the target operating system. This can be downloaded from https://www.bouncycastle.org/fips-java/. Only the "Provider" library is needed. The jar file should then be installed in a JRE search path.

The following classes must be imported in the application in which the component will be used:

import java.security.Security; import org.bouncycastle.jcajce.provider.BouncyCastleFipsProvider;

The Bouncy Castle provider must be added as a valid provider and must also be configured to operate in FIPS mode:

System.setProperty("org.bouncycastle.fips.approved_only","true"); Security.addProvider(new BouncyCastleFipsProvider());

When UseFIPSCompliantAPI is true, Secure Sockets Layer (SSL)-enabled classes can optionally be configured to use the Transport Layer Security (TLS) Bouncy Castle library. When SSLProvider is set to sslpAutomatic (default) or sslpInternal, an internal TLS implementation is used, but all cryptographic operations are offloaded to the Bouncy Castle FIPS provider to achieve FIPS-compliant operation. If SSLProvider is set to sslpPlatform, the Bouncy Castle JSSE will be used in place of the internal TLS implementation.

To enable the use of the Bouncy Castle JSSE take the following steps in addition to the steps above. Both the Bouncy Castle FIPS provider and the Bouncy Castle JSSE must be configured to use the Bouncy Castle TLS library in FIPS mode. Obtain the Bouncy Castle TLS library from https://www.bouncycastle.org/fips-java/. The jar file should then be installed in a JRE search path.

The following classes must be imported in the application in which the component will be used:

import java.security.Security; import org.bouncycastle.jcajce.provider.BouncyCastleFipsProvider; //required to use BCJSSE when SSLProvider is set to sslpPlatform import org.bouncycastle.jsse.provider.BouncyCastleJsseProvider;

The Bouncy Castle provider must be added as a valid provider and also must be configured to operate in FIPS mode:

System.setProperty("org.bouncycastle.fips.approved_only","true"); Security.addProvider(new BouncyCastleFipsProvider()); //required to use BCJSSE when SSLProvider is set to sslpPlatform Security.addProvider(new BouncyCastleJsseProvider("fips:BCFIPS")); //optional - configure logging level of BCJSSE Logger.getLogger("org.bouncycastle.jsse").setLevel(java.util.logging.Level.OFF); //configure the class to use BCJSSE component.setSSLProvider(1); //platform component.config("UseFIPSCompliantAPI=true"); Note: TLS 1.3 support requires the Bouncy Castle TLS library version 1.0.14 or later.

FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to true. This is a static setting that applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.

For more details, please see the FIPS 140-2 Compliance article.

Note: Enabling FIPS compliance requires a special license; please contact sales@nsoftware.com for details.

UseInternalSecurityAPI: Whether or not to use the system security libraries or an internal implementation.

When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.

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 (OFTPClient Class)

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.
303	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 nonsocket.
10039	[10039] Destination address required.
10040	[10040] Message is too long.
10041	[10041] Protocol wrong type for socket.
10042	[10042] Bad protocol option.
10043	[10043] Protocol is not supported.
10044	[10044] Socket type is not supported.
10045	[10045] Operation is not supported on socket.
10046	[10046] Protocol family is not supported.
10047	[10047] Address family is not supported by protocol family.
10048	[10048] Address already in use.
10049	[10049] Cannot 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] Cannot send after socket shutdown.
10059	[10059] Too many references, cannot splice.
10060	[10060] Connection timed out.
10061	[10061] Connection refused.
10062	[10062] Too many levels of symbolic links.
10063	[10063] File name is too long.
10064	[10064] Host is down.
10065	[10065] No route to host.
10066	[10066] Directory is 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 is not loaded yet.
11001	[11001] Host not found.
11002	[11002] Nonauthoritative 'Host not found' (try again or check DNS setup).
11003	[11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP.
11004	[11004] Valid name, no data record (check DNS setup).