SpringSftpSession (Apache Mina SSHD :: Spring integration SFTP adapter 2.4.0 API)

java.lang.Object
- org.apache.sshd.common.util.logging.AbstractLoggingBean
- - org.apache.sshd.spring.integration.sftp.SpringSftpSession

All Implemented Interfaces:

Closeable, AutoCloseable, org.springframework.integration.file.remote.session.Session<SftpClient.DirEntry>
```
public class SpringSftpSession
extends org.apache.sshd.common.util.logging.AbstractLoggingBean
implements org.springframework.integration.file.remote.session.Session<SftpClient.DirEntry>
```
Implements the Spring session for the SFTP client

Author:

Apache MINA SSHD Project

Field Summary
- Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean
  log

Constructor Summary

Constructors
Constructor and Description

SpringSftpSession(SftpClient clientInstance)

SpringSftpSession(SftpClient clientInstance, Callable<Exception> sessionCloser)

Constructors
Constructor and Description
`SpringSftpSession(SftpClient clientInstance)`
`SpringSftpSession(SftpClient clientInstance, Callable<Exception> sessionCloser)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`append(InputStream inputStream, String destination)`
`void`	`close()`
`protected void`	`closeClientInstance(SftpClient client)`
`protected void`	`closeSessionInstance(Callable<Exception> closer)`
`boolean`	`exists(String path)`
`boolean`	`finalizeRaw()`
`SftpClient`	`getClientInstance()`
`String`	`getHostPort()`
`Callable<Exception>`	`getSessionCloser()`
`boolean`	`isOpen()`
`SftpClient.DirEntry[]`	`list(String path)`
`String[]`	`listNames(String path)`
`boolean`	`mkdir(String directory)`
`void`	`read(String source, OutputStream outputStream)`
`InputStream`	`readRaw(String source)`
`boolean`	`remove(String path)`
`void`	`rename(String pathFrom, String pathTo)`
`boolean`	`rmdir(String directory)`
`String`	`toString()`
`void`	`write(InputStream inputStream, String destination)`

Methods inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean
getSimplifiedLogger

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

Methods inherited from interface org.springframework.integration.file.remote.session.Session
dirty, test

- Constructor Detail
  - SpringSftpSession
```
public SpringSftpSession(SftpClient clientInstance)
```
  - SpringSftpSession
```
public SpringSftpSession(SftpClient clientInstance,
                         Callable<Exception> sessionCloser)
```
- Method Detail
  - getHostPort
```
public String getHostPort()
```
    Specified by:
    
    getHostPort in interface org.springframework.integration.file.remote.session.Session<SftpClient.DirEntry>
  - isOpen
```
public boolean isOpen()
```
    Specified by:
    
    isOpen in interface org.springframework.integration.file.remote.session.Session<SftpClient.DirEntry>
  - getClientInstance
```
public SftpClient getClientInstance()
```
    Specified by:
    
    getClientInstance in interface org.springframework.integration.file.remote.session.Session<SftpClient.DirEntry>
  - getSessionCloser
```
public Callable<Exception> getSessionCloser()
```
  - close
```
public void close()
```
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface org.springframework.integration.file.remote.session.Session<SftpClient.DirEntry>
  - closeClientInstance
```
protected void closeClientInstance(SftpClient client)
                            throws Exception
```
    Throws:
    
    Exception
  - closeSessionInstance
```
protected void closeSessionInstance(Callable<Exception> closer)
                             throws Exception
```
    Throws:
    
    Exception
  - remove
```
public boolean remove(String path)
               throws IOException
```
    Specified by:
    
    remove in interface org.springframework.integration.file.remote.session.Session<SftpClient.DirEntry>
    
    Throws:
    
    IOException
  - mkdir
```
public boolean mkdir(String directory)
              throws IOException
```
    Specified by:
    
    mkdir in interface org.springframework.integration.file.remote.session.Session<SftpClient.DirEntry>
    
    Throws:
    
    IOException
  - rmdir
```
public boolean rmdir(String directory)
              throws IOException
```
    Specified by:
    
    rmdir in interface org.springframework.integration.file.remote.session.Session<SftpClient.DirEntry>
    
    Throws:
    
    IOException
  - rename
```
public void rename(String pathFrom,
                   String pathTo)
            throws IOException
```
    Specified by:
    
    rename in interface org.springframework.integration.file.remote.session.Session<SftpClient.DirEntry>
    
    Throws:
    
    IOException
  - exists
```
public boolean exists(String path)
               throws IOException
```
    Specified by:
    
    exists in interface org.springframework.integration.file.remote.session.Session<SftpClient.DirEntry>
    
    Throws:
    
    IOException
  - listNames
```
public String[] listNames(String path)
                   throws IOException
```
    Specified by:
    
    listNames in interface org.springframework.integration.file.remote.session.Session<SftpClient.DirEntry>
    
    Throws:
    
    IOException
  - list
```
public SftpClient.DirEntry[] list(String path)
                           throws IOException
```
    Specified by:
    
    list in interface org.springframework.integration.file.remote.session.Session<SftpClient.DirEntry>
    
    Throws:
    
    IOException
  - read
```
public void read(String source,
                 OutputStream outputStream)
          throws IOException
```
    Specified by:
    
    read in interface org.springframework.integration.file.remote.session.Session<SftpClient.DirEntry>
    
    Throws:
    
    IOException
  - write
```
public void write(InputStream inputStream,
                  String destination)
           throws IOException
```
    Specified by:
    
    write in interface org.springframework.integration.file.remote.session.Session<SftpClient.DirEntry>
    
    Throws:
    
    IOException
  - append
```
public void append(InputStream inputStream,
                   String destination)
            throws IOException
```
    Specified by:
    
    append in interface org.springframework.integration.file.remote.session.Session<SftpClient.DirEntry>
    
    Throws:
    
    IOException
  - readRaw
```
public InputStream readRaw(String source)
                    throws IOException
```
    Specified by:
    
    readRaw in interface org.springframework.integration.file.remote.session.Session<SftpClient.DirEntry>
    
    Throws:
    
    IOException
  - finalizeRaw
```
public boolean finalizeRaw()
                    throws IOException
```
    Specified by:
    
    finalizeRaw in interface org.springframework.integration.file.remote.session.Session<SftpClient.DirEntry>
    
    Throws:
    
    IOException
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class SpringSftpSession

Field Summary

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

Constructor Summary

Method Summary

Methods inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

Methods inherited from class java.lang.Object

Methods inherited from interface org.springframework.integration.file.remote.session.Session

Constructor Detail

SpringSftpSession

SpringSftpSession

Method Detail

getHostPort

isOpen

getClientInstance

getSessionCloser

close

closeClientInstance

closeSessionInstance

remove

mkdir

rmdir

rename

exists

listNames

list

read

write

append

readRaw

finalizeRaw

toString