SFTPClient Class

Properties   Methods   Events   Config Settings   Errors  

The SFTPClient class provides client-side functionality for SFTP (Secure File Transfer Protocol).

Syntax

secureblackbox.SFTPClient

Remarks

SFTP is a file transfer subsystem that runs on top of secure shell (SSH) connection. This means that SFTP uses the whole strength of security provided by the SSH protocol, at the same time providing strong file transfer capabilities.

Please do keep in mind that there exist two protocols that offer similar secure file transfer features. SFTP works on top of SSH and normally uses port 22. FTPS works on top of TLS (or SSL) and normally uses ports 21 and 990. The protocols are very different, so please make sure you are after the right component. This component works with SFTP. Use the FTPClient component to connect to FTPS servers.

Below are the typical steps that let you integrate SFTPClient to your project:

• Set up your Username and Password. SSH uses mandatory client-side authentication, so in most cases you need to provide your username, your password, or, sometimes, your private key. Use Key property to provide your key, if needed.
• Be ready to handle server authentication, which is also mandatory in SSH. SSH operates a concept of a trusted keys file, where keys of known servers are stored. You can assign a path to your own trusted keys file to the TrustedKeysFile property. When a client receives a server key, it reports it to your code via its KnownKeyReceived or UnknownKeyReceived event, depending on whether the key was found in the trusted list. If you leave TrustedKeysFile empty, SFTPClient will only be able to fire the UnknownKeyReceived event, since there will be no known keys to report.
• If needed, customize Proxy parameters and SSHSettings.
• Consider interacting more with SFTPClient by subscribing to AuthAttempt, AuthFailed, and AuthSucceeded events to be notified about the client authentication progress.
• When you are ready to connect, call Connect, passing the details of the server as parameters. During the initial handshake, the following events will fire: UnknownKeyReceived (or KnownKeyReceived), and then one or more AuthAttempt, AuthFailed and AuthSucceeded.
• Upon completion of the Connect method, the component is ready for file operations. Use DownloadFile, UploadFile, ListDir, DeleteFile and other file transfer methods to work with the server file system.
• When you are done with your work, call Disconnect to close the connection.

Some SFTP servers, primarily older ones, may expose various transfer issues. If you come across a weird issue that you believe should not be happening (such as repeated connection closures in the middle of the transfer), please try adjusting the following properties:

• AutoAdjustTransferBlock to false,
• PipelineLength to 1,
• UploadBlockSize to 16384,
• DownloadBlockSize to 16384.

These adjustments will put SFTPClient in very conservative transfer setup. While this setup may be quite sluggish with modern servers, it should make SFTPClient interoperable with most older servers.

Property List

---

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

Method List

---

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

Event List

---

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

Config Settings

---

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

AuthAttempts Property (SFTPClient Class)

Specifies the number of SSH authentication attempts.

Syntax

public int getAuthAttempts();
public void setAuthAttempts(int authAttempts);

Default Value

1

Remarks

Use this property to specify the number of authentication attempts to try. The AuthFailed event is fired for every failed attempt.

AutoAdjustTransferBlock Property (SFTPClient Class)

Specifies whether to adjust the send and receive buffer sizes automatically.

Syntax

public boolean isAutoAdjustTransferBlock();
public void setAutoAdjustTransferBlock(boolean autoAdjustTransferBlock);

Default Value

True

Remarks

Automatic transfer block size adjustment may be beneficial for maximizing interoperability and achieving the best transfer speeds.

Use DownloadBlockSize, UploadBlockSize, and PipelineLength properties to adjust the transfer settings manually.

ConflictResolutionMode Property (SFTPClient Class)

Defines the approach that should be used to resolve various conflicts during batch processing.

Syntax

public int getConflictResolutionMode();
public void setConflictResolutionMode(int conflictResolutionMode);

Enumerated values:
  public final static int cftmOverwrite = 0;
  public final static int cftmSkip = 1;
  public final static int cftmAppendToEnd = 2;
  public final static int cftmResume = 3;
  public final static int cftmOverwriteIfDiffSize = 4;
  public final static int cftmSaveWithNewName = 5;
  public final static int cftmRenameExistingTarget = 6;

Default Value

0

Remarks

Use this property to specify the approach to use when landing in conflicting transfer situations.

Connected Property (SFTPClient Class)

Indicates if the client is connected to the SFTP server.

Syntax

public boolean isConnected();

Default Value

