flux.file

Interface SecureFtpHost

All Superinterfaces:

FtpHost, Host, NetworkHost

public interface SecureFtpHost
extends FtpHost

Represents a Secure FTP (SFTP) host on a network. Provides authentication information for accessing Secure FTP hosts.

Author:

Copyright 2000-2025 Flux Corporation. All rights reserved.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getPrivateKeyFilename() Returns the absolute path of the private key file used for authentication with this secure FTP host.
java.lang.String	getPrivateKeyPassphrase() Returns the passphrase associated with the private key for this secure FTP host.
void	setPrivateKeyFilename(java.lang.String privateKeyFilename) Sets the absolute path of the private key file used for authentication with this secure FTP host.
void	setPrivateKeyPassphrase(java.lang.String passphrase) Sets the passphrase associated with the private key for this secure FTP host.

Methods inherited from interface flux.file.FtpHost

getFileListParser, getTransferMode, isIssueCdCommandsMode, isPassiveMode, setFileListParser, setIssueCdCommandsMode, setPassiveMode, setTransferMode

Methods inherited from interface flux.file.NetworkHost

getName, getPassword, getPort, getPortAsString, getUsername, setName, setPassword, setPort, setPortAsString, setUsername

Method Detail

getPrivateKeyFilename

java.lang.String getPrivateKeyFilename()

Returns the absolute path of the private key file used for authentication with this secure FTP host. This file contains only the raw private key data for this secure FTP host. There are no formatting characters or syntax for this file.

Use of this file is optional. If not set, the username and password are used to authenticate with this secure FTP host.

Returns:

The absolute path of the private key file used for authentication with this secure FTP host.

getPrivateKeyPassphrase

java.lang.String getPrivateKeyPassphrase()

Returns the passphrase associated with the private key for this secure FTP host. If a private key filename is not set, the private key passphrase is ignored.

Returns:

The passphrase associated with the private key for this secure FTP host.

setPrivateKeyFilename

void setPrivateKeyFilename(java.lang.String privateKeyFilename)

Sets the absolute path of the private key file used for authentication with this secure FTP host. This file contains only the raw private key data for this secure FTP host. There are no formatting characters or syntax for this file.

Use of this file is optional. If not set, the username and password are used to authenticate with this secure FTP host.

Parameters:

privateKeyFilename - The absolute path of the private key file used for authentication with this secure FTP host.

setPrivateKeyPassphrase

void setPrivateKeyPassphrase(java.lang.String passphrase)

Sets the passphrase associated with the private key for this secure FTP host. If a private key filename is not set, the private key passphrase is ignored.

Parameters:

passphrase - The passphrase associated with the private key for this secure FTP host.