com.helger.jsch.sftp

Class SftpRunner

java.lang.Object

com.helger.jsch.sftp.SftpRunner

All Implemented Interfaces:

AutoCloseable

public class SftpRunner
extends Object
implements AutoCloseable

Provides a convenience wrapper around an sftp channel. This implementation offers a simplified interface that manages the resources needed to issue sftp commands.

See Also:

ChannelSftp

Constructor Summary

Constructors

Constructor and Description
SftpRunner(ISessionFactory sessionFactory) Creates a new SftpRunner that will use a SessionManager that wraps the supplied sessionFactory.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the underlying SessionManager.
void	execute(ISftp sftp) Executes the sftp callback providing it an open ChannelSftp.

Methods inherited from class java.lang.Object

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

Constructor Detail

SftpRunner

public SftpRunner(@Nonnull
                  ISessionFactory sessionFactory)

Creates a new SftpRunner that will use a SessionManager that wraps the supplied sessionFactory.

Parameters:

sessionFactory - The factory used to create a session manager

Method Detail

execute

public void execute(@Nonnull
                    ISftp sftp)
             throws com.jcraft.jsch.JSchException,
                    IOException

Executes the sftp callback providing it an open ChannelSftp. Sftp callback implementations should NOT close the channel.

Parameters:

sftp - A callback

Throws:

com.jcraft.jsch.JSchException - If ssh execution fails

IOException - If unable to read the result data

close

public void close()
           throws IOException

Closes the underlying SessionManager.

Specified by:

close in interface AutoCloseable

Throws:

IOException

See Also:

SessionManager.close()