com.sshtools.j2ssh.session.SessionChannelClient

public class SessionChannelClient extends IOChannel

Version:: $Revision: 1.52 $
Author:: $author$

Field Summary

Fields inherited from class com.sshtools.j2ssh.connection.IOChannel
boundInputStream, boundOutputStream, in, ios, out

Fields inherited from class com.sshtools.j2ssh.connection.Channel
connection, localChannelId, localPacketSize, localWindow, remoteChannelId, remotePacketSize, remoteWindow, state
Constructor Summary

Constructors

Constructor

Description

SessionChannelClient()

Creates a new SessionChannelClient object.
Method Summary

Modifier and Type

Method

Description

void

changeTerminalDimensions(PseudoTerminal term)

boolean

executeCommand(String command)

byte[]

getChannelConfirmationData()

byte[]

getChannelOpenData()

String

getChannelType()

Integer

getExitCode()

protected int

getMaximumPacketSize()

protected int

getMaximumWindowSpace()

protected int

getMinimumWindowSpace()

String

getSessionType()

InputStream

getStderrInputStream()

SubsystemClient

getSubsystem()

boolean

isLocalFlowControlEnabled()

protected void

onChannelClose()

protected void

onChannelExtData(SshMsgChannelExtendedData msg)

protected void

onChannelOpen()

protected void

onChannelRequest(String requestType, boolean wantReply, byte[] requestData)

boolean

requestAgentForwarding()

boolean

requestPseudoTerminal(PseudoTerminal term)

boolean

requestPseudoTerminal(String term, int cols, int rows, int width, int height, String terminalModes)

boolean

requestX11Forwarding(int display, String cookie)

boolean

setEnvironmentVariable(String name, String value)

void

setSessionType(String sessionType)

void

setSignalListener(SignalListener signalListener)

boolean

startShell()

boolean

startSubsystem(SubsystemClient subsystem)

boolean

startSubsystem(String subsystem)

Methods inherited from class com.sshtools.j2ssh.connection.IOChannel
bindInputStream, bindOutputStream, getInputStream, getOutputStream, init, onChannelData, onChannelEOF, open, setLocalEOF

Methods inherited from class com.sshtools.j2ssh.connection.Channel
addEventListener, close, finalizeClose, getLocalChannelId, getLocalPacketSize, getLocalWindow, getName, getRemoteChannelId, getRemotePacketSize, getRemoteWindow, getState, init, isClosed, isLocalEOF, isOpen, isRemoteEOF, processChannelData, processChannelData, remoteClose, sendChannelData, sendChannelExtData, setName, setRemoteEOF

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- SessionChannelClient
  
  public SessionChannelClient()
  
  Creates a new SessionChannelClient object.
Method Details
- getChannelOpenData
  
  public byte[] getChannelOpenData()
  
  Specified by:
  
  getChannelOpenData in class Channel
  
  Returns:
- getChannelConfirmationData
  
  public byte[] getChannelConfirmationData()
  
  Specified by:
  
  getChannelConfirmationData in class Channel
  
  Returns:
- getChannelType
  
  public String getChannelType()
  
  Specified by:
  
  getChannelType in class Channel
  
  Returns:
- getMinimumWindowSpace
  
  protected int getMinimumWindowSpace()
  
  Specified by:
  
  getMinimumWindowSpace in class Channel
  
  Returns:
- getMaximumWindowSpace
  
  protected int getMaximumWindowSpace()
  
  Specified by:
  
  getMaximumWindowSpace in class Channel
  
  Returns:
- getMaximumPacketSize
  
  protected int getMaximumPacketSize()
  
  Specified by:
  
  getMaximumPacketSize in class Channel
  
  Returns:
- setSignalListener
  
  public void setSignalListener(SignalListener signalListener)
  
  Parameters:
  
  signalListener -
- setEnvironmentVariable
  
  public boolean setEnvironmentVariable(String name, String value) throws IOException
  
  Parameters:
  
  name -
  
  value -
  
  Returns:
  
  Throws:
  
  IOException
- requestAgentForwarding
  
  public boolean requestAgentForwarding() throws IOException
  
  Returns:
  
  Throws:
  
  IOException
  
  SshException
  
  InvalidChannelException
