com.maverick.sshd.agent

Class AgentForwardingChannel

java.lang.Object

com.maverick.sshd.Channel

com.maverick.sshd.agent.AgentForwardingChannel

All Implemented Interfaces:

Closeable, AutoCloseable

public class AgentForwardingChannel
extends Channel
implements Closeable

Nested Class Summary

Nested classes/interfaces inherited from class com.maverick.sshd.Channel

Channel.DataBlock, Channel.QueuedData

Field Summary

Fields

Modifier and Type	Field and Description
static String	SSH_AGENT_CLIENT

Fields inherited from class com.maverick.sshd.Channel

connection, localwindow, localWindowLock

Constructor Summary

Constructors

Constructor and Description
AgentForwardingChannel(String type, SessionChannel session)
AgentForwardingChannel(String type, SessionChannel session, ChannelEventListener listener)

Method Summary

Modifier and Type	Method and Description
protected byte[]	createChannel() Called when the channel is being created.
protected void	evaluateWindowSpace(int remaining) Called to evaluate the window space available.
boolean	isActive()
protected void	onAgentConnected(Connection con, Object agent)
protected void	onChannelClosed() Called when the channel has been closed to enable resources to be freed.
protected void	onChannelClosing() Called before the channel is closed
protected void	onChannelData(byte[] data) Called by the channel when data arrives from the remote side.
protected void	onChannelFree() This method is called when the channel has been closed and all its resources are no longer required.
protected void	onChannelOpen() Called when the channel has been opened - this method is only called when the remote side requests a channel open.
protected void	onChannelOpenConfirmation() Called when the channel has been confirmed as open by the remote side - this method is only called when the channel has been requested by this side of the connection
protected void	onChannelRequest(String type, boolean wantreply, byte[] requestdata) Called when a channel request is received.
protected void	onExtendedData(byte[] data, int type) Called by the channel when extended data arrives
protected void	onLocalEOF() Called when the local side is EOF.
protected void	onRemoteEOF() Called when the remote side reports its OutputStream as EOF.
protected byte[]	openChannel(byte[] requestdata) Called when the channel is being opened.

Methods inherited from class com.maverick.sshd.Channel

addEventListener, addInputListener, addOutputListener, canClose, clearIdleState, close, close, consumeWindowSpace, createCloseTask, executeTask, getChannelType, getConnection, getContext, getLocalId, getLocalPacket, getLocalWindow, getQueueSize, getRemoteId, getRemotePacket, getRemoteWindow, getSessionIdentifier, isClosed, isClosing, isEOF, isOpen, isSelfManagedWindowSpace, markEOF, onChannelOpenFailure, onRemoteClose, onWindowAdjust, queueSize, registerExtendedData, resetIdleState, sendChannelData, sendChannelData, sendChannelData, sendChannelData, sendChannelDataAndBlock, sendChannelRequest, sendEOF, sendExtendedData, sendExtendedData, sendRequestResponse, sendWindowAdjust

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.Closeable

close

Field Detail

SSH_AGENT_CLIENT

public static final String SSH_AGENT_CLIENT

See Also:

Constant Field Values

Constructor Detail

AgentForwardingChannel

public AgentForwardingChannel(String type,
                              SessionChannel session)
                       throws IOException

Throws:

IOException

AgentForwardingChannel

public AgentForwardingChannel(String type,
                              SessionChannel session,
                              ChannelEventListener listener)
                       throws IOException

Throws:

IOException

Method Detail

onChannelData

protected void onChannelData(byte[] data)

Description copied from class: Channel

Called by the channel when data arrives from the remote side.

Specified by:

onChannelData in class Channel

onExtendedData

protected void onExtendedData(byte[] data,
                              int type)

Description copied from class: Channel

Called by the channel when extended data arrives

Specified by:

onExtendedData in class Channel

onChannelFree

protected void onChannelFree()

Description copied from class: Channel

This method is called when the channel has been closed and all its resources are no longer required.

Specified by:

onChannelFree in class Channel

createChannel

protected byte[] createChannel()
                        throws IOException

Description copied from class: Channel

Called when the channel is being created. You can return data to be sent in the channel open request, or null for none.

Specified by:

createChannel in class Channel

Returns:

byte[]

Throws:

IOException

openChannel

protected byte[] openChannel(byte[] requestdata)
                      throws WriteOperationRequest,
                             ChannelOpenException

Description copied from class: Channel

Called when the channel is being opened. You can retrun data to be sent in the channel open confirmation message, or null for none.

Specified by:

openChannel in class Channel

Returns:

byte[]

Throws:

WriteOperationRequest

ChannelOpenException

isActive

public boolean isActive()

onChannelOpenConfirmation

protected void onChannelOpenConfirmation()

Description copied from class: Channel

Called when the channel has been confirmed as open by the remote side - this method is only called when the channel has been requested by this side of the connection

Specified by:

onChannelOpenConfirmation in class Channel

onAgentConnected

protected void onAgentConnected(Connection con,
                                Object agent)

onChannelClosed

protected void onChannelClosed()

Description copied from class: Channel

Called when the channel has been closed to enable resources to be freed.

Specified by:

onChannelClosed in class Channel

onChannelOpen

protected void onChannelOpen()

Description copied from class: Channel

Called when the channel has been opened - this method is only called when the remote side requests a channel open.

Specified by:

onChannelOpen in class Channel

onChannelClosing

protected void onChannelClosing()

Description copied from class: Channel

Called before the channel is closed

Specified by:

onChannelClosing in class Channel

onChannelRequest

protected void onChannelRequest(String type,
                                boolean wantreply,
                                byte[] requestdata)

Description copied from class: Channel

Called when a channel request is received.

Specified by:

onChannelRequest in class Channel

evaluateWindowSpace

protected void evaluateWindowSpace(int remaining)

Description copied from class: Channel

Called to evaluate the window space available. Send a window adjust message if there if the minimum amount of space is not available.

Specified by:

evaluateWindowSpace in class Channel

onRemoteEOF

protected void onRemoteEOF()

Description copied from class: Channel

Called when the remote side reports its OutputStream as EOF.

Specified by:

onRemoteEOF in class Channel

onLocalEOF

protected void onLocalEOF()

Description copied from class: Channel

Called when the local side is EOF.

Specified by:

onLocalEOF in class Channel