Package org.apache.sshd.common.forward

Interface PortForwardingEventListener

All Superinterfaces:

java.util.EventListener, SshdEventListener

public interface PortForwardingEventListener
extends SshdEventListener

Field Summary

Fields

Modifier and Type	Field	Description
static PortForwardingEventListener	EMPTY

Method Summary

Modifier and Type	Method	Description
default void	establishedDynamicTunnel(Session session, SshdSocketAddress local, SshdSocketAddress boundAddress, java.lang.Throwable reason)	Signals a successful/failed attempt to establish a dynamic port forwarding
default void	establishedExplicitTunnel(Session session, SshdSocketAddress local, SshdSocketAddress remote, boolean localForwarding, SshdSocketAddress boundAddress, java.lang.Throwable reason)	Signals a successful/failed attempt to establish a local/remote port forwarding
default void	establishingDynamicTunnel(Session session, SshdSocketAddress local)	Signals the attempt to establish a dynamic port forwarding
default void	establishingExplicitTunnel(Session session, SshdSocketAddress local, SshdSocketAddress remote, boolean localForwarding)	Signals the attempt to establish a local/remote port forwarding
default void	tearingDownDynamicTunnel(Session session, SshdSocketAddress address)	Signals a request to tear down a dynamic forwarding
default void	tearingDownExplicitTunnel(Session session, SshdSocketAddress address, boolean localForwarding, SshdSocketAddress remoteAddress)	Signals a request to tear down a local/remote port forwarding
default void	tornDownDynamicTunnel(Session session, SshdSocketAddress address, java.lang.Throwable reason)	Signals a successful/failed request to tear down a dynamic port forwarding
default void	tornDownExplicitTunnel(Session session, SshdSocketAddress address, boolean localForwarding, SshdSocketAddress remoteAddress, java.lang.Throwable reason)	Signals a successful/failed request to tear down a local/remote port forwarding
static <L extends PortForwardingEventListener> L	validateListener(L listener)

Field Detail

EMPTY

static final PortForwardingEventListener EMPTY

Method Detail

establishingExplicitTunnel

default void establishingExplicitTunnel(Session session,
                                        SshdSocketAddress local,
                                        SshdSocketAddress remote,
                                        boolean localForwarding)
                                 throws java.io.IOException

Signals the attempt to establish a local/remote port forwarding

Parameters:

session - The Session through which the attempt is made

local - The local address - may be null on the receiver side

remote - The remote address - may be null on the receiver side

localForwarding - Local/remote port forwarding indicator

Throws:

java.io.IOException - If failed to handle the event - in which case the attempt is aborted and the exception re-thrown to the caller

establishedExplicitTunnel

default void establishedExplicitTunnel(Session session,
                                       SshdSocketAddress local,
                                       SshdSocketAddress remote,
                                       boolean localForwarding,
                                       SshdSocketAddress boundAddress,
                                       java.lang.Throwable reason)
                                throws java.io.IOException

Signals a successful/failed attempt to establish a local/remote port forwarding

Parameters:

session - The Session through which the attempt was made

local - The local address - may be null on the receiver side

remote - The remote address - may be null on the receiver side

localForwarding - Local/remote port forwarding indicator

boundAddress - The bound address - non-null if successful

reason - Reason for failure - null if successful

Throws:

java.io.IOException - If failed to handle the event - in which case the established tunnel is aborted

tearingDownExplicitTunnel

default void tearingDownExplicitTunnel(Session session,
                                       SshdSocketAddress address,
                                       boolean localForwarding,
                                       SshdSocketAddress remoteAddress)
                                throws java.io.IOException

Signals a request to tear down a local/remote port forwarding

Parameters:

session - The Session through which the request is made

address - The (bound) address - local/remote according to the forwarding type

localForwarding - Local/remote port forwarding indicator

remoteAddress - The specified peer address when tunnel was established - may be null for server-side local tunneling requests

Throws:

java.io.IOException - If failed to handle the event - in which case the request is aborted

tornDownExplicitTunnel

default void tornDownExplicitTunnel(Session session,
                                    SshdSocketAddress address,
                                    boolean localForwarding,
                                    SshdSocketAddress remoteAddress,
                                    java.lang.Throwable reason)
                             throws java.io.IOException

Signals a successful/failed request to tear down a local/remote port forwarding

Parameters:

session - The Session through which the request is made

address - The (bound) address - local/remote according to the forwarding type

localForwarding - Local/remote port forwarding indicator

remoteAddress - The specified peer address when tunnel was established - may be null for server-side local tunneling requests

reason - Reason for failure - null if successful

Throws:

java.io.IOException - If failed to handle the event - Note: the exception is propagated, but the port forwarding may have been torn down - no rollback

establishingDynamicTunnel

default void establishingDynamicTunnel(Session session,
                                       SshdSocketAddress local)
                                throws java.io.IOException

Signals the attempt to establish a dynamic port forwarding

Parameters:

session - The Session through which the attempt is made

local - The local address

Throws:

java.io.IOException - If failed to handle the event - in which case the attempt is aborted and the exception re-thrown to the caller

establishedDynamicTunnel

default void establishedDynamicTunnel(Session session,
                                      SshdSocketAddress local,
                                      SshdSocketAddress boundAddress,
                                      java.lang.Throwable reason)
                               throws java.io.IOException

Signals a successful/failed attempt to establish a dynamic port forwarding

Parameters:

session - The Session through which the attempt is made

local - The local address

boundAddress - The bound address - non-null if successful

reason - Reason for failure - null if successful

Throws:

java.io.IOException - If failed to handle the event - in which case the established tunnel is aborted

tearingDownDynamicTunnel

default void tearingDownDynamicTunnel(Session session,
                                      SshdSocketAddress address)
                               throws java.io.IOException

Signals a request to tear down a dynamic forwarding

Parameters:

session - The Session through which the request is made

address - The (bound) address - local/remote according to the forwarding type

Throws:

java.io.IOException - If failed to handle the event - in which case the request is aborted

tornDownDynamicTunnel

default void tornDownDynamicTunnel(Session session,
                                   SshdSocketAddress address,
                                   java.lang.Throwable reason)
                            throws java.io.IOException

Signals a successful/failed request to tear down a dynamic port forwarding

Parameters:

session - The Session through which the request is made

address - The (bound) address - local/remote according to the forwarding type

reason - Reason for failure - null if successful

Throws:

java.io.IOException - If failed to handle the event - Note: the exception is propagated, but the port forwarding may have been torn down - no rollback

validateListener

static <L extends PortForwardingEventListener> L validateListener(L listener)