Apache Mina SSHD 2.15.0 · org.apache.sshd.server.shell.InvertedShellWrapper

Modifier and Type	Field and Description
private int	bufferSize
private ExitCallback	callback
private OutputStream	err
private final Executor	executor
private InputStream	in
private OutputStream	out
private Duration	pumpSleepTime
private final InvertedShell	shell
private InputStream	shellErr
private OutputStream	shellIn
private InputStream	shellOut
private boolean	shutdownExecutor

Constructor Summary

Access	Constructor and Description
public	InvertedShellWrapper(InvertedShell The `InvertedShell` shell) Auto-allocates an `Executor` in order to create the streams pump thread and uses the default `CoreModuleProperties#BUFFER_SIZE`
public	InvertedShellWrapper(InvertedShell The `InvertedShell` shell, int Buffer size to use - must be above min. size (`Byte#SIZE`) bufferSize) Auto-allocates an `Executor` in order to create the streams pump thread
public	InvertedShellWrapper(InvertedShell The `InvertedShell` shell, 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. executor, boolean If `true` the executor is shut down when shell wrapper is `destroy()`-ed. Ignored if executor service auto-allocated shutdownExecutor, int Buffer size to use - must be above min. size (`Byte#SIZE`) bufferSize)

Method Summary

Modifier and Type	Method and Description
public synchronized void	destroy(ChannelSession The `ChannelSession` through which the command has been received channel) Implements org.apache.sshd.server.command.CommandLifecycle.destroy. 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()
public void	setErrorStream(OutputStream The `OutputStream` used by the shell to write its errors err) Implements org.apache.sshd.server.command.CommandDirectErrorStreamAware.setErrorStream. Set the error stream that can be used by the shell to write its errors.
public void	setExitCallback(ExitCallback The `ExitCallback` to call when shell is closed callback) Implements org.apache.sshd.server.command.Command.setExitCallback. Set the callback that the shell has to call when it is closed.
public void	setInputStream(InputStream The `InputStream` used by the shell to read input. in) Implements org.apache.sshd.server.command.CommandDirectInputStreamAware.setInputStream. Set the input stream that can be used by the shell to read input.
public void	setOutputStream(OutputStream The `OutputStream` used by the shell to write its output out) Implements org.apache.sshd.server.command.CommandDirectOutputStreamAware.setOutputStream. Set the output stream that can be used by the shell to write its output.
public void	setSession(ServerSession The `ServerSession` in which this shell will be executed. session) Implements org.apache.sshd.server.session.ServerSessionAware.setSession.
public synchronized void	start(ChannelSession The `ChannelSession` through which the command has been received channel, Environment The `Environment` env) Implements org.apache.sshd.server.command.CommandLifecycle.start. Starts the command execution.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from 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

Field Detail

bufferSize	back to summary
private int bufferSize

callback	back to summary
private ExitCallback callback

err	back to summary
private OutputStream err

executor	back to summary
private final Executor executor

in	back to summary
private InputStream in

out	back to summary
private OutputStream out

pumpSleepTime	back to summary
private Duration pumpSleepTime

shell	back to summary
private final InvertedShell shell

shellErr	back to summary
private InputStream shellErr

shellIn	back to summary
private OutputStream shellIn

shellOut	back to summary
private InputStream shellOut

shutdownExecutor	back to summary
private boolean shutdownExecutor

Constructor Detail

InvertedShellWrapper back to summary

InvertedShellWrapper	back to summary
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:InvertedShell The `InvertedShell` See Also `InvertedShellWrapper(InvertedShell, int)`

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:InvertedShell: The InvertedShell

InvertedShellWrapper back to summary

InvertedShellWrapper	back to summary
public InvertedShellWrapper(InvertedShell shell, int bufferSize) Auto-allocates an `Executor` in order to create the streams pump thread Parameters shell:InvertedShell The `InvertedShell` bufferSize:int Buffer size to use - must be above min. size (`Byte#SIZE`) See Also `InvertedShellWrapper(InvertedShell, Executor, boolean, int)`

public InvertedShellWrapper(InvertedShell shell, int bufferSize)

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

Parameters

