Package org.apache.sshd.cli.server.helper

Class ServerPortForwardingEventListener

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.cli.server.helper.ServerEventListenerHelper

org.apache.sshd.cli.server.helper.ServerPortForwardingEventListener

All Implemented Interfaces:

java.util.EventListener, PortForwardingEventListener, NamedResource, SshdEventListener

public class ServerPortForwardingEventListener
extends ServerEventListenerHelper
implements PortForwardingEventListener

Field Summary

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

log

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

BY_NAME_COMPARATOR, NAME_EXTRACTOR

Fields inherited from interface org.apache.sshd.common.forward.PortForwardingEventListener

EMPTY

Constructor Summary

Constructors

Constructor	Description
ServerPortForwardingEventListener(org.slf4j.Logger logger)

Method Summary

Modifier and Type	Method	Description
void	establishedDynamicTunnel(Session session, SshdSocketAddress local, SshdSocketAddress boundAddress, java.lang.Throwable reason)	Signals a successful/failed attempt to establish a dynamic port forwarding
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
void	tornDownDynamicTunnel(Session session, SshdSocketAddress address, java.lang.Throwable reason)	Signals a successful/failed request to tear down a dynamic port forwarding
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

Methods inherited from class org.apache.sshd.cli.server.helper.ServerEventListenerHelper

getName

Methods inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

debug, debug, debug, debug, debug, error, error, error, error, error, getSimplifiedLogger, info, info, warn, warn, warn, warn, warn, warn, warn, warn

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

establishingDynamicTunnel, establishingExplicitTunnel, tearingDownDynamicTunnel, tearingDownExplicitTunnel

Constructor Detail

ServerPortForwardingEventListener

public ServerPortForwardingEventListener(org.slf4j.Logger logger)

Method Detail

establishedExplicitTunnel

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

Description copied from interface: PortForwardingEventListener

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

Specified by:

establishedExplicitTunnel in interface PortForwardingEventListener

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

tornDownExplicitTunnel

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

Description copied from interface: PortForwardingEventListener

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

Specified by:

tornDownExplicitTunnel in interface PortForwardingEventListener

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

establishedDynamicTunnel

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

Description copied from interface: PortForwardingEventListener

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

Specified by:

establishedDynamicTunnel in interface PortForwardingEventListener

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

tornDownDynamicTunnel

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

Description copied from interface: PortForwardingEventListener

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

Specified by:

tornDownDynamicTunnel in interface PortForwardingEventListener

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