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
- 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)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
addCapabilities(java.util.Collection<Capability> caps)
Adds the capabilities of this file system.protected FileObject
createFile(AbstractFileName name)
Creates a file object.protected FTPClientWrapper
createWrapper()
Get the wrapper to access this file system.protected void
doCloseCommunicationLink()
Close the underlying link used to access the filesFtpClient
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
-
-
-
-
Constructor Detail
-
FtpFileSystem
public FtpFileSystem(GenericFileName rootName, FtpClient ftpClient, FileSystemOptions fileSystemOptions)
- Parameters:
rootName
- The root of the file system.ftpClient
- The FtpClient.fileSystemOptions
- The FileSystemOptions.- 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 classAbstractFileSystem
-
addCapabilities
protected void addCapabilities(java.util.Collection<Capability> caps)
Adds the capabilities of this file system.- Specified by:
addCapabilities
in classAbstractFileSystem
- 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.
-
createWrapper
protected FTPClientWrapper createWrapper() throws FileSystemException
Get the wrapper to access this file system.- Returns:
- new instance.
- Throws:
FileSystemException
- if any error occurs.- Since:
- 2.1
-
putClient
public void putClient(FtpClient client)
Returns an FTP client after use.- Parameters:
client
- The FTPClient.
-
createFile
protected FileObject createFile(AbstractFileName name) throws FileSystemException
Creates a file object.- Specified by:
createFile
in classAbstractFileSystem
- Parameters:
name
- name referencing the new file.- Returns:
- new created FileObject.
- Throws:
FileSystemException
-
-