org.apache.sshd.client.channel

Class AbstractClientChannel

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.client.channel.AbstractClientChannel

All Implemented Interfaces:

ClientChannel, Channel, Closeable

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

Field Summary

Fields

Modifier and Type	Field and Description
protected OutputStream	err
protected String	exitSignal
protected Integer	exitStatus
protected InputStream	in
protected InputStream	invertedErr
protected OutputStream	invertedIn
protected InputStream	invertedOut
protected boolean	opened
protected String	openFailureMsg
protected int	openFailureReason
protected OpenFuture	openFuture
protected OutputStream	out
protected String	type

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

Fields inherited from interface org.apache.sshd.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

Methods

Modifier and Type	Method and Description
CloseFuture	close(boolean immediately) Close this resource asynchronously and return a future.
protected abstract void	doOpen()
protected void	doWriteData(byte[] data, int off, int len)
protected void	doWriteExtendedData(byte[] data, int off, int len)
OutputStream	getErr()
Integer	getExitStatus()
InputStream	getIn()
InputStream	getInvertedErr()
OutputStream	getInvertedIn() Access to an output stream to send data directly to the remote channel.
InputStream	getInvertedOut()
OutputStream	getOut()
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 rmpsize, Buffer buffer) For a client channel, this method will be called internally by the session when the confirmation has been received.
protected OpenFuture	internalOpen()
OpenFuture	open(int recipient, int rwsize, int rmpsize, Buffer buffer) For a server channel, this method will actually open the channel
protected void	postClose()
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)
int	waitFor(int mask, long timeout)

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

addRequestHandler, configureWindow, getGracefulCloseable, getId, getInnerCloseable, getLocalWindow, getRecipient, getRemoteWindow, getSession, handleClose, handleData, handleEof, 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 java.lang.Object

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

Methods inherited from interface org.apache.sshd.ClientChannel

open

Field Detail

opened

protected volatile boolean opened

type

protected final String type

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

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

close

public CloseFuture close(boolean immediately)

Description copied from interface: Closeable

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.

Specified by:

close in interface ClientChannel

Specified by:

close in interface Channel

Specified by:

close in interface Closeable

Overrides:

close in class CloseableUtils.AbstractCloseable

Parameters:

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

Returns:

a future

postClose

protected void postClose()

Overrides:

postClose in class AbstractChannel

waitFor

public int waitFor(int mask,
          long timeout)

Specified by:

waitFor in interface ClientChannel

internalOpen

protected OpenFuture internalOpen()
                           throws IOException

Throws:

IOException

open

public OpenFuture open(int recipient,
              int rwsize,
              int rmpsize,
              Buffer buffer)

Description copied from interface: Channel

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

Specified by:

open in interface Channel

handleOpenSuccess

public void handleOpenSuccess(int recipient,
                     int rwsize,
                     int rmpsize,
                     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.

Specified by:

handleOpenSuccess in interface Channel

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.

Specified by:

handleOpenFailure in interface Channel

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

getExitStatus

public Integer getExitStatus()

Specified by:

getExitStatus in interface ClientChannel