Package com.jcraft.jsch

Class ChannelSession

java.lang.Object

com.jcraft.jsch.Channel

com.jcraft.jsch.ChannelSession

All Implemented Interfaces:

java.lang.Runnable

Direct Known Subclasses:

ChannelExec, ChannelSftp, ChannelShell, ChannelSubsystem

class ChannelSession
extends Channel

Nested Class Summary

Nested classes/interfaces inherited from class com.jcraft.jsch.Channel

Channel.MyPipedInputStream, Channel.PassiveInputStream, Channel.PassiveOutputStream

Field Summary

Fields

Modifier and Type	Field	Description
private static byte[]	_session
protected boolean	agent_forwarding
protected java.util.Hashtable	env
protected boolean	pty
protected int	tcol
protected byte[]	terminal_mode
protected int	thp
protected int	trow
protected java.lang.String	ttype
protected int	twp
protected boolean	xforwading

Fields inherited from class com.jcraft.jsch.Channel

close, connected, connectTimeout, eof_local, eof_remote, exitstatus, id, index, io, lmpsize, lwsize, lwsize_max, notifyme, open_confirmation, recipient, reply, rmpsize, rwsize, SSH_MSG_CHANNEL_OPEN_CONFIRMATION, SSH_MSG_CHANNEL_OPEN_FAILURE, SSH_MSG_CHANNEL_WINDOW_ADJUST, SSH_OPEN_ADMINISTRATIVELY_PROHIBITED, SSH_OPEN_CONNECT_FAILED, SSH_OPEN_RESOURCE_SHORTAGE, SSH_OPEN_UNKNOWN_CHANNEL_TYPE, thread, type

Constructor Summary

Constructors

Constructor	Description
ChannelSession()

Method Summary

Modifier and Type	Method	Description
private java.util.Hashtable	getEnv()
void	run()
protected void	sendRequests()
void	setAgentForwarding(boolean enable)	Enable the agent forwarding.
void	setEnv(byte[] name, byte[] value)	Set the environment variable.
void	setEnv(java.lang.String name, java.lang.String value)	Set the environment variable.
void	setEnv(java.util.Hashtable env)	Deprecated. Use setEnv(String, String) or setEnv(byte[], byte[]) instead.
void	setPty(boolean enable)	Allocate a Pseudo-Terminal.
void	setPtySize(int col, int row, int wp, int hp)	Change the window dimension interactively.
void	setPtyType(java.lang.String ttype)	Set the terminal type.
void	setPtyType(java.lang.String ttype, int col, int row, int wp, int hp)	Set the terminal type.
void	setTerminalMode(byte[] terminal_mode)	Set the terminal mode.
void	setXForwarding(boolean enable)	Enable the X11 forwarding.
private byte[]	toByteArray(java.lang.Object o)

Methods inherited from class com.jcraft.jsch.Channel

addRemoteWindowSize, close, connect, connect, del, disconnect, disconnect, eof, eof_remote, genChannelOpenPacket, getChannel, getChannel, getData, getExitStatus, getExtInputStream, getId, getInputStream, getOutputStream, getRecipient, getSession, init, isClosed, isConnected, isEOF, sendChannelOpen, sendOpenConfirmation, sendOpenFailure, sendSignal, setExitStatus, setExtOutputStream, setExtOutputStream, setInputStream, setInputStream, setLocalPacketSize, setLocalWindowSize, setLocalWindowSizeMax, setOutputStream, setOutputStream, setRecipient, setRemotePacketSize, setRemoteWindowSize, setSession, start, write, write, write_ext

Methods inherited from class java.lang.Object

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

Field Detail

_session

private static byte[] _session

agent_forwarding

protected boolean agent_forwarding

xforwading

protected boolean xforwading

env

protected java.util.Hashtable env

pty

protected boolean pty

ttype

protected java.lang.String ttype

tcol

protected int tcol

trow

protected int trow

twp

protected int twp

thp

protected int thp

terminal_mode

protected byte[] terminal_mode

Constructor Detail

ChannelSession

ChannelSession()

Method Detail

setAgentForwarding

public void setAgentForwarding(boolean enable)

Enable the agent forwarding.

Parameters:

enable -

setXForwarding

public void setXForwarding(boolean enable)

Enable the X11 forwarding. Refer to RFC4254 6.3.1. Requesting X11 Forwarding.

Overrides:

setXForwarding in class Channel

Parameters:

enable -

setEnv

public void setEnv(java.util.Hashtable env)

Deprecated.

Use setEnv(String, String) or setEnv(byte[], byte[]) instead.

See Also:

setEnv(String, String), setEnv(byte[], byte[])

setEnv

public void setEnv(java.lang.String name,
                   java.lang.String value)

Set the environment variable. If name and value are needed to be passed to the remote in your favorite encoding, use setEnv(byte[], byte[]). Refer to RFC4254 6.4 Environment Variable Passing.

Parameters:

name - A name for environment variable.

value - A value for environment variable.

setEnv

public void setEnv(byte[] name,
                   byte[] value)

Set the environment variable. Refer to RFC4254 6.4 Environment Variable Passing.

Parameters:

name - A name of environment variable.

value - A value of environment variable.

See Also:

setEnv(String, String)

getEnv

private java.util.Hashtable getEnv()

setPty

public void setPty(boolean enable)

Allocate a Pseudo-Terminal. Refer to RFC4254 6.2. Requesting a Pseudo-Terminal.

Parameters:

enable -

setTerminalMode

public void setTerminalMode(byte[] terminal_mode)

Set the terminal mode.

Parameters:

terminal_mode -

setPtySize

public void setPtySize(int col,
                       int row,
                       int wp,
                       int hp)

Change the window dimension interactively. Refer to RFC4254 6.7. Window Dimension Change Message.

Parameters:

col - terminal width, columns

row - terminal height, rows

wp - terminal width, pixels

hp - terminal height, pixels

setPtyType

public void setPtyType(java.lang.String ttype)

Set the terminal type. This method is not effective after Channel#connect().

Parameters:

ttype - terminal type(for example, "vt100")

See Also:

setPtyType(String, int, int, int, int)

setPtyType

public void setPtyType(java.lang.String ttype,
                       int col,
                       int row,
                       int wp,
                       int hp)

Set the terminal type. This method is not effective after Channel#connect().

Parameters:

ttype - terminal type(for example, "vt100")

col - terminal width, columns

row - terminal height, rows

wp - terminal width, pixels

hp - terminal height, pixels

sendRequests

protected void sendRequests()
                     throws java.lang.Exception

Throws:

java.lang.Exception

toByteArray

private byte[] toByteArray(java.lang.Object o)

run

public void run()

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class Channel