Package org.apache.commons.vfs2.provider.ftp

Class FtpFileSystemConfigBuilder

java.lang.Object

org.apache.commons.vfs2.FileSystemConfigBuilder

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

Direct Known Subclasses:

FtpsFileSystemConfigBuilder

public class FtpFileSystemConfigBuilder
extends FileSystemConfigBuilder

The config builder for various FTP configuration options.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FtpFileSystemConfigBuilder(String prefix)	Create new config builder with specified prefix string.

Method Summary

Modifier and Type	Method	Description
org.apache.commons.lang3.Range<Integer>	getActivePortRange(FileSystemOptions options)	Gets the active port range.
Boolean	getAutodetectUtf8(FileSystemOptions options)	Gets whether to try to autodetect the server encoding (only UTF8 is supported).
protected Class<? extends FileSystem>	getConfigClass()	Gets the target of this configuration.
Integer	getConnectTimeout(FileSystemOptions options)	Deprecated. Use getConnectTimeoutDuration(FileSystemOptions).
Duration	getConnectTimeoutDuration(FileSystemOptions options)	Gets the timeout in milliseconds to use for the socket connection.
String	getControlEncoding(FileSystemOptions options)	Gets the control encoding.
Duration	getControlKeepAliveReplyTimeout(FileSystemOptions options)	Gets the controlKeepAliveReplyTimeout duration.
Duration	getControlKeepAliveTimeout(FileSystemOptions options)	Gets the controlKeepAliveTimeout duration.
Integer	getDataTimeout(FileSystemOptions options)	Deprecated. Use getDataTimeoutDuration(FileSystemOptions).
Duration	getDataTimeoutDuration(FileSystemOptions options)	Gets the timeout for opening the data channel.
String	getDefaultDateFormat(FileSystemOptions options)	Gets the default date format used by the server.
String	getEntryParser(FileSystemOptions options)	Gets the key to the EntryParser.
org.apache.commons.net.ftp.parser.FTPFileEntryParserFactory	getEntryParserFactory(FileSystemOptions options)	Gets the FTPFileEntryParserFactory parameter.
FtpFileType	getFileType(FileSystemOptions options)	Gets the file type parameter.
static FtpFileSystemConfigBuilder	getInstance()	Gets the singleton instance.
Boolean	getMdtmLastModifiedTime(FileSystemOptions options)	Gets the option to use FTP MDTM for FileContent.getLastModifiedTime().
Boolean	getPassiveMode(FileSystemOptions options)	Tests whether passive mode is set.
Proxy	getProxy(FileSystemOptions options)	Gets the Proxy.
String	getRecentDateFormat(FileSystemOptions options)	See FTPClientConfig for details and examples.
Boolean	getRemoteVerification(FileSystemOptions options)	Gets whether to use remote verification.
static List<Integer>	getSaneTransferAbortedOkReplyCodes()	Gets special retry code.
String	getServerLanguageCode(FileSystemOptions options)	Gets the language code used by the server.
String	getServerTimeZoneId(FileSystemOptions options)	See FTPClientConfig for details and examples.
String[]	getShortMonthNames(FileSystemOptions options)	See FTPClientConfig for details and examples.
Integer	getSoTimeout(FileSystemOptions options)	Deprecated. Use getSoTimeoutDuration(FileSystemOptions).
Duration	getSoTimeoutDuration(FileSystemOptions options)	Gets The so timeout duration.
List<Integer>	getTransferAbortedOkReplyCodes(FileSystemOptions options)	Gets the list of reply codes (apart from 200) that are considered as OK when prematurely closing a stream.
Boolean	getUserDirIsRoot(FileSystemOptions options)	Tests whether if VFS should treat the user directory as the root directory.
void	setActivePortRange(FileSystemOptions options, org.apache.commons.lang3.Range<Integer> portRange)	Sets the active port range.
void	setAutodetectUtf8(FileSystemOptions options, Boolean autodetectUTF8)	Sets whether to try to autodetect the server encoding (only UTF8 is supported).
void	setConnectTimeout(FileSystemOptions options, Integer duration)	Deprecated. Use setConnectTimeout(FileSystemOptions, Duration).
void	setConnectTimeout(FileSystemOptions options, Duration duration)	Sets the timeout for the initial control connection.
void	setControlEncoding(FileSystemOptions options, String encoding)	See FTP.setControlEncoding(java.lang.String) for details and examples.
void	setControlKeepAliveReplyTimeout(FileSystemOptions options, Duration duration)	Sets the control keep alive reply timeout for the FTP client.
void	setControlKeepAliveTimeout(FileSystemOptions options, Duration duration)	Sets the control keep alive timeout for the FTP client.
void	setDataTimeout(FileSystemOptions options, Integer duration)	Deprecated. Use setDataTimeout(FileSystemOptions, Duration).
void	setDataTimeout(FileSystemOptions options, Duration duration)	Sets the data timeout for the FTP client.
void	setDefaultDateFormat(FileSystemOptions options, String defaultDateFormat)	Sets the default date format used by the server.
void	setEntryParser(FileSystemOptions options, String key)	Sets the FQCN of your FileEntryParser used to parse the directory listing from your server.
void	setEntryParserFactory(FileSystemOptions options, org.apache.commons.net.ftp.parser.FTPFileEntryParserFactory factory)	FTPFileEntryParserFactory which will be used for ftp-entry parsing.
void	setFileType(FileSystemOptions options, FtpFileType ftpFileType)	Sets the file type parameter.
void	setMdtmLastModifiedTime(FileSystemOptions options, boolean mdtm)	Sets the option to use FTP MDTM for FileContent.getLastModifiedTime().
void	setPassiveMode(FileSystemOptions options, boolean passiveMode)	Enter into passive mode.
void	setProxy(FileSystemOptions options, Proxy proxy)	Sets the Proxy.
void	setRecentDateFormat(FileSystemOptions options, String recentDateFormat)	See FTPClientConfig for details and examples.
void	setRemoteVerification(FileSystemOptions options, boolean remoteVerification)	Sets whether to use remote verification.
void	setServerLanguageCode(FileSystemOptions options, String serverLanguageCode)	Sets the language code used by the server.
void	setServerTimeZoneId(FileSystemOptions options, String serverTimeZoneId)	See FTPClientConfig for details and examples.
void	setShortMonthNames(FileSystemOptions options, String[] shortMonthNames)	See FTPClientConfig for details and examples.
void	setSoTimeout(FileSystemOptions options, Integer timeout)	Deprecated. Use setSoTimeout(FileSystemOptions, Duration).
void	setSoTimeout(FileSystemOptions options, Duration timeout)	Sets the socket timeout for the FTP client.
void	setTransferAbortedOkReplyCodes(FileSystemOptions options, List<Integer> replyCodes)	Sets the list of reply codes that are considered as OK when prematurely closing a stream.
void	setUserDirIsRoot(FileSystemOptions options, boolean userDirIsRoot)	Use user directory as root (do not change to fs root).

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

