org.apache.commons.vfs.provider.ftp
Class FtpFileSystemConfigBuilder

java.lang.Object
  extended by org.apache.commons.vfs.FileSystemConfigBuilder
      extended by org.apache.commons.vfs.provider.ftp.FtpFileSystemConfigBuilder

public class FtpFileSystemConfigBuilder
extends FileSystemConfigBuilder

The config builder for various ftp configuration options

Version:
$Revision: 480428 $ $Date: 2006-11-29 07:15:24 +0100 (Mi, 29 Nov 2006) $
Author:
Mario Ivankovits

Field Summary
private static FtpFileSystemConfigBuilder builder
           
private static java.lang.String DATA_TIMEOUT
           
private static java.lang.String DEFAULT_DATE_FORMAT
           
private static java.lang.String FACTORY_KEY
           
private static java.lang.String PASSIVE_MODE
           
private static java.lang.String RECENT_DATE_FORMAT
           
private static java.lang.String SERVER_LANGUAGE_CODE
           
private static java.lang.String SERVER_TIME_ZONE_ID
           
private static java.lang.String SHORT_MONTH_NAMES
           
private static java.lang.String USER_DIR_IS_ROOT
           
 
Constructor Summary
private FtpFileSystemConfigBuilder()
           
 
Method Summary
protected  java.lang.Class getConfigClass()
           
 java.lang.Integer getDataTimeout(FileSystemOptions opts)
           
 java.lang.String getDefaultDateFormat(FileSystemOptions opts)
          get the language code used by the server.
 java.lang.String getEntryParser(FileSystemOptions opts)
           
 org.apache.commons.net.ftp.parser.FTPFileEntryParserFactory getEntryParserFactory(FileSystemOptions opts)
           
static FtpFileSystemConfigBuilder getInstance()
           
 java.lang.Boolean getPassiveMode(FileSystemOptions opts)
           
 java.lang.String getRecentDateFormat(FileSystemOptions opts)
          see FTPClientConfig for details and examples.
 java.lang.String getServerLanguageCode(FileSystemOptions opts)
          get the language code used by the server.
 java.lang.String getServerTimeZoneId(FileSystemOptions opts)
          see FTPClientConfig for details and examples.
 java.lang.String[] getShortMonthNames(FileSystemOptions opts)
          see FTPClientConfig for details and examples.
 java.lang.Boolean getUserDirIsRoot(FileSystemOptions opts)
           
 void setDataTimeout(FileSystemOptions opts, java.lang.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, java.lang.String defaultDateFormat)
          set the language code used by the server.
 void setEntryParser(FileSystemOptions opts, java.lang.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, java.lang.String recentDateFormat)
          see FTPClientConfig for details and examples.
 void setServerLanguageCode(FileSystemOptions opts, java.lang.String serverLanguageCode)
          set the language code used by the server.
 void setServerTimeZoneId(FileSystemOptions opts, java.lang.String serverTimeZoneId)
          see FTPClientConfig for details and examples.
 void setShortMonthNames(FileSystemOptions opts, java.lang.String[] shortMonthNames)
          see FTPClientConfig 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
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

builder

private static final FtpFileSystemConfigBuilder builder

FACTORY_KEY

private static final java.lang.String FACTORY_KEY

PASSIVE_MODE

private static final java.lang.String PASSIVE_MODE

USER_DIR_IS_ROOT

private static final java.lang.String USER_DIR_IS_ROOT

DATA_TIMEOUT

private static final java.lang.String DATA_TIMEOUT

SERVER_LANGUAGE_CODE

private static final java.lang.String SERVER_LANGUAGE_CODE

DEFAULT_DATE_FORMAT

private static final java.lang.String DEFAULT_DATE_FORMAT

RECENT_DATE_FORMAT

private static final java.lang.String RECENT_DATE_FORMAT

SERVER_TIME_ZONE_ID

private static final java.lang.String SERVER_TIME_ZONE_ID

