public class FtpFileSystemConfigBuilder extends FileSystemConfigBuilder
Modifier | Constructor and Description |
---|---|
protected |
FtpFileSystemConfigBuilder(String prefix)
Create new config builder with specified prefix string.
|
Modifier and Type | Method and Description |
---|---|
protected Class<? extends FileSystem> |
getConfigClass()
Get the target of this configuration.
|
Integer |
getConnectTimeout(FileSystemOptions opts)
Gets the timeout in milliseconds to use for the socket connection.
|
String |
getControlEncoding(FileSystemOptions opts) |
Integer |
getDataTimeout(FileSystemOptions opts) |
String |
getDefaultDateFormat(FileSystemOptions opts)
Get the default date format used by the server.
|
String |
getEntryParser(FileSystemOptions opts) |
org.apache.commons.net.ftp.parser.FTPFileEntryParserFactory |
getEntryParserFactory(FileSystemOptions opts) |
FtpFileType |
getFileType(FileSystemOptions opts)
Gets the file type parameter.
|
static FtpFileSystemConfigBuilder |
getInstance()
Gets the singleton instance.
|
Boolean |
getPassiveMode(FileSystemOptions opts) |
Proxy |
getProxy(FileSystemOptions opts)
Gets the Proxy.
|
String |
getRecentDateFormat(FileSystemOptions opts)
See
FTPClientConfig for details and examples. |
Boolean |
getRemoteVerification(FileSystemOptions opts)
Gets whether to use remote verification.
|
String |
getServerLanguageCode(FileSystemOptions opts)
Get the language code used by the server.
|
String |
getServerTimeZoneId(FileSystemOptions opts)
See
FTPClientConfig for details and examples. |
String[] |
getShortMonthNames(FileSystemOptions opts)
See
FTPClientConfig for details and examples. |
Integer |
getSoTimeout(FileSystemOptions opts) |
Boolean |
getUserDirIsRoot(FileSystemOptions opts)
Returns
Boolean.TRUE if VFS should treat the user directory as the root directory. |
void |
setConnectTimeout(FileSystemOptions opts,
Integer connectTimeout)
Sets the timeout for the initial control connection.
|
void |
setControlEncoding(FileSystemOptions opts,
String encoding)
See
FTP.setControlEncoding(java.lang.String) for details and examples. |
void |
setDataTimeout(FileSystemOptions opts,
Integer dataTimeout)
Set the data timeout for the ftp client.
|
void |
setDefaultDateFormat(FileSystemOptions opts,
String defaultDateFormat)
Set the default date format used by the server.
|
void |
setEntryParser(FileSystemOptions opts,
String key)
Set the FQCN of your FileEntryParser used to parse the directory listing from your server.
|
void |
setEntryParserFactory(FileSystemOptions opts,
org.apache.commons.net.ftp.parser.FTPFileEntryParserFactory factory)
FTPFileEntryParserFactory which will be used for ftp-entry parsing.
|
void |
setFileType(FileSystemOptions opts,
FtpFileType ftpFileType)
Sets the file type parameter.
|
void |
setPassiveMode(FileSystemOptions opts,
boolean passiveMode)
Enter into passive mode.
|
void |
setProxy(FileSystemOptions opts,
Proxy proxy)
Sets the Proxy.
|
void |
setRecentDateFormat(FileSystemOptions opts,
String recentDateFormat)
See
FTPClientConfig for details and examples. |
void |
setRemoteVerification(FileSystemOptions opts,
boolean remoteVerification)
Sets whether to use remote verification.
|
void |
setServerLanguageCode(FileSystemOptions opts,
String serverLanguageCode)
Set the language code used by the server.
|
void |
setServerTimeZoneId(FileSystemOptions opts,
String serverTimeZoneId)
See
FTPClientConfig for details and examples. |
void |
setShortMonthNames(FileSystemOptions opts,
String[] shortMonthNames)
See
FTPClientConfig for details and examples. |
void |
setSoTimeout(FileSystemOptions opts,
Integer soTimeout)
Sets the socket timeout for the FTP client.
|
void |
setUserDirIsRoot(FileSystemOptions opts,
boolean userDirIsRoot)
Use user directory as root (do not change to fs root).
|
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
protected FtpFileSystemConfigBuilder(String prefix)
prefix
- prefix string to use for parameters of this config builder.public static FtpFileSystemConfigBuilder getInstance()
protected Class<? extends FileSystem> getConfigClass()
FileSystemConfigBuilder
getConfigClass
in class FileSystemConfigBuilder
public Integer getConnectTimeout(FileSystemOptions opts)
opts
- The FileSystemOptions.public String getControlEncoding(FileSystemOptions opts)
opts
- The FileSystemOptions.public Integer getDataTimeout(FileSystemOptions opts)
opts
- The FileSystemOptions.setDataTimeout(org.apache.commons.vfs2.FileSystemOptions, java.lang.Integer)
public String getDefaultDateFormat(FileSystemOptions opts)
FTPClientConfig
for details and examples.opts
- The FileSystemOptionspublic String getEntryParser(FileSystemOptions opts)
opts
- The FileSystemOptions.setEntryParser(org.apache.commons.vfs2.FileSystemOptions, java.lang.String)
public org.apache.commons.net.ftp.parser.FTPFileEntryParserFactory getEntryParserFactory(FileSystemOptions opts)
opts
- The FlleSystemOptions.setEntryParserFactory(org.apache.commons.vfs2.FileSystemOptions, org.apache.commons.net.ftp.parser.FTPFileEntryParserFactory)
public FtpFileType getFileType(FileSystemOptions opts)
opts
- The FileSystemOptions.public Boolean getPassiveMode(FileSystemOptions opts)
opts
- The FileSystemOptions.setPassiveMode(org.apache.commons.vfs2.FileSystemOptions, boolean)
public Proxy getProxy(FileSystemOptions opts)
opts
- The FileSystemOptions.public String getRecentDateFormat(FileSystemOptions opts)
FTPClientConfig
for details and examples.opts
- The FileSystemOptions.public Boolean getRemoteVerification(FileSystemOptions opts)
opts
- The FileSystemOptions.public String getServerLanguageCode(FileSystemOptions opts)
FTPClientConfig
for details and examples.opts
- The FilesystemOptions.public String getServerTimeZoneId(FileSystemOptions opts)
FTPClientConfig
for details and examples.opts
- The FileSystemOptions.public String[] getShortMonthNames(FileSystemOptions opts)
FTPClientConfig
for details and examples.opts
- The FileSystemOptions.public Integer getSoTimeout(FileSystemOptions opts)
opts
- The FileSystem options.getDataTimeout(org.apache.commons.vfs2.FileSystemOptions)
public Boolean getUserDirIsRoot(FileSystemOptions opts)
Boolean.TRUE
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.opts
- The FileSystemOptions.Boolean.TRUE
if VFS treats the user directory as the root directory.setUserDirIsRoot(org.apache.commons.vfs2.FileSystemOptions, boolean)
public void setConnectTimeout(FileSystemOptions opts, Integer connectTimeout)
If you set the connectTimeout to null
no connectTimeout will be set.
opts
- The FileSystemOptions.connectTimeout
- the timeout value in millisecondspublic void setControlEncoding(FileSystemOptions opts, String encoding)
FTP.setControlEncoding(java.lang.String)
for details and examples.opts
- The FileSystemOptions.encoding
- the encoding to usepublic void setDataTimeout(FileSystemOptions opts, Integer dataTimeout)
If you set the dataTimeout
to null
, no dataTimeout will be set on the
ftp client.
opts
- The FileSystemOptions.dataTimeout
- The timeout value.public void setDefaultDateFormat(FileSystemOptions opts, String defaultDateFormat)
FTPClientConfig
for details and examples.opts
- The FileSystemOptions.defaultDateFormat
- The default date format.public void setEntryParser(FileSystemOptions opts, String key)
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.
opts
- The FileSystemOptions.key
- The key.public void setEntryParserFactory(FileSystemOptions opts, org.apache.commons.net.ftp.parser.FTPFileEntryParserFactory factory)
opts
- The FileSystemOptions.factory
- instance of your factorypublic void setFileType(FileSystemOptions opts, FtpFileType ftpFileType)
opts
- The FileSystemOptions.ftpFileType
- A FtpFileTypepublic void setPassiveMode(FileSystemOptions opts, boolean passiveMode)
opts
- The FileSystemOptions.passiveMode
- true if passive mode should be used.public void setProxy(FileSystemOptions opts, Proxy proxy)
You might need to make sure that passive mode
is activated.
opts
- the FileSystem options.proxy
- the Proxypublic void setRecentDateFormat(FileSystemOptions opts, String recentDateFormat)
FTPClientConfig
for details and examples.opts
- The FileSystemOptions.recentDateFormat
- The recent date format.public void setRemoteVerification(FileSystemOptions opts, boolean remoteVerification)
opts
- The FileSystemOptions.remoteVerification
- True if verification should be done.public void setServerLanguageCode(FileSystemOptions opts, String serverLanguageCode)
FTPClientConfig
for details and examples.opts
- The FileSystemOptions.serverLanguageCode
- The servers language code.public void setServerTimeZoneId(FileSystemOptions opts, String serverTimeZoneId)
FTPClientConfig
for details and examples.opts
- The FileSystemOptions.serverTimeZoneId
- The server timezone id.public void setShortMonthNames(FileSystemOptions opts, String[] shortMonthNames)
FTPClientConfig
for details and examples.opts
- The FileSystemOptions.shortMonthNames
- an array of short month name Strings.public void setSoTimeout(FileSystemOptions opts, Integer soTimeout)
If you set the soTimeout
to null
, no socket timeout will be set on the
ftp client.
opts
- The FileSystem options.soTimeout
- The timeout value in milliseconds.public void setUserDirIsRoot(FileSystemOptions opts, boolean userDirIsRoot)
opts
- The FileSystemOptions.userDirIsRoot
- true if the user directory should be treated as the root.Copyright © 2002–2025 The Apache Software Foundation. All rights reserved.