Interface Session.Shell

All Superinterfaces:
AutoCloseable, Channel, Closeable, ErrorNotifiable, SSHPacketHandler
All Known Implementing Classes:
SessionChannel
Enclosing interface:
Session

public static interface Session.Shell extends Channel
Shell API.
  • Method Details

    • canDoFlowControl

      Boolean canDoFlowControl()
      Whether the client can do local flow control using control-S and control-Q.
      Returns:
      boolean value indicating whether 'client can do', or null if no such information was received
    • changeWindowDimensions

      void changeWindowDimensions(int cols, int rows, int width, int height) throws TransportException
      Sends a window dimension change message.
      Parameters:
      cols - terminal width, columns
      rows - terminal height, rows
      width - terminal width, pixels
      height - terminal height, pixels
      Throws:
      TransportException
    • getErrorStream

      InputStream getErrorStream()
      Returns the shell's stderr stream.
    • signal

      void signal(Signal signal) throws TransportException
      Send a signal.
      Parameters:
      signal - the signal
      Throws:
      TransportException - if error sending the signal