FtpFileSystemConfigBuilder

protected FtpFileSystemConfigBuilder(String prefix)

Create new config builder with specified prefix string.

Parameters:

prefix - prefix string to use for parameters of this config builder.

Since:

2.1

Method Details

getInstance

public static FtpFileSystemConfigBuilder getInstance()

Gets the singleton instance.

Returns:

the singleton instance.

getSaneTransferAbortedOkReplyCodes

public static List<Integer> getSaneTransferAbortedOkReplyCodes()

Gets special retry code. See VFS-674, its accompanying PR and https://github.com/apache/commons-vfs/pull/51 as to why 426 and 550 are here.

Returns:

special retry code.

getActivePortRange

public org.apache.commons.lang3.Range<Integer> getActivePortRange(FileSystemOptions options)

Gets the active port range.

Parameters:

options - The FileSystemOptions.

Returns:

the Range of active ports

Since:

2.10.0

getAutodetectUtf8

public Boolean getAutodetectUtf8(FileSystemOptions options)

Gets whether to try to autodetect the server encoding (only UTF8 is supported).

Parameters:

options - The FileSystemOptions.

Returns:

True if autodetection should be done.

Since:

2.4

getConfigClass

protected Class<? extends FileSystem> getConfigClass()

Description copied from class: FileSystemConfigBuilder

Gets the target of this configuration.

Specified by:

getConfigClass in class FileSystemConfigBuilder

Returns:

the specific file system class

getConnectTimeout

@Deprecated
public Integer getConnectTimeout(FileSystemOptions options)

Deprecated.

Use getConnectTimeoutDuration(FileSystemOptions).

Gets the timeout in milliseconds to use for the socket connection.

Parameters:

options - The FileSystemOptions.

Returns:

The timeout in milliseconds to use for the socket connection.

Since:

2.1

getConnectTimeoutDuration

public Duration getConnectTimeoutDuration(FileSystemOptions options)

Gets the timeout in milliseconds to use for the socket connection.

Parameters:

options - The FileSystemOptions.

Returns:

The timeout in milliseconds to use for the socket connection.

Since:

2.8.0

getControlEncoding

public String getControlEncoding(FileSystemOptions options)

