org.apache.commons.vfs2.provider.ftps

Class FtpsFileSystemConfigBuilder

java.lang.Object

org.apache.commons.vfs2.FileSystemConfigBuilder

org.apache.commons.vfs2.provider.ftp.FtpFileSystemConfigBuilder

org.apache.commons.vfs2.provider.ftps.FtpsFileSystemConfigBuilder

public final class FtpsFileSystemConfigBuilder
extends FtpFileSystemConfigBuilder

The configuration builder for various FTPS configuration options.

Since:

2.0

Method Summary

Modifier and Type	Method and Description
FtpsDataChannelProtectionLevel	getDataChannelProtectionLevel(FileSystemOptions opts) Gets the data channel protection level (PROT).
FtpsMode	getFtpsMode(FileSystemOptions opts) Return the FTPS mode.
String	getFtpsType(FileSystemOptions opts) Deprecated. As of 2.1, use getFtpsMode(FileSystemOptions)
static FtpsFileSystemConfigBuilder	getInstance() Gets the singleton builder.
KeyManager	getKeyManager(FileSystemOptions opts) Gets the KeyManager used to provide a client-side certificate if the FTPS server requests it.
String	getKeyPW(FileSystemOptions opts) get the key password.
String	getKeyStore(FileSystemOptions opts) get the keyStore path.
String	getKeyStorePW(FileSystemOptions opts) get the keyStore password.
TrustManager	getTrustManager(FileSystemOptions opts) Gets the TrustManager that validates the FTPS server's certificate.
String	getTrustStore(FileSystemOptions opts) get the keyStore path.
String	getTrustStorePW(FileSystemOptions opts) get the trustStore password.
void	setDataChannelProtectionLevel(FileSystemOptions opts, FtpsDataChannelProtectionLevel prot) Sets the data channel protection level (PROT).
void	setFtpsMode(FileSystemOptions opts, FtpsMode ftpsMode) Set FTPS mode, either "implicit" or "explicit".
void	setFtpsType(FileSystemOptions opts, String ftpsType) Deprecated. As of 2.1, use setFtpsMode(FileSystemOptions, FtpsMode)
void	setKeyManager(FileSystemOptions opts, KeyManager keyManager) Sets the KeyManager used to provide a client-side certificate if the FTPS server requests it.
void	setKeyPW(FileSystemOptions opts, String keyPW) Set the Key password.
void	setKeyStore(FileSystemOptions opts, String keyStore) Set the key store.
void	setKeyStorePW(FileSystemOptions opts, String keyStorePW) Set the key store password.
void	setTrustManager(FileSystemOptions opts, TrustManager trustManager) Sets the TrustManager that validates the FTPS server's certificate.
void	setTrustStore(FileSystemOptions opts, String trustStore) Set the key store.
void	setTrustStorePW(FileSystemOptions opts, String trustStorePW) Set the trust store password.

Methods inherited from class org.apache.commons.vfs2.provider.ftp.FtpFileSystemConfigBuilder

getConfigClass, getConnectTimeout, getControlEncoding, getDataTimeout, getDefaultDateFormat, getEntryParser, getEntryParserFactory, getFileType, getPassiveMode, getProxy, getRecentDateFormat, getRemoteVerification, getServerLanguageCode, getServerTimeZoneId, getShortMonthNames, getSoTimeout, getUserDirIsRoot, setConnectTimeout, setControlEncoding, setDataTimeout, setDefaultDateFormat, setEntryParser, setEntryParserFactory, setFileType, setPassiveMode, setProxy, setRecentDateFormat, setRemoteVerification, setServerLanguageCode, setServerTimeZoneId, setShortMonthNames, setSoTimeout, setUserDirIsRoot

Methods inherited from class org.apache.commons.vfs2.FileSystemConfigBuilder

getBoolean, getBoolean, getBoolean, getByte, getByte, getByte, getCharacter, getCharacter, getCharacter, getDouble, getDouble, getDouble, getEnum, getEnum, getFloat, getFloat, getFloat, getInteger, getInteger, getInteger, getLong, getLong, getLong, getParam, getRootURI, getShort, getShort, getShort, getString, getString, hasObject, hasParam, setParam, setParam, setRootURI

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

public static FtpsFileSystemConfigBuilder getInstance()

Gets the singleton builder.

Returns:

the singleton builder.

setFtpsMode

public void setFtpsMode(FileSystemOptions opts,
                        FtpsMode ftpsMode)

Set FTPS mode, either "implicit" or "explicit".

Note, that implicit mode is not standardized and considered as deprecated. Some unit tests for VFS fail with implicit mode and it is not yet clear if its a problem with Commons VFS/Commons Net or our test server Apache FTP/SSHD.

Parameters:

opts - The FileSystemOptions.

ftpsMode - The mode to establish a FTPS connection.

Since:

2.1

See Also:

Wikipedia: FTPS/Implicit

getFtpsMode

public FtpsMode getFtpsMode(FileSystemOptions opts)

Return the FTPS mode. Defaults to "explicit" if not defined.

Parameters:

opts - The FileSystemOptions.

Returns:

The file type.

See Also:

