org.apache.sshd.client.channel

Class PtyCapableChannelSession

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.common.util.CloseableUtils.IoBaseCloseable

org.apache.sshd.common.util.CloseableUtils.AbstractCloseable

org.apache.sshd.common.util.CloseableUtils.AbstractInnerCloseable

org.apache.sshd.common.channel.AbstractChannel

org.apache.sshd.client.channel.AbstractClientChannel

org.apache.sshd.client.channel.ChannelSession

org.apache.sshd.client.channel.PtyCapableChannelSession

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, ClientChannel, ExecutorServiceCarrier, ExecutorServiceConfigurer

Direct Known Subclasses:

ChannelExec, ChannelShell

public class PtyCapableChannelSession
extends ChannelSession

Serves as the base channel session for executing remote commands - including a full shell. Note: all the configuration changes via the various setXXX methods must be made before the channel is actually open. If they are invoked afterwards then they have no effect (silently ignored).

A typical code snippet would be:

 try(client = SshClient.setUpDefaultClient()) {
      client.start();

      try(ClientSession s = client.connect(getCurrentTestName(), "localhost", port).verify(7L, TimeUnit.SECONDS).getSession()) {
          s.addPasswordIdentity(getCurrentTestName());
          s.auth().verify(5L, TimeUnit.SECONDS);

          try(ChannelExec shell = s.createExecChannel("my super duper command")) {
              shell.setEnv("var1", "val1");
              shell.setEnv("var2", "val2");
              ...etc...

              shell.setPtyType(...);
              shell.setPtyLines(...);
              ...etc...

              shell.open().verify(5L, TimeUnit.SECONDS);
              shell.waitFor(ClientChannel.CLOSED, TimeUnit.SECONDS.toMillis(17L));    // can use zero for infinite wait

              Integer status = shell.getExitStatus();
              if (status.intValue() != 0) {
                  ...error...
              }
          }
      } finally {
          client.stop();
      }
 }
 

Author:

Apache MINA SSHD Project

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.sshd.common.channel.AbstractChannel

AbstractChannel.GracefulChannelCloseable, AbstractChannel.GracefulState

Nested classes/interfaces inherited from class org.apache.sshd.common.util.CloseableUtils.AbstractCloseable

CloseableUtils.AbstractCloseable.State

Nested classes/interfaces inherited from interface org.apache.sshd.client.channel.ClientChannel

ClientChannel.Streaming

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_COLUMNS_COUNT
static int	DEFAULT_HEIGHT
static Map<PtyMode,Integer>	DEFAULT_PTY_MODES
static int	DEFAULT_ROWS_COUNT
static int	DEFAULT_WIDTH

Fields inherited from class org.apache.sshd.client.channel.AbstractClientChannel

asyncErr, asyncIn, asyncOut, err, exitSignal, exitStatus, in, invertedErr, invertedIn, invertedOut, opened, openFailureMsg, openFailureReason, openFuture, out, streaming, type

Fields inherited from class org.apache.sshd.common.channel.AbstractChannel

DEFAULT_CHANNEL_CLOSE_TIMEOUT, DEFAULT_PACKET_SIZE, DEFAULT_WINDOW_SIZE, eof, executor, gracefulFuture, gracefulState, handlers, id, localWindow, recipient, remoteWindow, RESPONSE_BUFFER_GROWTH_FACTOR, service, session, shutdownExecutor

Fields inherited from class org.apache.sshd.common.util.CloseableUtils.AbstractCloseable

closeFuture, lock, state

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

log

Fields inherited from interface org.apache.sshd.client.channel.ClientChannel

CHANNEL_EXEC, CHANNEL_SHELL, CHANNEL_SUBSYSTEM, CLOSED, EOF, EXIT_SIGNAL, EXIT_STATUS, OPENED, STDERR_DATA, STDOUT_DATA, TIMEOUT

Constructor Summary

Constructors

Constructor and Description
PtyCapableChannelSession(boolean usePty)

Method Summary

