Class SftpFileProvider
java.lang.Object
org.apache.commons.vfs2.provider.AbstractVfsComponent
org.apache.commons.vfs2.provider.AbstractVfsContainer
org.apache.commons.vfs2.provider.AbstractFileProvider
org.apache.commons.vfs2.provider.AbstractOriginatingFileProvider
org.apache.commons.vfs2.provider.sftp.SftpFileProvider
- All Implemented Interfaces:
FileProvider
,VfsComponent
A provider for accessing files over SFTP.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
User Information.static final UserAuthenticationData.Type[]
Authentication types.protected static final Collection<Capability>
The provider's capabilities. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected FileSystem
doCreateFileSystem
(FileName name, FileSystemOptions fileSystemOptions) Creates aFileSystem
.Get the filesystem capabilities.
These are the same as on the filesystem, but available before the first filesystem was instanciated.Returns the FileSystemConfigBuidler.void
init()
Initializes the component.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, setContext, setLogger
-
Field Details
-
ATTR_USER_INFO
User Information.- See Also:
-
AUTHENTICATOR_TYPES
Authentication types. -
capabilities
The provider's capabilities.
-
-
Constructor Details
-
SftpFileProvider
public SftpFileProvider()Constructs a new provider.
-
-
Method Details
-
doCreateFileSystem
protected FileSystem doCreateFileSystem(FileName name, FileSystemOptions fileSystemOptions) throws FileSystemException Creates aFileSystem
.- Specified by:
doCreateFileSystem
in classAbstractOriginatingFileProvider
- 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.
-
init
Initializes the component.- Specified by:
init
in interfaceVfsComponent
- Overrides:
init
in classAbstractVfsComponent
- Throws:
FileSystemException
- if an error occurs.
-
getConfigBuilder
Description copied from class:AbstractFileProvider
Returns the FileSystemConfigBuidler.- Specified by:
getConfigBuilder
in interfaceFileProvider
- Overrides:
getConfigBuilder
in classAbstractFileProvider
- Returns:
- the FileSystemConfigBuilder.
-
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.
-