Package 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:

Closeable, AutoCloseable, FileSystem, VfsComponent

Direct Known Subclasses:

FtpsFileSystem

public class FtpFileSystem
extends AbstractFileSystem

An FTP file system.

Constructor Summary

Constructors

Constructor	Description
FtpFileSystem(GenericFileName rootName, FtpClient ftpClient, FileSystemOptions fileSystemOptions)	Constructs a new instance.

Method Summary

Modifier and Type	Method	Description
protected void	addCapabilities(Collection<Capability> caps)	Adds the capabilities of this file system.
protected FileObject	createFile(AbstractFileName name)	Creates a file object.
protected FTPClientWrapper	createWrapper()	Gets the wrapper to access this file system.
protected void	doCloseCommunicationLink()	Closes the underlying link used to access the files.
FtpClient	getClient()	Creates an FTP client to use.
void	putClient(FtpClient client)	Returns an FTP client after 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 Details

FtpFileSystem

public FtpFileSystem(GenericFileName rootName,
 FtpClient ftpClient,
 FileSystemOptions fileSystemOptions)

Constructs a new instance.

Parameters:

rootName - The root of the file system.

ftpClient - The FtpClient.

fileSystemOptions - The FileSystemOptions.

Since:

2.0 (was protected)

Method Details

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.

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

createWrapper

protected FTPClientWrapper createWrapper()
                                  throws FileSystemException

Gets the wrapper to access this file system.

Returns:

new instance.

Throws:

FileSystemException - if any error occurs.

Since:

2.1

doCloseCommunicationLink

protected void doCloseCommunicationLink()

Description copied from class: AbstractFileSystem

Closes the underlying link used to access the files.

Overrides:

doCloseCommunicationLink in class AbstractFileSystem

getClient

public FtpClient getClient()
                    throws FileSystemException

Creates an FTP client to use.

Returns:

An FTPClient.

Throws:

FileSystemException - if an error occurs.

putClient

public void putClient(FtpClient client)

Returns an FTP client after use.

Parameters:

client - The FTPClient.