com.sshtools.synergy.ssh

Interface ForwardingFactory<T extends SshContext>

All Known Implementing Classes:

SocketListeningForwardingFactoryImpl

public interface ForwardingFactory<T extends SshContext>

This interface defines the behaviour for remote forwarding requests. When an SSH client requests a remote forwarding we typically open a server socket, accept connections and open remote forwarding channels on the client.

Method Summary

Modifier and Type	Method and Description
boolean	belongsTo(ConnectionProtocol<T> connection) Does this factory belong to the connection provided?
int	bindInterface(java.lang.String addressToBind, int portToBind, ConnectionProtocol<?> connection, java.lang.String channelType)
int	bindInterface(java.lang.String addressToBind, int portToBind, ConnectionProtocol<T> connection) A client has requested that the server start listening and forward any subsequent connections to the client.
SocketListeningForwardingFactoryImpl.ActiveTunnelManager<T>	getActiveTunnelManager()
java.lang.String	getChannelType() Get the underlying channel type for this forwarding factory.
int	getStartedEventCode()
int	getStoppedEventCode()
void	stopListening(boolean dropActiveTunnels) Stop listening on active interfaces.

Method Detail

bindInterface

int bindInterface(java.lang.String addressToBind,
                  int portToBind,
                  ConnectionProtocol<T> connection)
           throws java.io.IOException

A client has requested that the server start listening and forward any subsequent connections to the client.

Parameters:

addressToBind - String

portToBind - int

connection - ConnectionProtocol

Throws:

java.io.IOException

bindInterface

int bindInterface(java.lang.String addressToBind,
                  int portToBind,
                  ConnectionProtocol<?> connection,
                  java.lang.String channelType)
           throws java.io.IOException

Parameters:

addressToBind -

portToBind -

connection -

channelType -

Throws:

java.io.IOException

belongsTo

boolean belongsTo(ConnectionProtocol<T> connection)

Does this factory belong to the connection provided?

Parameters:

connection - ConnectionProtocol

Returns:

boolean

stopListening

void stopListening(boolean dropActiveTunnels)

Stop listening on active interfaces.

Parameters:

dropActiveTunnels - boolean

getChannelType

java.lang.String getChannelType()

Get the underlying channel type for this forwarding factory.

getStartedEventCode

int getStartedEventCode()

getStoppedEventCode

int getStoppedEventCode()

getActiveTunnelManager

SocketListeningForwardingFactoryImpl.ActiveTunnelManager<T> getActiveTunnelManager()