org.apache.sshd.server.channel

Class ChannelSession

java.lang.Object

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

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

org.apache.sshd.common.channel.AbstractChannel

org.apache.sshd.server.channel.AbstractServerChannel

org.apache.sshd.server.channel.ChannelSession

All Implemented Interfaces:

Channel, Closeable

public class ChannelSession
extends AbstractServerChannel

TODO Add javadoc

Author:

Apache MINA SSHD Project

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ChannelSession.Factory
protected static class	ChannelSession.StandardEnvironment

Field Summary

Fields

Modifier and Type	Field and Description
protected Command	command
protected CloseFuture	commandExitFuture
static long	DEFAULT_COMMAND_EXIT_TIMEOUT
protected ChannelSession.StandardEnvironment	env
protected java.io.OutputStream	err
protected java.io.OutputStream	out
protected ChannelDataReceiver	receiver
protected Buffer	tempBuffer
protected java.lang.String	type

Fields inherited from class org.apache.sshd.server.channel.AbstractServerChannel

exitStatusSent

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

CLOSE_RECV, CLOSE_SENT, DEFAULT_PACKET_SIZE, DEFAULT_WINDOW_SIZE, eof, gracefulState, handlers, id, localWindow, recipient, remoteWindow, service, session

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

CLOSED, closeFuture, GRACEFUL, IMMEDIATE, lock, log, OPENED, state

Constructor Summary

Constructors

Constructor and Description
ChannelSession()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addEnvVariable(java.lang.String name, java.lang.String value)
protected void	closeShell(int exitValue)
protected void	doWriteData(byte[] data, int off, int len)
protected void	doWriteExtendedData(byte[] data, int off, int len)
protected Closeable	getCommandCloseable()
protected ChannelSession.StandardEnvironment	getEnvironment()
protected Closeable	getInnerCloseable()
protected int	getPtyModeValue(PtyMode mode)
protected boolean	handleAgentForwarding(Buffer buffer)
protected boolean	handleBreak(Buffer buffer)
protected boolean	handleEnv(Buffer buffer)
void	handleEof()
protected boolean	handleExec(Buffer buffer)
protected boolean	handlePtyReq(Buffer buffer)
java.lang.Boolean	handleRequest(java.lang.String type, Buffer buffer)
protected boolean	handleShell(Buffer buffer)
protected boolean	handleSignal(Buffer buffer)
protected boolean	handleSubsystem(Buffer buffer)
protected boolean	handleWindowChange(Buffer buffer)
protected boolean	handleX11Forwarding(Buffer buffer)
protected void	postClose()
protected void	prepareCommand()
void	setDataReceiver(ChannelDataReceiver receiver) For Command to install ChannelDataReceiver.

Methods inherited from class org.apache.sshd.server.channel.AbstractServerChannel

doInit, handleOpenFailure, handleOpenSuccess, open, sendExitStatus

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

addRequestHandler, configureWindow, getGracefulCloseable, getId, getLocalWindow, getRecipient, getRemoteWindow, getSession, handleClose, handleData, handleExtendedData, handleFailure, handleRequest, handleWindowAdjust, init, notifyStateChanged, sendEof, sendWindowAdjust, toString, writePacket

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

doCloseGracefully, doCloseImmediately

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

close

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

close

Field Detail

DEFAULT_COMMAND_EXIT_TIMEOUT

public static final long DEFAULT_COMMAND_EXIT_TIMEOUT

See Also:

Constant Field Values

type

protected java.lang.String type

out

protected java.io.OutputStream out

err

protected java.io.OutputStream err

command

protected Command command

receiver

protected ChannelDataReceiver receiver

env

protected ChannelSession.StandardEnvironment env

tempBuffer

protected Buffer tempBuffer

commandExitFuture

protected final CloseFuture commandExitFuture

Constructor Detail

ChannelSession

public ChannelSession()

Method Detail

getInnerCloseable

protected Closeable getInnerCloseable()

Overrides:

getInnerCloseable in class AbstractChannel

getCommandCloseable

protected Closeable getCommandCloseable()

postClose

protected void postClose()

Overrides:

postClose in class AbstractChannel

handleEof

public void handleEof()
               throws java.io.IOException

Specified by:

handleEof in interface Channel

Overrides:

handleEof in class AbstractChannel

Throws:

java.io.IOException

doWriteData

protected void doWriteData(byte[] data,
               int off,
               int len)
                    throws java.io.IOException

Specified by:

doWriteData in class AbstractChannel

Throws:

java.io.IOException

doWriteExtendedData

protected void doWriteExtendedData(byte[] data,
                       int off,
                       int len)
                            throws java.io.IOException

Specified by:

doWriteExtendedData in class AbstractChannel

Throws:

java.io.IOException

handleRequest

public java.lang.Boolean handleRequest(java.lang.String type,
                              Buffer buffer)
                                throws java.io.IOException

Throws:

java.io.IOException

handleEnv

protected boolean handleEnv(Buffer buffer)
                     throws java.io.IOException

Throws:

java.io.IOException

handlePtyReq

protected boolean handlePtyReq(Buffer buffer)
                        throws java.io.IOException

Throws:

java.io.IOException

handleWindowChange

protected boolean handleWindowChange(Buffer buffer)
                              throws java.io.IOException

Throws:

java.io.IOException

handleSignal

protected boolean handleSignal(Buffer buffer)
                        throws java.io.IOException

Throws:

java.io.IOException

handleBreak

protected boolean handleBreak(Buffer buffer)
                       throws java.io.IOException

Throws:

java.io.IOException

handleShell

protected boolean handleShell(Buffer buffer)
                       throws java.io.IOException

Throws:

java.io.IOException

handleExec

protected boolean handleExec(Buffer buffer)
                      throws java.io.IOException

Throws:

java.io.IOException

handleSubsystem

protected boolean handleSubsystem(Buffer buffer)
                           throws java.io.IOException

Throws:

java.io.IOException

setDataReceiver

public void setDataReceiver(ChannelDataReceiver receiver)

For Command to install ChannelDataReceiver. When you do this, Command.setInputStream(InputStream) will no longer be invoked. If you call this method from Command.start(Environment), the input stream you received in Command.setInputStream(InputStream) will not read any data.

prepareCommand

protected void prepareCommand()
                       throws java.io.IOException

Throws:

java.io.IOException

getPtyModeValue

protected int getPtyModeValue(PtyMode mode)

handleAgentForwarding

protected boolean handleAgentForwarding(Buffer buffer)
                                 throws java.io.IOException

Throws:

java.io.IOException

handleX11Forwarding

protected boolean handleX11Forwarding(Buffer buffer)
                               throws java.io.IOException

Throws:

java.io.IOException

addEnvVariable

protected void addEnvVariable(java.lang.String name,
                  java.lang.String value)

getEnvironment

protected ChannelSession.StandardEnvironment getEnvironment()

closeShell

protected void closeShell(int exitValue)
                   throws java.io.IOException

Throws:

java.io.IOException