shell:InvertedShell: The InvertedShell
bufferSize:int: Buffer size to use - must be above min. size (Byte#SIZE)

InvertedShellWrapper back to summary

InvertedShellWrapper	back to summary
public InvertedShellWrapper(InvertedShell shell, Executor executor, boolean shutdownExecutor, int bufferSize) Parameters shell:InvertedShell The `InvertedShell` executor: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:boolean If `true` the executor is shut down when shell wrapper is `destroy()`-ed. Ignored if executor service auto-allocated bufferSize:int Buffer size to use - must be above min. size (`Byte#SIZE`)

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

Parameters

shell:InvertedShell: The InvertedShell
executor: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:boolean: If true the executor is shut down when shell wrapper is destroy()-ed. Ignored if executor service auto-allocated
bufferSize:int: Buffer size to use - must be above min. size (Byte#SIZE)

Method Detail

destroy back to summary

destroy	back to summary
public synchronized void destroy(ChannelSession channel) throws Exception Implements org.apache.sshd.server.command.CommandLifecycle.destroy. Doc from org.apache.sshd.server.command.CommandLifecycle.destroy. This method is called by the SSH server to destroy the command because the client has disconnected somehow. Parameters channel:ChannelSession The `ChannelSession` through which the command has been received Annotations @Override Exceptions Exception: if failed to destroy

public synchronized void destroy(ChannelSession channel) throws Exception

Implements org.apache.sshd.server.command.CommandLifecycle.destroy.

Doc from org.apache.sshd.server.command.CommandLifecycle.destroy.

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

Parameters

channel:ChannelSession: The ChannelSession through which the command has been received

Annotations

@Override

Exceptions

Exception:: if failed to destroy

pumpStream	back to summary
protected boolean pumpStream(InputStream in, OutputStream out, byte[] buffer) throws IOException

pumpStreams	back to summary
protected void pumpStreams()

setErrorStream back to summary

setErrorStream	back to summary
public void setErrorStream(OutputStream err) Implements org.apache.sshd.server.command.CommandDirectErrorStreamAware.setErrorStream. Doc from org.apache.sshd.server.command.CommandDirectErrorStreamAware.setErrorStream. Set the error stream that can be used by the shell to write its errors. Parameters err:OutputStream The `OutputStream` used by the shell to write its errors Annotations @Override

public void setErrorStream(OutputStream err)

Implements org.apache.sshd.server.command.CommandDirectErrorStreamAware.setErrorStream.

Doc from org.apache.sshd.server.command.CommandDirectErrorStreamAware.setErrorStream.

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

Parameters

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

Annotations

@Override

setExitCallback back to summary

setExitCallback	back to summary
public void setExitCallback(ExitCallback callback) Implements org.apache.sshd.server.command.Command.setExitCallback. Doc from org.apache.sshd.server.command.Command.setExitCallback. Set the callback that the shell has to call when it is closed. Parameters callback:ExitCallback The `ExitCallback` to call when shell is closed Annotations @Override

public void setExitCallback(ExitCallback callback)

Implements org.apache.sshd.server.command.Command.setExitCallback.

Doc from org.apache.sshd.server.command.Command.setExitCallback.

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

Parameters

callback:ExitCallback: The ExitCallback to call when shell is closed

Annotations

@Override

setInputStream back to summary

setInputStream	back to summary
public void setInputStream(InputStream in) Implements org.apache.sshd.server.command.CommandDirectInputStreamAware.setInputStream. Doc from org.apache.sshd.server.command.CommandDirectInputStreamAware.setInputStream. Set the input stream that can be used by the shell to read input. Parameters in:InputStream The `InputStream` used by the shell to read input. Annotations @Override

public void setInputStream(InputStream in)

Implements org.apache.sshd.server.command.CommandDirectInputStreamAware.setInputStream.

Doc from org.apache.sshd.server.command.CommandDirectInputStreamAware.setInputStream.

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

Parameters

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

Annotations

@Override

setOutputStream back to summary

setOutputStream	back to summary
public void setOutputStream(OutputStream out) Implements org.apache.sshd.server.command.CommandDirectOutputStreamAware.setOutputStream. Doc from org.apache.sshd.server.command.CommandDirectOutputStreamAware.setOutputStream. Set the output stream that can be used by the shell to write its output. Parameters out:OutputStream The `OutputStream` used by the shell to write its output Annotations @Override

public void setOutputStream(OutputStream out)

Implements org.apache.sshd.server.command.CommandDirectOutputStreamAware.setOutputStream.

Doc from org.apache.sshd.server.command.CommandDirectOutputStreamAware.setOutputStream.

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

Parameters

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

Annotations

@Override

setSession back to summary

setSession	back to summary
public void setSession(ServerSession session) Implements org.apache.sshd.server.session.ServerSessionAware.setSession. Parameters session:ServerSession Doc from org.apache.sshd.server.session.ServerSessionAware.setSession. The `ServerSession` in which this shell will be executed. Annotations @Override

public void setSession(ServerSession session)

Implements org.apache.sshd.server.session.ServerSessionAware.setSession.

Parameters

session:ServerSession

Doc from org.apache.sshd.server.session.ServerSessionAware.setSession.

The ServerSession in which this shell will be executed.

Annotations

@Override

start back to summary

start	back to summary
public synchronized void start(ChannelSession channel, Environment env) throws IOException Implements org.apache.sshd.server.command.CommandLifecycle.start. Doc from org.apache.sshd.server.command.CommandLifecycle.start. Starts the command execution. All streams must have been set before calling this method. The command should implement `java.lang.Runnable`, and this method should spawn a new thread like: `Thread(this).start();` Parameters channel:ChannelSession The `ChannelSession` through which the command has been received env:Environment The `Environment` Annotations @Override Exceptions IOException: If failed to start

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

Implements org.apache.sshd.server.command.CommandLifecycle.start.

Doc from org.apache.sshd.server.command.CommandLifecycle.start.

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

Thread(this).start();

Parameters

channel:ChannelSession: The ChannelSession through which the command has been received
env:Environment: The Environment

Annotations

@Override

Exceptions

IOException:: If failed to start

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public Class InvertedShellWrapper

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail