Class FtpFileSystemConfigBuilder
java.lang.Object
org.apache.commons.vfs.FileSystemConfigBuilder
org.apache.commons.vfs.provider.ftp.FtpFileSystemConfigBuilder
The config builder for various ftp configuration options
- Version:
- $Revision: 480428 $ $Date: 2006-11-29 07:15:24 +0100 (Wed, 29 Nov 2006) $
- Author:
- Mario Ivankovits
-
Method Summary
Modifier and TypeMethodDescriptionprotected Class
get the language code used by the server.org.apache.commons.net.ftp.parser.FTPFileEntryParserFactory
static FtpFileSystemConfigBuilder
seeFTPClientConfig
for details and examples.get the language code used by the server.seeFTPClientConfig
for details and examples.String[]
seeFTPClientConfig
for details and examples.void
setDataTimeout
(FileSystemOptions opts, Integer dataTimeout) set the data timeout for the ftp client.
If you set the dataTimeout tonull
no dataTimeout will be set on the ftp client.void
setDefaultDateFormat
(FileSystemOptions opts, String defaultDateFormat) set the language code 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.
If you do not use the default commons-net FTPFileEntryParserFactory e.g.void
setEntryParserFactory
(FileSystemOptions opts, org.apache.commons.net.ftp.parser.FTPFileEntryParserFactory factory) FTPFileEntryParserFactory which will be used for ftp-entry parsingvoid
setPassiveMode
(FileSystemOptions opts, boolean passiveMode) enter into passive modevoid
setRecentDateFormat
(FileSystemOptions opts, String recentDateFormat) seeFTPClientConfig
for details and examples.void
setServerLanguageCode
(FileSystemOptions opts, String serverLanguageCode) set the language code used by the server.void
setServerTimeZoneId
(FileSystemOptions opts, String serverTimeZoneId) seeFTPClientConfig
for details and examples.void
setShortMonthNames
(FileSystemOptions opts, String[] shortMonthNames) seeFTPClientConfig
for details and examples.void
setUserDirIsRoot
(FileSystemOptions opts, boolean userDirIsRoot) use user directory as root (do not change to fs root)Methods inherited from class org.apache.commons.vfs.FileSystemConfigBuilder
getParam, hasParam, setParam
-
Method Details
-
getInstance
-
setEntryParserFactory
public void setEntryParserFactory(FileSystemOptions opts, org.apache.commons.net.ftp.parser.FTPFileEntryParserFactory factory) FTPFileEntryParserFactory which will be used for ftp-entry parsing- Parameters:
opts
-factory
- instance of your factory
-
getEntryParserFactory
public org.apache.commons.net.ftp.parser.FTPFileEntryParserFactory getEntryParserFactory(FileSystemOptions opts) - Parameters:
opts
-- See Also:
-
setEntryParser
set 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 usingsetEntryParserFactory(org.apache.commons.vfs.FileSystemOptions, org.apache.commons.net.ftp.parser.FTPFileEntryParserFactory)
this is the "key" parameter passed as argument into your custom factory- Parameters:
opts
-key
-
-
getEntryParser
- Parameters:
opts
-- See Also:
-
getConfigClass
- Specified by:
getConfigClass
in classFileSystemConfigBuilder
-
setPassiveMode
enter into passive mode- Parameters:
opts
-passiveMode
-
-
getPassiveMode
- Parameters:
opts
-- See Also:
-
setUserDirIsRoot
use user directory as root (do not change to fs root)- Parameters:
opts
-userDirIsRoot
-
-
getUserDirIsRoot
- Parameters:
opts
-- See Also:
-
getDataTimeout
- Parameters:
opts
-- See Also:
-
setDataTimeout
set the data timeout for the ftp client.
If you set the dataTimeout tonull
no dataTimeout will be set on the ftp client.- Parameters:
opts
-dataTimeout
-
-
getServerLanguageCode
get the language code used by the server. seeFTPClientConfig
for details and examples. -
setServerLanguageCode
set the language code used by the server. seeFTPClientConfig
for details and examples. -
getDefaultDateFormat
get the language code used by the server. seeFTPClientConfig
for details and examples. -
setDefaultDateFormat
set the language code used by the server. seeFTPClientConfig
for details and examples. -
getRecentDateFormat
seeFTPClientConfig
for details and examples. -
setRecentDateFormat
seeFTPClientConfig
for details and examples. -
getServerTimeZoneId
seeFTPClientConfig
for details and examples. -
setServerTimeZoneId
seeFTPClientConfig
for details and examples. -
getShortMonthNames
seeFTPClientConfig
for details and examples. -
setShortMonthNames
seeFTPClientConfig
for details and examples.
-