org.apache.sshd.server.shell

Class InvertedShellWrapper

java.lang.Object

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

org.apache.sshd.server.shell.InvertedShellWrapper

All Implemented Interfaces:

Command, CommandDirectErrorStreamAware, CommandDirectInputStreamAware, CommandDirectOutputStreamAware, CommandDirectStreamsAware, CommandLifecycle, ServerSessionAware

public class InvertedShellWrapper
extends AbstractLoggingBean
implements Command, ServerSessionAware

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.

Field Summary

Fields

Modifier and Type	Field and Description
private int	bufferSize
private ExitCallback	callback
private java.io.OutputStream	err
private java.util.concurrent.Executor	executor
private java.io.InputStream	in
private java.io.OutputStream	out
private java.time.Duration	pumpSleepTime
private InvertedShell	shell
private java.io.InputStream	shellErr
private java.io.OutputStream	shellIn
private java.io.InputStream	shellOut
private boolean	shutdownExecutor

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

log

Constructor Summary

Constructors

Constructor and Description
InvertedShellWrapper(InvertedShell shell) Auto-allocates an Executor in order to create the streams pump thread and uses the default CoreModuleProperties.BUFFER_SIZE
InvertedShellWrapper(InvertedShell shell, java.util.concurrent.Executor executor, boolean shutdownExecutor, int bufferSize)
InvertedShellWrapper(InvertedShell shell, int bufferSize) Auto-allocates an Executor in order to create the streams pump thread

Method Summary

Modifier and Type	Method and Description
void	destroy(ChannelSession channel) This method is called by the SSH server to destroy the command because the client has disconnected somehow.
protected boolean	pumpStream(java.io.InputStream in, java.io.OutputStream out, byte[] buffer)
protected void	pumpStreams()
void	setErrorStream(java.io.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(java.io.InputStream in) Set the input stream that can be used by the shell to read input.
void	setOutputStream(java.io.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.
java.lang.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

Field Detail

shell

private final InvertedShell shell

executor

private final java.util.concurrent.Executor executor

bufferSize

private int bufferSize

pumpSleepTime

private java.time.Duration pumpSleepTime

in

private java.io.InputStream in

out

private java.io.OutputStream out

err

private java.io.OutputStream err

shellIn

private java.io.OutputStream shellIn

shellOut

private java.io.InputStream shellOut

shellErr

private java.io.InputStream shellErr

callback

private ExitCallback callback

shutdownExecutor

private boolean shutdownExecutor

Constructor Detail

InvertedShellWrapper

public InvertedShellWrapper(InvertedShell shell)

Auto-allocates an Executor in order to create the streams pump thread and uses the default CoreModuleProperties.BUFFER_SIZE

Parameters:

shell - The InvertedShell

See Also:

InvertedShellWrapper(InvertedShell, int)

InvertedShellWrapper

public InvertedShellWrapper(InvertedShell shell,
                            int bufferSize)

Auto-allocates an Executor in order to create the streams pump thread

Parameters:

shell - The InvertedShell

bufferSize - Buffer size to use - must be above min. size (Byte.SIZE)

See Also:

InvertedShellWrapper(InvertedShell, Executor, boolean, int)

InvertedShellWrapper

public InvertedShellWrapper(InvertedShell shell,
                            java.util.concurrent.Executor executor,
                            boolean shutdownExecutor,
                            int bufferSize)

Parameters:

shell - The InvertedShell

executor - The Executor to use in order to create the streams pump thread. If null one is auto-allocated and shutdown when wrapper is destroy()-ed.

shutdownExecutor - If true the executor is shut down when shell wrapper is destroy()-ed. Ignored if executor service auto-allocated

bufferSize - Buffer size to use - must be above min. size (Byte.SIZE)

Method Detail

setInputStream

public void setInputStream(java.io.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.

setOutputStream

public void setOutputStream(java.io.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

setErrorStream

public void setErrorStream(java.io.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

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 ServerSessionAware

Parameters:

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

start

public void start(ChannelSession channel,
                  Environment env)
           throws java.io.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:

java.io.IOException - If failed to start

destroy

public void destroy(ChannelSession channel)
             throws java.lang.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:

java.lang.Exception - if failed to destroy

pumpStreams

protected void pumpStreams()

pumpStream

protected boolean pumpStream(java.io.InputStream in,
                             java.io.OutputStream out,
                             byte[] buffer)
                      throws java.io.IOException

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object