org.apache.sshd.server.shell

Class InvertedShellWrapper

java.lang.Object

org.apache.sshd.server.shell.InvertedShellWrapper

All Implemented Interfaces:

Command, SessionAware

public class InvertedShellWrapper
extends Object
implements Command, SessionAware

A shell implementation that wraps an instance of InvertedShell as a Command. This is useful when using external processes. When starting the shell, this wrapper will also create a thread used to pump the streams and also to check if the shell is alive.

Author:

Apache MINA SSHD Project

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_BUFFER_SIZE default buffer size for the IO pumps.

Constructor Summary

Constructors

Constructor and Description
InvertedShellWrapper(InvertedShell shell)
InvertedShellWrapper(InvertedShell shell, Executor executor)
InvertedShellWrapper(InvertedShell shell, Executor executor, boolean shutdownExecutor, int bufferSize)
InvertedShellWrapper(InvertedShell shell, Executor executor, int bufferSize)
InvertedShellWrapper(InvertedShell shell, int bufferSize)

Method Summary

Modifier and Type	Method and Description
void	destroy() Destroy the shell.
protected void	pumpStreams()
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(Environment env) Starts the shell.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_BUFFER_SIZE

public static final int DEFAULT_BUFFER_SIZE

default buffer size for the IO pumps.

See Also:

Constant Field Values

Constructor Detail

InvertedShellWrapper

public InvertedShellWrapper(InvertedShell shell)

InvertedShellWrapper

public InvertedShellWrapper(InvertedShell shell,
                            Executor executor)

InvertedShellWrapper

public InvertedShellWrapper(InvertedShell shell,
                            int bufferSize)

InvertedShellWrapper

public InvertedShellWrapper(InvertedShell shell,
                            Executor executor,
                            int bufferSize)

InvertedShellWrapper

public InvertedShellWrapper(InvertedShell shell,
                            Executor executor,
                            boolean shutdownExecutor,
                            int bufferSize)

Method Detail

setInputStream

public void setInputStream(InputStream in)

Description copied from interface: Command

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

Specified by:

setInputStream in interface Command

Parameters:

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

setOutputStream

public void setOutputStream(OutputStream out)

Description copied from interface: Command

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

Specified by:

setOutputStream in interface Command

Parameters:

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

setErrorStream

public void setErrorStream(OutputStream err)

Description copied from interface: Command

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

Specified by:

setErrorStream in interface Command

Parameters:

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

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

setSession

public void setSession(ServerSession session)

Specified by:

setSession in interface SessionAware

Parameters:

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

start

public void start(Environment env)
           throws IOException

Description copied from interface: Command

Starts the shell. 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 Command

Parameters:

env - The Environment

Throws:

IOException - If failed to start

destroy

public void destroy()

Description copied from interface: Command

Destroy the shell. This method can be called by the SSH server to destroy the shell because the client has disconnected somehow.

Specified by:

destroy in interface Command

pumpStreams

protected void pumpStreams()