Modifier and Type	Class and Description
public class	ChannelSession.CommandCloseable

Modifier and Type	Field and Description
protected ChannelAsyncOutputStream	asyncErr
protected ChannelAsyncOutputStream	asyncOut
protected final CloseFuture	commandExitFuture
protected Command	commandInstance
protected final AtomicBoolean	commandStarted
public static final List<ChannelRequestHandler>	DEFAULT_HANDLERS
protected final StandardEnvironment	env
protected OutputStream	err
protected Buffer	extendedDataBuffer
protected ChannelDataReceiver	extendedDataWriter
protected OutputStream	out
protected ChannelDataReceiver	receiver
protected Buffer	receiverBuffer
protected String	type

Access	Constructor and Description
public	ChannelSession()
public	ChannelSession(Collection<? extends RequestHandler<Channel>> handlers)

Method Summary

Modifier and Type	Method and Description
protected void	addEnvVariable(String name, String value)
protected void	closeImmediately0()
protected void	closeShell(int exitValue, boolean closeImmediately)
protected void	doWriteData(byte[] data, int off, long len) Implements abstract org.apache.sshd.common.channel.AbstractChannel.doWriteData.
protected void	doWriteExtendedData(byte[] data, int off, long len) Implements abstract org.apache.sshd.common.channel.AbstractChannel.doWriteExtendedData.
public StandardEnvironment	getEnvironment()
protected Closeable	getInnerCloseable() Overrides org.apache.sshd.common.channel.AbstractChannel.getInnerCloseable.
protected int	getPtyModeValue(PtyMode mode)
public ServerSession	getSession() Overrides org.apache.sshd.common.channel.AbstractChannel.getSession. Implements org.apache.sshd.common.session.SessionHolder.getSession.
protected RequestHandler.Result	handleAgentForwarding(String requestType, Buffer buffer, boolean wantReply)
protected RequestHandler.Result	handleAgentForwardingParsed(String requestType)
protected RequestHandler.Result	handleBreak(Buffer buffer, boolean wantReply)
protected RequestHandler.Result	handleBreakParsed(long breakLength)
protected RequestHandler.Result	handleEnv(Buffer buffer, boolean wantReply)
protected RequestHandler.Result	handleEnvParsed(String name, String value)
public void	handleEof() Overrides org.apache.sshd.common.channel.AbstractChannel.handleEof. Implements org.apache.sshd.common.channel.Channel.handleEof. Invoked when `SSH_MSG_CHANNEL_EOF` received
protected RequestHandler.Result	handleExec(String request, Buffer buffer, boolean wantReply)
protected RequestHandler.Result	handleExecParsed(String request, String commandLine)
protected RequestHandler.Result	handleInternalRequest(String The request type requestType, boolean Whether reply is requested wantReply, Buffer The `Buffer` containing extra request-specific data buffer) Overrides org.apache.sshd.common.channel.AbstractChannel.handleInternalRequest. Called by `handleUnknownChannelRequest(String, boolean, Buffer)` in order to allow channel request handling if none of the registered handlers processed the request - last chance.
protected RequestHandler.Result	handlePtyReq(Buffer buffer, boolean wantReply)
protected RequestHandler.Result	handlePtyReqParsed(String term, int tColumns, int tRows, int tWidth, int tHeight, Map<PtyMode, Integer> ptyModes)
protected RequestHandler.Result	handleShell(String request, Buffer buffer, boolean wantReply)
protected RequestHandler.Result	handleShellParsed(String request)
protected RequestHandler.Result	handleSignal(Buffer buffer, boolean wantReply)
protected RequestHandler.Result	handleSignalParsed(String name)
protected RequestHandler.Result	handleSubsystem(String request, Buffer buffer, boolean wantReply)
protected RequestHandler.Result	handleSubsystemParsed(String request, String subsystem)
public void	handleWindowAdjust(Buffer The rest of the message data `Buffer` after decoding the channel identifiers buffer) Overrides org.apache.sshd.common.channel.AbstractChannel.handleWindowAdjust. Implements org.apache.sshd.common.channel.Channel.handleWindowAdjust. Invoked when `SSH_MSG_CHANNEL_WINDOW_ADJUST` received
protected RequestHandler.Result	handleWindowChange(Buffer buffer, boolean wantReply)
protected RequestHandler.Result	handleWindowChangeParsed(int tColumns, int tRows, int tWidth, int tHeight)
protected RequestHandler.Result	handleX11Forwarding(String requestType, Buffer buffer, boolean wantReply)
protected RequestHandler.Result	handleX11ForwardingParsed(String requestType, ServerSession session, boolean singleConnection, String authProtocol, String authCookie, int screenId)
protected boolean	isValidXauth(String auth)
protected boolean	mayWrite() Overrides org.apache.sshd.common.channel.AbstractChannel.mayWrite.
protected RequestHandler.Result	prepareChannelCommand(String request, Command cmd)
protected Command	Returns: The updated command instance - if `null` then the request that initially caused the creation of the command is failed and the original command (if any) destroyed (eventually) Note if a different command instance than the input one is returned, then it is up to the implementor to take care of the wrapping or destruction of the original command instance. prepareCommand(String The request that caused the command to be created requestType, Command The created `Command` - may be `null` command) Called by `prepareChannelCommand(String, Command)` in order to set up the command's streams, session, file-system, exit callback, etc..
protected IoWriteFuture	sendResponse(Buffer buffer, String req, RequestHandler.Result result, boolean wantReply) Overrides org.apache.sshd.common.channel.AbstractChannel.sendResponse.
public void	setDataReceiver(ChannelDataReceiver The `ChannelDataReceiver` instance receiver) For `Command` to install `ChannelDataReceiver`.
public void	setExtendedDataWriter(ChannelDataReceiver The `ChannelDataReceiver`. extendedDataWriter) A special `ChannelDataReceiver` that can be used to receive data sent as "extended" - usually STDERR Note by default any such data sent to the channel session causes an exception, but specific implementations may choose to register such a receiver (e.g., for custom usage of the STDERR stream).

