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

java.lang.Object
  extended by org.apache.commons.vfs.FileSystemConfigBuilder
      extended by org.pentaho.di.core.vfs.configuration.KettleGenericFileSystemConfigBuilder
          extended by 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:

ParameterDescription
AuthKeyPassphraseThe passphrase that unlocks the private key. (Recommended on a per host basis, unless the passphrase is the same for ALL authentication keys)
identityLocal file path (Not VFS) to the private key for authentication.

Author:
cboyden

Method Summary
static KettleSftpFileSystemConfigBuilder getInstance()
           
 void setParameter(org.apache.commons.vfs.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, parseParameterName
 
Methods inherited from class org.apache.commons.vfs.FileSystemConfigBuilder
getRootURI, setRootURI
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getInstance

public static KettleSftpFileSystemConfigBuilder getInstance()

setParameter

public void setParameter(org.apache.commons.vfs.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