java.lang.Object

com.sshtools.j2ssh.forwarding.ForwardingClient

All Implemented Interfaces:: ChannelFactory

public class ForwardingClient extends Object implements ChannelFactory

Version:: $Revision: 1.37 $
Author:: $author$

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

class

ForwardingClient.ClientForwardingListener
Field Summary

Fields

Modifier and Type

Field

Description

static final String

REMOTE_FORWARD_CANCEL_REQUEST

static final String

REMOTE_FORWARD_REQUEST
Constructor Summary

Constructors

Constructor

Description

ForwardingClient(ConnectionProtocol connection)

Creates a new ForwardingClient object.
Method Summary

Modifier and Type

Method

Description

ForwardingConfiguration

addLocalForwarding(ForwardingConfiguration fwd)

ForwardingConfiguration

addLocalForwarding(String uniqueName, String addressToBind, int portToBind, String hostToConnect, int portToConnect)

void

addRemoteForwarding(ForwardingConfiguration fwd)

void

addRemoteForwarding(String uniqueName, String addressToBind, int portToBind, String hostToConnect, int portToConnect)

Channel

createChannel(String channelType, byte[] requestData)

void

enableX11Forwarding(XDisplay localDisplay)

List

getChannelType()

ForwardingConfiguration

getLocalForwardingByAddress(String addressToBind, int portToBind)

ForwardingConfiguration

getLocalForwardingByName(String name)

Map

getLocalForwardings()

ForwardingConfiguration

getRemoteForwardingByAddress(String addressToBind, int portToBind)

ForwardingConfiguration

getRemoteForwardingByName(String name)

Map

getRemoteForwardings()

ForwardingConfiguration

getX11ForwardingConfiguration()

boolean

hasActiveConfigurations()

boolean

hasActiveForwardings()

void

removeLocalForwarding(String name)

void

removeRemoteForwarding(String name)

void

startLocalForwarding(String uniqueName)

void

startRemoteForwarding(String name)

void

startX11Forwarding()

void

stopLocalForwarding(String uniqueName)

void

stopRemoteForwarding(String name)

void

synchronizeConfiguration(SshConnectionProperties properties)

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

Field Details
- REMOTE_FORWARD_REQUEST
  
  public static final String REMOTE_FORWARD_REQUEST
  See Also:
  
  Constant Field Values
- REMOTE_FORWARD_CANCEL_REQUEST
  
  public static final String REMOTE_FORWARD_CANCEL_REQUEST
  See Also:
  
  Constant Field Values
Constructor Details
- ForwardingClient
  
  public ForwardingClient(ConnectionProtocol connection) throws IOException
  
  Creates a new ForwardingClient object.
  
  Parameters:
  
  connection -
  
  Throws:
  
  IOException
Method Details
- getChannelType
  
  public List getChannelType()
  
  Returns:
- enableX11Forwarding
  
  public void enableX11Forwarding(XDisplay localDisplay)
  
  Parameters:
  
  localDisplay -
- getX11ForwardingConfiguration
  
  public ForwardingConfiguration getX11ForwardingConfiguration()
  
  Returns:
- hasActiveConfigurations
  
  public boolean hasActiveConfigurations()
  
  Returns:
- synchronizeConfiguration
  
  public void synchronizeConfiguration(SshConnectionProperties properties)
- hasActiveForwardings
  
  public boolean hasActiveForwardings()
  
  Returns:
- getLocalForwardingByAddress
  
  public ForwardingConfiguration getLocalForwardingByAddress(String addressToBind, int portToBind) throws ForwardingConfigurationException
  
  Parameters:
  
  addressToBind -
  
  portToBind -
  
  Returns:
  
  Throws:
  
  ForwardingConfigurationException
- getLocalForwardingByName
  
  public ForwardingConfiguration getLocalForwardingByName(String name) throws ForwardingConfigurationException
  
  Parameters:
  
  name -
  
  Returns:
  
  Throws:
  
  ForwardingConfigurationException
- getRemoteForwardingByName
  
  public ForwardingConfiguration getRemoteForwardingByName(String name) throws ForwardingConfigurationException
  
  Parameters:
  
  name -
  
  Returns:
  
  Throws:
  
  ForwardingConfigurationException
- getLocalForwardings
  
  public Map getLocalForwardings()
  
  Returns:
