Package org.jline.builtins.ssh

Class Ssh

java.lang.Object

org.jline.builtins.ssh.Ssh

public class Ssh
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Ssh.ExecuteParams
static class	Ssh.ShellParams

Field Summary

Fields

Modifier and Type	Field	Description
static final String[]	functions

Constructor Summary

Constructors

Constructor	Description
Ssh(Consumer<Ssh.ShellParams> shell, Consumer<Ssh.ExecuteParams> execute, Supplier<org.apache.sshd.server.SshServer> serverBuilder, Supplier<org.apache.sshd.client.SshClient> clientBuilder)

Method Summary

Modifier and Type	Method	Description
void	ssh(Terminal terminal, LineReader reader, String user, InputStream stdin, PrintStream stdout, PrintStream stderr, String[] argv)	Connects to an SSH server and either executes a remote command or opens an interactive shell.
void	sshd(PrintStream stdout, PrintStream stderr, String[] argv)

Methods inherited from class java.lang.Object

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

Field Details

functions

public static final String[] functions

Constructor Details

Ssh

public Ssh(Consumer<Ssh.ShellParams> shell,
 Consumer<Ssh.ExecuteParams> execute,
 Supplier<org.apache.sshd.server.SshServer> serverBuilder,
 Supplier<org.apache.sshd.client.SshClient> clientBuilder)

Method Details

ssh

public void ssh(Terminal terminal,
 LineReader reader,
 String user,
 InputStream stdin,
 PrintStream stdout,
 PrintStream stderr,
 String[] argv)
         throws Exception

Connects to an SSH server and either executes a remote command or opens an interactive shell. Parses connection target from argv (optionally containing user and port), establishes an SSH client session, and forwards local stdin/stdout/stderr to the remote side. In interactive mode configures a PTY from the provided Terminal, installs signal handlers for window changes and job-control signals, and restores terminal state on exit.

Parameters:

terminal - the Terminal used for raw-mode control, PTY geometry, and signal handling

reader - a LineReader used for user interaction (passwords/prompts)

user - the default username to use if not specified in argv

stdin - input stream to forward to the remote session

stdout - output stream to receive remote standard output

stderr - output stream to receive remote standard error and interaction errors

argv - command-line arguments; first positional is target ([user@]host[:port]) and remaining tokens form an optional remote command; supports --help

Throws:

Exception - for SSH, authentication, or I/O errors that occur while connecting or during remote command/shell execution

sshd

public void sshd(PrintStream stdout,
 PrintStream stderr,
 String[] argv)
          throws Exception

Throws:

Exception