SHORT_MONTH_NAMES

private static final java.lang.String SHORT_MONTH_NAMES
Constructor Detail

FtpFileSystemConfigBuilder

private FtpFileSystemConfigBuilder()
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 -
factory - instance of your factory

getEntryParserFactory

public org.apache.commons.net.ftp.parser.FTPFileEntryParserFactory getEntryParserFactory(FileSystemOptions opts)
Parameters:
opts -
See Also:
setEntryParserFactory(org.apache.commons.vfs.FileSystemOptions, org.apache.commons.net.ftp.parser.FTPFileEntryParserFactory)

setEntryParser

public void setEntryParser(FileSystemOptions opts,
                           java.lang.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.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

public java.lang.String getEntryParser(FileSystemOptions opts)
Parameters:
opts -
See Also:
setEntryParser(org.apache.commons.vfs.FileSystemOptions, java.lang.String)

getConfigClass

protected java.lang.Class getConfigClass()
Specified by:
getConfigClass in class FileSystemConfigBuilder

setPassiveMode

public void setPassiveMode(FileSystemOptions opts,
                           boolean passiveMode)
enter into passive mode

Parameters:
opts -
passiveMode -

getPassiveMode

public java.lang.Boolean getPassiveMode(FileSystemOptions opts)
Parameters:
opts -
See Also:
setPassiveMode(org.apache.commons.vfs.FileSystemOptions, boolean)

setUserDirIsRoot

public void setUserDirIsRoot(FileSystemOptions opts,
                             boolean userDirIsRoot)
use user directory as root (do not change to fs root)

Parameters:
opts -
userDirIsRoot -

getUserDirIsRoot

public java.lang.Boolean getUserDirIsRoot(FileSystemOptions opts)
Parameters:
opts -
See Also:
setUserDirIsRoot(org.apache.commons.vfs.FileSystemOptions, boolean)

getDataTimeout

public java.lang.Integer getDataTimeout(FileSystemOptions opts)
Parameters:
opts -
See Also:
setDataTimeout(org.apache.commons.vfs.FileSystemOptions, java.lang.Integer)

setDataTimeout

public void setDataTimeout(FileSystemOptions opts,
                           java.lang.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 -
dataTimeout -

getServerLanguageCode

public java.lang.String getServerLanguageCode(FileSystemOptions opts)
get the language code used by the server. see FTPClientConfig for details and examples.


setServerLanguageCode

public void setServerLanguageCode(FileSystemOptions opts,
                                  java.lang.String serverLanguageCode)
set the language code used by the server. see FTPClientConfig for details and examples.


getDefaultDateFormat

public java.lang.String getDefaultDateFormat(FileSystemOptions opts)
get the language code used by the server. see FTPClientConfig for details and examples.


setDefaultDateFormat

public void setDefaultDateFormat(FileSystemOptions opts,
                                 java.lang.String defaultDateFormat)
set the language code used by the server. see FTPClientConfig for details and examples.


getRecentDateFormat

public java.lang.String getRecentDateFormat(FileSystemOptions opts)
see FTPClientConfig for details and examples.


setRecentDateFormat

public void setRecentDateFormat(FileSystemOptions opts,
                                java.lang.String recentDateFormat)
see FTPClientConfig for details and examples.


getServerTimeZoneId

public java.lang.String getServerTimeZoneId(FileSystemOptions opts)
see FTPClientConfig for details and examples.


setServerTimeZoneId

public void setServerTimeZoneId(FileSystemOptions opts,
                                java.lang.String serverTimeZoneId)
see FTPClientConfig for details and examples.


getShortMonthNames

public java.lang.String[] getShortMonthNames(FileSystemOptions opts)
see FTPClientConfig for details and examples.


setShortMonthNames

public void setShortMonthNames(FileSystemOptions opts,
                               java.lang.String[] shortMonthNames)
see FTPClientConfig for details and examples.