org.apache.commons.vfs2.provider.sftp
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.

Author:

Commons VFS team

Field Summary

static String	ATTR_USER_INFO User Information.
static UserAuthenticationData.Type[]	AUTHENTICATOR_TYPES Authentication types.
protected static Collection<Capability>	capabilities The provider's capabilities.

Constructor Summary

SftpFileProvider()

Method Summary

protected FileSystem	doCreateFileSystem(FileName name, FileSystemOptions fileSystemOptions) Creates a FileSystem.
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() Initialises 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ATTR_USER_INFO

public static final 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 Collection<Capability> capabilities

The provider's capabilities.

Constructor Detail

SftpFileProvider

public SftpFileProvider()

Method Detail

doCreateFileSystem

protected FileSystem doCreateFileSystem(FileName name,
                                        FileSystemOptions fileSystemOptions)
                                 throws FileSystemException

Creates a FileSystem.

Specified by:

doCreateFileSystem in class AbstractOriginatingFileProvider

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

Initialises the component.

Specified by:

init in interface VfsComponent

Overrides:

init in class AbstractVfsComponent

Throws:

FileSystemException - if an error occurs.

getConfigBuilder

public FileSystemConfigBuilder getConfigBuilder()

Description copied from class: AbstractFileProvider

Returns the FileSystemConfigBuidler.

Specified by:

getConfigBuilder in interface FileProvider

Overrides:

getConfigBuilder in class AbstractFileProvider

Returns:

the FileSystemConfigBuilder.

getCapabilities

public 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.