net.sf.sshapi.vfs

Class SftpFileSystemConfigBuilder

java.lang.Object

org.apache.commons.vfs2.FileSystemConfigBuilder

net.sf.sshapi.vfs.SftpFileSystemConfigBuilder

public class SftpFileSystemConfigBuilder
extends org.apache.commons.vfs2.FileSystemConfigBuilder

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCharset(org.apache.commons.vfs2.FileSystemOptions opts) Get the character encoding to use.
java.lang.String	getCompression(org.apache.commons.vfs2.FileSystemOptions opts) Get the compression algorithm to use.
protected java.lang.Class	getConfigClass()
SshHostKeyValidator	getHostKeyVerification(org.apache.commons.vfs2.FileSystemOptions opts) Get the host key validator to use.
java.io.File[]	getIdentities(org.apache.commons.vfs2.FileSystemOptions opts) Get the files contain private keys (for authentication) to use.
static SftpFileSystemConfigBuilder	getInstance() Get a static instance.
java.io.File	getKnownHosts(org.apache.commons.vfs2.FileSystemOptions opts) Get the file to use to store known hosts.
SshClient	getSshClient(org.apache.commons.vfs2.FileSystemOptions opts) Get the shared SSH client to use.
void	setCharset(org.apache.commons.vfs2.FileSystemOptions opts, java.lang.String charset) Set the character encoding to use.
void	setCompression(org.apache.commons.vfs2.FileSystemOptions opts, java.lang.String compression) Set the compression algorithm to use.
void	setHostKeyVerification(org.apache.commons.vfs2.FileSystemOptions opts, SshHostKeyValidator hostKeyVerification) Set the host key validator to use.
void	setIdentities(org.apache.commons.vfs2.FileSystemOptions opts, java.io.File[] identities) Set the files contain private keys (for authentication) to use.
void	setKnownHosts(org.apache.commons.vfs2.FileSystemOptions opts, java.io.File sshdir) Set the file to use to store known hosts.
void	setSshClient(org.apache.commons.vfs2.FileSystemOptions opts, SshClient sshClient) Set the shared SSH client to use.

Methods inherited from class org.apache.commons.vfs2.FileSystemConfigBuilder

getBoolean, getBoolean, getBoolean, getByte, getByte, getByte, getCharacter, getCharacter, getCharacter, getDouble, getDouble, getDouble, getFloat, getFloat, getFloat, getInteger, getInteger, getInteger, getLong, getLong, getLong, getParam, getRootURI, getShort, getShort, getShort, getString, getString, hasObject, hasParam, setParam, setRootURI

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static SftpFileSystemConfigBuilder getInstance()

Get a static instance.

Returns:

instance

setKnownHosts

public void setKnownHosts(org.apache.commons.vfs2.FileSystemOptions opts,
                          java.io.File sshdir)

Set the file to use to store known hosts.

Parameters:

opts - options

sshdir - directory contain known hosts file

getKnownHosts

public java.io.File getKnownHosts(org.apache.commons.vfs2.FileSystemOptions opts)

Get the file to use to store known hosts.

Parameters:

opts - options

Returns:

directory contain known hosts file

setHostKeyVerification

public void setHostKeyVerification(org.apache.commons.vfs2.FileSystemOptions opts,
                                   SshHostKeyValidator hostKeyVerification)

Set the host key validator to use.

Parameters:

opts - options

hostKeyVerification - host key validator

getHostKeyVerification

public SshHostKeyValidator getHostKeyVerification(org.apache.commons.vfs2.FileSystemOptions opts)

Get the host key validator to use.

Parameters:

opts - options

Returns:

host key validator

setSshClient

public void setSshClient(org.apache.commons.vfs2.FileSystemOptions opts,
                         SshClient sshClient)

Set the shared SSH client to use. If set, no additional connection will be made, instead a new SftpClient will be created fron the existing connection.

Parameters:

opts - options

sshClient - client

getSshClient

public SshClient getSshClient(org.apache.commons.vfs2.FileSystemOptions opts)

Get the shared SSH client to use. If set, no additional connection will be made, instead a new SftpClient will be created fron the existing connection.

Parameters:

opts - options

Returns:

shared client

setCharset

public void setCharset(org.apache.commons.vfs2.FileSystemOptions opts,
                       java.lang.String charset)

Set the character encoding to use.

Parameters:

opts - options

charset - character encoding

getCharset

public java.lang.String getCharset(org.apache.commons.vfs2.FileSystemOptions opts)

Get the character encoding to use.

Parameters:

opts - options

Returns:

character encoding

setIdentities

public void setIdentities(org.apache.commons.vfs2.FileSystemOptions opts,
                          java.io.File[] identities)

Set the files contain private keys (for authentication) to use.

Parameters:

opts - options

identities - files contain private keys (for authentication) to use.

getIdentities

public java.io.File[] getIdentities(org.apache.commons.vfs2.FileSystemOptions opts)

Get the files contain private keys (for authentication) to use.

Parameters:

opts - options

Returns:

files contain private keys (for authentication) to use.

setCompression

public void setCompression(org.apache.commons.vfs2.FileSystemOptions opts,
                           java.lang.String compression)

Set the compression algorithm to use.

Parameters:

opts - options

compression - compression

getCompression

public java.lang.String getCompression(org.apache.commons.vfs2.FileSystemOptions opts)

Get the compression algorithm to use.

Parameters:

opts - options

Returns:

compression

getConfigClass

protected java.lang.Class getConfigClass()

Specified by:

getConfigClass in class org.apache.commons.vfs2.FileSystemConfigBuilder