Package 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
,CommandLifecycle
,SessionAware
public class InvertedShellWrapper extends AbstractLoggingBean implements Command, SessionAware
A shell implementation that wraps an instance ofInvertedShell
as aCommand
. 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 Description static int
DEFAULT_BUFFER_SIZE
Default buffer size for the I/O pumps.static long
DEFAULT_PUMP_SLEEP_TIME
Default value forPUMP_SLEEP_TIME
if none setstatic String
PUMP_SLEEP_TIME
Value used to control the "busy-wait" sleep time (millis) on the pumping loop if nothing was pumped - must be positive-
Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean
log
-
-
Constructor Summary
Constructors Constructor Description InvertedShellWrapper(InvertedShell shell)
Auto-allocates anExecutor
in order to create the streams pump thread and uses theDEFAULT_BUFFER_SIZE
InvertedShellWrapper(InvertedShell shell, int bufferSize)
Auto-allocates anExecutor
in order to create the streams pump threadInvertedShellWrapper(InvertedShell shell, Executor executor, boolean shutdownExecutor, int bufferSize)
-
Method Summary
All Methods Instance Methods Concrete Methods 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.protected boolean
pumpStream(InputStream in, OutputStream out, byte[] buffer)
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(ChannelSession channel, Environment env)
Starts the command execution.String
toString()
-
Methods inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean
getSimplifiedLogger
-
-
-
-
Field Detail
-
DEFAULT_BUFFER_SIZE
public static final int DEFAULT_BUFFER_SIZE
Default buffer size for the I/O pumps.- See Also:
- Constant Field Values
-
PUMP_SLEEP_TIME
public static final String PUMP_SLEEP_TIME
Value used to control the "busy-wait" sleep time (millis) on the pumping loop if nothing was pumped - must be positive- See Also:
DEFAULT_PUMP_SLEEP_TIME
, Constant Field Values
-
DEFAULT_PUMP_SLEEP_TIME
public static final long DEFAULT_PUMP_SLEEP_TIME
Default value forPUMP_SLEEP_TIME
if none set- See Also:
- Constant Field Values
-
-
Constructor Detail
-
InvertedShellWrapper
public InvertedShellWrapper(InvertedShell shell)
Auto-allocates anExecutor
in order to create the streams pump thread and uses theDEFAULT_BUFFER_SIZE
- Parameters:
shell
- TheInvertedShell
- See Also:
InvertedShellWrapper(InvertedShell, int)
-
InvertedShellWrapper
public InvertedShellWrapper(InvertedShell shell, int bufferSize)
Auto-allocates anExecutor
in order to create the streams pump thread- Parameters:
shell
- TheInvertedShell
bufferSize
- Buffer size to use - must be above min. size (Byte.SIZE
)- See Also:
InvertedShellWrapper(InvertedShell, Executor, boolean, int)
-
InvertedShellWrapper
public InvertedShellWrapper(InvertedShell shell, Executor executor, boolean shutdownExecutor, int bufferSize)
- Parameters:
shell
- TheInvertedShell
executor
- TheExecutor
to use in order to create the streams pump thread. Ifnull
one is auto-allocated and shutdown when wrapper isdestroy()
-ed.shutdownExecutor
- Iftrue
the executor is shut down when shell wrapper isdestroy()
-ed. Ignored if executor service auto-allocatedbufferSize
- Buffer size to use - must be above min. size (Byte.SIZE
)
-
-
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 interfaceCommand
- Parameters:
in
- TheInputStream
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 interfaceCommand
- Parameters:
out
- TheOutputStream
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 interfaceCommand
- Parameters:
err
- TheOutputStream
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 interfaceCommand
- Parameters:
callback
- TheExitCallback
to call when shell is closed
-
setSession
public void setSession(ServerSession session)
- Specified by:
setSession
in interfaceSessionAware
- Parameters:
session
- TheServerSession
in which this shell will be executed.
-
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 implementRunnable
, and this method should spawn a new thread like:Thread(this).start();
- Specified by:
start
in interfaceCommandLifecycle
- Parameters:
channel
- TheChannelSession
through which the command has been receivedenv
- TheEnvironment
- 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 interfaceCommandLifecycle
- Parameters:
channel
- TheChannelSession
through which the command has been received- Throws:
Exception
- if failed to destroy
-
pumpStreams
protected void pumpStreams()
-
pumpStream
protected boolean pumpStream(InputStream in, OutputStream out, byte[] buffer) throws IOException
- Throws:
IOException
-
-