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(); } }
AbstractChannel.GracefulChannelCloseable, AbstractChannel.GracefulState
AbstractCloseable.State
ClientChannel.Streaming
AttributeStore.AttributeKey<T>
Modifier and Type | Field and Description |
---|---|
private boolean |
agentForwarding |
static int |
DEFAULT_COLUMNS_COUNT |
static int |
DEFAULT_HEIGHT |
static java.util.Map<PtyMode,java.lang.Integer> |
DEFAULT_PTY_MODES |
static int |
DEFAULT_ROWS_COUNT |
static int |
DEFAULT_WIDTH |
private java.util.Map<java.lang.String,java.lang.String> |
env |
private int |
ptyColumns |
private int |
ptyHeight |
private int |
ptyLines |
private java.util.Map<PtyMode,java.lang.Integer> |
ptyModes |
private java.lang.String |
ptyType |
private int |
ptyWidth |
private boolean |
usePty |
asyncErr, asyncIn, asyncOut, err, exitSignalHolder, exitStatusHolder, in, invertedErr, invertedIn, invertedOut, opened, openFailureLang, openFailureMsg, openFailureReason, openFuture, out, streaming
channelListenerProxy, channelListeners, eofReceived, eofSent, gracefulFuture, gracefulState, initialized, RESPONSE_BUFFER_GROWTH_FACTOR, service
closeFuture, lock, state
log
CHANNEL_EXEC, CHANNEL_SHELL, CHANNEL_SUBSYSTEM
EMPTY
NONE
CLOSE_WAIT_TIMEOUT, DEFAULT_CLOSE_WAIT_TIMEOUT
Constructor and Description |
---|
PtyCapableChannelSession(boolean usePty) |
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() |
void |
sendWindowChange(int columns,
int lines) |
void |
sendWindowChange(int columns,
int lines,
int height,
int width) |
void |
setAgentForwarding(boolean agentForwarding) |
void |
setEnv(java.lang.String key,
java.lang.String 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) |
doCloseImmediately, doOpen, handleInternalRequest, handleXonXoff, pumpInputStream, securedRead
addChannelSignalRequestHandlers, doWriteData, doWriteExtendedData, getAsyncErr, getAsyncIn, getAsyncOut, getChannelState, getChannelType, getErr, getExitSignal, getExitStatus, getIn, getInnerCloseable, getInvertedErr, getInvertedIn, getInvertedOut, getOut, getStreaming, handleOpenFailure, handleOpenSuccess, handleWindowAdjust, open, open, setErr, setIn, setOut, setStreaming, updateCurrentChannelState, waitFor
addChannelListener, addPendingRequest, addRequestHandler, close, configureWindow, getAttribute, 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, isShutdownOnExit, notifyStateChanged, notifyStateChanged, preClose, removeAttribute, removeChannelListener, removePendingRequest, removeRequestHandler, resolveAttribute, resolveChannelStreamPacketWriterResolver, sendEof, sendResponse, sendWindowAdjust, setAttribute, setChannelStreamPacketWriterResolver, setExecutorService, setRecipient, setShutdownOnExit, signalChannelClosed, signalChannelClosed, signalChannelInitialized, signalChannelInitialized, signalChannelOpenFailure, signalChannelOpenFailure, signalChannelOpenSuccess, signalChannelOpenSuccess, toString, validateIncomingDataSize, writePacket
doCloseGracefully
addCloseFutureListener, builder, isClosed, isClosing, removeCloseFutureListener
getSimplifiedLogger
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
validateCommandExitStatusCode
addRequestHandler, addRequestHandlers, getId, getLocalWindow, getRecipient, getRemoteWindow, getRequestHandlers, getSession, handleClose, handleData, handleEof, handleExtendedData, handleFailure, handleRequest, handleSuccess, init, isEofSignalled, isInitialized, removeRequestHandler, removeRequestHandlers
addChannelListener, getChannelListenerProxy, removeChannelListener
getBoolean, getBooleanProperty, getInteger, getIntProperty, getLong, getLongProperty, getObject, getParentPropertyResolver, getProperties, getString, getStringProperty
getAttribute, removeAttribute, resolveAttribute, resolveAttribute, resolveAttribute, resolveAttribute, setAttribute
writePacket
getChannelStreamPacketWriterResolver, resolveChannelStreamPacketWriter, resolveChannelStreamPacketWriterResolver, setChannelStreamPacketWriterResolver
addCloseFutureListener, close, close, close, getMaxCloseWaitTime, isClosed, isClosing, isOpen, removeCloseFutureListener
public static final int DEFAULT_COLUMNS_COUNT
public static final int DEFAULT_ROWS_COUNT
public static final int DEFAULT_WIDTH
public static final int DEFAULT_HEIGHT
public static final java.util.Map<PtyMode,java.lang.Integer> DEFAULT_PTY_MODES
private boolean agentForwarding
private boolean usePty
private java.lang.String ptyType
private int ptyColumns
private int ptyLines
private int ptyWidth
private int ptyHeight
private java.util.Map<PtyMode,java.lang.Integer> ptyModes
private final java.util.Map<java.lang.String,java.lang.String> env
public void setupSensibleDefaultPty()
public boolean isAgentForwarding()
public void setAgentForwarding(boolean agentForwarding)
public boolean isUsePty()
public void setUsePty(boolean usePty)
public java.lang.String getPtyType()
public void setPtyType(java.lang.String ptyType)
public int getPtyColumns()
public void setPtyColumns(int ptyColumns)
public int getPtyLines()
public void setPtyLines(int ptyLines)
public int getPtyWidth()
public void setPtyWidth(int ptyWidth)
public int getPtyHeight()
public void setPtyHeight(int ptyHeight)
public java.util.Map<PtyMode,java.lang.Integer> getPtyModes()
public void setPtyModes(java.util.Map<PtyMode,java.lang.Integer> ptyModes)
public void setEnv(java.lang.String key, java.lang.String value)
public void sendWindowChange(int columns, int lines) throws java.io.IOException
java.io.IOException
public void sendWindowChange(int columns, int lines, int height, int width) throws java.io.IOException
java.io.IOException
protected void doOpenPty() throws java.io.IOException
java.io.IOException