False

Remarks

Use this read-only property to check whether the client is connected to the server.

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

ConnectionInfo Property (SFTPClient Class)

Contains the secure connection info.

Syntax

public SSHConnectionInfo getConnectionInfo();

Remarks

This property contains various information about the secure connection.

This property is read-only.

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

CurrentListEntry Property (SFTPClient Class)

Contains the current entry returned by ListDir .

Syntax

public FTPListEntry getCurrentListEntry();

Remarks

Use this property to access the current list entry as returned by ListDir call. Entries are passed back to the application one by one, with ListEntry thrown for each entry.

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

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

DownloadBlockSize Property (SFTPClient Class)

The download block size in bytes.

Syntax

public int getDownloadBlockSize();
public void setDownloadBlockSize(int downloadBlockSize);

Default Value

65536

Remarks

Use this property to manually control the size of download blocks. Typically you will only need to adjust this property if the default transfer settings (AutoAdjustTransferBlock) don't work.

ExternalCrypto Property (SFTPClient Class)

Provides access to external signing and DC parameters.

Syntax

public ExternalCrypto getExternalCrypto();

Remarks

Use this property to tune-up remote cryptography settings. SecureBlackbox supports two independent types of external cryptography: synchronous (based on the ExternalSign event) and asynchronous (based on the DC protocol and the DCAuth signing component).

This property is read-only.

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

FIPSMode Property (SFTPClient Class)

Reserved.

Syntax

public boolean isFIPSMode();
public void setFIPSMode(boolean FIPSMode);

Default Value

False

Remarks

This property is reserved for future use.

ForceCompression Property (SFTPClient Class)

Enforces compression for the SSH layer.

Syntax

public boolean isForceCompression();
public void setForceCompression(boolean forceCompression);

Default Value

False

Remarks

Set this property before opening a connection to enforce compression of the SSH packets.

Key Property (SFTPClient Class)

Contains the client's SSH key.

Syntax

public SSHKey getKey();
public void setKey(SSHKey key);

Remarks

Use this property to provide the client's SSH key for authentication. Note that you may start with providing the public part of the key, and only complete it with the private part in response to PrivateKeyNeeded event.

Alternative, you may load the private key straightaway.

This property is not available at design time.

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

MaxSFTPVersion Property (SFTPClient Class)

Higher SFTP version to support.

Syntax

public int getMaxSFTPVersion();
public void setMaxSFTPVersion(int maxSFTPVersion);

Default Value

6

Remarks

MaxSFTPVersion and MinSFTPVersion properties control the range of SFTP protocol versions supported by this client.

MinSFTPVersion Property (SFTPClient Class)

Lower SFTP version to support.

Syntax

public int getMinSFTPVersion();
public void setMinSFTPVersion(int minSFTPVersion);

Default Value

0

Remarks

MaxSFTPVersion and MinSFTPVersion properties control the range of SFTP protocol versions to be supported by this client.

Password Property (SFTPClient Class)

Specifies user's authentication password.

Syntax

public String getPassword();
public void setPassword(String password);

Default Value

""

Remarks

Use this property to provide an authentication password. This property is only applicable for password-based and keyboard-interactive authentication types.

PipelineLength Property (SFTPClient Class)

The number of parallelized transfer requests.

Syntax

public int getPipelineLength();
public void setPipelineLength(int pipelineLength);

Default Value

32

Remarks

This property controls the number of upload/download requests sent simultaneously. This speeds the transfer up, but may lead to issues with older/immature servers.

Typically you will only need to adjust this property if the default transfer settings (AutoAdjustTransferBlock) don't work.

Proxy Property (SFTPClient Class)

The proxy server settings.

Syntax

public ProxySettings getProxy();

Remarks

Use this property to tune up the proxy server settings.

This property is read-only.

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

ServerKey Property (SFTPClient Class)

Returns the server's public key.

Syntax

public SSHKey getServerKey();

Remarks

Use this property to check the details of the server public key.

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

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

SocketSettings Property (SFTPClient Class)

Manages network connection settings.

Syntax

public SocketSettings getSocketSettings();

Remarks

Use this property to tune up network connection parameters.

This property is read-only.

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

SSHSettings Property (SFTPClient Class)

The SSH connection settings.

Syntax

public SSHSettings getSSHSettings();

Remarks

Use this property to access and tune-up the SSH layer settings.

This property is read-only.

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

TrustedKeysFile Property (SFTPClient Class)

