org.jenkinsci.plugins.remote_terminal_access.ssh

Class AbstractRemoteSshCommand

java.lang.Object

org.jenkinsci.main.modules.sshd.AsynchronousCommand

org.jenkinsci.plugins.remote_terminal_access.ssh.AbstractRemoteSshCommand

All Implemented Interfaces:

org.apache.sshd.server.Command, org.apache.sshd.server.SessionAware

Direct Known Subclasses:

DiagnoseCommand, LeaseSshCommand

public abstract class AbstractRemoteSshCommand
extends org.jenkinsci.main.modules.sshd.AsynchronousCommand

Author:

Kohsuke Kawaguchi

Field Summary

Fields

Modifier and Type	Field and Description
protected org.kohsuke.ajaxterm.ProcessWithPty	proc

Constructor Summary

Constructors

Constructor and Description
AbstractRemoteSshCommand(org.jenkinsci.main.modules.sshd.SshCommandFactory.CommandLine cmdLine)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	configure(ProcessWithPtyLauncher pb) Configures how/where the process is launched.
protected int	die(String msg)
protected PrintStream	getErrorPrintStream() When the terminal is allocated, I discovered that the linux SSH client (at least) sends the terminal mode ONLCR to 1, and expects us to send back CR+LF instead of just NL.
protected abstract int	main(List<String> args)
protected int	run()
protected int	run(List<String> args) Runs the specified commands and pumps the stdin/stdout/stderr between proc and the SSH client.
void	start(org.apache.sshd.server.Environment env) Pass along the signal from the client to the child process.

Methods inherited from class org.jenkinsci.main.modules.sshd.AsynchronousCommand

destroy, getCmdLine, getCurrentUser, getEnvironment, getErrorStream, getInputStream, getOutputStream, getSession, setErrorStream, setExitCallback, setInputStream, setOutputStream, setSession

Methods inherited from class java.lang.Object

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

Field Detail

proc

protected org.kohsuke.ajaxterm.ProcessWithPty proc

Constructor Detail

AbstractRemoteSshCommand

public AbstractRemoteSshCommand(org.jenkinsci.main.modules.sshd.SshCommandFactory.CommandLine cmdLine)

Method Detail

start

public void start(org.apache.sshd.server.Environment env)
           throws IOException

Pass along the signal from the client to the child process.

Specified by:

start in interface org.apache.sshd.server.Command

Overrides:

start in class org.jenkinsci.main.modules.sshd.AsynchronousCommand

Throws:

IOException

getErrorPrintStream

protected PrintStream getErrorPrintStream()

When the terminal is allocated, I discovered that the linux SSH client (at least) sends the terminal mode ONLCR to 1, and expects us to send back CR+LF instead of just NL. If I understand pty correctly, I should be able to send a command to set this off, but I can't find such a command in terminfo, so I'm just working around by sending CR+LF. This unfortunately requires reflection as PrintStream doesn't make it modifiable.

die

protected int die(String msg)

run

protected int run(List<String> args)
           throws IOException,
                  InterruptedException

Runs the specified commands and pumps the stdin/stdout/stderr between proc and the SSH client.

Returns:

When the child process exits, this method returns with its exit code.

Throws:

IOException

InterruptedException

configure

protected abstract void configure(ProcessWithPtyLauncher pb)
                           throws IOException,
                                  InterruptedException

Configures how/where the process is launched.

Throws:

IOException

InterruptedException

run

protected int run()

Specified by:

run in class org.jenkinsci.main.modules.sshd.AsynchronousCommand

main

protected abstract int main(List<String> args)
                     throws IOException,
                            InterruptedException,
                            org.kohsuke.args4j.CmdLineException

Throws:

IOException

InterruptedException

org.kohsuke.args4j.CmdLineException