org.apache.sshd.server.shell

Interface InvertedShell

All Superinterfaces:

CommandLifecycle, ServerSessionHolder, SessionAware, SessionContextHolder, SessionHolder<ServerSession>

All Known Implementing Classes:

ProcessShell

public interface InvertedShell
extends SessionHolder<ServerSession>, ServerSessionHolder, CommandLifecycle, SessionAware

This shell have inverted streams, such as the one obtained when launching a new Process from java. This interface is meant to be used with InvertedShellWrapper class as an implementation of Factory.

Method Summary

Modifier and Type	Method and Description
int	exitValue() Retrieve the exit value of the shell.
ChannelSession	getChannelSession()
java.io.InputStream	getErrorStream()
java.io.OutputStream	getInputStream() Returns the output stream used to feed the shell.
java.io.InputStream	getOutputStream()
default ServerSession	getSession()
boolean	isAlive() Check if the underlying shell is still alive

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

getSessionContext

Methods inherited from interface org.apache.sshd.server.session.ServerSessionHolder

getServerSession

Methods inherited from interface org.apache.sshd.server.command.CommandLifecycle

destroy, start

Methods inherited from interface org.apache.sshd.server.SessionAware

setSession

Method Detail

getSession

default ServerSession getSession()

Specified by:

getSession in interface SessionHolder<ServerSession>

getChannelSession

ChannelSession getChannelSession()

Returns:

The ChannelSession instance through which the shell was created - may be null if shell not started yet

getInputStream

java.io.OutputStream getInputStream()

Returns the output stream used to feed the shell. This method is called after the shell has been started.

Returns:

The OutputStream used to feed the shell

getOutputStream

java.io.InputStream getOutputStream()

Returns:

The InputStream representing the output stream of the shell

getErrorStream

java.io.InputStream getErrorStream()

Returns:

The InputStream representing the error stream of the shell

isAlive

boolean isAlive()

Check if the underlying shell is still alive

Returns:

true if alive

exitValue

int exitValue()

Retrieve the exit value of the shell. This method must only be called when the shell is not alive anymore.

Returns:

the exit value of the shell