net.sf.sshapi

Interface SshChannel

All Superinterfaces:

SshDataProducingComponent, SshLifecycleComponent, SshStreamChannel

public interface SshChannel
extends SshStreamChannel

Interface for custom channels created by SshChannelHandler implementations.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SshChannel.ChannelData Encapsulate details needed for channel creation

Method Summary

Modifier and Type	Method and Description
SshChannel.ChannelData	getChannelData() Get the SshChannel.ChannelData that was used to create this channel
java.lang.String	getName() Get the channel name
boolean	sendRequest(java.lang.String requesttype, boolean wantreply, byte[] requestdata) Sends a channel request.

Methods inherited from interface net.sf.sshapi.SshStreamChannel

getInputStream, getOutputStream

Methods inherited from interface net.sf.sshapi.SshDataProducingComponent

addDataListener, removeDataListener

Methods inherited from interface net.sf.sshapi.SshLifecycleComponent

addListener, close, isOpen, open, removeListener

Method Detail

getName

java.lang.String getName()

Get the channel name

Returns:

name

getChannelData

SshChannel.ChannelData getChannelData()

Get the SshChannel.ChannelData that was used to create this channel

Returns:

channel data

sendRequest

boolean sendRequest(java.lang.String requesttype,
                    boolean wantreply,
                    byte[] requestdata)
             throws SshException

Sends a channel request. Many channels have extensions that are specific to that particular channel type, an example of which is requesting a pseudo terminal from an interactive session.

Parameters:

requesttype - the name of the request, for example "pty-req"

wantreply - specifies whether the remote side should send a success/failure message

requestdata - the request data

Returns:

true if the request succeeded and wantreply=true, otherwise false

Throws:

SshException