A file containing the keys of authorized servers.

Syntax

public String getTrustedKeysFile();
public void setTrustedKeysFile(String trustedKeysFile);

Default Value

""

Remarks

Use this property to provide a path to the 'authorized_keys' file to be used by the client.

UploadBlockSize Property (SFTPClient Class)

The upload block size in bytes.

Syntax

public int getUploadBlockSize();
public void setUploadBlockSize(int uploadBlockSize);

Default Value

32256

Remarks

Use this property to manually control the size of upload blocks. Typically you will only need to adjust this property if the default transfer settings (AutoAdjustTransferBlock) don't work.

Username Property (SFTPClient Class)

The client's username to authenticate to the server.

Syntax

public String getUsername();
public void setUsername(String username);

Default Value

""

Remarks

Use this property to provide an authentication username (login). This property is only applicable for password-based and keyboard-interactive authentication types.

UseUTF8 Property (SFTPClient Class)

Enables UTF8 for all string content.

Syntax

public boolean isUseUTF8();
public void setUseUTF8(boolean useUTF8);

Default Value

False

Remarks

If UseUTF8 is true, the class expects all downloaded filenames to be encoded in UTF-8. Set UseUTF8 to false if you connect to a server that does not support UTF8 (e.g., OpenSSH). In this case the file names will be interpreted in the default character set.

Version Property (SFTPClient Class)

The SFTP version negotiated.

Syntax

public int getVersion();

Default Value

0

Remarks

Use this property to get the negotiated SFTP version.

This property is read-only.

AbsolutePath Method (SFTPClient Class)

Requests the absolute path for a relative path.

Syntax

public String absolutePath(String remotePath);

Remarks

Use this method to ask the SFTP server to convert a relative path to an absolute.

ChangeDir Method (SFTPClient Class)

Changes current working directory on the server.

Syntax

public void changeDir(String remoteDir);

Remarks

Changes current working directory on the server to RemoteDir.