- requestX11Forwarding
  
  public boolean requestX11Forwarding(int display, String cookie) throws IOException
  
  Parameters:
  
  display -
  
  cookie -
  
  Returns:
  
  Throws:
  
  IOException
- getExitCode
  
  public Integer getExitCode()
  
  Returns:
- changeTerminalDimensions
  
  public void changeTerminalDimensions(PseudoTerminal term) throws IOException
  
  Parameters:
  
  term -
  
  Throws:
  
  IOException
- executeCommand
  
  public boolean executeCommand(String command) throws IOException
  
  Parameters:
  
  command -
  
  Returns:
  
  Throws:
  
  IOException
- requestPseudoTerminal
  
  public boolean requestPseudoTerminal(String term, int cols, int rows, int width, int height, String terminalModes) throws IOException
  
  Parameters:
  
  term -
  
  cols -
  
  rows -
  
  width -
  
  height -
  
  terminalModes -
  
  Returns:
  
  Throws:
  
  IOException
- requestPseudoTerminal
  
  public boolean requestPseudoTerminal(PseudoTerminal term) throws IOException
  
  Parameters:
  
  term -
  
  Returns:
  
  Throws:
  
  IOException
- startShell
  
  public boolean startShell() throws IOException
  
  Returns:
  
  Throws:
  
  IOException
- startSubsystem
  
  public boolean startSubsystem(String subsystem) throws IOException
  
  Parameters:
  
  subsystem -
  
  Returns:
  
  Throws:
  
  IOException
- startSubsystem
  
  public boolean startSubsystem(SubsystemClient subsystem) throws IOException
  
  Parameters:
  
  subsystem -
  
  Returns:
  
  Throws:
  
  IOException
- isLocalFlowControlEnabled
  
  public boolean isLocalFlowControlEnabled()
  
  Returns:
- getSessionType
  
  public String getSessionType()
  
  Returns:
- setSessionType
  
  public void setSessionType(String sessionType)
  
  Parameters:
  
  sessionType -
- getSubsystem
  
  public SubsystemClient getSubsystem()
  
  Returns:
- onChannelClose
  
  protected void onChannelClose() throws IOException
  
  Overrides:
  
  onChannelClose in class IOChannel
  
  Throws:
  
  IOException
- onChannelOpen
  
  protected void onChannelOpen() throws IOException
  
  Specified by:
  
  onChannelOpen in class Channel
  
  Throws:
  
  IOException
- getStderrInputStream
  
  public InputStream getStderrInputStream() throws IOException
  
  Returns:
  
  Throws:
  
  IOException
- onChannelExtData
  
  protected void onChannelExtData(SshMsgChannelExtendedData msg) throws IOException
  
  Overrides:
  
  onChannelExtData in class IOChannel
  
  Parameters:
  
  msg -
  
  Throws:
  
  IOException
- onChannelRequest
  
  protected void onChannelRequest(String requestType, boolean wantReply, byte[] requestData) throws IOException
  
  Specified by:
  
  onChannelRequest in class Channel
  
  Parameters:
  
  requestType -
  
  wantReply -
  
  requestData -
  
  Throws:
  
  IOException

Class SessionChannelClient

Field Summary

Fields inherited from class com.sshtools.j2ssh.connection.IOChannel

Fields inherited from class com.sshtools.j2ssh.connection.Channel

Constructor Summary

Method Summary

Methods inherited from class com.sshtools.j2ssh.connection.IOChannel

Methods inherited from class com.sshtools.j2ssh.connection.Channel

Methods inherited from class java.lang.Object

Constructor Details

SessionChannelClient

Method Details

getChannelOpenData

getChannelConfirmationData

getChannelType

getMinimumWindowSpace

getMaximumWindowSpace

getMaximumPacketSize

setSignalListener

setEnvironmentVariable

requestAgentForwarding

requestX11Forwarding

getExitCode

changeTerminalDimensions

executeCommand

requestPseudoTerminal

requestPseudoTerminal

startShell

startSubsystem

startSubsystem

isLocalFlowControlEnabled

getSessionType

setSessionType

getSubsystem

onChannelClose

onChannelOpen

getStderrInputStream

onChannelExtData

onChannelRequest