|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.vfs2.FileSystemConfigBuilder
org.apache.commons.vfs2.provider.ftp.FtpFileSystemConfigBuilder
public final class FtpFileSystemConfigBuilder
The config BUILDER for various ftp configuration options.
Method Summary | |
---|---|
protected Class<? extends FileSystem> |
getConfigClass()
|
String |
getControlEncoding(FileSystemOptions opts)
|
Integer |
getDataTimeout(FileSystemOptions opts)
|
String |
getDefaultDateFormat(FileSystemOptions opts)
get the language code used by the server. |
String |
getEntryParser(FileSystemOptions opts)
|
org.apache.commons.net.ftp.parser.FTPFileEntryParserFactory |
getEntryParserFactory(FileSystemOptions opts)
|
static FtpFileSystemConfigBuilder |
getInstance()
|
Boolean |
getPassiveMode(FileSystemOptions opts)
|
String |
getRecentDateFormat(FileSystemOptions opts)
see FTPClientConfig for details and examples. |
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)
|
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. If you set the dataTimeout to null 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 parsing. |
void |
setPassiveMode(FileSystemOptions opts,
boolean passiveMode)
enter into passive mode. |
void |
setRecentDateFormat(FileSystemOptions opts,
String recentDateFormat)
see FTPClientConfig for details and examples. |
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)
set the socket timeout for the ftp client. If you set the socketTimeout to null no socketTimeout will be set on the
ftp client. |
void |
setUserDirIsRoot(FileSystemOptions opts,
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, getFloat, getFloat, getFloat, getInteger, getInteger, getInteger, getLong, getLong, getLong, getParam, getRootURI, getShort, getShort, getShort, getString, getString, hasObject, hasParam, setParam, setRootURI |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static FtpFileSystemConfigBuilder getInstance()
public void setEntryParserFactory(FileSystemOptions opts, org.apache.commons.net.ftp.parser.FTPFileEntryParserFactory factory)
opts
- The FileSystemOptions.factory
- instance of your factorypublic 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 void setEntryParser(FileSystemOptions opts, String key)
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 String getEntryParser(FileSystemOptions opts)
opts
- The FileSystemOptions.
setEntryParser(org.apache.commons.vfs2.FileSystemOptions, java.lang.String)
protected Class<? extends FileSystem> getConfigClass()
getConfigClass
in class FileSystemConfigBuilder
public void setPassiveMode(FileSystemOptions opts, boolean passiveMode)
opts
- The FileSystemOptions.passiveMode
- true if passive mode should be used.public Boolean getPassiveMode(FileSystemOptions opts)
opts
- The FileSystemOptions.
setPassiveMode(org.apache.commons.vfs2.FileSystemOptions, boolean)
public void setUserDirIsRoot(FileSystemOptions opts, boolean userDirIsRoot)
opts
- The FileSystemOptions.userDirIsRoot
- true if the user directory should be treated as the root.public Boolean getUserDirIsRoot(FileSystemOptions opts)
opts
- The FileSystemOptions.
setUserDirIsRoot(org.apache.commons.vfs2.FileSystemOptions, boolean)
public Integer getDataTimeout(FileSystemOptions opts)
opts
- The FileSystemOptions.
setDataTimeout(org.apache.commons.vfs2.FileSystemOptions, java.lang.Integer)
public void setDataTimeout(FileSystemOptions opts, Integer dataTimeout)
null
no dataTimeout will be set on the
ftp client.
opts
- The FileSystemOptions.dataTimeout
- The timeout value.public Integer getSoTimeout(FileSystemOptions opts)
opts
- The FileSystem options.
getDataTimeout(org.apache.commons.vfs2.FileSystemOptions)
public void setSoTimeout(FileSystemOptions opts, Integer soTimeout)
null
no socketTimeout will be set on the
ftp client.
opts
- The FileSystem options.soTimeout
- The timeout value.public String getServerLanguageCode(FileSystemOptions opts)
FTPClientConfig
for details and examples.
opts
- The FilesystemOptions.
public void setServerLanguageCode(FileSystemOptions opts, String serverLanguageCode)
FTPClientConfig
for details and examples.
opts
- The FileSystemOptions.serverLanguageCode
- The servers language code.public String getDefaultDateFormat(FileSystemOptions opts)
FTPClientConfig
for details and examples.
opts
- The FileSystemOptions
public void setDefaultDateFormat(FileSystemOptions opts, String defaultDateFormat)
FTPClientConfig
for details and examples.
opts
- The FileSystemOptions.defaultDateFormat
- The default date format.public String getRecentDateFormat(FileSystemOptions opts)
FTPClientConfig
for details and examples.
opts
- The FileSystemOptions.
public void setRecentDateFormat(FileSystemOptions opts, String recentDateFormat)
FTPClientConfig
for details and examples.
opts
- The FileSystemOptions.recentDateFormat
- The recent date format.public String getServerTimeZoneId(FileSystemOptions opts)
FTPClientConfig
for details and examples.
opts
- The FileSystemOptions.
public void setServerTimeZoneId(FileSystemOptions opts, String serverTimeZoneId)
FTPClientConfig
for details and examples.
opts
- The FileSystemOptions.serverTimeZoneId
- The server timezone id.public String[] getShortMonthNames(FileSystemOptions opts)
FTPClientConfig
for details and examples.
opts
- The FileSystemOptions.
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 setControlEncoding(FileSystemOptions opts, String encoding)
FTP.setControlEncoding(java.lang.String)
for details and examples.
opts
- The FileSystemOptions.encoding
- the encoding to usepublic String getControlEncoding(FileSystemOptions opts)
opts
- The FileSystemOptions.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |