SftpSession (Ibis AdapterFramework parent 7.9-SNAPSHOT API)

java.lang.Object
- nl.nn.adapterframework.ftp.SftpSession

All Implemented Interfaces:

IConfigurable, IConfigurationAware, INamedObject, IScopeProvider, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

SftpFileSystem
```
public class SftpSession
extends Object
implements IConfigurable
```
Helper class for sftp.

Author:

Niels Meijer

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SftpSession.TransportType

Nested Classes
Modifier and Type	Class and Description
`static class`	`SftpSession.TransportType`

Constructor Summary

Constructors
Constructor and Description

SftpSession()

Constructors
Constructor and Description
`SftpSession()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()`
`static void`	`close(com.jcraft.jsch.ChannelSftp sftpClient)`
`void`	`configure()`
`com.jcraft.jsch.ChannelSftp`	`openClient(String remoteDirectory)`
`void`	`setAuthAlias(String string)` Name of the alias to obtain credentials to authenticatie on remote server
`void`	`setHost(String string)` Name or ip address of remote host
`void`	`setKnownHostsPath(String string)` Path to file with knownhosts
`void`	`setName(String name)` The functional name of the object.
`void`	`setPassword(String string)` Password to authenticatie on remote server
`void`	`setPort(int i)` Port number of remote host
`void`	`setPrefCSEncryption(String string)` Optional preferred encryption from client to server for sftp protocol
`void`	`setPrefSCEncryption(String string)` Optional preferred encryption from server to client for sftp protocol
`void`	`setPrivateKeyAuthAlias(String string)` Name of the alias to obtain credentials for passphrase of private key file
`void`	`setPrivateKeyFilePath(String string)` Path to private key file for sftp authentication
`void`	`setPrivateKeyPassword(String password)` Passphrase of private key file
`void`	`setProxyAuthAlias(String string)` alias to obtain credentials to authenticate on proxy
`void`	`setProxyHost(String string)` Proxy hostname
`void`	`setProxyPassword(String string)` Default password in case proxy requires authentication
`void`	`setProxyPort(int i)` Proxy port
`void`	`setProxyTransportType(SftpSession.TransportType type)` Transport type in case of sftp
`void`	`setProxyUsername(String string)` Default user name in case proxy requires authentication
`void`	`setStrictHostKeyChecking(boolean b)` Verify the hosts againt the knownhosts file.
`void`	`setUsername(String string)` Name of the user to authenticatie on remote server

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface nl.nn.adapterframework.core.INamedObject
getName

Methods inherited from interface nl.nn.adapterframework.core.IConfigurationAware
getApplicationContext, getName

Methods inherited from interface nl.nn.adapterframework.core.IScopeProvider
getConfigurationClassLoader

Methods inherited from interface org.springframework.context.ApplicationContextAware
setApplicationContext

- Constructor Detail
  - SftpSession
```
public SftpSession()
```
- Method Detail
  - configure
```
public void configure()
               throws ConfigurationException
```
    Specified by:
    
    configure in interface IConfigurable
    
    Throws:
    
    ConfigurationException
  - openClient
```
public com.jcraft.jsch.ChannelSftp openClient(String remoteDirectory)
                                       throws FtpConnectException
```
    Throws:
    
    FtpConnectException
  - close
```
public static void close(com.jcraft.jsch.ChannelSftp sftpClient)
```
  - close
```
public void close()
```
  - setHost
```
public void setHost(String string)
```
    Name or ip address of remote host
  - setPort
```
public void setPort(int i)
```
    Port number of remote host
    
    Default value
    
    21
  - setAuthAlias
```
public void setAuthAlias(String string)
```
    Name of the alias to obtain credentials to authenticatie on remote server
  - setUsername
```
public void setUsername(String string)
```
    Name of the user to authenticatie on remote server
  - setPassword
```
public void setPassword(String string)
```
    Password to authenticatie on remote server
  - setProxyHost
```
public void setProxyHost(String string)
```
    Proxy hostname
  - setProxyPort
```
public void setProxyPort(int i)
```
    Proxy port
    
    Default value
    
    1080
  - setProxyAuthAlias
```
public void setProxyAuthAlias(String string)
```
    alias to obtain credentials to authenticate on proxy
  - setProxyUsername
```
public void setProxyUsername(String string)
```
    Default user name in case proxy requires authentication
  - setProxyPassword
```
public void setProxyPassword(String string)
```
    Default password in case proxy requires authentication
  - setProxyTransportType
```
public void setProxyTransportType(SftpSession.TransportType type)
```
    Transport type in case of sftp
    
    Default value
    
    SOCKS5
  - setPrefCSEncryption
```
public void setPrefCSEncryption(String string)
```
    Optional preferred encryption from client to server for sftp protocol
  - setPrefSCEncryption
```
public void setPrefSCEncryption(String string)
```
    Optional preferred encryption from server to client for sftp protocol
  - setPrivateKeyFilePath
```
public void setPrivateKeyFilePath(String string)
```
    Path to private key file for sftp authentication
  - setPrivateKeyAuthAlias
```
public void setPrivateKeyAuthAlias(String string)
```
    Name of the alias to obtain credentials for passphrase of private key file
  - setPrivateKeyPassword
```
public void setPrivateKeyPassword(String password)
```
    Passphrase of private key file
  - setKnownHostsPath
```
public void setKnownHostsPath(String string)
```
    Path to file with knownhosts
  - setStrictHostKeyChecking
```
public void setStrictHostKeyChecking(boolean b)
```
    Verify the hosts againt the knownhosts file.
    
    Default value
    
    true
  - setName
```
public void setName(String name)
```
    Description copied from interface: INamedObject
    
    The functional name of the object.
    
    Specified by:
    
    setName in interface INamedObject

Class SftpSession

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface nl.nn.adapterframework.core.INamedObject

Methods inherited from interface nl.nn.adapterframework.core.IConfigurationAware

Methods inherited from interface nl.nn.adapterframework.core.IScopeProvider

Methods inherited from interface org.springframework.context.ApplicationContextAware

Constructor Detail

SftpSession

Method Detail

configure

openClient

close

close

setHost

setPort

setAuthAlias

setUsername

setPassword

setProxyHost

setProxyPort

setProxyAuthAlias

setProxyUsername

setProxyPassword

setProxyTransportType

setPrefCSEncryption

setPrefSCEncryption

setPrivateKeyFilePath

setPrivateKeyAuthAlias

setPrivateKeyPassword

setKnownHostsPath

setStrictHostKeyChecking

setName