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

java.lang.Object
  extended by org.apache.commons.vfs.provider.AbstractVfsComponent
      extended by org.apache.commons.vfs.provider.AbstractVfsContainer
          extended by org.apache.commons.vfs.provider.AbstractFileProvider
              extended by org.apache.commons.vfs.provider.AbstractOriginatingFileProvider
                  extended by org.apache.commons.vfs.provider.ftp.FtpFileProvider
All Implemented Interfaces:
FileProvider, VfsComponent

public class FtpFileProvider
extends AbstractOriginatingFileProvider

A provider for FTP file systems.

Version:
$Revision: 804644 $ $Date: 2009-08-16 10:02:15 +0200 (So, 16. Aug 2009) $
Author:
Adam Murdoch

Field Summary
static java.lang.String ATTR_FILE_ENTRY_PARSER
          File Entry Parser.
static UserAuthenticationData.Type[] AUTHENTICATOR_TYPES
          Authenticator types.
 
Constructor Summary
FtpFileProvider()
           
 
Method Summary
protected  FileSystem doCreateFileSystem(FileName name, FileSystemOptions fileSystemOptions)
          Creates the filesystem.
 java.util.Collection getCapabilities()
          Get the filesystem capabilities.
These are the same as on the filesystem, but available before the first filesystem was instanciated.
 FileSystemConfigBuilder getConfigBuilder()
          Returns the FileSystemConfigBuidler.
 
Methods inherited from class org.apache.commons.vfs.provider.AbstractOriginatingFileProvider
findFile, findFile, getFileSystem
 
Methods inherited from class org.apache.commons.vfs.provider.AbstractFileProvider
addFileSystem, close, closeFileSystem, createFileSystem, findFileSystem, freeUnusedResources, getFileNameParser, parseUri, setFileNameParser
 
Methods inherited from class org.apache.commons.vfs.provider.AbstractVfsContainer
addComponent, removeComponent
 
Methods inherited from class org.apache.commons.vfs.provider.AbstractVfsComponent
getContext, getLogger, init, setContext, setLogger
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ATTR_FILE_ENTRY_PARSER

public static final java.lang.String ATTR_FILE_ENTRY_PARSER
File Entry Parser.

See Also:
Constant Field Values

AUTHENTICATOR_TYPES

public static final UserAuthenticationData.Type[] AUTHENTICATOR_TYPES
Authenticator types.

Constructor Detail

FtpFileProvider

public FtpFileProvider()
Method Detail

doCreateFileSystem

protected FileSystem doCreateFileSystem(FileName name,
                                        FileSystemOptions fileSystemOptions)
                                 throws FileSystemException
Creates the filesystem.

Specified by:
doCreateFileSystem in class AbstractOriginatingFileProvider
Parameters:
name - The name of the root file of the file system to create.
fileSystemOptions - The FileSystem options.
Returns:
The FileSystem.
Throws:
FileSystemException - if an error occurs.

getConfigBuilder

public FileSystemConfigBuilder getConfigBuilder()
Description copied from class: AbstractFileProvider
Returns the FileSystemConfigBuidler.

Specified by:
getConfigBuilder in interface FileProvider
Overrides:
getConfigBuilder in class AbstractFileProvider
Returns:
the FileSystemConfigBuilder.

getCapabilities

public java.util.Collection getCapabilities()
Description copied from interface: FileProvider
Get the filesystem capabilities.
These are the same as on the filesystem, but available before the first filesystem was instanciated.

Returns:
a Collection of the file systems Capabilities.


Copyright © 2002-2009 Apache Software Foundation. All Rights Reserved.