Package com.sshtools.common.command

Class AbstractExecutableCommand

java.lang.Object

com.sshtools.common.command.AbstractExecutableCommand

All Implemented Interfaces:

ExecutableCommand, Component

Direct Known Subclasses:

NativeExecutableCommand, ScpCommand

public abstract class AbstractExecutableCommand
extends Object
implements ExecutableCommand

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

Nested Class Summary

Nested classes/interfaces inherited from interface com.sshtools.common.command.ExecutableCommand

ExecutableCommand.ExecutableCommandFactory<T extends ExecutableCommand>

Field Summary

Fields

Modifier and Type	Field	Description
protected SessionChannelServer	session	The session channel instance on which this command is being executed

Fields inherited from interface com.sshtools.common.command.ExecutableCommand

STILL_ACTIVE

Constructor Summary

Constructors

Constructor	Description
AbstractExecutableCommand()

Method Summary

Modifier and Type	Method	Description
boolean	allocatePseudoTerminal(String term, int cols, int rows, int width, int height, byte[] modes)
abstract boolean	createProcess(String[] args, Map<String,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.
InputStream	getInputStream()	Get the STDIN InputStream for this process.
OutputStream	getOutputStream()	Get the STDOUT OutputStream for this process.
SessionChannel	getSession()
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 Details

session

protected SessionChannelServer session

The session channel instance on which this command is being executed

Constructor Details

AbstractExecutableCommand

public AbstractExecutableCommand()

Method Details

init

public void init(SessionChannelServer session)

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

Specified by:

init in interface ExecutableCommand

Parameters:

session -

getSession

public SessionChannel getSession()

Specified by:

getSession in interface ExecutableCommand

createProcess

public abstract boolean createProcess(String[] args,
 Map<String,String> environment)

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

Specified by:

createProcess in interface ExecutableCommand

Parameters:

cmd -

environment -

Returns:

boolean

start

public void start()

Start the command.

Specified by:

start in interface ExecutableCommand

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.

Specified by:

onStart in interface ExecutableCommand

kill

public abstract void kill()

Kill the command.

Specified by:

kill in interface ExecutableCommand

getExitCode

public abstract int getExitCode()

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

Specified by:

getExitCode in interface ExecutableCommand

Returns:

int

getOutputStream

public OutputStream getOutputStream()

Get the STDOUT OutputStream for this process.

Specified by:

getOutputStream in interface ExecutableCommand

Returns:

OutputStream

getStderrOutputStream

public OutputStream getStderrOutputStream()

Get the STDERR OutputStream for this process.

Specified by:

getStderrOutputStream in interface ExecutableCommand

Returns:

OutputStream

getInputStream

public InputStream getInputStream()

Get the STDIN InputStream for this process.

Specified by:

getInputStream in interface ExecutableCommand

Returns:

InputStream

allocatePseudoTerminal

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

Specified by:

allocatePseudoTerminal in interface ExecutableCommand