- getRemoteForwardings
  
  public Map getRemoteForwardings()
  
  Returns:
- getRemoteForwardingByAddress
  
  public ForwardingConfiguration getRemoteForwardingByAddress(String addressToBind, int portToBind) throws ForwardingConfigurationException
  
  Parameters:
  
  addressToBind -
  
  portToBind -
  
  Returns:
  
  Throws:
  
  ForwardingConfigurationException
- removeLocalForwarding
  
  public void removeLocalForwarding(String name) throws ForwardingConfigurationException
  
  Parameters:
  
  name -
  
  Throws:
  
  ForwardingConfigurationException
- removeRemoteForwarding
  
  public void removeRemoteForwarding(String name) throws IOException, ForwardingConfigurationException
  
  Parameters:
  
  name -
  
  Throws:
  
  IOException
  
  ForwardingConfigurationException
- addLocalForwarding
  
  public ForwardingConfiguration addLocalForwarding(String uniqueName, String addressToBind, int portToBind, String hostToConnect, int portToConnect) throws ForwardingConfigurationException
  
  Parameters:
  
  uniqueName -
  
  addressToBind -
  
  portToBind -
  
  hostToConnect -
  
  portToConnect -
  
  Returns:
  
  Throws:
  
  ForwardingConfigurationException
- addLocalForwarding
  
  public ForwardingConfiguration addLocalForwarding(ForwardingConfiguration fwd) throws ForwardingConfigurationException
  
  Parameters:
  
  fwd -
  
  Returns:
  
  Throws:
  
  ForwardingConfigurationException
- addRemoteForwarding
  
  public void addRemoteForwarding(String uniqueName, String addressToBind, int portToBind, String hostToConnect, int portToConnect) throws ForwardingConfigurationException
  
  Parameters:
  
  uniqueName -
  
  addressToBind -
  
  portToBind -
  
  hostToConnect -
  
  portToConnect -
  
  Throws:
  
  ForwardingConfigurationException
- addRemoteForwarding
  
  public void addRemoteForwarding(ForwardingConfiguration fwd) throws ForwardingConfigurationException
  
  Parameters:
  
  fwd -
  
  Throws:
  
  ForwardingConfigurationException
- createChannel
  
  public Channel createChannel(String channelType, byte[] requestData) throws InvalidChannelException
  
  Specified by:
  
  createChannel in interface ChannelFactory
  
  Parameters:
  
  channelType -
  
  requestData -
  
  Returns:
  
  Throws:
  
  InvalidChannelException
- startLocalForwarding
  
  public void startLocalForwarding(String uniqueName) throws ForwardingConfigurationException
  
  Parameters:
  
  uniqueName -
  
  Throws:
  
  ForwardingConfigurationException
- startX11Forwarding
  
  public void startX11Forwarding() throws IOException, ForwardingConfigurationException
  
  Throws:
  
  IOException
  
  ForwardingConfigurationException
- startRemoteForwarding
  
  public void startRemoteForwarding(String name) throws IOException, ForwardingConfigurationException
  
  Parameters:
  
  name -
  
  Throws:
  
  IOException
  
  ForwardingConfigurationException
- stopLocalForwarding
  
  public void stopLocalForwarding(String uniqueName) throws ForwardingConfigurationException
  
  Parameters:
  
  uniqueName -
  
  Throws:
  
  ForwardingConfigurationException
- stopRemoteForwarding
  
  public void stopRemoteForwarding(String name) throws IOException, ForwardingConfigurationException
  
  Parameters:
  
  name -
  
  Throws:
  
  IOException
  
  ForwardingConfigurationException

Class ForwardingClient

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

REMOTE_FORWARD_REQUEST

REMOTE_FORWARD_CANCEL_REQUEST

Constructor Details

ForwardingClient

Method Details

getChannelType

enableX11Forwarding

getX11ForwardingConfiguration

hasActiveConfigurations

synchronizeConfiguration

hasActiveForwardings

getLocalForwardingByAddress

getLocalForwardingByName

getRemoteForwardingByName

getLocalForwardings

getRemoteForwardings

getRemoteForwardingByAddress

removeLocalForwarding

removeRemoteForwarding

addLocalForwarding

addLocalForwarding

addRemoteForwarding

addRemoteForwarding

createChannel

startLocalForwarding

startX11Forwarding

startRemoteForwarding

stopLocalForwarding

stopRemoteForwarding