org.apache.sshd.common.forward

Interface ForwardingFilter

All Superinterfaces:

AutoCloseable, Channel, Closeable, PortForwardingEventListenerManager, PortForwardingEventListenerManagerHolder, PortForwardingInformationProvider, PortForwardingManager

All Known Implementing Classes:

DefaultForwardingFilter

public interface ForwardingFilter
extends PortForwardingManager, PortForwardingEventListenerManager, PortForwardingEventListenerManagerHolder, Closeable

TODO Add javadoc

Author:

Apache MINA SSHD Project

Field Summary

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

CLOSE_WAIT_TIMEOUT, DEFAULT_CLOSE_WAIT_TIMEOUT

Method Summary

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

Methods inherited from interface org.apache.sshd.common.forward.PortForwardingManager

startDynamicPortForwarding, startLocalPortForwarding, startRemotePortForwarding, stopDynamicPortForwarding, stopLocalPortForwarding, stopRemotePortForwarding

Methods inherited from interface org.apache.sshd.common.forward.PortForwardingInformationProvider

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

Methods inherited from interface org.apache.sshd.common.forward.PortForwardingEventListenerManager

addPortForwardingEventListener, getPortForwardingEventListenerProxy, removePortForwardingEventListener

Methods inherited from interface org.apache.sshd.common.forward.PortForwardingEventListenerManagerHolder

addPortForwardingEventListenerManager, getRegisteredManagers, removePortForwardingEventListenerManager

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

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

Method Detail

getForwardedPort

SshdSocketAddress getForwardedPort(int remotePort)

Parameters:

remotePort - The remote port

Returns:

The local SshdSocketAddress that the remote port is forwarded to

localPortForwardingRequested

SshdSocketAddress localPortForwardingRequested(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(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