Inherited from org.apache.sshd.server.channel.AbstractServerChannel:: doInit handleOpenFailure handleOpenSuccess open sendExitStatus

Field Detail

asyncErr	back to summary
protected ChannelAsyncOutputStream asyncErr

asyncOut	back to summary
protected ChannelAsyncOutputStream asyncOut

commandExitFuture	back to summary
protected final CloseFuture commandExitFuture

commandInstance	back to summary
protected Command commandInstance

commandStarted	back to summary
protected final AtomicBoolean commandStarted

DEFAULT_HANDLERS	back to summary
public static final List<ChannelRequestHandler> DEFAULT_HANDLERS

env	back to summary
protected final StandardEnvironment env

err	back to summary
protected OutputStream err

extendedDataBuffer	back to summary
protected Buffer extendedDataBuffer

extendedDataWriter	back to summary
protected ChannelDataReceiver extendedDataWriter

out	back to summary
protected OutputStream out

receiver	back to summary
protected ChannelDataReceiver receiver

receiverBuffer	back to summary
protected Buffer receiverBuffer

type	back to summary
protected String type

Constructor Detail

ChannelSession	back to summary
public ChannelSession()

ChannelSession	back to summary
public ChannelSession(Collection<? extends RequestHandler<Channel>> handlers)

Method Detail

addEnvVariable	back to summary
protected void addEnvVariable(String name, String value)

closeImmediately0	back to summary
protected void closeImmediately0()

closeShell	back to summary
protected void closeShell(int exitValue, boolean closeImmediately) throws IOException

doWriteData	back to summary
protected void doWriteData(byte[] data, int off, long len) throws IOException Implements abstract org.apache.sshd.common.channel.AbstractChannel.doWriteData. Annotations @Override

doWriteData

back to summary

protected void doWriteData(byte[] data, int off, long len) throws IOException

Implements abstract org.apache.sshd.common.channel.AbstractChannel.doWriteData.

Annotations

@Override

doWriteExtendedData	back to summary
protected void doWriteExtendedData(byte[] data, int off, long len) throws IOException Implements abstract org.apache.sshd.common.channel.AbstractChannel.doWriteExtendedData. Annotations @Override

doWriteExtendedData

back to summary

protected void doWriteExtendedData(byte[] data, int off, long len) throws IOException

Implements abstract org.apache.sshd.common.channel.AbstractChannel.doWriteExtendedData.

Annotations

@Override

getEnvironment	back to summary
public StandardEnvironment getEnvironment()

getInnerCloseable	back to summary
protected Closeable getInnerCloseable() Overrides org.apache.sshd.common.channel.AbstractChannel.getInnerCloseable. Annotations @Override

getInnerCloseable

