org.apache.sshd.client.channel

Class AbstractClientChannel

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

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, ClientChannel, ExecutorServiceCarrier, ExecutorServiceConfigurer

Direct Known Subclasses:

AgentForwardedChannel, AgentForwardedChannel, ChannelDirectTcpip, ChannelSession, TcpipClientChannel, X11ForwardSupport.ChannelForwardedX11

public abstract class AbstractClientChannel
extends AbstractChannel
implements ClientChannel

TODO Add javadoc

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
protected ChannelAsyncInputStream	asyncErr
protected ChannelAsyncOutputStream	asyncIn
protected ChannelAsyncInputStream	asyncOut
protected OutputStream	err
protected String	exitSignal
protected Integer	exitStatus
protected InputStream	in
protected InputStream	invertedErr
protected OutputStream	invertedIn
protected InputStream	invertedOut
protected AtomicBoolean	opened
protected String	openFailureMsg
protected int	openFailureReason
protected OpenFuture	openFuture
protected OutputStream	out
protected ClientChannel.Streaming	streaming
protected String	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

Modifier	Constructor and Description
protected	AbstractClientChannel(String type)

Method Summary

Modifier and Type	Method and Description
protected abstract void	doOpen()
protected void	doWriteData(byte[] data, int off, int len)
protected void	doWriteExtendedData(byte[] data, int off, int len)
IoInputStream	getAsyncErr()
IoOutputStream	getAsyncIn()
IoInputStream	getAsyncOut()
OutputStream	getErr()
Integer	getExitStatus()
InputStream	getIn()
protected Closeable	getInnerCloseable()
InputStream	getInvertedErr()
OutputStream	getInvertedIn() Access to an output stream to send data directly to the remote channel.
InputStream	getInvertedOut()
OutputStream	getOut()
ClientChannel.Streaming	getStreaming()
void	handleOpenFailure(Buffer buffer) For a client channel, this method will be called internally by the session when the server has rejected this channel opening.
void	handleOpenSuccess(int recipient, int rwSize, int packetSize, Buffer buffer) For a client channel, this method will be called internally by the session when the confirmation has been received.
void	handleWindowAdjust(Buffer buffer)
OpenFuture	open()
OpenFuture	open(int recipient, int rwSize, int packetSize, Buffer buffer) For a server channel, this method will actually open the channel
void	setErr(OutputStream err)
void	setIn(InputStream in) Set an input stream that will be read by this channel and forwarded to the remote channel.
void	setOut(OutputStream out)
void	setStreaming(ClientChannel.Streaming streaming)
int	waitFor(int mask, long timeout)

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

addRequestHandler, configureWindow, doCloseImmediately, 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

opened

protected final AtomicBoolean opened

type

protected final String type

streaming

protected ClientChannel.Streaming streaming

asyncIn

protected ChannelAsyncOutputStream asyncIn

asyncOut

protected ChannelAsyncInputStream asyncOut

asyncErr

protected ChannelAsyncInputStream asyncErr

in

protected InputStream in

invertedIn

protected OutputStream invertedIn

out

protected OutputStream out

invertedOut

protected InputStream invertedOut

err

protected OutputStream err

invertedErr

protected InputStream invertedErr

exitStatus

protected Integer exitStatus

exitSignal

protected String exitSignal

openFailureReason

protected int openFailureReason

openFailureMsg

protected String openFailureMsg

openFuture

protected OpenFuture openFuture

Constructor Detail

AbstractClientChannel

protected AbstractClientChannel(String type)

Method Detail

getStreaming

public ClientChannel.Streaming getStreaming()

Specified by:

getStreaming in interface ClientChannel

setStreaming

public void setStreaming(ClientChannel.Streaming streaming)

Specified by:

setStreaming in interface ClientChannel

getAsyncIn

public IoOutputStream getAsyncIn()

Specified by:

getAsyncIn in interface ClientChannel

getAsyncOut

public IoInputStream getAsyncOut()

Specified by:

getAsyncOut in interface ClientChannel

getAsyncErr

public IoInputStream getAsyncErr()

Specified by:

getAsyncErr in interface ClientChannel

getInvertedIn

public OutputStream getInvertedIn()

Description copied from interface: ClientChannel

Access to an output stream to send data directly to the remote channel. This can be used instead of using ClientChannel.setIn(java.io.InputStream) method and having the channel polling for data in that stream.

Specified by:

getInvertedIn in interface ClientChannel

Returns:

an OutputStream to be used to send data

getIn

public InputStream getIn()

setIn

public void setIn(InputStream in)

Description copied from interface: ClientChannel

Set an input stream that will be read by this channel and forwarded to the remote channel. Note that using such a stream will create an additional thread for pumping the stream which will only be able to end when that stream is actually closed or some data is read. It is recommended to use the ClientChannel.getInvertedIn() method instead and write data directly.

Specified by:

setIn in interface ClientChannel

Parameters:

in - an InputStream to be polled and forwarded

getInvertedOut

public InputStream getInvertedOut()

Specified by:

getInvertedOut in interface ClientChannel

getOut

public OutputStream getOut()

setOut

public void setOut(OutputStream out)

Specified by:

setOut in interface ClientChannel

getInvertedErr

public InputStream getInvertedErr()

Specified by:

getInvertedErr in interface ClientChannel

getErr

public OutputStream getErr()

setErr

public void setErr(OutputStream err)

Specified by:

setErr in interface ClientChannel

getInnerCloseable

protected Closeable getInnerCloseable()

Overrides:

getInnerCloseable in class AbstractChannel

waitFor

public int waitFor(int mask,
                   long timeout)

Specified by:

waitFor in interface ClientChannel

open

public OpenFuture open()
                throws IOException

Specified by:

open in interface ClientChannel

Throws:

IOException

open

public OpenFuture open(int recipient,
                       int rwSize,
                       int packetSize,
                       Buffer buffer)

Description copied from interface: Channel

For a server channel, this method will actually open the channel

Parameters:

recipient - Recipient identifier

rwSize - Read/Write window size

packetSize - Preferred maximum packet size

buffer - Incoming Buffer that triggered the call. Note: the buffer's read position is exactly after the information that read to this call was decoded

Returns:

An OpenFuture for the channel open request

handleOpenSuccess

public void handleOpenSuccess(int recipient,
                              int rwSize,
                              int packetSize,
                              Buffer buffer)

Description copied from interface: Channel

For a client channel, this method will be called internally by the session when the confirmation has been received.

Parameters:

recipient - Recipient identifier

rwSize - Read/Write window size

packetSize - Preferred maximum packet size

buffer - Incoming Buffer that triggered the call. Note: the buffer's read position is exactly after the information that read to this call was decoded

doOpen

protected abstract void doOpen()
                        throws IOException

Throws:

IOException

handleOpenFailure

public void handleOpenFailure(Buffer buffer)

Description copied from interface: Channel

For a client channel, this method will be called internally by the session when the server has rejected this channel opening.

Parameters:

buffer - Incoming Buffer that triggered the call. Note: the buffer's read position is exactly after the information that read to this call was decoded

doWriteData

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

Specified by:

doWriteData in class AbstractChannel

Throws:

IOException

doWriteExtendedData

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

Specified by:

doWriteExtendedData in class AbstractChannel

Throws:

IOException

handleWindowAdjust

public void handleWindowAdjust(Buffer buffer)
                        throws IOException

Overrides:

handleWindowAdjust in class AbstractChannel

Throws:

IOException

getExitStatus

public Integer getExitStatus()

Specified by:

getExitStatus in interface ClientChannel