Package org.apache.sshd.server.command

Class AbstractCommandSupport

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.server.command.AbstractCommandSupport

All Implemented Interfaces:

Runnable, SessionContextHolder, SessionHolder<ServerSession>, ExecutorServiceCarrier, Command, CommandDirectErrorStreamAware, CommandDirectInputStreamAware, CommandDirectOutputStreamAware, CommandDirectStreamsAware, CommandLifecycle, ServerSessionAware, ServerSessionHolder

Direct Known Subclasses:

AbstractFileSystemCommand

public abstract class AbstractCommandSupport
extends AbstractLoggingBean
implements Command, Runnable, ExecutorServiceCarrier, ServerSessionAware, SessionHolder<ServerSession>, ServerSessionHolder

Provides a basic useful skeleton for Command executions

Author:

Apache MINA SSHD Project

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	cbCalled
protected Thread	cmdRunner
protected CloseableExecutorService	executorService

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

log

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractCommandSupport(String command, CloseableExecutorService executorService)

Method Summary

Modifier and Type	Method	Description
void	destroy(ChannelSession channel)	This method is called by the SSH server to destroy the command because the client has disconnected somehow.
String	getCommand()
Environment	getEnvironment()
OutputStream	getErrorStream()
CloseableExecutorService	getExecutorService()
ExitCallback	getExitCallback()
InputStream	getInputStream()
OutputStream	getOutputStream()
ServerSession	getServerSession()
ServerSession	getSession()
protected Future<?>	getStartedCommandFuture()
protected void	onExit(int exitValue)
protected void	onExit(int exitValue, String exitMessage)
void	setErrorStream(OutputStream err)	Set the error stream that can be used by the shell to write its errors.
void	setExitCallback(ExitCallback callback)	Set the callback that the shell has to call when it is closed.
void	setInputStream(InputStream in)	Set the input stream that can be used by the shell to read input.
void	setOutputStream(OutputStream out)	Set the output stream that can be used by the shell to write its output.
void	setSession(ServerSession session)
void	start(ChannelSession channel, Environment env)	Starts the command execution.
String	toString()

Methods inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

debug, debug, debug, debug, debug, error, error, error, error, error, getSimplifiedLogger, info, info, warn, warn, warn, warn, warn, warn, warn, warn

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Runnable

run

Methods inherited from interface org.apache.sshd.common.session.SessionHolder

getSessionContext

Field Detail

cmdRunner

protected volatile Thread cmdRunner

executorService

protected CloseableExecutorService executorService

cbCalled

protected boolean cbCalled

Constructor Detail

AbstractCommandSupport

protected AbstractCommandSupport(String command,
                                 CloseableExecutorService executorService)

Method Detail

getCommand

public String getCommand()

getSession

public ServerSession getSession()

Specified by:

getSession in interface SessionHolder<ServerSession>

getServerSession

public ServerSession getServerSession()

Specified by:

getServerSession in interface ServerSessionHolder

Returns:

The underlying ServerSession used

setSession

public void setSession(ServerSession session)

Specified by:

setSession in interface ServerSessionAware

Parameters:

session - The ServerSession in which this shell will be executed.

getExecutorService

public CloseableExecutorService getExecutorService()

Specified by:

getExecutorService in interface ExecutorServiceCarrier

getInputStream

public InputStream getInputStream()

setInputStream

public void setInputStream(InputStream in)

Description copied from interface: CommandDirectInputStreamAware

Set the input stream that can be used by the shell to read input.

Specified by:

setInputStream in interface CommandDirectInputStreamAware

Parameters:

in - The InputStream used by the shell to read input.

getOutputStream

public OutputStream getOutputStream()

setOutputStream

public void setOutputStream(OutputStream out)

Description copied from interface: CommandDirectOutputStreamAware

Set the output stream that can be used by the shell to write its output.

Specified by:

setOutputStream in interface CommandDirectOutputStreamAware

Parameters:

out - The OutputStream used by the shell to write its output

getErrorStream

public OutputStream getErrorStream()

setErrorStream

public void setErrorStream(OutputStream err)

Description copied from interface: CommandDirectErrorStreamAware

Set the error stream that can be used by the shell to write its errors.

Specified by:

setErrorStream in interface CommandDirectErrorStreamAware

Parameters:

err - The OutputStream used by the shell to write its errors

getExitCallback

public ExitCallback getExitCallback()

setExitCallback

public void setExitCallback(ExitCallback callback)

Description copied from interface: Command

Set the callback that the shell has to call when it is closed.

Specified by:

setExitCallback in interface Command

Parameters:

callback - The ExitCallback to call when shell is closed

getEnvironment

public Environment getEnvironment()

getStartedCommandFuture

protected Future<?> getStartedCommandFuture()

start

public void start(ChannelSession channel,
                  Environment env)
           throws IOException

Description copied from interface: CommandLifecycle

Starts the command execution. All streams must have been set before calling this method. The command should implement Runnable, and this method should spawn a new thread like:

 Thread(this).start(); 
 

Specified by:

start in interface CommandLifecycle

Parameters:

channel - The ChannelSession through which the command has been received

env - The Environment

Throws:

IOException - If failed to start

destroy

public void destroy(ChannelSession channel)
             throws Exception

Description copied from interface: CommandLifecycle

This method is called by the SSH server to destroy the command because the client has disconnected somehow.

Specified by:

destroy in interface CommandLifecycle

Parameters:

channel - The ChannelSession through which the command has been received

Throws:

Exception - if failed to destroy

onExit

protected void onExit(int exitValue)

onExit

protected void onExit(int exitValue,
                      String exitMessage)

toString

public String toString()

Overrides:

toString in class Object