org.apache.sshd.client.channel

Class PtyCapableChannelSession

java.lang.Object

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

org.apache.sshd.common.util.closeable.IoBaseCloseable

org.apache.sshd.common.util.closeable.AbstractCloseable

org.apache.sshd.common.util.closeable.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:

java.io.Closeable, java.lang.AutoCloseable, java.nio.channels.Channel, ClientChannel, ClientSessionHolder, AttributeRepository, AttributeStore, ChannelListenerManager, PtyChannelConfigurationHolder, PtyChannelConfigurationMutator, ChannelStreamPacketWriterResolver, ChannelStreamPacketWriterResolverManager, PacketWriter, PropertyResolver, SessionContextHolder, SessionHolder<Session>, ExecutorServiceCarrier

Direct Known Subclasses:

ChannelExec, ChannelShell

public class PtyCapableChannelSession
extends ChannelSession
implements PtyChannelConfigurationMutator

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(CONNECT_TIMEOUT).getSession()) {
          s.addPasswordIdentity(getCurrentTestName());
          s.auth().verify(AUTH_TIMEOUT);

          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(OPEN_TIMEOUT);
              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();
      }
 }
 
 

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.closeable.AbstractCloseable

AbstractCloseable.State

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

ClientChannel.Streaming

Nested classes/interfaces inherited from interface org.apache.sshd.common.AttributeRepository

AttributeRepository.AttributeKey<T>

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	agentForwarding
private PtyChannelConfiguration	config
private java.util.Map<java.lang.String,java.lang.Object>	env
private boolean	usePty

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

DEFAULT_INPUT_STREAM_PUMP_CHUNK_SIZE, INPUT_STREAM_PUMP_CHUNK_SIZE

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

asyncErr, asyncIn, asyncOut, err, exitSignalHolder, exitStatusHolder, in, invertedErr, invertedIn, invertedOut, opened, openFailureLang, openFailureMsg, openFailureReason, openFuture, out, streaming

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

channelListenerProxy, channelListeners, eofReceived, eofSent, gracefulFuture, gracefulState, initialized, RESPONSE_BUFFER_GROWTH_FACTOR, service

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

closeFuture, futureLock, state

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

log

Fields inherited from interface org.apache.sshd.common.channel.PtyChannelConfigurationHolder

DEFAULT_COLUMNS_COUNT, DEFAULT_HEIGHT, DEFAULT_PTY_MODES, DEFAULT_ROWS_COUNT, DEFAULT_WIDTH, DUMMY_PTY_TYPE, WINDOWS_PTY_TYPE

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

CHANNEL_EXEC, CHANNEL_SHELL, CHANNEL_SUBSYSTEM

Fields inherited from interface org.apache.sshd.common.PropertyResolver

EMPTY

Fields inherited from interface org.apache.sshd.common.channel.throttle.ChannelStreamPacketWriterResolver

NONE

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

CLOSE_WAIT_TIMEOUT, DEFAULT_CLOSE_WAIT_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
PtyCapableChannelSession(boolean usePty, PtyChannelConfigurationHolder configHolder, java.util.Map<java.lang.String,?> env)

Method Summary

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

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

closeImmediately0, doOpen, getInnerCloseable, handleInternalRequest, handleXonXoff, pumpInputStream, securedRead

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

addChannelSignalRequestHandlers, doWriteData, doWriteExtendedData, getAsyncErr, getAsyncIn, getAsyncOut, getChannelState, getChannelType, getErr, getExitSignal, getExitStatus, getIn, getInvertedErr, getInvertedIn, getInvertedOut, getOut, getStreaming, handleOpenFailure, handleOpenSuccess, handleWindowAdjust, open, open, setErr, setIn, setOut, setStreaming, updateCurrentChannelState, waitFor

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

addChannelListener, addPendingRequest, addRequestHandler, attributeKeys, clearAttributes, computeAttributeIfAbsent, configureWindow, getAttribute, getAttributesCount, getChannelListenerProxy, getChannelStreamPacketWriterResolver, getExecutorService, getId, getLocalWindow, getParentPropertyResolver, getProperties, getRecipient, getRemoteWindow, getRequestHandlers, getSession, handleChannelRequest, handleClose, handleData, handleEof, handleExtendedData, handleFailure, handleRequest, handleSuccess, handleUnknownChannelRequest, init, invokeChannelSignaller, isEofSent, isEofSignalled, isInitialized, notifyStateChanged, notifyStateChanged, preClose, removeAttribute, removeChannelListener, removePendingRequest, removeRequestHandler, resolveChannelStreamPacketWriterResolver, sendEof, sendResponse, sendWindowAdjust, setAttribute, setChannelStreamPacketWriterResolver, setRecipient, signalChannelClosed, signalChannelClosed, signalChannelInitialized, signalChannelInitialized, signalChannelOpenFailure, signalChannelOpenFailure, signalChannelOpenSuccess, signalChannelOpenSuccess, toString, validateIncomingDataSize, writePacket

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

