Package com.sshtools.common.command

Class NativeExecutableCommand

java.lang.Object

com.sshtools.common.command.AbstractExecutableCommand

com.sshtools.common.command.NativeExecutableCommand

All Implemented Interfaces:

ExecutableCommand, Component

public class NativeExecutableCommand
extends AbstractExecutableCommand

A further extension of the AbstractExecutableCommand that provides the ability to execute a native process. Caution should be taken with this current implementation as no processing of EOL is provided and results may vary on different platforms. It is recommended that only automated clients use this feature due to the many differences in user terminals which may cause problems with command output not performing as expected.

Nested Class Summary

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

ExecutableCommand.ExecutableCommandFactory<T extends ExecutableCommand>

Field Summary

Fields inherited from class com.sshtools.common.command.AbstractExecutableCommand

session

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

STILL_ACTIVE

Constructor Summary

Constructors

Constructor	Description
NativeExecutableCommand()

Method Summary

Modifier and Type	Method	Description
boolean	createProcess(String[] commandLine, Map<String,String> environment)	Create the process but wait for the AbstractExecutableCommand.onStart() method before performing any IO.
int	getExitCode()	Get the exit code for this process.
void	kill()	Kill the command.
void	onStart()	Called once the command has been started.

Methods inherited from class com.sshtools.common.command.AbstractExecutableCommand

allocatePseudoTerminal, getInputStream, getOutputStream, getSession, getStderrOutputStream, init, start

Methods inherited from class java.lang.Object

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

Constructor Details

NativeExecutableCommand

public NativeExecutableCommand()

Method Details

onStart

public void onStart()

Description copied from class: AbstractExecutableCommand

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

Specified by:

onStart in class AbstractExecutableCommand

getExitCode

public int getExitCode()

Description copied from class: AbstractExecutableCommand

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

Specified by:

getExitCode in interface ExecutableCommand

Specified by:

getExitCode in class AbstractExecutableCommand

Returns:

int

createProcess

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

Description copied from class: AbstractExecutableCommand

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

Specified by:

createProcess in interface ExecutableCommand

Specified by:

createProcess in class AbstractExecutableCommand

Returns:

boolean

kill

public void kill()

Description copied from class: AbstractExecutableCommand

Kill the command.

Specified by:

kill in interface ExecutableCommand

Specified by:

kill in class AbstractExecutableCommand