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.

Field Summary

Fields

Modifier and Type	Field and 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 and Description
SftpFileProvider() Constructs a new provider.

Method Summary

Modifier and Type	Method and Description
(package private) static com.jcraft.jsch.Session	createSession(GenericFileName rootName, FileSystemOptions fileSystemOptions) Creates a new Session.
protected FileSystem	doCreateFileSystem(FileName name, FileSystemOptions fileSystemOptions) Creates a FileSystem.
java.util.Collection<Capability>	getCapabilities() Gets the file system capabilities.
FileSystemConfigBuilder	getConfigBuilder() Returns the FileSystemConfigBuidler.

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, init, 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 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

createSession

static com.jcraft.jsch.Session createSession(GenericFileName rootName,
                                             FileSystemOptions fileSystemOptions)
                                      throws FileSystemException

Creates a new Session.

Returns:

A Session, never null.

Throws:

FileSystemException

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.

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 java.util.Collection<Capability> getCapabilities()

Description copied from interface: FileProvider

Gets the file system capabilities.

These are the same as on the file system, but available before the first file system was instanciated.

Returns:

a Collection of the file systems Capabilities.