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

java.lang.Object
  extended by org.apache.commons.vfs2.provider.AbstractVfsComponent
      extended by org.apache.commons.vfs2.provider.AbstractVfsContainer
          extended by org.apache.commons.vfs2.provider.AbstractFileProvider
              extended by org.apache.commons.vfs2.provider.AbstractOriginatingFileProvider
                  extended by org.apache.commons.vfs2.provider.ftp.FtpFileProvider
All Implemented Interfaces:
FileProvider, VfsComponent
Direct Known Subclasses:
FtpsFileProvider

public class FtpFileProvider
extends AbstractOriginatingFileProvider

A provider for FTP file systems.

Author:
Commons VFS team

Field Summary
static 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.
 Collection<Capability> 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.vfs2.provider.AbstractOriginatingFileProvider
findFile, findFile, getFileSystem
 
Methods inherited from class org.apache.commons.vfs2.provider.AbstractFileProvider
addFileSystem, close, closeFileSystem, createFileSystem, findFileSystem, freeUnusedResources, getFileNameParser, parseUri, setFileNameParser
 
Methods inherited from class org.apache.commons.vfs2.provider.AbstractVfsContainer
addComponent, removeComponent
 
Methods inherited from class org.apache.commons.vfs2.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 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 Collection<Capability> 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-2012 The Apache Software Foundation. All Rights Reserved.