flux.file
Interface FtpSslHost

All Superinterfaces:

FtpHost, Host, NetworkHost

public interface FtpSslHost
extends FtpHost

Represents an FTP-over-SSL (FTPS) host on a network.

Author:

Copyright 2014 Flux Corporation. All rights reserved.

Method Summary

java.lang.String	getClientCertificatesFilename() Returns the absolute path of the Java keystore file containing client certificates used for authentication with this FTP-over-SSL host.
java.lang.String	getClientCertificatesPassword() Returns the password associated with the Java keystore file containing client certificates for this FTP-over-SSL host.
FtpSslEncryptionProtocol	getEncryptionProtocol() Returns the encryption protocol to use when communicating with this host.
java.lang.String	getServerCertificatesFilename() Returns the absolute path of the Java keystore file containing server certificates used for authentication with this FTP-over-SSL host.
java.lang.String	getServerCertificatesPassword() Returns the password associated with the Java keystore file containing server certificates for this FTP-over-SSL host.
void	setClientCertificatesFilename(java.lang.String filename) Sets the absolute path of the Java keystore file containing client certificates used for authentication with this FTP-over-SSL host.
void	setClientCertificatesPassword(java.lang.String password) Sets the password associated with the Java keystore file containing client certificates for this FTP-over-SSL host.
void	setEncryptionProtocol(FtpSslEncryptionProtocol encryptionProtocol) Sets the encryption protocol to use when communicating with this host.
void	setServerCertificatesFilename(java.lang.String filename) Sets the absolute path of the Java keystore file containing server certificates used for authentication with this FTP-over-SSL host.
void	setServerCertificatesPassword(java.lang.String password) Sets the password associated with the Java keystore file containing server certificates for this FTP-over-SSL 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

getClientCertificatesFilename

java.lang.String getClientCertificatesFilename()

Returns the absolute path of the Java keystore file containing client certificates used for authentication with this FTP-over-SSL host.

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

Returns:

The absolute path of the Java keystore file containing client certificates used for authentication with this FTP-over-SSL host.

getClientCertificatesPassword

java.lang.String getClientCertificatesPassword()

Returns the password associated with the Java keystore file containing client certificates for this FTP-over-SSL host. If a keystore file is not set, the password is ignored. If a keystore file is set, a non-null and non-empty password must be set.

Returns:

The password associated with the Java keystore file containing client certificates for this FTP-over-SSL host.

getEncryptionProtocol

FtpSslEncryptionProtocol getEncryptionProtocol()

Returns the encryption protocol to use when communicating with this host. Defaults to TLS.

Returns:

The encryption protocol to use when communicating with this host.

getServerCertificatesFilename

java.lang.String getServerCertificatesFilename()

Returns the absolute path of the Java keystore file containing server certificates used for authentication with this FTP-over-SSL host.

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

Returns:

The absolute path of the Java keystore file containing the server certificates used for authentication with this FTP-over-SSL host.

getServerCertificatesPassword

java.lang.String getServerCertificatesPassword()

Returns the password associated with the Java keystore file containing server certificates for this FTP-over-SSL host. If a keystore file is not set, the password is ignored. If a keystore file is set, a non-null and non-empty password must be set.

Returns:

The password associated with the Java keystore file containing the server certificates for this FTP-over-SSL host.

setClientCertificatesFilename

void setClientCertificatesFilename(java.lang.String filename)

Sets the absolute path of the Java keystore file containing client certificates used for authentication with this FTP-over-SSL host.

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

Parameters:

filename - The absolute path of the Java keystore file containing client certificates used for authentication with this FTP-over-SSL host.

setClientCertificatesPassword

void setClientCertificatesPassword(java.lang.String password)

Sets the password associated with the Java keystore file containing client certificates for this FTP-over-SSL host. If a keystore file is not set, the password is ignored. If a keystore file is set, a non-null and non-empty password must be set.

Parameters:

password - The password associated with the Java keystore file containing client certificates for this FTP-over-SSL host.

setEncryptionProtocol

void setEncryptionProtocol(FtpSslEncryptionProtocol encryptionProtocol)

Sets the encryption protocol to use when communicating with this host.

Parameters:

encryptionProtocol - The encryption protocol to use when communicating with this host.

setServerCertificatesFilename

void setServerCertificatesFilename(java.lang.String filename)

Sets the absolute path of the Java keystore file containing server certificates used for authentication with this FTP-over-SSL host.

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

Parameters:

filename - The absolute path of the Java keystore file containing server certificates used for authentication with this FTP-over-SSL host.

setServerCertificatesPassword

void setServerCertificatesPassword(java.lang.String password)

Sets the password associated with the Java keystore file containing server certificates for this FTP-over-SSL host. If a keystore file is not set, the password is ignored. If a keystore file is set, a non-null and non-empty password must be set.

Parameters:

password - The password associated with the Java keystore file containing server certificate for this FTP-over-SSL host.