doCloseGracefully, doCloseImmediately

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

addCloseFutureListener, builder, close, getFutureLock, isClosed, isClosing, removeCloseFutureListener

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

getSimplifiedLogger

Methods inherited from class java.lang.Object

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

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

copyConfiguration, setupSensitiveDefaultPtyConfiguration

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

getClientSession, validateCommandExitStatusCode, waitFor

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

addRequestHandler, addRequestHandlers, getId, getLocalWindow, getRecipient, getRemoteWindow, getRequestHandlers, handleClose, handleData, handleEof, handleExtendedData, handleFailure, handleRequest, handleSuccess, init, isEofSignalled, isInitialized, removeRequestHandler, removeRequestHandlers, resolveAttribute, resolveAttribute

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

getSession, getSessionContext

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

addChannelListener, getChannelListenerProxy, removeChannelListener

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

getBoolean, getBooleanProperty, getCharset, getInteger, getIntProperty, getLong, getLongProperty, getObject, getParentPropertyResolver, getProperties, getString, getStringProperty

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

clearAttributes, computeAttributeIfAbsent, removeAttribute, setAttribute

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

attributeKeys, getAttribute, getAttributesCount, ofAttributesMap, ofKeyValuePair

Methods inherited from interface org.apache.sshd.common.io.PacketWriter

calculatePadLength, writePacket

Methods inherited from interface org.apache.sshd.common.channel.throttle.ChannelStreamPacketWriterResolverManager

getChannelStreamPacketWriterResolver, resolveChannelStreamPacketWriter, resolveChannelStreamPacketWriterResolver, setChannelStreamPacketWriterResolver

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

addCloseFutureListener, close, close, close, getMaxCloseWaitTime, isClosed, isClosing, isOpen, removeCloseFutureListener

Field Detail

agentForwarding

private boolean agentForwarding

usePty

private boolean usePty

env

private final java.util.Map<java.lang.String,java.lang.Object> env

config

private final PtyChannelConfiguration config

Constructor Detail

PtyCapableChannelSession

public PtyCapableChannelSession(boolean usePty,
                                PtyChannelConfigurationHolder configHolder,
                                java.util.Map<java.lang.String,?> env)

Method Detail

resolvePtyType

protected java.lang.String resolvePtyType(PtyChannelConfigurationHolder configHolder)

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 java.lang.String getPtyType()

Specified by:

getPtyType in interface PtyChannelConfigurationHolder

setPtyType

public void setPtyType(java.lang.String ptyType)

Specified by:

setPtyType in interface PtyChannelConfigurationMutator

getPtyColumns

public int getPtyColumns()

Specified by:

getPtyColumns in interface PtyChannelConfigurationHolder

setPtyColumns

public void setPtyColumns(int ptyColumns)

Specified by:

setPtyColumns in interface PtyChannelConfigurationMutator

getPtyLines

public int getPtyLines()

Specified by:

getPtyLines in interface PtyChannelConfigurationHolder

setPtyLines

public void setPtyLines(int ptyLines)

Specified by:

setPtyLines in interface PtyChannelConfigurationMutator

getPtyWidth

public int getPtyWidth()

Specified by:

getPtyWidth in interface PtyChannelConfigurationHolder

setPtyWidth

public void setPtyWidth(int ptyWidth)

Specified by:

setPtyWidth in interface PtyChannelConfigurationMutator

getPtyHeight

public int getPtyHeight()

Specified by:

getPtyHeight in interface PtyChannelConfigurationHolder

setPtyHeight

public void setPtyHeight(int ptyHeight)

Specified by:

setPtyHeight in interface PtyChannelConfigurationMutator

getPtyModes

public java.util.Map<PtyMode,java.lang.Integer> getPtyModes()

Specified by:

getPtyModes in interface PtyChannelConfigurationHolder

setPtyModes

public void setPtyModes(java.util.Map<PtyMode,java.lang.Integer> ptyModes)

Specified by:

setPtyModes in interface PtyChannelConfigurationMutator

setEnv

public java.lang.Object setEnv(java.lang.String key,
                               java.lang.Object value)

Parameters:

key - The (never null) key (Note: may be empty...)

value - The value to set - if null then the pre-existing value for the key (if any) is removed.

Returns:

The replaced/removed previous value - null if no previous value set for the key.

sendWindowChange

public void sendWindowChange(int columns,
                             int lines)
                      throws java.io.IOException

Throws:

java.io.IOException

sendWindowChange

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

Throws:

java.io.IOException

doOpenPty

protected void doOpenPty()
                  throws java.io.IOException

Throws:

java.io.IOException