FTPS API

Overview

These public interfaces are used in FTPS components. They are provided for implementing advanced functionality in your scripts. In order for you to use these interfaces in your project, you have to reference CozyRoc.SSISPlus.dll library.

IFtpsClientConnection

When you call FTPS Connection Manager AcquireConnection method, it returns object implementing IFtpsClientConnection interface. This is the interface used for interaction with FTPS Server.

Connect method

Connects to FTPS server. The result is IFtpClient object.

Close method

Closes the connection to a FTPS Server. Use always after you finish working with the server. You may also dispose the returned object from Connect method as alternative.

IsConnected method

Returns true if connected to the server.

SendCommand method (1.6 SR-2)

Sends command for remote execution. These are the method parameters:

  • command (string) - remote command.
ConnectionType property (int)

Specify connection type. This property has the options listed in the following table.

Value Description
0 Unsecured FTP connection.
1 Use Explicit SSL FTPS.
2 Use Implicit SSL FTPS.
3 Use Explicit TLS FTPS (1.3 SR-1).
4 Use Implicit TLS FTPS (1.3 SR-1).
ServerHost property (string)

Specify the name or IP address of the FTPS server.

ServerPort property (int)

Specify the port number on the FTPS server to use for the connection. The default value of this property is 21.

ServerUser property (string)

Specify user name to access the FTPS server.

ServerPassword property (string)

Specify user password to access the FTPS server.

ServerTimeout property (int)

Specify the number of seconds before timing out session connect. The default value of this property is 60 seconds.

RetainSameConnection property (bool) (1.3 SR-5)

Specify if all clients should use the same connection. This property has the options listed in the following table.

Value Description
True All clients use same connection.
False Every client use different connection (default).
ServerPasswordEncryption property (int) (1.3 SR-2)

Note: Starting from 1.4 SR-3 this option is no longer needed because it is automatically determined.

Specify OTP S/Key password encryption. This property has the options listed in the following table.

Value Description
0 No password encryption.
1 MD4 password encryption.
2 MD5 password encryption.
CertificateFile property (string) (1.3 SR-5)

Specify client certificate file.

CertificatePassword property (string) (1.3 SR-5)

Specify client certificate password.

PassiveMode property (bool) (1.3 SR-5)

Specify what mode to use for data connections. This property has the options listed in the following table.

Value Description
True Use passive mode for data connections (default).
False Use active mode for data connections.
PassiveIgnoreAddress property (bool) (1.4 SR-2)

Specify if the reported server address in passive mode is ignored. This property has the options listed in the following table.

Value Description
True The reported server address is ignored. Use this setting when when the reported IP address is unroutable.
False The reported server address is not ignored (default).
LogFile property (string) (1.5)

Specify verbose log file name for investigating SSH connection issues.

TransferBinary property (bool) (1.5)

Specify file transfers mode. This property has the options listed in the following table.

Value Description
True Use binary file transfer mode (default).
False Use ASCII file transfer mode.
ClearCommandChannel property (bool) (1.5)

Specify command channel encryption. This property has the options listed in the following table.

Value Description
True Use clear command channel, after authenticating to the remote server. The data connections are still encrypted. Use this option when you have introspecting firewall, which dynamically opens data ports required by the FTPS.
False Command channel is encrypted (default).
ClearDataChannel property (bool) (1.6 SR-2)

Specify data channel encryption. This property has the options listed in the following table.

Value Description
True Data channel is not encrypted.
False Data Channel is encrypted (default).
ProxyType property (int)

Specify proxy type. This property has the options listed in the following table.

Value Description
0 Proxy not specified.
1 Use SOCKS4 proxy type.
2 Use SOCKS5 proxy type.
3 Use HTTP proxy type.
4 Use FTP w/ SITE proxy type. Available only for unsecured connection type.
5 Use FTP w/ OPEN proxy type. Available only for unsecured connection type.
6 Use FTP w/ USER proxy type. Available only for unsecured connection type (1.3 SR-1).
ProxyHost property (string)

Specify the name or IP address of the proxy server.

ProxyPort property (int)

Specify the port number on the proxy server to use for the connection. The default value of this property is 80.

ProxyUser property (string)

Specify user name to access the proxy server.

ProxyPassword property (string)

Specify password to access the proxy server.