org.apache.commons.vfs2.provider.ftp

Class FtpFileSystemConfigBuilder

java.lang.Object

org.apache.commons.vfs2.FileSystemConfigBuilder

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

public final class FtpFileSystemConfigBuilder
extends FileSystemConfigBuilder

The config BUILDER for various ftp configuration options.

Version:

$Revision: 1036327 $ $Date: 2010-11-18 11:40:09 +0530 (Thu, 18 Nov 2010) $

Author:

Commons VFS team

Method Summary

Modifier and Type	Method and Description
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)
Integer	getFileType(FileSystemOptions opts) Get the file type of the file being transferred.
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	setFileType(FileSystemOptions opts, Integer fileType) Sets the file type of the file being transferred.
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

getInstance

public static FtpFileSystemConfigBuilder 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 - The FileSystemOptions.

factory - instance of your factory

getEntryParserFactory

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

Parameters:

opts - The FlleSystemOptions.

Returns:

An FTPFileEntryParserFactory.

See Also:

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

setEntryParser

public 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. 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:

opts - The FileSystemOptions.

key - The key.

getEntryParser

public String getEntryParser(FileSystemOptions opts)

Parameters:

opts - The FileSystemOptions.

Returns:

the key to the EntryParser.

See Also:

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

getConfigClass

protected Class<? extends FileSystem> getConfigClass()

Specified by:

getConfigClass in class FileSystemConfigBuilder

setPassiveMode

public void setPassiveMode(FileSystemOptions opts,
                           boolean passiveMode)

enter into passive mode.

Parameters:

opts - The FileSystemOptions.

passiveMode - true if passive mode should be used.

getPassiveMode

public Boolean getPassiveMode(FileSystemOptions opts)

Parameters:

opts - The FileSystemOptions.

Returns:

true if passive mode is set.

See Also:

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

setUserDirIsRoot

public void setUserDirIsRoot(FileSystemOptions opts,
                             boolean userDirIsRoot)

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

Parameters:

opts - The FileSystemOptions.

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

getUserDirIsRoot

public Boolean getUserDirIsRoot(FileSystemOptions opts)

Parameters:

opts - The FileSystemOptions.

Returns:

true if the user directory is treated as the root.

See Also:

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

getDataTimeout

public Integer getDataTimeout(FileSystemOptions opts)

Parameters:

opts - The FileSystemOptions.

Returns:

The timeout as an Integer.

See Also:

setDataTimeout(org.apache.commons.vfs2.FileSystemOptions, java.lang.Integer)

setDataTimeout

public 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.

Parameters:

opts - The FileSystemOptions.

dataTimeout - The timeout value.

getSoTimeout

public Integer getSoTimeout(FileSystemOptions opts)

Parameters:

opts - The FileSystem options.

Returns:

The timeout value.

Since:

2.0

See Also:

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

setSoTimeout

public 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.

Parameters:

opts - The FileSystem options.

soTimeout - The timeout value.

Since:

2.0

getServerLanguageCode

public String getServerLanguageCode(FileSystemOptions opts)

get the language code used by the server. see FTPClientConfig for details and examples.

Parameters:

opts - The FilesystemOptions.

Returns:

The language code of the server.

setServerLanguageCode

public void setServerLanguageCode(FileSystemOptions opts,
                                  String serverLanguageCode)

set the language code used by the server. see FTPClientConfig for details and examples.

Parameters:

opts - The FileSystemOptions.

serverLanguageCode - The servers language code.

getDefaultDateFormat

public String getDefaultDateFormat(FileSystemOptions opts)

get the language code used by the server. see FTPClientConfig for details and examples.

Parameters:

opts - The FileSystemOptions

Returns:

The default date format.

setDefaultDateFormat

public void setDefaultDateFormat(FileSystemOptions opts,
                                 String defaultDateFormat)

set the language code used by the server. see FTPClientConfig for details and examples.

Parameters:

opts - The FileSystemOptions.

defaultDateFormat - The default date format.

getRecentDateFormat

public String getRecentDateFormat(FileSystemOptions opts)

see FTPClientConfig for details and examples.

Parameters:

opts - The FileSystemOptions.

Returns:

The recent date format.

setRecentDateFormat

public void setRecentDateFormat(FileSystemOptions opts,
                                String recentDateFormat)

see FTPClientConfig for details and examples.

Parameters:

opts - The FileSystemOptions.

recentDateFormat - The recent date format.

getServerTimeZoneId

public String getServerTimeZoneId(FileSystemOptions opts)

see FTPClientConfig for details and examples.

Parameters:

opts - The FileSystemOptions.

Returns:

The server timezone id.

setServerTimeZoneId

public void setServerTimeZoneId(FileSystemOptions opts,
                                String serverTimeZoneId)

see FTPClientConfig for details and examples.

Parameters:

opts - The FileSystemOptions.

serverTimeZoneId - The server timezone id.

getShortMonthNames

public String[] getShortMonthNames(FileSystemOptions opts)

see FTPClientConfig for details and examples.

Parameters:

opts - The FileSystemOptions.

Returns:

An array of short month names.

setShortMonthNames

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

see FTPClientConfig for details and examples.

Parameters:

opts - The FileSystemOptions.

shortMonthNames - an array of short month name Strings.

setControlEncoding

public void setControlEncoding(FileSystemOptions opts,
                               String encoding)

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

Parameters:

opts - The FileSystemOptions.

encoding - the encoding to use

Since:

2.0

getControlEncoding

public String getControlEncoding(FileSystemOptions opts)

Parameters:

opts - The FileSystemOptions.

Returns:

The encoding.

Since:

2.0

setFileType

public void setFileType(FileSystemOptions opts,
                        Integer fileType)

Sets the file type of the file being transferred.

Parameters:

opts - The FileSystemOptions.

fileType - Type of the file being transferred

getFileType

public Integer getFileType(FileSystemOptions opts)

Get the file type of the file being transferred.

Parameters:

opts - The FileSystemOptions.

Returns:

Type of the file being transferred