Package org.pentaho.di.core.vfs.configuration

Class KettleSftpFileSystemConfigBuilder

java.lang.Object

org.apache.commons.vfs2.FileSystemConfigBuilder

org.pentaho.di.core.vfs.configuration.KettleGenericFileSystemConfigBuilder

org.pentaho.di.core.vfs.configuration.KettleSftpFileSystemConfigBuilder

All Implemented Interfaces:

IKettleFileSystemConfigBuilder

public class KettleSftpFileSystemConfigBuilder
extends KettleGenericFileSystemConfigBuilder

An SFTP FileSystemConfigBuilder that uses Kettle variables to build SFTP VFS configuration options. Options can be specified by host by appending the host name (as it will appear in the VFS URL) to the end of the parameter. (e.g.- vfs.sftp.parameter.192.168.1.5) Overriden parameters are currently:

Parameter	Description
AuthKeyPassphrase	The passphrase that unlocks the private key. (Recommended on a per host basis, unless the passphrase is the same for ALL authentication keys)
identity	Local file path (Not VFS) to the private key for authentication.

Author:

cboyden

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	KettleSftpFileSystemConfigBuilder()

Method Summary

Modifier and Type	Method	Description
protected Class<? extends org.apache.commons.vfs2.FileSystem>	getConfigClass()
static KettleSftpFileSystemConfigBuilder	getInstance()
void	setParameter(org.apache.commons.vfs2.FileSystemOptions opts, String name, String value, String fullParameterName, String vfsUrl)	Publicly expose a generic way to set parameters

Methods inherited from class org.pentaho.di.core.vfs.configuration.KettleGenericFileSystemConfigBuilder

extractScheme, getVariableSpace, parseParameterName, setParameter

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

KettleSftpFileSystemConfigBuilder

protected KettleSftpFileSystemConfigBuilder()

Method Detail

getInstance

public static KettleSftpFileSystemConfigBuilder getInstance()

getConfigClass

protected Class<? extends org.apache.commons.vfs2.FileSystem> getConfigClass()

Overrides:

getConfigClass in class KettleGenericFileSystemConfigBuilder

setParameter

public void setParameter(org.apache.commons.vfs2.FileSystemOptions opts,
                         String name,
                         String value,
                         String fullParameterName,
                         String vfsUrl)
                  throws IOException

Publicly expose a generic way to set parameters

Specified by:

setParameter in interface IKettleFileSystemConfigBuilder

Overrides:

setParameter in class KettleGenericFileSystemConfigBuilder

Throws:

IOException