Config Method (SFTPClient 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 (SFTPClient Class)

Connects to an SFTP server.

Syntax

public void connect(String address, int port);

Remarks

Use this method to connect to the SFTP server identified via its Address and Port.

CreateLink Method (SFTPClient Class)

Creates a symbolic or hard link to a remote file.

Syntax

public void createLink(String linkPath, String targetPath, boolean hardLink);

Remarks

Use this method to create a symbolic or hard link on the server. Provide the name of the new link object via the LinkPath parameter, and the destinating file or directory path via the TargetPath parameter. HardLink specifies whether the new link should be hard (true) or symbolic (false).

DeleteDir Method (SFTPClient Class)

Removes directory from the SFTP server.

Syntax

public void deleteDir(String remoteDir);

Remarks

Use RemoteDir to provide a path to the directory to be deleted.

DeleteFile Method (SFTPClient Class)

Deletes a file from the SFTP server.

Syntax

public void deleteFile(String remoteFile);

Remarks

Use the RemoteFile parameter to specify the name of the file to delete.

DeleteFiles Method (SFTPClient Class)

Deletes a group of files from the SFTP server.

Syntax

public void deleteFiles(String remotePath, String mask, boolean caseSensitive, boolean recursive, int errorHandling);

Remarks

Use this method to delete a group of files from the SFTP server. Specify the files to be deleted via RemotePath and Mask parameters. Use CaseSensitive and Recursive parameters to tune up the operation.

The ErrorHandling parameter specifies the error handling tactics.

This method is a more efficient way to delete a group of files than deleting them one by one.

DirExists Method (SFTPClient Class)

Checks if a directory exists on the SFTP server.

Syntax

public boolean dirExists(String remoteDir);

Remarks

RemoteDir specifies the name of the remote directory to check for existence.

Disconnect Method (SFTPClient Class)

Disconnects from the SFTP server.

Syntax

public void disconnect();

Remarks

Call this method to disconnect from the SFTP server.

DoAction Method (SFTPClient Class)

Performs an additional action.

Syntax

public String doAction(String actionID, String actionParams);

Remarks

DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

Common ActionIDs:

DownloadBytes Method (SFTPClient Class)

Downloads a file from the server into an array of bytes.

Syntax

public byte[] downloadBytes(String remoteFile);

Remarks

Use this method to download RemoteFile into a byte array.

DownloadFile Method (SFTPClient Class)

Downloads a file from the SFTP server.

Syntax

public void downloadFile(String remoteFile, String localFile);

Remarks

Use this method to download RemoteFile into the location specified by LocalFile.

DownloadFiles Method (SFTPClient Class)

Downloads multiple files from the SFTP server.

Syntax

public void downloadFiles(String remotePath, String localDir, boolean recursive, int errorHandling);

Remarks

RemotePath contains a file mask or regular expression by which the files are selected for download.

LocalDir specifies the local folder where the files should be saved. The Recursive parameter tells the component whether it should navigate source directories recursively when downloading files. If set to false, only the files residing in the actual RemotePath, but not its subdirectories, will be downloaded.

The ErrorHandling parameter specifies the error handling tactics.

DownloadStream Method (SFTPClient Class)

Downloads a file from the SFTP server.

Syntax

public void downloadStream(String remoteFile, java.io.OutputStream localStream);

Remarks

Use this method to download RemoteFile into a LocalStream object.

ExecuteSSHCommand Method (SFTPClient Class)

Sends an SSH command to the server in the middle of SFTP session.

Syntax

public byte[] executeSSHCommand(String command);

Remarks

Use this command to send an SSH command to the server in the middle of an SFTP session. The command is executed in a secondary channel, so the SFTP connection is not affected.

This method is suitable for simple commands that do not require interaction with the user. The call returns the command output.

ExtensionCmd Method (SFTPClient Class)

Sends an extension command to the server.

Syntax

public byte[] extensionCmd(String extn, byte[] dataBuffer);

Remarks

Use this method to send an extension command to the SFTP server. Provide the extension type via the Extn parameter, and the request body via the DataBuffer parameter.

Upon completion of the command, the method returns the response as received from the server.

FileExists Method (SFTPClient Class)

Checks whether a file exists on the server.

Syntax

public boolean fileExists(String remoteFile);

Remarks

Use this method to check if a RemoteFile exists on the server.

GetCurrentDir Method (SFTPClient Class)

Returns the current directory on the SFTP server.

Syntax

public String getCurrentDir();

Remarks

Use this method to retrieve the current directory as stored by the class. This is a virtualized current directory, as SFTP protocol does not maintain a concept of the current directory.

GetFileSize Method (SFTPClient Class)

Checks the size of a remote file.

Syntax

public long getFileSize(String remoteFile);

Remarks

Returns the size of the RemoteFile.

ListDir Method (SFTPClient Class)

Lists the content of the current remote directory.

Syntax

public String listDir(boolean includeFiles, boolean includeDirectories);

Remarks

IncludeFiles specifies whether file names and symlinks should be included in the results. IncludeDirectories specifies whether directory names should be included in the result.

Upon receiving the listing, the component will report each entry in it via ListEntry event.

MakeDir Method (SFTPClient Class)

Creates a new directory on the server.

Syntax

public void makeDir(String remoteDir);

Remarks

RemoteDir specifies the name of the new directory.

RenameFile Method (SFTPClient Class)

Renames a file.

Syntax

public void renameFile(String sourceFile, String destFile);

Remarks

Use this method to rename a remote file. Provide the old and the new name via SourceFile and DestFile parameters.

RequestAttributes Method (SFTPClient Class)

Requests attributes of the remote file.

Syntax

public String requestAttributes(String remotePath, boolean followSymLinks);

Remarks

Use this method to request attributes of a remote file. Pass the name of the file via the RemotePath parameter, and use FollowSymLinks to specify whether symbolic links should be resolved.

The method returns the list of attributes as a line of semicolon-separated entries: Size=78220;Owner=user@system;Group=none@system;Permissions=432;ATime=2020-04-28 08:21:00.295;MTime=2020-04-28 08:21:00.302;CTime=2020-04-28 08:21:00.295;AttribBits=24;LinkCount=1.

Reset Method (SFTPClient Class)

Resets the class settings.

Syntax

public void reset();

Remarks

Reset is a generic method available in every class.

SetAttributes Method (SFTPClient Class)

Sets the attributes upon a remote file.

Syntax

public void setAttributes(String remotePath, String attributes);

Remarks

Use this method to set the attributes of a remote file.

UploadBytes Method (SFTPClient Class)

Uploads a byte array to the server.

Syntax

public void uploadBytes(byte[] bytes, String remoteFile);

Remarks

Use this method to upload Bytes or its part to RemoteFile on the server.

UploadFile Method (SFTPClient Class)

Uploads a file to the server.

Syntax

public void uploadFile(String localFile, String remoteFile);

Remarks

Use this method to upload LocalFile to the RemoteFile location on the server.

UploadFiles Method (SFTPClient Class)

Uploads multiple files to the server.

Syntax

public void uploadFiles(String localPath, String remoteDir, boolean recursive, int errorHandling);

Remarks

Use this property to upload a batch of files to the server.

LocalPath specifies a wildcard or regular expression by which the local files are picked for uploading. RemoteDir specifies the location on the server where these files should be saved. The Recursive parameter tells the component whether it should navigate source directories recursively when uploading files. If set to false, only the files residing in the actual LocalPath, but not its subdirectories, will be uploaded.

The ErrorHandling parameter specifies one of the pre-defined error handling tactics:

UploadStream Method (SFTPClient Class)

Uploads a file to the server.

Syntax

public void uploadStream(java.io.InputStream localStream, String remoteFile);

Remarks

Use this method to upload the contents of LocalStream to the RemoteFile location on the server.

AuthAttempt Event (SFTPClient Class)

Fires when an authentication attempt is performed.

Syntax

public class DefaultSFTPClientEventListener implements SFTPClientEventListener {
  ...
  public void authAttempt(SFTPClientAuthAttemptEvent e) {}
  ...
}

public class SFTPClientAuthAttemptEvent {
  public int authType;
}

Remarks

This event signals the start of an authentication attempt. The AuthType parameter specifies the authentication type. This event may be fired more than once if the client tries different authentication methods one after another.

Supported authentication types:

AuthFailed Event (SFTPClient Class)

Fires if an authentication attempt fails.

Syntax

public class DefaultSFTPClientEventListener implements SFTPClientEventListener {
  ...
  public void authFailed(SFTPClientAuthFailedEvent e) {}
  ...
}

public class SFTPClientAuthFailedEvent {
  public int authType;
}

Remarks

This event fires if an authentication attempt fails (for example, if a bad password had been provided). AuthType parameter indicates the authentication type.

AuthFailed may be fired more than once, depending on the configured authentication parameters and the value assigned to the AuthAttempts property.

This event does not necessarily lead to connection abortion, as the client may still have a chance of authenticating with a different method.

Supported authentication types:

AuthSucceeded Event (SFTPClient Class)

Reports a successful authentication.

Syntax

public class DefaultSFTPClientEventListener implements SFTPClientEventListener {
  ...
  public void authSucceeded(SFTPClientAuthSucceededEvent e) {}
  ...
}

public class SFTPClientAuthSucceededEvent {
}

Remarks

This event marks the completion of the authentication procedure, and signifies transition to the SSH connection subprotocol.

Banner Event (SFTPClient Class)

Reports the receipt of the Welcome message from the server.

Syntax

public class DefaultSFTPClientEventListener implements SFTPClientEventListener {
  ...
  public void banner(SFTPClientBannerEvent e) {}
  ...
}

public class SFTPClientBannerEvent {
  public byte[] text;
  public byte[] language;
}

Remarks

The class fires this event when it receives a welcome message from the server. Use the Text parameter to access the encoded message.

Disconnect Event (SFTPClient Class)

Reports SFTP connection closure.

Syntax

public class DefaultSFTPClientEventListener implements SFTPClientEventListener {
  ...
  public void disconnect(SFTPClientDisconnectEvent e) {}
  ...
}

public class SFTPClientDisconnectEvent {
  public int closeReason;
}

Remarks

The class fires this event to report connection closure. No more SFTP activity could be done after the disconnect.

Error Event (SFTPClient Class)

Information about errors during SFTP connection.

Syntax

public class DefaultSFTPClientEventListener implements SFTPClientEventListener {
  ...
  public void error(SFTPClientErrorEvent e) {}
  ...
}

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

Remarks

The event is fired in case of exceptional conditions during data transfer.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of error codes please refer to SFTP.

ExternalSign Event (SFTPClient Class)

Handles remote or external signing initiated by the SignExternal method or other source.

Syntax

public class DefaultSFTPClientEventListener implements SFTPClientEventListener {
  ...
  public void externalSign(SFTPClientExternalSignEvent e) {}
  ...
}

public class SFTPClientExternalSignEvent {
  public String operationId;
  public String hashAlgorithm;
  public String pars;
  public String data;
  public String signedData; //read-write
}

Remarks

Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed.

The event handler must pass the value of Data to the signer, obtain the signature, and pass it back to the class via the SignedData parameter.

OperationId provides a comment about the operation and its origin. It depends on the exact class being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contains algorithm-dependent parameters.

The class uses base16 (hex) encoding for the Data, SignedData, and Pars parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing.

A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16

A sample event handler that uses the .NET RSACryptoServiceProvider class may look like the following: signer.OnExternalSign += (s, e) => { var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable); var key = (RSACryptoServiceProvider)cert.PrivateKey; var dataToSign = e.Data.FromBase16String(); var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1"); e.SignedData = signedData.ToBase16String(); };

FileNameChangeNeeded Event (SFTPClient Class)

Asks the application for a new file name.

Syntax

public class DefaultSFTPClientEventListener implements SFTPClientEventListener {
  ...
  public void fileNameChangeNeeded(SFTPClientFileNameChangeNeededEvent e) {}
  ...
}

public class SFTPClientFileNameChangeNeededEvent {
  public String fileName; //read-write
  public boolean force; //read-write
}

Remarks

The component uses this event to ask the application for a new file name in the case of a name conflict. Adjust the FileName as required to avoid the conflict, or set Force to true to go ahead with the current name (possibly overwriting an existing file).

FileOperation Event (SFTPClient Class)

Signifies the start of a file transfer operation.

Syntax

public class DefaultSFTPClientEventListener implements SFTPClientEventListener {
  ...
  public void fileOperation(SFTPClientFileOperationEvent e) {}
  ...
}

public class SFTPClientFileOperationEvent {
  public int operation;
  public String remotePath;
  public String localPath;
  public boolean skip; //read-write
  public boolean cancel; //read-write
}

Remarks

This event is fired each time the class starts an upload or download operation within a multi-file call. Operation defines the operation about to start, RemotePath specifies the name and path to the remote file, and LocalPath specifies the name and path to the local file.

If needed, set Skip to true to ignore the current file, or Cancel to abort the whole batch.

Supported operations:

FileOperationResult Event (SFTPClient Class)

Signifies the completion of a file transfer operation.

Syntax

public class DefaultSFTPClientEventListener implements SFTPClientEventListener {
  ...
  public void fileOperationResult(SFTPClientFileOperationResultEvent e) {}
  ...
}

public class SFTPClientFileOperationResultEvent {
  public int operation;
  public String remotePath;
  public String localPath;
  public int errorCode;
  public String comment;
  public boolean cancel; //read-write
}

Remarks

This event is fired each time the class completes a file transfer within a multi-file call. Operation defines the operation performed on the file, RemotePath specifies the name and path to the remote file, and LocalPath specifies the name and path to the local file.

ErrorCode and Comment return the code and textual description of the error, if it was encountered.

Set Cancel to True to cancel the multi-file operation.

Supported operations:

KnownKeyReceived Event (SFTPClient Class)

Signals that the server has introduced itself with a known key.

Syntax

public class DefaultSFTPClientEventListener implements SFTPClientEventListener {
  ...
  public void knownKeyReceived(SFTPClientKnownKeyReceivedEvent e) {}
  ...
}

public class SFTPClientKnownKeyReceivedEvent {
  public String algorithm;
  public int bits;
  public String fingerprintSHA256;
}

Remarks

The class fires this event to tell the application that the server has introduced itself with a known key from TrustedKeysFile.

The details of the key are provided: Algorithm and Bits specify the key algorithm and the number of bits. FingerprintSHA256 contains the key's fingerprint.

Use ServerKey to access more key details.

ListEntry Event (SFTPClient Class)

Reports a directory listing entry to the application.

Syntax

public class DefaultSFTPClientEventListener implements SFTPClientEventListener {
  ...
  public void listEntry(SFTPClientListEntryEvent e) {}
  ...
}

public class SFTPClientListEntryEvent {
  public String fileName;
}

Remarks

The class fires this event to report a directory listing entry to the application. FileName contains the entry name.

Use CurrentListEntry to access the details of the entry.

Notification Event (SFTPClient Class)

This event notifies the application about an underlying control flow event.

Syntax

public class DefaultSFTPClientEventListener implements SFTPClientEventListener {
  ...
  public void notification(SFTPClientNotificationEvent e) {}
  ...
}

public class SFTPClientNotificationEvent {
  public String eventID;
  public String eventParam;
}

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.

PasswordChangeRequest Event (SFTPClient Class)

Signals that the server requests a password change.

Syntax

public class DefaultSFTPClientEventListener implements SFTPClientEventListener {
  ...
  public void passwordChangeRequest(SFTPClientPasswordChangeRequestEvent e) {}
  ...
}

public class SFTPClientPasswordChangeRequestEvent {
  public String prompt;
  public String newPassword; //read-write
  public boolean cancel; //read-write
}

Remarks

The class fires this event to pass the password change request from the server to the application. This event is fired during the SSH handshake.

PrivateKeyNeeded Event (SFTPClient Class)

Asks the application for the client's private key.

Syntax

public class DefaultSFTPClientEventListener implements SFTPClientEventListener {
  ...
  public void privateKeyNeeded(SFTPClientPrivateKeyNeededEvent e) {}
  ...
}

public class SFTPClientPrivateKeyNeededEvent {
  public boolean skip; //read-write
}

Remarks

The class fires this event if the public key provided in Key was accepted by the server, but no private key is available for it.

Use this event handler to attach the private key to your Key. The component will pick the key up and continue the authentication.

Progress Event (SFTPClient Class)

Fires periodically during the data transfer.

Syntax

public class DefaultSFTPClientEventListener implements SFTPClientEventListener {
  ...
  public void progress(SFTPClientProgressEvent e) {}
  ...
}

public class SFTPClientProgressEvent {
  public long total;
  public long current;
  public boolean cancel; //read-write
}

Remarks

Use this event to check the progress of an upload or download operation. Total indicates the total number of bytes to be transferred; Current specifies how much data has been transferred so far, and Cancel gives you a chance to cancel the operation.

UnknownKeyReceived Event (SFTPClient Class)

Signals that the server has introduced itself with an unknown key.

Syntax

public class DefaultSFTPClientEventListener implements SFTPClientEventListener {
  ...
  public void unknownKeyReceived(SFTPClientUnknownKeyReceivedEvent e) {}
  ...
}

public class SFTPClientUnknownKeyReceivedEvent {
  public String algorithm;
  public int bits;
  public String fingerprintSHA256;
  public int action; //read-write
}

Remarks

The class fires this event to tell the application that the server has introduced itself with a key not present in TrustedKeysFile.

The details of the key are provided: Algorithm and Bits specify the key algorithm and the number of bits. FingerprintSHA256 contains the key's fingerprint.

In this event handler, you need to make a decision whether to proceed with the connection. Use Action to tell the class what it should do with the key:

Note that accepting an unknown and unchecked key may be risky.

ExternalCrypto Type

Specifies the parameters of external cryptographic calls.

Remarks

External cryptocalls are used in a Distributed Cryptography (DC) subsystem, which allows the delegation of security operations to the remote agent. For instance, it can be used to compute the signature value on the server, while retaining the client's private key locally.

Fields

Constructors

public ExternalCrypto();

FTPListEntry Type

Represents a basic container for the remote file details.

Remarks

The class represents the details of a file entry returned by the FTP server.

Fields

Constructors

public FTPListEntry();

ProxySettings Type

A container for proxy server settings.

Remarks

This type exposes a collection of properties for tuning up the proxy server configuration.

Fields

Constructors

public ProxySettings();

SocketSettings Type

A container for the socket settings.

Remarks

This type is a container for socket-layer parameters.

Fields

Constructors

public SocketSettings();

SSHConnectionInfo Type

Contains information about SSH connection.

Remarks

SSHConnectionInfo object contains information about one SSH connection.

Fields

Constructors

public SSHConnectionInfo();

SSHKey Type

SSHKey is used to store information about single compound public-key algorithm (such as RSA or DSA) key.

Remarks

SSH keys are used to secure the SSH protocol flow. They support different algorithms and key lengths, a very typical example being RSA-2048 bits.

Fields

Constructors

public SSHKey( bytes,  startIndex,  count,  password);

public SSHKey( bytes,  startIndex,  count);

public SSHKey( stream,  password);

public SSHKey( stream);

public SSHKey( path,  password);

public SSHKey( path);

public SSHKey();

SSHSettings Type

A container for various SSH protocol settings.

Remarks

SSHSettings stores various settings of SSH client or server.

Fields

Constructors

public SSHSettings();

Config Settings (SFTPClient 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.

SFTPClient Config Settings

Base Config Settings

Trappable Errors (SFTPClient Class)

SFTPClient Errors