Gets the control encoding.

Parameters:

options - The FileSystemOptions.

Returns:

The control encoding.

Since:

2.0

getControlKeepAliveReplyTimeout

public Duration getControlKeepAliveReplyTimeout(FileSystemOptions options)

Gets the controlKeepAliveReplyTimeout duration.

Parameters:

options - The FileSystem options

Returns:

The controlKeepAliveReplyTimeout duration.

Since:

2.8.0

getControlKeepAliveTimeout

public Duration getControlKeepAliveTimeout(FileSystemOptions options)

Gets the controlKeepAliveTimeout duration.

Parameters:

options - The FileSystem options

Returns:

The controlKeepAliveTimeout duration.

Since:

2.8.0

getDataTimeout

@Deprecated
public Integer getDataTimeout(FileSystemOptions options)

Deprecated.

Use getDataTimeoutDuration(FileSystemOptions).

Gets timeout for opening the data channel in milliseconds.

Parameters:

options - The FileSystemOptions.

Returns:

The timeout for opening the data channel in milliseconds.

See Also:

• setDataTimeout(org.apache.commons.vfs2.FileSystemOptions, java.time.Duration)

getDataTimeoutDuration

public Duration getDataTimeoutDuration(FileSystemOptions options)

Gets the timeout for opening the data channel.

Parameters:

options - The FileSystemOptions.

Returns:

The timeout for opening the data channel.

Since:

2.8.0

See Also:

• setDataTimeout(org.apache.commons.vfs2.FileSystemOptions, java.time.Duration)

getDefaultDateFormat

public String getDefaultDateFormat(FileSystemOptions options)

Gets the default date format used by the server. See FTPClientConfig for details and examples.

Parameters:

options - The FileSystemOptions

Returns:

The default date format.

getEntryParser

public String getEntryParser(FileSystemOptions options)

Gets the key to the EntryParser.

Parameters:

options - The FileSystemOptions.

Returns:

the key to the EntryParser.

See Also:

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

getEntryParserFactory

public org.apache.commons.net.ftp.parser.FTPFileEntryParserFactory getEntryParserFactory(FileSystemOptions options)

Gets the FTPFileEntryParserFactory parameter.

Parameters:

options - The FileSystemOptions.

Returns:

The FTPFileEntryParserFactory parameter.

See Also:

• setEntryParserFactory(org.apache.commons.vfs2.FileSystemOptions, org.apache.commons.net.ftp.parser.FTPFileEntryParserFactory)

getFileType

public FtpFileType getFileType(FileSystemOptions options)

Gets the file type parameter.

Parameters:

options - The FileSystemOptions.

Returns:

A FtpFileType

Since:

2.1

getMdtmLastModifiedTime

public Boolean getMdtmLastModifiedTime(FileSystemOptions options)

Gets the option to use FTP MDTM for FileContent.getLastModifiedTime().

Parameters:

options - The FileSystemOptions.

Returns:

true if MDTM should be used.

Since:

2.8.0

getPassiveMode

public Boolean getPassiveMode(FileSystemOptions options)

Tests whether passive mode is set.

Parameters:

options - The FileSystemOptions.

Returns:

whether passive mode is set.

See Also:

• setPassiveMode(org.apache.commons.vfs2.FileSystemOptions, boolean)

getProxy

public Proxy getProxy(FileSystemOptions options)

Gets the Proxy.

Parameters:

options - The FileSystemOptions.

Returns:

the Proxy

Since:

2.1

getRecentDateFormat

public String getRecentDateFormat(FileSystemOptions options)

See FTPClientConfig for details and examples.

Parameters:

options - The FileSystemOptions.

Returns:

The recent date format.

getRemoteVerification

public Boolean getRemoteVerification(FileSystemOptions options)

Gets whether to use remote verification.

Parameters:

options - The FileSystemOptions.

Returns:

True if remote verification should be done.

getServerLanguageCode

public String getServerLanguageCode(FileSystemOptions options)

Gets the language code used by the server. See FTPClientConfig for details and examples.

Parameters:

options - The FilesystemOptions.

Returns:

The language code of the server.

getServerTimeZoneId

public String getServerTimeZoneId(FileSystemOptions options)

See FTPClientConfig for details and examples.

Parameters:

options - The FileSystemOptions.

Returns:

The server timezone id.

getShortMonthNames

public String[] getShortMonthNames(FileSystemOptions options)

See FTPClientConfig for details and examples.

Parameters:

options - The FileSystemOptions.

Returns:

An array of short month names.

getSoTimeout

@Deprecated
public Integer getSoTimeout(FileSystemOptions options)

Deprecated.

Use getSoTimeoutDuration(FileSystemOptions).

Gets The so timeout duration in milliseconds.

Parameters:

options - The FileSystem options.

Returns:

The so timeout duration in milliseconds.

Since:

2.0

See Also:

• getDataTimeout(org.apache.commons.vfs2.FileSystemOptions)

getSoTimeoutDuration

public Duration getSoTimeoutDuration(FileSystemOptions options)

Gets The so timeout duration.

Parameters:

options - The FileSystem options.

Returns:

The timeout value in milliseconds.

Since:

2.8.0

See Also:

• getDataTimeout(org.apache.commons.vfs2.FileSystemOptions)

getTransferAbortedOkReplyCodes

public List<Integer> getTransferAbortedOkReplyCodes(FileSystemOptions options)

Gets the list of reply codes (apart from 200) that are considered as OK when prematurely closing a stream.

Parameters:

options - The FileSystem options.

Returns:

The list of reply codes (apart from 200) that are considered as OK when prematurely closing a stream.

Since:

2.4

getUserDirIsRoot

public Boolean getUserDirIsRoot(FileSystemOptions options)

Tests whether if VFS should treat the user directory as the root directory. Defaults to Boolean.TRUE if the method setUserDirIsRoot(FileSystemOptions, boolean) has not been invoked.

Parameters:

options - The FileSystemOptions.

Returns:

Boolean.TRUE if VFS treats the user directory as the root directory.

See Also:

• setUserDirIsRoot(org.apache.commons.vfs2.FileSystemOptions, boolean)

setActivePortRange

public void setActivePortRange(FileSystemOptions options,
 org.apache.commons.lang3.Range<Integer> portRange)

Sets the active port range.

Parameters:

options - The FileSystemOptions.

portRange - the Range of active ports

Since:

2.10.0

setAutodetectUtf8

public void setAutodetectUtf8(FileSystemOptions options,
 Boolean autodetectUTF8)

Sets whether to try to autodetect the server encoding (only UTF8 is supported).

Parameters:

options - The FileSystemOptions.

autodetectUTF8 - true if autodetection should be done.

Since:

2.4

setConnectTimeout

public void setConnectTimeout(FileSystemOptions options,
 Duration duration)

Sets the timeout for the initial control connection.

If you set the connectTimeout to null no connectTimeout will be set.

Parameters:

options - The FileSystemOptions.

duration - the timeout duration in milliseconds

Since:

2.8.0

setConnectTimeout

@Deprecated
public void setConnectTimeout(FileSystemOptions options,
 Integer duration)

Deprecated.

Use setConnectTimeout(FileSystemOptions, Duration).

Sets the timeout for the initial control connection.

If you set the connectTimeout to null no connectTimeout will be set.

Parameters:

options - The FileSystemOptions.

duration - the timeout duration.

Since:

2.1

setControlEncoding

public void setControlEncoding(FileSystemOptions options,
 String encoding)

See FTP.setControlEncoding(java.lang.String) for details and examples.

Parameters:

options - The FileSystemOptions.

encoding - the encoding to use

Since:

2.0

setControlKeepAliveReplyTimeout

public void setControlKeepAliveReplyTimeout(FileSystemOptions options,
 Duration duration)

Sets the control keep alive reply timeout for the FTP client.

Parameters:

options - The FileSystem options.

duration - timeout duration.

Since:

2.8.0

setControlKeepAliveTimeout

public void setControlKeepAliveTimeout(FileSystemOptions options,
 Duration duration)

Sets the control keep alive timeout for the FTP client.

Sets the controlKeepAliveTimeout to ensure the socket be alive after download huge file.

Parameters:

options - The FileSystem options.

duration - The timeout duration.

Since:

2.8.0

setDataTimeout

public void setDataTimeout(FileSystemOptions options,
 Duration duration)

Sets the data timeout for the FTP client.

If you set the dataTimeout to null, no dataTimeout will be set on the FTP client.

Parameters:

options - The FileSystemOptions.

duration - The timeout duration.

Since:

2.8.0

setDataTimeout

@Deprecated
public void setDataTimeout(FileSystemOptions options,
 Integer duration)

Deprecated.

Use setDataTimeout(FileSystemOptions, Duration).

Sets the data timeout for the FTP client.

If you set the dataTimeout to null, no dataTimeout will be set on the FTP client.

Parameters:

options - The FileSystemOptions.

duration - The timeout value.

setDefaultDateFormat

public void setDefaultDateFormat(FileSystemOptions options,
 String defaultDateFormat)

Sets the default date format used by the server. See FTPClientConfig for details and examples.

