Interface Forwarder

All Superinterfaces:

AutoCloseable, Channel, Closeable, org.apache.sshd.common.Closeable, PortForwardingEventListenerManager, PortForwardingEventListenerManagerHolder, PortForwardingInformationProvider, PortForwardingManager

All Known Implementing Classes:

DefaultForwarder

public interface Forwarder
extends PortForwardingManager, PortForwardingEventListenerManager, PortForwardingEventListenerManagerHolder, org.apache.sshd.common.Closeable

TODO Add javadoc

Author:

Apache MINA SSHD Project

Method Summary

Modifier and Type	Method	Description
org.apache.sshd.common.util.net.SshdSocketAddress	getForwardedPort(int remotePort)
void	localPortForwardingCancelled(org.apache.sshd.common.util.net.SshdSocketAddress local)	Called when the other side cancelled a remote port forward.
org.apache.sshd.common.util.net.SshdSocketAddress	localPortForwardingRequested(org.apache.sshd.common.util.net.SshdSocketAddress local)	Called when the other side requested a remote port forward.

Methods inherited from interface org.apache.sshd.common.Closeable

addCloseFutureListener, close, close, isClosed, isClosing, isOpen, removeCloseFutureListener

Methods inherited from interface PortForwardingEventListenerManager

addPortForwardingEventListener, getPortForwardingEventListenerProxy, removePortForwardingEventListener

Methods inherited from interface PortForwardingEventListenerManagerHolder

addPortForwardingEventListenerManager, getRegisteredManagers, removePortForwardingEventListenerManager

Methods inherited from interface PortForwardingInformationProvider

getBoundLocalPortForwards, getBoundRemotePortForward, getLocalForwardsBindings, getRemoteForwardsBindings, getStartedLocalPortForwards, getStartedRemotePortForwards, isLocalPortForwardingStartedForPort, isRemotePortForwardingStartedForPort

Methods inherited from interface PortForwardingManager

startDynamicPortForwarding, startLocalPortForwarding, startLocalPortForwarding, startRemotePortForwarding, stopDynamicPortForwarding, stopLocalPortForwarding, stopRemotePortForwarding

Method Details

getForwardedPort

org.apache.sshd.common.util.net.SshdSocketAddress getForwardedPort(int remotePort)

Parameters:

remotePort - The remote port

Returns:

The local SshdSocketAddress that the remote port is forwarded to

localPortForwardingRequested

org.apache.sshd.common.util.net.SshdSocketAddress localPortForwardingRequested(org.apache.sshd.common.util.net.SshdSocketAddress local)
                                                                        throws IOException

Called when the other side requested a remote port forward.

Parameters:

local - The request address

Returns:

The bound local SshdSocketAddress - null if not allowed to forward

Throws:

IOException - If failed to handle request

localPortForwardingCancelled

void localPortForwardingCancelled(org.apache.sshd.common.util.net.SshdSocketAddress local)
                           throws IOException

Called when the other side cancelled a remote port forward.

Parameters:

local - The local SshdSocketAddress

Throws:

IOException - If failed to handle request