org.jenkinsci.plugins.remote_terminal_access.ssh

Class AbstractTunnelCommand

java.lang.Object

org.jenkinsci.main.modules.sshd.AsynchronousCommand

org.jenkinsci.plugins.remote_terminal_access.ssh.AbstractTunnelCommand

All Implemented Interfaces:

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

Direct Known Subclasses:

DiagnoseTunnelCommand, LeaseTunnelCommand

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

SSH command that tunnels another SSH session for the purpose of adding contextual data around it.

To implement a subtype,

• Override the run() method and parse command line options and arguments that define the context.
• Implement getCommandFactory() and getShellFactory() to run a command and shell for the tunneled SSH sessions. This is where you refer to the parsed context information.

Author:

Kohsuke Kawaguchi

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract org.apache.sshd.server.CommandFactory	getCommandFactory()
protected org.apache.sshd.server.FileSystemView	getFileSystemFactory() Override this method to add sftp support
protected abstract org.apache.sshd.common.Factory<org.apache.sshd.server.Command>	getShellFactory()
protected int	run() Turn the connection over into another nested SSH session.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractTunnelCommand

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

Method Detail

run

protected int run()
           throws Exception

Turn the connection over into another nested SSH session. IOW, stdin/stdout behave as if it's freshly connected to another SSH port.

Specified by:

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

Throws:

Exception

getCommandFactory

protected abstract org.apache.sshd.server.CommandFactory getCommandFactory()

getShellFactory

protected abstract org.apache.sshd.common.Factory<org.apache.sshd.server.Command> getShellFactory()

getFileSystemFactory

protected org.apache.sshd.server.FileSystemView getFileSystemFactory()

Override this method to add sftp support