Class SftpFileProvider
- java.lang.Object
-
- org.apache.commons.vfs.provider.AbstractVfsComponent
-
- org.apache.commons.vfs.provider.AbstractVfsContainer
-
- org.apache.commons.vfs.provider.AbstractFileProvider
-
- org.apache.commons.vfs.provider.AbstractOriginatingFileProvider
-
- org.apache.commons.vfs.provider.sftp.SftpFileProvider
-
- All Implemented Interfaces:
FileProvider
,VfsComponent
public class SftpFileProvider extends AbstractOriginatingFileProvider
A provider for accessing files over SFTP.- Version:
- $Id: SftpFileProvider.java 480428 2006-11-29 06:15:24Z bayard $
- Author:
- Adam Murdoch, Gary D. Gregory
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ATTR_USER_INFO
static UserAuthenticationData.Type[]
AUTHENTICATOR_TYPES
protected static java.util.Collection
capabilities
-
Constructor Summary
Constructors Constructor Description SftpFileProvider()
-
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
getCapabilities()
Get the filesystem capabilities.
These are the same as on the filesystem, but available before the first filesystem was instanciated.FileSystemConfigBuilder
getConfigBuilder()
Gets the configbuilder useable to collect the needed fileSystemOptions.void
init()
Initialises the component.-
Methods inherited from class org.apache.commons.vfs.provider.AbstractOriginatingFileProvider
findFile, findFile
-
Methods inherited from class org.apache.commons.vfs.provider.AbstractFileProvider
addFileSystem, close, closeFileSystem, createFileSystem, findFileSystem, freeUnusedResources, getFileNameParser, parseUri, setFileNameParser
-
Methods inherited from class org.apache.commons.vfs.provider.AbstractVfsContainer
addComponent, removeComponent
-
Methods inherited from class org.apache.commons.vfs.provider.AbstractVfsComponent
getContext, getLogger, setContext, setLogger
-
-
-
-
Field Detail
-
capabilities
protected static final java.util.Collection capabilities
-
ATTR_USER_INFO
public static final java.lang.String ATTR_USER_INFO
- See Also:
- Constant Field Values
-
AUTHENTICATOR_TYPES
public static final UserAuthenticationData.Type[] AUTHENTICATOR_TYPES
-
-
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.- Throws:
FileSystemException
-
init
public void init() throws FileSystemException
Initialises the component.- Specified by:
init
in interfaceVfsComponent
- Overrides:
init
in classAbstractVfsComponent
- Throws:
FileSystemException
-
getConfigBuilder
public FileSystemConfigBuilder getConfigBuilder()
Description copied from interface:FileProvider
Gets the configbuilder useable to collect the needed fileSystemOptions.- Specified by:
getConfigBuilder
in interfaceFileProvider
- Overrides:
getConfigBuilder
in classAbstractFileProvider
-
getCapabilities
public java.util.Collection 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.
-
-