com.jscape.inet.ssh.connection.channels
Class SessionClient

java.lang.Object
  com.jscape.inet.ssh.connection.channels.Channel
      com.jscape.inet.ssh.connection.channels.SessionClient

public class SessionClient
extends Channel

Version:

1.0

Author:

Alex Usun

Nested Class Summary

Nested classes/interfaces inherited from class com.jscape.inet.ssh.connection.channels.Channel

Channel.ChannelClosedListener, Channel.DataOutputStream, Channel.Parameters

Field Summary

static java.lang.String

TYPE The channel type

Method Summary

void	changeTerminalWindow(TerminalWindow window)
static SessionClient	create(long windowSize, long packetSize, Connection connection) Creates a new session client channel.
void	execCommand(java.lang.String command)
X11Client	openX11Channel()
void	requestPty(java.lang.String type, TerminalWindow window, byte[] modes)
void	requestX11Forwarding()
void	sendEnvironmentVariable(java.lang.String name, java.lang.String value)
void	signal(java.lang.String name)
void	startShell()
void	startSubsystem(java.lang.String name, boolean wantReply)
void	switchLocalFlowControl(boolean on)

Methods inherited from class com.jscape.inet.ssh.connection.channels.Channel

close, getConnection, getIncomingWindow, getInputStream, getLocalNo, getOutputStream, getParameters, getReadTimeout, getRemoteNo, getType, hashCode, isClosed, onMessage, sendRequest, setChannelClosedListener, setReadTimeout

Methods inherited from class java.lang.Object

equals, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

TYPE

public static final java.lang.String TYPE

The channel type

See Also:

Constant Field Values

Method Detail

create

public static SessionClient create(long windowSize,
                                   long packetSize,
                                   Connection connection)
                            throws java.io.IOException,
                                   ConnectionException

Creates a new session client channel.

Parameters:

windowSize - the channel initial window

packetSize - the channel max packet size

connection - the underlayed SSH connection

Returns:

the opened session channel

Throws:

java.io.IOException - if an I/O error occurs

ConnectionException - if the channel cannot be opened

requestPty

public void requestPty(java.lang.String type,
                       TerminalWindow window,
                       byte[] modes)
                throws ConnectionException

Parameters:

type -

window -

modes -

Throws:

ConnectionException

requestX11Forwarding

public void requestX11Forwarding()

openX11Channel

public X11Client openX11Channel()

Returns:

X11Client instance

sendEnvironmentVariable

public void sendEnvironmentVariable(java.lang.String name,
                                    java.lang.String value)
                             throws java.io.IOException

Parameters:

name -

value -

Throws:

java.io.IOException

ConnectionException

startShell

public void startShell()
                throws java.io.IOException

Throws:

java.io.IOException

execCommand

public void execCommand(java.lang.String command)
                 throws java.io.IOException

Parameters:

command -

Throws:

java.io.IOException

startSubsystem

public void startSubsystem(java.lang.String name,
                           boolean wantReply)
                    throws java.io.IOException

Parameters:

name -

Throws:

java.io.IOException

changeTerminalWindow

public void changeTerminalWindow(TerminalWindow window)
                          throws java.io.IOException

Parameters:

window -

Throws:

java.io.IOException

switchLocalFlowControl

public void switchLocalFlowControl(boolean on)
                            throws java.io.IOException

Parameters:

on -

Throws:

java.io.IOException

signal

public void signal(java.lang.String name)
            throws java.io.IOException

Parameters:

name -

Throws:

java.io.IOException