back to summary

protected Closeable getInnerCloseable()

Overrides org.apache.sshd.common.channel.AbstractChannel.getInnerCloseable.

Annotations

@Override

getPtyModeValue	back to summary
protected int getPtyModeValue(PtyMode mode)

getSession	back to summary
public ServerSession getSession() Overrides org.apache.sshd.common.channel.AbstractChannel.getSession. Implements org.apache.sshd.common.session.SessionHolder.getSession. Annotations @Override

getSession

back to summary

public ServerSession getSession()

Overrides org.apache.sshd.common.channel.AbstractChannel.getSession.

Implements org.apache.sshd.common.session.SessionHolder.getSession.

Annotations

@Override

handleAgentForwarding	back to summary
protected RequestHandler.Result handleAgentForwarding(String requestType, Buffer buffer, boolean wantReply) throws IOException

handleAgentForwardingParsed	back to summary
protected RequestHandler.Result handleAgentForwardingParsed(String requestType) throws IOException

handleBreak	back to summary
protected RequestHandler.Result handleBreak(Buffer buffer, boolean wantReply) throws IOException

handleBreakParsed	back to summary
protected RequestHandler.Result handleBreakParsed(long breakLength) throws IOException

handleEnv	back to summary
protected RequestHandler.Result handleEnv(Buffer buffer, boolean wantReply) throws IOException

handleEnvParsed	back to summary
protected RequestHandler.Result handleEnvParsed(String name, String value) throws IOException

handleEof back to summary

handleEof	back to summary
public void handleEof() throws IOException Overrides org.apache.sshd.common.channel.AbstractChannel.handleEof. Implements org.apache.sshd.common.channel.Channel.handleEof. Doc from org.apache.sshd.common.channel.Channel.handleEof. Invoked when `SSH_MSG_CHANNEL_EOF` received Annotations @Override Exceptions IOException: If failed to handle the message

public void handleEof() throws IOException

Overrides org.apache.sshd.common.channel.AbstractChannel.handleEof.

Implements org.apache.sshd.common.channel.Channel.handleEof.

Doc from org.apache.sshd.common.channel.Channel.handleEof.

Invoked when SSH_MSG_CHANNEL_EOF received

Annotations

@Override

Exceptions

IOException:: If failed to handle the message

handleExec	back to summary
protected RequestHandler.Result handleExec(String request, Buffer buffer, boolean wantReply) throws IOException

handleExecParsed	back to summary
protected RequestHandler.Result handleExecParsed(String request, String commandLine) throws IOException

handleInternalRequest back to summary

handleInternalRequest	back to summary
protected RequestHandler.Result handleInternalRequest(String requestType, boolean wantReply, Buffer buffer) throws IOException Overrides org.apache.sshd.common.channel.AbstractChannel.handleInternalRequest. Doc from org.apache.sshd.common.channel.AbstractChannel.handleInternalRequest. Called by `handleUnknownChannelRequest(String, boolean, Buffer)` in order to allow channel request handling if none of the registered handlers processed the request - last chance. Parameters requestType:String The request type wantReply:boolean Whether reply is requested buffer:Buffer The `Buffer` containing extra request-specific data Returns:RequestHandler.Result The handling result - if `null` or `Unsupported` and reply is required then a failure message will be sent Annotations @Override Exceptions IOException: If failed to process the request internally

protected RequestHandler.Result handleInternalRequest(String requestType, boolean wantReply, Buffer buffer) throws IOException

Overrides org.apache.sshd.common.channel.AbstractChannel.handleInternalRequest.

Doc from org.apache.sshd.common.channel.AbstractChannel.handleInternalRequest.

Called by handleUnknownChannelRequest(String, boolean, Buffer) in order to allow channel request handling if none of the registered handlers processed the request - last chance.

Parameters

requestType:String: The request type
wantReply:boolean: Whether reply is requested
buffer:Buffer: The Buffer containing extra request-specific data

Returns:RequestHandler.Result

The handling result - if null or Unsupported and reply is required then a failure message will be sent

Annotations

@Override

Exceptions

IOException:: If failed to process the request internally

handlePtyReq	back to summary
protected RequestHandler.Result handlePtyReq(Buffer buffer, boolean wantReply) throws IOException

handlePtyReqParsed	back to summary
protected RequestHandler.Result handlePtyReqParsed(String term, int tColumns, int tRows, int tWidth, int tHeight, Map<PtyMode, Integer> ptyModes) throws IOException

handleShell	back to summary
protected RequestHandler.Result handleShell(String request, Buffer buffer, boolean wantReply) throws IOException

handleShellParsed	back to summary
protected RequestHandler.Result handleShellParsed(String request) throws IOException

handleSignal	back to summary
protected RequestHandler.Result handleSignal(Buffer buffer, boolean wantReply) throws IOException

handleSignalParsed	back to summary
protected RequestHandler.Result handleSignalParsed(String name) throws IOException

handleSubsystem	back to summary
protected RequestHandler.Result handleSubsystem(String request, Buffer buffer, boolean wantReply) throws IOException

handleSubsystemParsed	back to summary
protected RequestHandler.Result handleSubsystemParsed(String request, String subsystem) throws IOException

handleWindowAdjust back to summary

handleWindowAdjust	back to summary
public void handleWindowAdjust(Buffer buffer) throws IOException Overrides org.apache.sshd.common.channel.AbstractChannel.handleWindowAdjust. Implements org.apache.sshd.common.channel.Channel.handleWindowAdjust. Doc from org.apache.sshd.common.channel.Channel.handleWindowAdjust. Invoked when `SSH_MSG_CHANNEL_WINDOW_ADJUST` received Parameters buffer:Buffer The rest of the message data `Buffer` after decoding the channel identifiers Annotations @Override Exceptions IOException: If failed to handle the message

public void handleWindowAdjust(Buffer buffer) throws IOException

Overrides org.apache.sshd.common.channel.AbstractChannel.handleWindowAdjust.

Implements org.apache.sshd.common.channel.Channel.handleWindowAdjust.

Doc from org.apache.sshd.common.channel.Channel.handleWindowAdjust.

Invoked when SSH_MSG_CHANNEL_WINDOW_ADJUST received

Parameters

buffer:Buffer: The rest of the message data Buffer after decoding the channel identifiers

Annotations

@Override

Exceptions

IOException:: If failed to handle the message

handleWindowChange	back to summary
protected RequestHandler.Result handleWindowChange(Buffer buffer, boolean wantReply) throws IOException

handleWindowChangeParsed	back to summary
protected RequestHandler.Result handleWindowChangeParsed(int tColumns, int tRows, int tWidth, int tHeight) throws IOException

handleX11Forwarding	back to summary
protected RequestHandler.Result handleX11Forwarding(String requestType, Buffer buffer, boolean wantReply) throws IOException

handleX11ForwardingParsed	back to summary
protected RequestHandler.Result handleX11ForwardingParsed(String requestType, ServerSession session, boolean singleConnection, String authProtocol, String authCookie, int screenId) throws IOException

isValidXauth	back to summary
protected boolean isValidXauth(String auth)

mayWrite

back to summary

protected boolean mayWrite()

Overrides org.apache.sshd.common.channel.AbstractChannel.mayWrite.

Annotations

@Override

prepareChannelCommand	back to summary
protected RequestHandler.Result prepareChannelCommand(String request, Command cmd) throws IOException

prepareCommand back to summary

protected Command prepareCommand(String requestType, Command command) throws IOException

Called by prepareChannelCommand(String, Command) in order to set up the command's streams, session, file-system, exit callback, etc..

Parameters

requestType:String: The request that caused the command to be created
command:Command: The created Command - may be null

Returns:Command

The updated command instance - if null then the request that initially caused the creation of the command is failed and the original command (if any) destroyed (eventually)

Note

if a different command instance than the input one is returned, then it is up to the implementor to take care of the wrapping or destruction of the original command instance.

Exceptions

IOException:: If failed to prepare the command

sendResponse

back to summary

protected IoWriteFuture sendResponse(Buffer buffer, String req, RequestHandler.Result result, boolean wantReply) throws IOException

Overrides org.apache.sshd.common.channel.AbstractChannel.sendResponse.

Annotations

@Override

setDataReceiver back to summary

public void setDataReceiver(ChannelDataReceiver receiver)

For Command to install ChannelDataReceiver. When you do this, Command#setInputStream(java.io.InputStream) or org.apache.sshd.server.command.AsyncCommand#setIoInputStream(org.apache.sshd.common.io.IoInputStream) will no longer be invoked. If you call this method from Command#start(ChannelSession, Environment), the input stream you received in Command#setInputStream(java.io.InputStream) will not read any data.

