Package org.springframework.integration.sftp.session

Class SftpSession

java.lang.Object
org.springframework.integration.sftp.session.SftpSession
All Implemented Interfaces:
Closeable, AutoCloseable, Session<com.jcraft.jsch.ChannelSftp.LsEntry>
public class SftpSession extends Object implements Session<com.jcraft.jsch.ChannelSftp.LsEntry>
Default SFTP Session implementation. Wraps a JSCH session instance.
Since:
2.0
Author:
Josh Long, Mario Gray, Mark Fisher, Oleg Zhurakousky, Gary Russell, Artem Bilan

  • Constructor Details

    • SftpSession

      public SftpSession(com.jcraft.jsch.Session jschSession)

    • SftpSession

      public SftpSession(org.springframework.integration.sftp.session.JSchSessionWrapper wrapper)

  • Method Details

    • setChannelConnectTimeout

      public void setChannelConnectTimeout(Duration timeout)
      Set the connect timeout.
      Parameters:
      timeout - the timeout to set.
      Since:
      5.2

    • remove

      public boolean remove(String path) throws IOException
      Specified by:
      remove in interface Session<com.jcraft.jsch.ChannelSftp.LsEntry>
      Throws:
      IOException

    • list

      public com.jcraft.jsch.ChannelSftp.LsEntry[] list(String path) throws IOException
      Specified by:
      list in interface Session<com.jcraft.jsch.ChannelSftp.LsEntry>
      Throws:
      IOException

    • listNames

      public String[] listNames(String path) throws IOException
      Specified by:
      listNames in interface Session<com.jcraft.jsch.ChannelSftp.LsEntry>
      Throws:
      IOException

    • read

      public void read(String source, OutputStream os) throws IOException
      Specified by:
      read in interface Session<com.jcraft.jsch.ChannelSftp.LsEntry>
      Throws:
      IOException

    • readRaw

      public InputStream readRaw(String source) throws IOException
      Description copied from interface: Session
      Retrieve a remote file as a raw InputStream.
      Specified by:
      readRaw in interface Session<com.jcraft.jsch.ChannelSftp.LsEntry>
      Parameters:
      source - The path of the remote file.
      Returns:
      The raw inputStream.
      Throws:
      IOException - Any IOException.

    • finalizeRaw

      public boolean finalizeRaw()
      Description copied from interface: Session
      Invoke after closing the InputStream from Session.readRaw(String). Required by some session providers.
      Specified by:
      finalizeRaw in interface Session<com.jcraft.jsch.ChannelSftp.LsEntry>
      Returns:
      true if successful.

    • write

      public void write(InputStream inputStream, String destination) throws IOException
      Specified by:
      write in interface Session<com.jcraft.jsch.ChannelSftp.LsEntry>
      Throws:
      IOException

    • append

      public void append(InputStream inputStream, String destination) throws IOException
      Description copied from interface: Session
      Append to a file.
      Specified by:
      append in interface Session<com.jcraft.jsch.ChannelSftp.LsEntry>
      Parameters:
      inputStream - the stream.
      destination - the destination.
      Throws:
      IOException - an IO Exception.

    • close

      public void close()
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable
      Specified by:
      close in interface Session<com.jcraft.jsch.ChannelSftp.LsEntry>

    • isOpen

      public boolean isOpen()
      Specified by:
      isOpen in interface Session<com.jcraft.jsch.ChannelSftp.LsEntry>

    • rename

      public void rename(String pathFrom, String pathTo) throws IOException
      Specified by:
      rename in interface Session<com.jcraft.jsch.ChannelSftp.LsEntry>
      Throws:
      IOException

    • mkdir

      public boolean mkdir(String remoteDirectory) throws IOException
      Specified by:
      mkdir in interface Session<com.jcraft.jsch.ChannelSftp.LsEntry>
      Throws:
      IOException

    • rmdir

      public boolean rmdir(String remoteDirectory) throws IOException
      Description copied from interface: Session
      Remove a remote directory.
      Specified by:
      rmdir in interface Session<com.jcraft.jsch.ChannelSftp.LsEntry>
      Parameters:
      remoteDirectory - The directory.
      Returns:
      True if the directory was removed.
      Throws:
      IOException - an IO exception.

    • exists

      public boolean exists(String path)
      Description copied from interface: Session
      Check if the remote file or directory exists.
      Specified by:
      exists in interface Session<com.jcraft.jsch.ChannelSftp.LsEntry>
      Parameters:
      path - the remote path.
      Returns:
      true or false if remote path exists or not.

    • getClientInstance

      public com.jcraft.jsch.ChannelSftp getClientInstance()
      Description copied from interface: Session
      Get the underlying client library's client instance for this session. Returns an Object to avoid significant changes to -file, -ftp, -sftp modules, which would be required if we added another generic parameter. Implementations should narrow the return type.
      Specified by:
      getClientInstance in interface Session<com.jcraft.jsch.ChannelSftp.LsEntry>
      Returns:
      The client instance.

    • getHostPort

      public String getHostPort()
      Description copied from interface: Session
      Return the host:port pair this session is connected to.
      Specified by:
      getHostPort in interface Session<com.jcraft.jsch.ChannelSftp.LsEntry>
      Returns:
      the host:port pair this session is connected to.

    • test

      public boolean test()
      Description copied from interface: Session
      Test the session is still alive, e.g. when checking out from a pool. The default implementation simply delegates to Session.isOpen().
      Specified by:
      test in interface Session<com.jcraft.jsch.ChannelSftp.LsEntry>
      Returns:
      true if the test is successful.