Class SftpClientFactory

java.lang.Object

org.apache.commons.vfs2.provider.sftp.SftpClientFactory

public final class SftpClientFactory
extends Object

Create a JSch Session instance.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	SftpClientFactory.JSchLogger	Interface JSchLogger with JCL.

Field Summary

Fields

Modifier and Type	Field	Description
private static final org.apache.commons.logging.Log	LOG
private static final String	OPENSSH_CONFIG_NAME
private static final String	SSH_DIR_NAME

Constructor Summary

Constructors

Modifier	Constructor	Description
private	SftpClientFactory()

Method Summary

Modifier and Type	Method	Description
private static void	addIdentities(com.jcraft.jsch.JSch jsch, File sshDir, IdentityProvider[] identities)
private static void	addIdentity(com.jcraft.jsch.JSch jsch, IdentityProvider identity)
static com.jcraft.jsch.Session	createConnection(String hostname, int port, char[] username, char[] password, FileSystemOptions fileSystemOptions)	Creates a new connection to the server.
private static com.jcraft.jsch.ProxyHTTP	createProxyHTTP(String proxyHost, int proxyPort)
private static com.jcraft.jsch.ProxySOCKS5	createProxySOCKS5(String proxyHost, int proxyPort)
private static com.jcraft.jsch.Proxy	createStreamProxy(String proxyHost, int proxyPort, FileSystemOptions fileSystemOptions, SftpFileSystemConfigBuilder builder)
private static File	findSshDir()	Finds the .ssh directory.
private static void	setConfigRepository(com.jcraft.jsch.JSch jsch, File sshDir, com.jcraft.jsch.ConfigRepository configRepository, boolean loadOpenSSHConfig)
private static void	setKnownHosts(com.jcraft.jsch.JSch jsch, File sshDir, File knownHostsFile)

Methods inherited from class Object

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

Field Details

SSH_DIR_NAME

private static final String SSH_DIR_NAME

See Also:

• Constant Field Values

OPENSSH_CONFIG_NAME

private static final String OPENSSH_CONFIG_NAME

See Also:

• Constant Field Values

LOG

private static final org.apache.commons.logging.Log LOG

Constructor Details

SftpClientFactory

private SftpClientFactory()

Method Details

addIdentities

private static void addIdentities(com.jcraft.jsch.JSch jsch,
 File sshDir,
 IdentityProvider[] identities)
                           throws FileSystemException

Throws:

FileSystemException

addIdentity

private static void addIdentity(com.jcraft.jsch.JSch jsch,
 IdentityProvider identity)
                         throws FileSystemException

Throws:

FileSystemException

createConnection

public static com.jcraft.jsch.Session createConnection(String hostname,
 int port,
 char[] username,
 char[] password,
 FileSystemOptions fileSystemOptions)
                                                throws FileSystemException

Creates a new connection to the server.

Parameters:

hostname - The name of the host to connect to.

port - The port to use.

username - The user's id.

password - The user's password.

fileSystemOptions - The FileSystem options.

Returns:

A Session, never null.

Throws:

FileSystemException - if an error occurs.

createProxyHTTP

private static com.jcraft.jsch.ProxyHTTP createProxyHTTP(String proxyHost,
 int proxyPort)

createProxySOCKS5

private static com.jcraft.jsch.ProxySOCKS5 createProxySOCKS5(String proxyHost,
 int proxyPort)

createStreamProxy

private static com.jcraft.jsch.Proxy createStreamProxy(String proxyHost,
 int proxyPort,
 FileSystemOptions fileSystemOptions,
 SftpFileSystemConfigBuilder builder)

findSshDir

private static File findSshDir()

Finds the .ssh directory.

The lookup order is:

1. The system property vfs.sftp.sshdir (the override mechanism)
2. user.home/.ssh
3. On Windows only: C:\cygwin\home[user.name]\.ssh
4. The current directory, as a last resort.

Windows Notes

The default installation directory for Cygwin is C:\cygwin. On my set up (Gary here), I have Cygwin in C:\bin\cygwin, not the default. Also, my .ssh directory was created in the user.home directory.

Returns:

The .ssh directory

setConfigRepository

private static void setConfigRepository(com.jcraft.jsch.JSch jsch,
 File sshDir,
 com.jcraft.jsch.ConfigRepository configRepository,
 boolean loadOpenSSHConfig)
                                 throws FileSystemException

Throws:

FileSystemException

setKnownHosts

private static void setKnownHosts(com.jcraft.jsch.JSch jsch,
 File sshDir,
 File knownHostsFile)
                           throws FileSystemException

Throws:

FileSystemException