Apache Mina SSHD 2.15.0 · org.apache.sshd.common.channel.SttySupport

Modifier and Type	Field and Description
public static final String	DEFAULT_SSHD_STTY_COMMAND
public static final int	DEFAULT_TERMINAL_HEIGHT
public static final int	DEFAULT_TERMINAL_WIDTH
public static final String	SSHD_STTY_COMMAND_PROP
private static final AtomicReference<String>	STTY_COMMAND_HOLDER
private static final AtomicReference<String>	TTY_PROPS_HOLDER
private static final AtomicLong	TTY_PROPS_LAST_FETCHED_HOLDER

Access	Constructor and Description
private	SttySupport()

Method Summary

Modifier and Type	Method and Description
private static int	copyStream(InputStream in, OutputStream bout)
public static String	Returns: The execution result exec(final String The command to execute cmd) Execute the specified command and return the output (both stdout and stderr).
private static String	Returns: The execution result exec(String... The command components cmd) Execute the specified command and return the output (both stdout and stderr).
private static int	findChar(String stty, String name)
private static int	findFlag(String stty, String name)
public static String	Returns: The command to use to set the terminal options. getSttyCommand()
public static int	Returns: The terminal height getTerminalHeight() Returns the value of "stty size" height param Note this method caches the value from the first time it is called in order to increase speed, which means that changing to size of the terminal will not be reflected in the console.
public static int	getTerminalProperty(String prop)
public static int	Returns: The terminal width getTerminalWidth() Returns the value of "stty size" width param Note this method caches the value from the first time it is called in order to increase speed, which means that changing to size of the terminal will not be reflected in the console.
public static String	getTtyProps()
public static Map<PtyMode, Integer>	getUnixPtyModes()
public static Map<PtyMode, Integer>	parsePtyModes(String stty)
public static void	setSttyCommand(String The command to use to set the terminal options. Defaults to `DEFAULT_SSHD_STTY_COMMAND`, or the value of the `SSHD_STTY_COMMAND_PROP` system property if not set via this method cmd)
public static String	Returns: The execution result stty(String The command arguments args) Execute the stty command with the specified arguments against the current active terminal.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

DEFAULT_SSHD_STTY_COMMAND	back to summary
public static final String DEFAULT_SSHD_STTY_COMMAND

DEFAULT_TERMINAL_HEIGHT	back to summary
public static final int DEFAULT_TERMINAL_HEIGHT

DEFAULT_TERMINAL_WIDTH	back to summary
public static final int DEFAULT_TERMINAL_WIDTH

SSHD_STTY_COMMAND_PROP	back to summary
public static final String SSHD_STTY_COMMAND_PROP

STTY_COMMAND_HOLDER	back to summary
private static final AtomicReference<String> STTY_COMMAND_HOLDER

TTY_PROPS_HOLDER	back to summary
private static final AtomicReference<String> TTY_PROPS_HOLDER

TTY_PROPS_LAST_FETCHED_HOLDER	back to summary
private static final AtomicLong TTY_PROPS_LAST_FETCHED_HOLDER

SttySupport	back to summary
private SttySupport()

Method Detail

copyStream	back to summary
private static int copyStream(InputStream in, OutputStream bout) throws IOException

exec back to summary

exec	back to summary
public static String exec(final String cmd) throws IOException, InterruptedException Execute the specified command and return the output (both stdout and stderr). Parameters cmd:String The command to execute Returns:String The execution result Exceptions IOException: If failed to execute the command InterruptedException: If interrupted while awaiting command execution See Also `exec(String[])`

public static String exec(final String cmd) throws IOException, InterruptedException

Execute the specified command and return the output (both stdout and stderr).

Parameters

cmd:String: The command to execute

Returns:String

The execution result

Exceptions

IOException:: If failed to execute the command
InterruptedException:: If interrupted while awaiting command execution

See Also

exec(String[])

exec	back to summary
private static String exec(String... cmd) throws IOException, InterruptedException Execute the specified command and return the output (both stdout and stderr). Parameters cmd:String[] The command components Returns:String The execution result Exceptions IOException: If failed to execute the command InterruptedException: If interrupted while awaiting command execution

exec

back to summary

private static String exec(String... cmd) throws IOException, InterruptedException

Execute the specified command and return the output (both stdout and stderr).

Parameters

cmd:String[]: The command components

Returns:String

The execution result

Exceptions

IOException:: If failed to execute the command
InterruptedException:: If interrupted while awaiting command execution

findChar	back to summary
private static int findChar(String stty, String name)

findFlag	back to summary
private static int findFlag(String stty, String name)

getSttyCommand	back to summary
public static String getSttyCommand() Returns:String The command to use to set the terminal options. See Also `setSttyCommand(String)`

getTerminalHeight	back to summary
public static int getTerminalHeight() Returns the value of "stty size" height param Note this method caches the value from the first time it is called in order to increase speed, which means that changing to size of the terminal will not be reflected in the console. Returns:int The terminal height

getTerminalHeight

back to summary

public static int getTerminalHeight()

Returns the value of "stty size" height param

Note

this method caches the value from the first time it is called in order to increase speed, which means that changing to size of the terminal will not be reflected in the console.

Returns:int: The terminal height

getTerminalProperty	back to summary
public static int getTerminalProperty(String prop) throws IOException, InterruptedException

getTerminalWidth	back to summary
public static int getTerminalWidth() Returns the value of "stty size" width param Note this method caches the value from the first time it is called in order to increase speed, which means that changing to size of the terminal will not be reflected in the console. Returns:int The terminal width

getTerminalWidth

back to summary

public static int getTerminalWidth()

Returns the value of "stty size" width param

Note

this method caches the value from the first time it is called in order to increase speed, which means that changing to size of the terminal will not be reflected in the console.

Returns:int: The terminal width

getTtyProps	back to summary
public static String getTtyProps() throws IOException, InterruptedException

getUnixPtyModes	back to summary
public static Map<PtyMode, Integer> getUnixPtyModes() throws IOException, InterruptedException

parsePtyModes	back to summary
public static Map<PtyMode, Integer> parsePtyModes(String stty)

setSttyCommand	back to summary
public static void setSttyCommand(String cmd) Parameters cmd:String The command to use to set the terminal options. Defaults to `DEFAULT_SSHD_STTY_COMMAND`, or the value of the `SSHD_STTY_COMMAND_PROP` system property if not set via this method

stty back to summary

stty	back to summary
public static String stty(String args) throws IOException, InterruptedException Execute the stty command with the specified arguments against the current active terminal. Parameters args:String The command arguments Returns:String The execution result Exceptions IOException: If failed to execute the command InterruptedException: If interrupted while awaiting command execution See Also `exec(String)`

public static String stty(String args) throws IOException, InterruptedException

Execute the stty command with the specified arguments against the current active terminal.

Parameters

args:String: The command arguments

Returns:String

The execution result

Exceptions

IOException:: If failed to execute the command
InterruptedException:: If interrupted while awaiting command execution

See Also

exec(String)

public final Class SttySupport

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail