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
public class SftpFileProvider extends AbstractOriginatingFileProvider
A provider for accessing files over SFTP.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ATTR_USER_INFO
User Information.static UserAuthenticationData.Type[]
AUTHENTICATOR_TYPES
Authentication types.protected static java.util.Collection<Capability>
capabilities
The provider's capabilities.
-
Constructor Summary
Constructors Constructor Description SftpFileProvider()
Constructs a new provider.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected FileSystem
doCreateFileSystem(FileName name, FileSystemOptions fileSystemOptions)
Creates aFileSystem
.java.util.Collection<Capability>
getCapabilities()
Get the filesystem capabilities.
These are the same as on the filesystem, but available before the first filesystem was instanciated.FileSystemConfigBuilder
getConfigBuilder()
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 Detail
-
ATTR_USER_INFO
public static final java.lang.String ATTR_USER_INFO
User Information.- See Also:
- Constant Field Values
-
AUTHENTICATOR_TYPES
public static final UserAuthenticationData.Type[] AUTHENTICATOR_TYPES
Authentication types.
-
capabilities
protected static final java.util.Collection<Capability> capabilities
The provider's capabilities.
-
-
Constructor Detail
-
SftpFileProvider
public SftpFileProvider()
Constructs a new provider.
-
-
Method Detail
-
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
public void init() throws FileSystemException
Initializes the component.- Specified by:
init
in interfaceVfsComponent
- Overrides:
init
in classAbstractVfsComponent
- Throws:
FileSystemException
- if an error occurs.
-
getConfigBuilder
public FileSystemConfigBuilder getConfigBuilder()
Description copied from class:AbstractFileProvider
Returns the FileSystemConfigBuidler.- Specified by:
getConfigBuilder
in interfaceFileProvider
- Overrides:
getConfigBuilder
in classAbstractFileProvider
- Returns:
- the FileSystemConfigBuilder.
-
getCapabilities
public java.util.Collection<Capability> 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.
-
-