ForwardingSocketChannel (J2SSH Javadocs)

java.lang.Object
- com.sshtools.j2ssh.connection.Channel
- - com.sshtools.j2ssh.connection.SocketChannel
  - - com.sshtools.j2ssh.forwarding.ForwardingSocketChannel

All Implemented Interfaces:: ForwardingChannel

public class ForwardingSocketChannel
extends SocketChannel
implements ForwardingChannel

Version:: $Revision: 1.13 $
Author:: $author$

Field Summary
- Fields inherited from class com.sshtools.j2ssh.connection.SocketChannel
  socket
- Fields inherited from class com.sshtools.j2ssh.connection.Channel
  connection, localChannelId, localPacketSize, localWindow, remoteChannelId, remotePacketSize, remoteWindow, state
- Fields inherited from interface com.sshtools.j2ssh.forwarding.ForwardingChannel
  LOCAL_FORWARDING_CHANNEL, REMOTE_FORWARDING_CHANNEL, X11_FORWARDING_CHANNEL

Constructor Summary

Constructors
Constructor and Description
`ForwardingSocketChannel(java.lang.String forwardType, java.lang.String name, java.lang.String hostToConnectOrBind, int portToConnectOrBind, java.lang.String originatingHost, int originatingPort)` Creates a new ForwardingSocketChannel object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`byte[]`	`getChannelConfirmationData()`
`byte[]`	`getChannelOpenData()`
`java.lang.String`	`getChannelType()`
`java.lang.String`	`getHostToConnectOrBind()`
`protected int`	`getMaximumPacketSize()`
`protected int`	`getMaximumWindowSpace()`
`protected int`	`getMinimumWindowSpace()`
`java.lang.String`	`getName()`
`java.lang.String`	`getOriginatingHost()`
`int`	`getOriginatingPort()`
`int`	`getPortToConnectOrBind()`
`protected void`	`onChannelRequest(java.lang.String request, boolean wantReply, byte[] requestData)`

Methods inherited from class com.sshtools.j2ssh.connection.SocketChannel
bindSocket, onChannelClose, onChannelData, onChannelEOF, onChannelExtData, onChannelOpen

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

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

- Constructor Detail
  - ForwardingSocketChannel
```
public ForwardingSocketChannel(java.lang.String forwardType,
                               java.lang.String name,
                               java.lang.String hostToConnectOrBind,
                               int portToConnectOrBind,
                               java.lang.String originatingHost,
                               int originatingPort)
                        throws ForwardingConfigurationException
```
    Creates a new ForwardingSocketChannel object.
    
    Parameters:
    
    forwardType -
    
    hostToConnectOrBind -
    
    portToConnectOrBind -
    
    originatingHost -
    
    originatingPort -
    
    Throws:
    
    ForwardingConfigurationException
- Method Detail
  - getName
```
public java.lang.String getName()
```
    Specified by:
    
    getName in interface ForwardingChannel
    
    Overrides:
    
    getName in class Channel
  - getChannelOpenData
```
public byte[] getChannelOpenData()
```
    Specified by:
    
    getChannelOpenData in class Channel
    
    Returns:
  - getChannelConfirmationData
```
public byte[] getChannelConfirmationData()
```
    Specified by:
    
    getChannelConfirmationData in class Channel
    
    Returns:
  - getChannelType
```
public java.lang.String getChannelType()
```
    Specified by:
    
    getChannelType in interface ForwardingChannel
    
    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:
  - getOriginatingHost
```
public java.lang.String getOriginatingHost()
```
    Specified by:
    
    getOriginatingHost in interface ForwardingChannel
    
    Returns:
  - getOriginatingPort
```
public int getOriginatingPort()
```
    Specified by:
    
    getOriginatingPort in interface ForwardingChannel
    
    Returns:
  - getHostToConnectOrBind
```
public java.lang.String getHostToConnectOrBind()
```
    Specified by:
    
    getHostToConnectOrBind in interface ForwardingChannel
    
    Returns:
  - getPortToConnectOrBind
```
public int getPortToConnectOrBind()
```
    Specified by:
    
    getPortToConnectOrBind in interface ForwardingChannel
    
    Returns:
  - onChannelRequest
```
protected void onChannelRequest(java.lang.String request,
                                boolean wantReply,
                                byte[] requestData)
                         throws java.io.IOException
```
    Specified by:
    
    onChannelRequest in class Channel
    
    Parameters:
    
    request -
    
    wantReply -
    
    requestData -
    
    Throws:
    
    java.io.IOException

Class ForwardingSocketChannel

Field Summary

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

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

Fields inherited from interface com.sshtools.j2ssh.forwarding.ForwardingChannel

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Constructor Detail

ForwardingSocketChannel

Method Detail

getName

getChannelOpenData

getChannelConfirmationData

getChannelType

getMinimumWindowSpace

getMaximumWindowSpace

getMaximumPacketSize

getOriginatingHost

getOriginatingPort

getHostToConnectOrBind

getPortToConnectOrBind

onChannelRequest