Parameters:

options - The FileSystemOptions.

defaultDateFormat - The default date format.

setEntryParser

public void setEntryParser(FileSystemOptions options,
 String key)

Sets the FQCN of your FileEntryParser used to parse the directory listing from your server.

If you do not use the default commons-net FTPFileEntryParserFactory e.g. by using setEntryParserFactory(org.apache.commons.vfs2.FileSystemOptions, org.apache.commons.net.ftp.parser.FTPFileEntryParserFactory) this is the "key" parameter passed as argument into your custom factory.

Parameters:

options - The FileSystemOptions.

key - The key.

setEntryParserFactory

public void setEntryParserFactory(FileSystemOptions options,
 org.apache.commons.net.ftp.parser.FTPFileEntryParserFactory factory)

FTPFileEntryParserFactory which will be used for ftp-entry parsing.

Parameters:

options - The FileSystemOptions.

factory - instance of your factory

setFileType

public void setFileType(FileSystemOptions options,
 FtpFileType ftpFileType)

Sets the file type parameter.

Parameters:

options - The FileSystemOptions.

ftpFileType - A FtpFileType

Since:

2.1

setMdtmLastModifiedTime

public void setMdtmLastModifiedTime(FileSystemOptions options,
 boolean mdtm)

Sets the option to use FTP MDTM for FileContent.getLastModifiedTime().

Parameters:

options - The FileSystemOptions.

mdtm - true if MDTM should be used.

Since:

2.8.0

setPassiveMode

public void setPassiveMode(FileSystemOptions options,
 boolean passiveMode)

Enter into passive mode.

Parameters:

options - The FileSystemOptions.

passiveMode - true if passive mode should be used.

setProxy

public void setProxy(FileSystemOptions options,
 Proxy proxy)

Sets the Proxy.

You might need to make sure that passive mode is activated.

Parameters:

options - the FileSystem options.

proxy - the Proxy

Since:

2.1

setRecentDateFormat

public void setRecentDateFormat(FileSystemOptions options,
 String recentDateFormat)

See FTPClientConfig for details and examples.

Parameters:

options - The FileSystemOptions.

recentDateFormat - The recent date format.

setRemoteVerification

public void setRemoteVerification(FileSystemOptions options,
 boolean remoteVerification)

Sets whether to use remote verification.

Parameters:

options - The FileSystemOptions.

remoteVerification - True if verification should be done.

setServerLanguageCode

public void setServerLanguageCode(FileSystemOptions options,
 String serverLanguageCode)

Sets the language code used by the server. See FTPClientConfig for details and examples.

Parameters:

options - The FileSystemOptions.

serverLanguageCode - The servers language code.

setServerTimeZoneId

public void setServerTimeZoneId(FileSystemOptions options,
 String serverTimeZoneId)

See FTPClientConfig for details and examples.

Parameters:

options - The FileSystemOptions.

serverTimeZoneId - The server timezone id.

setShortMonthNames

public void setShortMonthNames(FileSystemOptions options,
 String[] shortMonthNames)

See FTPClientConfig for details and examples.

Parameters:

options - The FileSystemOptions.

shortMonthNames - an array of short month name Strings.

setSoTimeout

public void setSoTimeout(FileSystemOptions options,
 Duration timeout)

Sets the socket timeout for the FTP client.

If you set the soTimeout to null, no socket timeout will be set on the FTP client.

Parameters:

options - The FileSystem options.

timeout - The timeout value in milliseconds.

Since:

2.8.0

setSoTimeout

@Deprecated
public void setSoTimeout(FileSystemOptions options,
 Integer timeout)

Deprecated.

Use setSoTimeout(FileSystemOptions, Duration).

Sets the socket timeout for the FTP client.

If you set the soTimeout to null, no socket timeout will be set on the FTP client.

Parameters:

options - The FileSystem options.

timeout - The timeout value in milliseconds.

Since:

2.0

setTransferAbortedOkReplyCodes

public void setTransferAbortedOkReplyCodes(FileSystemOptions options,
 List<Integer> replyCodes)

Sets the list of reply codes that are considered as OK when prematurely closing a stream.

If you set the replyCodes to an empty list, all reply codes besides 200 will be considered as an error.

Parameters:

options - The FileSystem options.

replyCodes - The reply codes.

Since:

2.4

setUserDirIsRoot

public void setUserDirIsRoot(FileSystemOptions options,
 boolean userDirIsRoot)

Use user directory as root (do not change to fs root).

Parameters:

options - The FileSystemOptions.

userDirIsRoot - true if the user directory should be treated as the root.