Parameters

receiver:ChannelDataReceiver: The ChannelDataReceiver instance

setExtendedDataWriter back to summary

public void setExtendedDataWriter(ChannelDataReceiver extendedDataWriter)

A special ChannelDataReceiver that can be used to receive data sent as "extended" - usually STDERR

Note

by default any such data sent to the channel session causes an exception, but specific implementations may choose to register such a receiver (e.g., for custom usage of the STDERR stream). A good place in the code to register such a writer would be in commands that also implement ChannelSessionAware.

Parameters

extendedDataWriter:ChannelDataReceiver: The ChannelDataReceiver.

org.apache.sshd.server.channel back to summary

public Class ChannelSession.CommandCloseable

Class Inheritance

extends IoBaseCloseable

java.lang.Object
org.apache.sshd.common.util.logging.AbstractLoggingBean
org.apache.sshd.common.util.closeable.IoBaseCloseable
org.apache.sshd.server.channel.ChannelSession.CommandCloseable

Constructor Summary

Access	Constructor and Description
public	CommandCloseable()

Method Summary

Modifier and Type	Method and Description
public void	addCloseFutureListener(SshFutureListener<CloseFuture> The notification `SshFutureListener` - never `null` listener) Implements org.apache.sshd.common.Closeable.addCloseFutureListener. Pre-register a listener to be informed when resource is closed.
public CloseFuture	close(boolean `true` if the resource should be shut down abruptly, `false` for a graceful close immediately) Implements org.apache.sshd.common.Closeable.close. Close this resource asynchronously and return a future.
public boolean	isClosed() Implements org.apache.sshd.common.Closeable.isClosed. Returns `true` if this object has been closed.
public boolean	isClosing() Implements org.apache.sshd.common.Closeable.isClosing. Returns `true` if the `close(boolean)` method has been called.
public void	removeCloseFutureListener(SshFutureListener<CloseFuture> The register `SshFutureListener` - never `null`. Ignored if not registered or resource already closed listener) Implements org.apache.sshd.common.Closeable.removeCloseFutureListener. Remove a pre-registered close event listener

Constructor Detail

CommandCloseable	back to summary
public CommandCloseable()

Method Detail

addCloseFutureListener back to summary

public void addCloseFutureListener(SshFutureListener<CloseFuture> listener)

Implements org.apache.sshd.common.Closeable.addCloseFutureListener.

Doc from org.apache.sshd.common.Closeable.addCloseFutureListener.

Pre-register a listener to be informed when resource is closed. If resource is already closed, the listener will be invoked immediately and not registered for future notification

Parameters

listener:SshFutureListener<CloseFuture>: The notification SshFutureListener - never null

Annotations

@Override

close back to summary

public CloseFuture close(boolean immediately)

Implements org.apache.sshd.common.Closeable.close.

Doc from org.apache.sshd.common.Closeable.close.

Close this resource asynchronously and return a future. Resources support two closing modes: a graceful mode which will cleanly close the resource and an immediate mode which will close the resources abruptly.

Parameters

immediately:boolean: true if the resource should be shut down abruptly, false for a graceful close

Returns:CloseFuture

a CloseFuture representing the close request

Annotations

@Override

isClosed back to summary

public boolean isClosed()

Implements org.apache.sshd.common.Closeable.isClosed.

Doc from org.apache.sshd.common.Closeable.isClosed.

Returns true if this object has been closed.

Returns:boolean

true if closing

Annotations

@Override

isClosing back to summary

public boolean isClosing()

Implements org.apache.sshd.common.Closeable.isClosing.

Doc from org.apache.sshd.common.Closeable.isClosing.

Returns true if the close(boolean) method has been called. Note that this method will return true even if this isClosed() returns true.

Returns:boolean

true if closing

Annotations

@Override

removeCloseFutureListener back to summary

public void removeCloseFutureListener(SshFutureListener<CloseFuture> listener)

Implements org.apache.sshd.common.Closeable.removeCloseFutureListener.

Doc from org.apache.sshd.common.Closeable.removeCloseFutureListener.

Remove a pre-registered close event listener

Parameters

listener:SshFutureListener<CloseFuture>: The register SshFutureListener - never null. Ignored if not registered or resource already closed

Annotations

@Override

public Class ChannelSession

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class ChannelSession.CommandCloseable

Constructor Summary

Method Summary

Constructor Detail

Method Detail