com.sshtools.j2ssh.forwarding

Class ForwardingClient

Implemented Interfaces:
ChannelFactory

public class ForwardingClient
extends java.lang.Object
implements ChannelFactory

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

Nested Class Summary

class
ForwardingClient.ClientForwardingListener

Field Summary

static String
REMOTE_FORWARD_CANCEL_REQUEST
static String
REMOTE_FORWARD_REQUEST

Constructor Summary

ForwardingClient(ConnectionProtocol connection)
Creates a new ForwardingClient object.

Method Summary

ForwardingConfiguration
addLocalForwarding(String uniqueName, String addressToBind, int portToBind, String hostToConnect, int portToConnect)
ForwardingConfiguration
addLocalForwarding(ForwardingConfiguration fwd)
void
addRemoteForwarding(String uniqueName, String addressToBind, int portToBind, String hostToConnect, int portToConnect)
void
addRemoteForwarding(ForwardingConfiguration fwd)
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)

Field Details

REMOTE_FORWARD_CANCEL_REQUEST

public static final String REMOTE_FORWARD_CANCEL_REQUEST

REMOTE_FORWARD_REQUEST

public static final String REMOTE_FORWARD_REQUEST

Constructor Details

ForwardingClient

public ForwardingClient(ConnectionProtocol connection)
            throws IOException
Creates a new ForwardingClient object.
Parameters:
connection -

Method Details

addLocalForwarding

public ForwardingConfiguration addLocalForwarding(String uniqueName,
                                                  String addressToBind,
                                                  int portToBind,
                                                  String hostToConnect,
                                                  int portToConnect)
            throws ForwardingConfigurationException
Parameters:
uniqueName -
addressToBind -
portToBind -
hostToConnect -
portToConnect -
Returns:

addLocalForwarding

public ForwardingConfiguration addLocalForwarding(ForwardingConfiguration fwd)
            throws ForwardingConfigurationException
Parameters:
fwd -
Returns:

addRemoteForwarding

public void addRemoteForwarding(String uniqueName,
                                String addressToBind,
                                int portToBind,
                                String hostToConnect,
                                int portToConnect)
            throws ForwardingConfigurationException
Parameters:
uniqueName -
addressToBind -
portToBind -
hostToConnect -
portToConnect -

addRemoteForwarding

public void addRemoteForwarding(ForwardingConfiguration fwd)
            throws ForwardingConfigurationException
Parameters:
fwd -

createChannel

public Channel createChannel(String channelType,
                             byte[] requestData)
            throws InvalidChannelException
Specified by:
createChannel in interface ChannelFactory
Parameters:
channelType -
requestData -
Returns:

enableX11Forwarding

public void enableX11Forwarding(XDisplay localDisplay)
Parameters:
localDisplay -

getChannelType

public List getChannelType()
Returns:

getLocalForwardingByAddress

public ForwardingConfiguration getLocalForwardingByAddress(String addressToBind,
                                                           int portToBind)
            throws ForwardingConfigurationException
Parameters:
addressToBind -
portToBind -
Returns:

getLocalForwardingByName

public ForwardingConfiguration getLocalForwardingByName(String name)
            throws ForwardingConfigurationException
Parameters:
name -
Returns:

getLocalForwardings

public Map getLocalForwardings()
Returns:

getRemoteForwardingByAddress

public ForwardingConfiguration getRemoteForwardingByAddress(String addressToBind,
                                                            int portToBind)
            throws ForwardingConfigurationException
Parameters:
addressToBind -
portToBind -
Returns:

getRemoteForwardingByName

public ForwardingConfiguration getRemoteForwardingByName(String name)
            throws ForwardingConfigurationException
Parameters:
name -
Returns:

getRemoteForwardings

public Map getRemoteForwardings()
Returns:

getX11ForwardingConfiguration

public ForwardingConfiguration getX11ForwardingConfiguration()
Returns:

hasActiveConfigurations

public boolean hasActiveConfigurations()
Returns:

hasActiveForwardings

public boolean hasActiveForwardings()
Returns:

removeLocalForwarding

public void removeLocalForwarding(String name)
            throws ForwardingConfigurationException
Parameters:
name -

removeRemoteForwarding

public void removeRemoteForwarding(String name)
            throws IOException,
                   ForwardingConfigurationException
Parameters:
name -

startLocalForwarding

public void startLocalForwarding(String uniqueName)
            throws ForwardingConfigurationException
Parameters:
uniqueName -

startRemoteForwarding

public void startRemoteForwarding(String name)
            throws IOException,
                   ForwardingConfigurationException
Parameters:
name -

startX11Forwarding

public void startX11Forwarding()
            throws IOException,
                   ForwardingConfigurationException

stopLocalForwarding

public void stopLocalForwarding(String uniqueName)
            throws ForwardingConfigurationException
Parameters:
uniqueName -

stopRemoteForwarding

public void stopRemoteForwarding(String name)
            throws IOException,
                   ForwardingConfigurationException
Parameters:
name -

synchronizeConfiguration

public void synchronizeConfiguration(SshConnectionProperties properties)

Copyright © 2002-2003 Lee David Painter & Contributors. All Rights Reserved.