Package org.apache.sshd.common.forward

Interface PortForwardingInformationProvider

All Known Subinterfaces:

ClientSession, Forwarder, PortForwardingManager, ServerSession, Session

All Known Implementing Classes:

AbstractClientSession, AbstractServerSession, AbstractSession, ClientSessionImpl, DefaultForwarder, ServerSessionImpl, SessionHelper

public interface PortForwardingInformationProvider

Author:

Apache MINA SSHD Project

Method Summary

Modifier and Type	Method	Description
List<SshdSocketAddress>	getBoundLocalPortForwards(int port)
SshdSocketAddress	getBoundRemotePortForward(int port)
List<Map.Entry<SshdSocketAddress,SshdSocketAddress>>	getLocalForwardsBindings()
List<Map.Entry<Integer,SshdSocketAddress>>	getRemoteForwardsBindings()
List<SshdSocketAddress>	getStartedLocalPortForwards()
NavigableSet<Integer>	getStartedRemotePortForwards()
default boolean	isLocalPortForwardingStartedForPort(int port)	Test if local port forwarding is started
default boolean	isRemotePortForwardingStartedForPort(int port)	Test if remote port forwarding is started

Method Details

getStartedLocalPortForwards

List<SshdSocketAddress> getStartedLocalPortForwards()

Returns:

A List snapshot of the currently started local port forward bindings

getBoundLocalPortForwards

List<SshdSocketAddress> getBoundLocalPortForwards(int port)

Parameters:

port - The port number

Returns:

The local bound SshdSocketAddress-es for the port

See Also:

• isLocalPortForwardingStartedForPort
• getStartedLocalPortForwards()

getLocalForwardsBindings

List<Map.Entry<SshdSocketAddress,SshdSocketAddress>> getLocalForwardsBindings()

Returns:

A snapshot of the currently bound forwarded local ports as "pairs" of local/remote SshdSocketAddress-es

isLocalPortForwardingStartedForPort

default boolean isLocalPortForwardingStartedForPort(int port)

Test if local port forwarding is started

Parameters:

port - The local port

Returns:

true if local port forwarding is started

See Also:

• getBoundLocalPortForwards

getStartedRemotePortForwards

NavigableSet<Integer> getStartedRemotePortForwards()

Returns:

A NavigableSet snapshot of the currently started remote port forwards

getBoundRemotePortForward

SshdSocketAddress getBoundRemotePortForward(int port)

Parameters:

port - The port number

Returns:

The remote bound SshdSocketAddress for the port - null if none bound

See Also:

• isRemotePortForwardingStartedForPort
• getStartedRemotePortForwards()

getRemoteForwardsBindings

List<Map.Entry<Integer,SshdSocketAddress>> getRemoteForwardsBindings()

Returns:

A snapshot of the currently bound forwarded remote ports as "pairs" of port + bound SshdSocketAddress

isRemotePortForwardingStartedForPort

default boolean isRemotePortForwardingStartedForPort(int port)

Test if remote port forwarding is started

Parameters:

port - The remote port

Returns:

true if remote port forwarding is started

See Also:

• getBoundRemotePortForward