Package org.qubership.atp.environments.utils.jsch

Class SshConnectionManager

java.lang.Object

org.qubership.atp.environments.utils.jsch.SshConnectionManager

All Implemented Interfaces:

Closeable, AutoCloseable

public class SshConnectionManager
extends Object
implements Closeable, AutoCloseable

Constructor Summary

Constructors

Constructor	Description
SshConnectionManager(String host, int port, String login, String password, String key, String passphrase)	SSH connection constructor.

Method Summary

Modifier and Type	Method	Description
void	close()
void	open()	Open SSH connection.
Optional<String>	runCommand(String command)	See runCommand(String, Collector).
<R> Optional<R>	runCommand(String command, Collector<? super String,?,R> collector)	Preferred way to execute commands.
void	setSessionTimeout(int sessionTimeout)

Methods inherited from class java.lang.Object

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

Constructor Details

SshConnectionManager

public SshConnectionManager(String host,
 int port,
 String login,
 String password,
 String key,
 String passphrase)

SSH connection constructor.

Method Details

open

public void open()

Open SSH connection.

setSessionTimeout

public void setSessionTimeout(int sessionTimeout)

runCommand

public Optional<String> runCommand(String command)

See runCommand(String, Collector).

runCommand

public <R> Optional<R> runCommand(String command,
 Collector<? super String,?,R> collector)
                           throws TimeoutException

Preferred way to execute commands. ! Uses 'bash -c ...' without '--login' option. ! May not work as expected since environment variables may differ from interactive mode.

Returns:

command output. May not be present.

Throws:

RuntimeException - if command executed with error.

TimeoutException

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable