Class AbstractChannel

java.lang.Object

net.schmizz.sshj.connection.channel.AbstractChannel

All Implemented Interfaces:

Closeable, AutoCloseable, ErrorNotifiable, SSHPacketHandler, Channel

Direct Known Subclasses:

AbstractDirectChannel, AbstractForwardedChannel

public abstract class AbstractChannel
extends Object
implements Channel

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AbstractChannel.TransportRunnable

Nested classes/interfaces inherited from interface Channel

Channel.Direct, Channel.Forwarded

Nested classes/interfaces inherited from interface ErrorNotifiable

ErrorNotifiable.Util

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	autoExpand
private final Queue<Event<ConnectionException>>	chanReqResponseEvents
protected final Event<ConnectionException>	closeEvent	Channel close event
private boolean	closeRequested	Whether we have already sent a CHANNEL_CLOSE request to the server
protected final Connection	conn	Connection layer
private boolean	eof
private final int	id	Channel ID
private final ChannelInputStream	in	stdout stream
protected final org.slf4j.Logger	log
protected final LoggerFactory	loggerFactory	Logger
protected final Window.Local	lwin	Local window
private final ReentrantLock	openCloseLock
protected final Event<ConnectionException>	openEvent	Channel open event
private ChannelOutputStream	out	stdin stream
private int	recipient	Remote recipient ID
private static final int	REMOTE_MAX_PACKET_SIZE_CEILING
private final Charset	remoteCharset	Remote character set
protected Window.Remote	rwin	Remote window
protected final Transport	trans	Transport layer
private final String	type	Channel type

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractChannel(Connection conn, String type)
protected	AbstractChannel(Connection conn, String type, Charset remoteCharset)

Method Summary

Modifier and Type	Method	Description
void	close()	Close this channel.
protected void	closeAllStreams()	Called when all I/O streams should be closed.
protected void	eofInputStreams()	Called when EOF has been received.
protected void	finishOff()
boolean	getAutoExpand()
int	getID()
InputStream	getInputStream()
int	getLocalMaxPacketSize()
long	getLocalWinSize()
LoggerFactory	getLoggerFactory()	Get the LoggerFactory associated with the SSH client.
OutputStream	getOutputStream()
int	getRecipient()
Charset	getRemoteCharset()
int	getRemoteMaxPacketSize()
long	getRemoteWinSize()
String	getType()
private void	gotChannelRequest(SSHPacket buf)
private void	gotClose()
private void	gotEOF()
protected void	gotExtendedData(SSHPacket buf)
private void	gotResponse(boolean success)
protected void	gotUnknown(Message msg, SSHPacket buf)
private void	gotWindowAdjustment(SSHPacket buf)
void	handle(Message msg, SSHPacket buf)	Delegate handling of some SSH packet to this object.
protected void	handleRequest(String reqType, SSHPacket buf)
protected void	init(int recipient, long remoteWinSize, long remoteMaxPacketSize)
boolean	isEOF()	Returns whether EOF has been received.
boolean	isOpen()
void	join()
void	join(long timeout, TimeUnit unit)
protected SSHPacket	newBuffer(Message cmd)
void	notifyError(SSHException error)	Notifies this object of an error.
protected void	receiveInto(ChannelInputStream stream, SSHPacket buf)
protected Event<ConnectionException>	sendChannelRequest(String reqType, boolean wantReply, Buffer.PlainBuffer reqSpecific)
protected void	sendClose()
void	setAutoExpand(boolean autoExpand)	Set whether local window should automatically expand when data is received, irrespective of whether data has been read from that stream.
String	toString()
(package private) boolean	whileOpen(AbstractChannel.TransportRunnable runnable)

Methods inherited from class Object

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

Field Details

REMOTE_MAX_PACKET_SIZE_CEILING

private static final int REMOTE_MAX_PACKET_SIZE_CEILING

See Also:

• Constant Field Values

loggerFactory

protected final LoggerFactory loggerFactory

Logger

log

protected final org.slf4j.Logger log

trans

protected final Transport trans

Transport layer

conn

protected final Connection conn

Connection layer

type

private final String type

Channel type

id

private final int id

Channel ID

recipient

private int recipient

Remote recipient ID

remoteCharset

private final Charset remoteCharset

Remote character set

eof

private boolean eof

chanReqResponseEvents

private final Queue<Event<ConnectionException>> chanReqResponseEvents

openCloseLock

private final ReentrantLock openCloseLock

openEvent

protected final Event<ConnectionException> openEvent

Channel open event

closeEvent

protected final Event<ConnectionException> closeEvent

Channel close event

closeRequested

private boolean closeRequested

Whether we have already sent a CHANNEL_CLOSE request to the server

lwin

protected final Window.Local lwin

Local window

in

private final ChannelInputStream in

stdout stream

rwin

protected Window.Remote rwin

Remote window

out

private ChannelOutputStream out

stdin stream

autoExpand

private volatile boolean autoExpand

Constructor Details

AbstractChannel

protected AbstractChannel(Connection conn,
 String type)

AbstractChannel

protected AbstractChannel(Connection conn,
 String type,
 Charset remoteCharset)

Method Details

init

protected void init(int recipient,
 long remoteWinSize,
 long remoteMaxPacketSize)

getAutoExpand

public boolean getAutoExpand()

Specified by:

getAutoExpand in interface Channel

Returns:

whether auto-expansion of local window is set.

See Also:

• Channel.setAutoExpand(boolean)

getID

public int getID()

Specified by:

getID in interface Channel

Returns:

the channel ID

getInputStream

public InputStream getInputStream()

Specified by:

getInputStream in interface Channel

Returns:

the InputStream for this channel.

getLocalMaxPacketSize

public int getLocalMaxPacketSize()

Specified by:

getLocalMaxPacketSize in interface Channel

Returns:

the maximum packet size that we have specified.

getLocalWinSize

public long getLocalWinSize()

Specified by:

getLocalWinSize in interface Channel

Returns:

the current local window size.

getOutputStream

public OutputStream getOutputStream()

Specified by:

getOutputStream in interface Channel

Returns:

an OutputStream for this channel.

getRecipient

public int getRecipient()

Specified by:

getRecipient in interface Channel

Returns:

the channel ID at the remote end.

getRemoteCharset

public Charset getRemoteCharset()

Specified by:

getRemoteCharset in interface Channel

Returns:

the character set used to communicate with the remote machine for certain strings (like paths).

getRemoteMaxPacketSize

public int getRemoteMaxPacketSize()

Specified by:

getRemoteMaxPacketSize in interface Channel

Returns:

the maximum packet size as specified by the remote end.

getRemoteWinSize

public long getRemoteWinSize()

Specified by:

getRemoteWinSize in interface Channel

Returns:

the current remote window size.

getType

public String getType()

Specified by:

getType in interface Channel

Returns:

the channel type identifier.

handle

public void handle(Message msg,
 SSHPacket buf)
            throws SSHException

Description copied from interface: SSHPacketHandler

Delegate handling of some SSH packet to this object.

Specified by:

handle in interface SSHPacketHandler

Parameters:

msg - the SSH message identifier

buf - SSHPacket containing rest of the request

Throws:

SSHException - if there is a non-recoverable error

isEOF

public boolean isEOF()

Description copied from interface: Channel

Returns whether EOF has been received.

Specified by:

isEOF in interface Channel

getLoggerFactory

public LoggerFactory getLoggerFactory()

Description copied from interface: Channel

Get the LoggerFactory associated with the SSH client.

Specified by:

getLoggerFactory in interface Channel

gotClose

private void gotClose()
               throws TransportException

Throws:

TransportException

closeAllStreams

protected void closeAllStreams()

Called when all I/O streams should be closed. Subclasses can override but must call super.

notifyError

public void notifyError(SSHException error)

Description copied from interface: ErrorNotifiable

Notifies this object of an error.

Specified by:

notifyError in interface ErrorNotifiable

setAutoExpand

public void setAutoExpand(boolean autoExpand)

Description copied from interface: Channel

Set whether local window should automatically expand when data is received, irrespective of whether data has been read from that stream. This is useful e.g. when a remote command produces a lot of output that would fill the local window but you are not interested in reading from its InputStream.

Specified by:

setAutoExpand in interface Channel

Parameters:

autoExpand - whether local windows should automatically expand

close

public void close()
           throws ConnectionException,
TransportException

Description copied from interface: Channel

Close this channel.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Channel

Specified by:

close in interface Closeable

Throws:

ConnectionException

TransportException

join

public void join()
          throws ConnectionException

Specified by:

join in interface Channel

Throws:

ConnectionException

join

public void join(long timeout,
 TimeUnit unit)
          throws ConnectionException

Specified by:

join in interface Channel

Throws:

ConnectionException

sendClose

protected void sendClose()
                  throws TransportException

Throws:

TransportException

isOpen

public boolean isOpen()

Specified by:

isOpen in interface Channel

Returns:

whether the channel is open.

whileOpen

boolean whileOpen(AbstractChannel.TransportRunnable runnable)
           throws TransportException,
ConnectionException

Throws:

TransportException

ConnectionException

gotChannelRequest

private void gotChannelRequest(SSHPacket buf)
                        throws ConnectionException,
TransportException

Throws:

ConnectionException

TransportException

gotWindowAdjustment

private void gotWindowAdjustment(SSHPacket buf)
                          throws ConnectionException

Throws:

ConnectionException

finishOff

protected void finishOff()

gotExtendedData

protected void gotExtendedData(SSHPacket buf)
                        throws SSHException

Throws:

SSHException

gotUnknown

protected void gotUnknown(Message msg,
 SSHPacket buf)
                   throws ConnectionException,
TransportException

Throws:

ConnectionException

TransportException

handleRequest

protected void handleRequest(String reqType,
 SSHPacket buf)
                      throws ConnectionException,
TransportException

Throws:

ConnectionException

TransportException

newBuffer

protected SSHPacket newBuffer(Message cmd)

receiveInto

protected void receiveInto(ChannelInputStream stream,
 SSHPacket buf)
                    throws SSHException

Throws:

SSHException

sendChannelRequest

protected Event<ConnectionException> sendChannelRequest(String reqType,
 boolean wantReply,
 Buffer.PlainBuffer reqSpecific)
                                                 throws TransportException

Throws:

TransportException

gotResponse

private void gotResponse(boolean success)
                  throws ConnectionException

Throws:

ConnectionException

gotEOF

private void gotEOF()
             throws TransportException

Throws:

TransportException

eofInputStreams

protected void eofInputStreams()

Called when EOF has been received. Subclasses can override but must call super.

toString

public String toString()

Overrides:

toString in class Object