org.apache.commons.vfs2.provider.ftp

Class FtpFileSystem

java.lang.Object

org.apache.commons.vfs2.provider.AbstractVfsComponent

org.apache.commons.vfs2.provider.AbstractFileSystem

org.apache.commons.vfs2.provider.ftp.FtpFileSystem

All Implemented Interfaces:

FileSystem, VfsComponent

public class FtpFileSystem
extends AbstractFileSystem

An FTP file system.

Constructor Summary

Constructors

Constructor and Description
FtpFileSystem(GenericFileName rootName, ClientWrapperFactory clientWrapperFactory, FileSystemOptions fileSystemOptions)

Method Summary

Modifier and Type	Method and Description
protected void	addCapabilities(Collection<Capability> caps) Adds the capabilities of this file system.
protected FileObject	createFile(AbstractFileName name) Creates a file object.
protected void	doCloseCommunicationLink() Close the underlying link used to access the files
FtpClient	getClient() Creates an FTP client to use.

Methods inherited from class org.apache.commons.vfs2.provider.AbstractFileSystem

addJunction, addListener, close, closeCommunicationLink, decorateFileObject, doReplicateFile, fireFileChanged, fireFileCreated, fireFileDeleted, getAttribute, getFileFromCache, getFileSystemManager, getFileSystemOptions, getLastModTimeAccuracy, getParentLayer, getRoot, getRootName, getRootURI, hasCapability, init, isOpen, isReleaseable, notifyAllStreamsClosed, putFileToCache, removeFileFromCache, removeJunction, removeListener, replicateFile, resolveFile, resolveFile, setAttribute

Methods inherited from class org.apache.commons.vfs2.provider.AbstractVfsComponent

getContext, getLogger, setContext, setLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FtpFileSystem

public FtpFileSystem(GenericFileName rootName,
                     ClientWrapperFactory clientWrapperFactory,
                     FileSystemOptions fileSystemOptions)
              throws FileSystemException

Parameters:

rootName - The root of the file system.

clientWrapperFactory - The FtpClientWrapperFactory.

fileSystemOptions - The FileSystemOptions.

Throws:

FileSystemException

Since:

2.0 (was protected)

Method Detail

doCloseCommunicationLink

protected void doCloseCommunicationLink()

Description copied from class: AbstractFileSystem

Close the underlying link used to access the files

Overrides:

doCloseCommunicationLink in class AbstractFileSystem

addCapabilities

protected void addCapabilities(Collection<Capability> caps)

Adds the capabilities of this file system.

Specified by:

addCapabilities in class AbstractFileSystem

Parameters:

caps - collections of Capabilities, can be immutable.

getClient

public FtpClient getClient()
                    throws FileSystemException

Creates an FTP client to use.

Returns:

An FTPCleint.

Throws:

FileSystemException - if an error occurs.

createFile

protected FileObject createFile(AbstractFileName name)
                         throws FileSystemException

Creates a file object.

Specified by:

createFile in class AbstractFileSystem

Parameters:

name - name referencing the new file.

Returns:

new created FileObject.

Throws:

FileSystemException