setFtpsType(org.apache.commons.vfs2.FileSystemOptions, java.lang.String)

setKeyStore

public void setKeyStore(FileSystemOptions opts,
                        String keyStore)

Set the key store.

Parameters:

opts - The FileSystemOptions.

keyStore - The path for the keyStore.

getKeyStore

public String getKeyStore(FileSystemOptions opts)

get the keyStore path.

Parameters:

opts - The FileSystemOptions.

Returns:

the key store path.

setTrustStore

public void setTrustStore(FileSystemOptions opts,
                          String trustStore)

Set the key store.

Parameters:

opts - The FileSystemOptions.

trustStore - The path for the keyStore.

getTrustStore

public String getTrustStore(FileSystemOptions opts)

get the keyStore path.

Parameters:

opts - The FileSystemOptions.

Returns:

the key store path.

setKeyStorePW

public void setKeyStorePW(FileSystemOptions opts,
                          String keyStorePW)

Set the key store password.

Parameters:

opts - The FileSystemOptions.

keyStorePW - The keyStore password.

getKeyStorePW

public String getKeyStorePW(FileSystemOptions opts)

get the keyStore password.

Parameters:

opts - The FileSystemOptions.

Returns:

the key store password.

setTrustStorePW

public void setTrustStorePW(FileSystemOptions opts,
                            String trustStorePW)

Set the trust store password.

Parameters:

opts - The FileSystemOptions.

trustStorePW - The trustStore password.

getTrustStorePW

public String getTrustStorePW(FileSystemOptions opts)

get the trustStore password.

Parameters:

opts - The FileSystemOptions.

Returns:

the trust store password.

setKeyPW

public void setKeyPW(FileSystemOptions opts,
                     String keyPW)

Set the Key password.

Parameters:

opts - The FileSystemOptions.

keyPW - The key password.

getKeyPW

public String getKeyPW(FileSystemOptions opts)

get the key password.

Parameters:

opts - The FileSystemOptions.

Returns:

the key password.

setFtpsType

@Deprecated
public void setFtpsType(FileSystemOptions opts,
                                    String ftpsType)

Deprecated. As of 2.1, use setFtpsMode(FileSystemOptions, FtpsMode)

Set FTPS type, either "implicit" or "explicit".

Note, that implicit mode is not standardized and considered as deprecated. Some unit tests for VFS fail with implicit mode and it is not yet clear if its a problem with Commons VFS/Commons Net or our test server Apache FTP/SSHD.

Parameters:

opts - The FileSystemOptions.

ftpsType - The file type.

See Also:

Wikipedia: FTPS/Implicit

getFtpsType

@Deprecated
public String getFtpsType(FileSystemOptions opts)

Deprecated. As of 2.1, use getFtpsMode(FileSystemOptions)

Return the FTPS type. Defaults to "explicit" if not defined.

Parameters:

opts - The FileSystemOptions.

Returns:

The file type.

See Also:

setFtpsType(org.apache.commons.vfs2.FileSystemOptions, java.lang.String)

getDataChannelProtectionLevel

public FtpsDataChannelProtectionLevel getDataChannelProtectionLevel(FileSystemOptions opts)

Gets the data channel protection level (PROT).

Parameters:

opts - The FileSystemOptions.

Returns:

The PROT value.

Since:

2.1

See Also:

FTPSClient.execPROT(String)

setDataChannelProtectionLevel

public void setDataChannelProtectionLevel(FileSystemOptions opts,
                                          FtpsDataChannelProtectionLevel prot)

Sets the data channel protection level (PROT).

Parameters:

opts - The FileSystemOptions.

prot - The PROT value, null has no effect.

Since:

2.1

See Also:

FTPSClient.execPROT(String)

getKeyManager

public KeyManager getKeyManager(FileSystemOptions opts)

Gets the KeyManager used to provide a client-side certificate if the FTPS server requests it.

Parameters:

opts - The FileSystemOptions.

Returns:

the key manager instance or null

Since:

2.1

See Also:

FTPSClient.setKeyManager(KeyManager)

setKeyManager

public void setKeyManager(FileSystemOptions opts,
                          KeyManager keyManager)

Sets the KeyManager used to provide a client-side certificate if the FTPS server requests it.

Parameters:

opts - The FileSystemOptions.

keyManager - The key manager instance.

Since:

2.1

See Also:

FTPSClient.setKeyManager(KeyManager)

getTrustManager

public TrustManager getTrustManager(FileSystemOptions opts)

Gets the TrustManager that validates the FTPS server's certificate.

If the params do not contain the key for the trust manager, it will return a trust manger that simply checks this certificate for validity.

Parameters:

opts - The FileSystemOptions.

Returns:

the trust manager instance or null

Since:

2.1

See Also:

FTPSClient.setTrustManager(TrustManager)

setTrustManager

public void setTrustManager(FileSystemOptions opts,
                            TrustManager trustManager)

Sets the TrustManager that validates the FTPS server's certificate.

Parameters:

opts - The FileSystemOptions.

trustManager - The trust manager instance.

Since:

2.1

See Also:

FTPSClient.setTrustManager(TrustManager)