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
An FTP file system.
-
Constructor Summary
ConstructorsConstructorDescriptionFtpFileSystem(GenericFileName rootName, FtpClient ftpClient, FileSystemOptions fileSystemOptions) Constructs a new instance. -
Method Summary
Modifier and TypeMethodDescriptionprotected voidaddCapabilities(Collection<Capability> caps) Adds the capabilities of this file system.protected FileObjectcreateFile(AbstractFileName name) Creates a file object.protected FTPClientWrapperGets the wrapper to access this file system.protected voidCloses the underlying link used to access the files.Creates an FTP client to use.voidReturns 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, setAttributeMethods inherited from class org.apache.commons.vfs2.provider.AbstractVfsComponent
getContext, getLogger, setContext, setLogger
-
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
Adds the capabilities of this file system.- Specified by:
addCapabilitiesin classAbstractFileSystem- Parameters:
caps- collections of Capabilities, can be immutable.
-
createFile
Creates a file object.- Specified by:
createFilein classAbstractFileSystem- Parameters:
name- name referencing the new file.- Returns:
- new created FileObject.
- Throws:
FileSystemException
-
createWrapper
Gets the wrapper to access this file system.- Returns:
- new instance.
- Throws:
FileSystemException- if any error occurs.- Since:
- 2.1
-
doCloseCommunicationLink
Description copied from class:AbstractFileSystemCloses the underlying link used to access the files.- Overrides:
doCloseCommunicationLinkin classAbstractFileSystem
-
getClient
Creates an FTP client to use.- Returns:
- An FTPClient.
- Throws:
FileSystemException- if an error occurs.
-
putClient
Returns an FTP client after use.- Parameters:
client- The FTPClient.
-