Modifier and Type	Method and Description
protected void	doOpenPty()
int	getPtyColumns()
int	getPtyHeight()
int	getPtyLines()
Map<PtyMode,Integer>	getPtyModes()
String	getPtyType()
int	getPtyWidth()
boolean	isAgentForwarding()
boolean	isUsePty()
void	sendWindowChange(int columns, int lines, int height, int width)
void	setAgentForwarding(boolean agentForwarding)
void	setEnv(String key, String value)
void	setPtyColumns(int ptyColumns)
void	setPtyHeight(int ptyHeight)
void	setPtyLines(int ptyLines)
void	setPtyModes(Map<PtyMode,Integer> ptyModes)
void	setPtyType(String ptyType)
void	setPtyWidth(int ptyWidth)
void	setupSensibleDefaultPty()
void	setUsePty(boolean usePty)

Methods inherited from class org.apache.sshd.client.channel.ChannelSession

doCloseImmediately, doOpen, pumpInputStream, securedRead

Methods inherited from class org.apache.sshd.client.channel.AbstractClientChannel

doWriteData, doWriteExtendedData, getAsyncErr, getAsyncIn, getAsyncOut, getErr, getExitStatus, getIn, getInnerCloseable, getInvertedErr, getInvertedIn, getInvertedOut, getOut, getStreaming, handleOpenFailure, handleOpenSuccess, handleWindowAdjust, open, open, setErr, setIn, setOut, setStreaming, waitFor

Methods inherited from class org.apache.sshd.common.channel.AbstractChannel

addRequestHandler, configureWindow, getExecutorService, getId, getLocalWindow, getRecipient, getRemoteWindow, getSession, handleClose, handleData, handleEof, handleExtendedData, handleFailure, handleRequest, init, isEofSignalled, isShutdownOnExit, notifyStateChanged, sendEof, sendResponse, sendWindowAdjust, setEofSignalled, setExecutorService, setShutdownOnExit, toString, writePacket

Methods inherited from class org.apache.sshd.common.util.CloseableUtils.AbstractInnerCloseable

doCloseGracefully

Methods inherited from class org.apache.sshd.common.util.CloseableUtils.AbstractCloseable

builder, close, isClosed, isClosing, preClose

Methods inherited from class org.apache.sshd.common.util.CloseableUtils.IoBaseCloseable

close, isOpen

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.sshd.client.channel.ClientChannel

close

Methods inherited from interface java.nio.channels.Channel

close, isOpen

Methods inherited from interface org.apache.sshd.common.channel.Channel

close

Methods inherited from interface org.apache.sshd.common.Closeable

isClosed, isClosing

Field Detail

DEFAULT_COLUMNS_COUNT

public static final int DEFAULT_COLUMNS_COUNT

See Also:

Constant Field Values

DEFAULT_ROWS_COUNT

public static final int DEFAULT_ROWS_COUNT

See Also:

Constant Field Values

DEFAULT_WIDTH

public static final int DEFAULT_WIDTH

See Also:

Constant Field Values

DEFAULT_HEIGHT

public static final int DEFAULT_HEIGHT

See Also:

Constant Field Values

DEFAULT_PTY_MODES

public static final Map<PtyMode,Integer> DEFAULT_PTY_MODES

Constructor Detail

PtyCapableChannelSession

public PtyCapableChannelSession(boolean usePty)

Method Detail

setupSensibleDefaultPty

public void setupSensibleDefaultPty()

isAgentForwarding

public boolean isAgentForwarding()

setAgentForwarding

public void setAgentForwarding(boolean agentForwarding)

isUsePty

public boolean isUsePty()

setUsePty

public void setUsePty(boolean usePty)

getPtyType

public String getPtyType()

setPtyType

public void setPtyType(String ptyType)

getPtyColumns

public int getPtyColumns()

setPtyColumns

public void setPtyColumns(int ptyColumns)

getPtyLines

public int getPtyLines()

setPtyLines

public void setPtyLines(int ptyLines)

getPtyWidth

public int getPtyWidth()

setPtyWidth

public void setPtyWidth(int ptyWidth)

getPtyHeight

public int getPtyHeight()

setPtyHeight

public void setPtyHeight(int ptyHeight)

getPtyModes

public Map<PtyMode,Integer> getPtyModes()

setPtyModes

public void setPtyModes(Map<PtyMode,Integer> ptyModes)

setEnv

public void setEnv(String key,
                   String value)

sendWindowChange

public void sendWindowChange(int columns,
                             int lines,
                             int height,
                             int width)
                      throws IOException

Throws:

IOException

doOpenPty

protected void doOpenPty()
                  throws IOException

Throws:

IOException