com.sshtools.common.command

Class ExecutableCommand

java.lang.Object

com.sshtools.common.command.ExecutableCommand

Direct Known Subclasses:

NativeExecutableCommand, ScpCommand

public abstract class ExecutableCommand
extends java.lang.Object

This class can be extended to provide a single executable command. Commands are configured in the com.maverick.sshd.ConfigurationContext and they make use of the input/output streams provided to communicate with the client.

Author:

Lee David Painter

Field Summary

Fields

Modifier and Type	Field and Description
protected SessionChannelServer	session The session channel instance on which this command is being executed
static int	STILL_ACTIVE Value returned from getExitCode() to indicate that the process is still active.

Constructor Summary

Constructors

Constructor and Description
ExecutableCommand()

Method Summary

Modifier and Type	Method and Description
boolean	allocatePseudoTerminal(java.lang.String term, int cols, int rows, int width, int height, byte[] modes)
abstract boolean	createProcess(java.lang.String[] args, java.util.Map<java.lang.String,java.lang.String> environment) Create the process but wait for the onStart() method before performing any IO.
abstract int	getExitCode() Get the exit code for this process.
java.io.InputStream	getInputStream() Get the STDIN InputStream for this process.
java.io.OutputStream	getOutputStream() Get the STDOUT OutputStream for this process.
SessionChannel	getSession()
java.io.OutputStream	getStderrOutputStream() Get the STDERR OutputStream for this process.
void	init(SessionChannelServer session) Initialize the command.
abstract void	kill() Kill the command.
abstract void	onStart() Called once the command has been started.
void	start() Start the command.

Methods inherited from class java.lang.Object

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

Field Detail

STILL_ACTIVE

public static final int STILL_ACTIVE

Value returned from getExitCode() to indicate that the process is still active.

See Also:

Constant Field Values

session

protected SessionChannelServer session

The session channel instance on which this command is being executed

Constructor Detail

ExecutableCommand

public ExecutableCommand()

Method Detail

init

public void init(SessionChannelServer session)

Initialize the command. This can be overridden but always call this super method with the command's session.

Parameters:

session -

getSession

public SessionChannel getSession()

createProcess

public abstract boolean createProcess(java.lang.String[] args,
                                      java.util.Map<java.lang.String,java.lang.String> environment)

Create the process but wait for the onStart() method before performing any IO.

Parameters:

cmd -

environment -

Returns:

boolean

start

public void start()

Start the command.

onStart

public abstract void onStart()

Called once the command has been started. Operations within this method SHOULD NOT block as this will cause the connection to lockup.

kill

public abstract void kill()

Kill the command.

getExitCode

public abstract int getExitCode()

Get the exit code for this process. If the process has not completed return STILL_ACTIVE.

Returns:

int

getOutputStream

public java.io.OutputStream getOutputStream()

Get the STDOUT OutputStream for this process.

Returns:

OutputStream

getStderrOutputStream

public java.io.OutputStream getStderrOutputStream()

Get the STDERR OutputStream for this process.

Returns:

OutputStream

getInputStream

public java.io.InputStream getInputStream()

Get the STDIN InputStream for this process.

Returns:

InputStream

allocatePseudoTerminal

public boolean allocatePseudoTerminal(java.lang.String term,
                                      int cols,
                                      int rows,
                                      int width,
                                      int height,
                                      byte[] modes)