Top Methods
org.apache.sshd.common.forward

public Interface PortForwardingInformationProvider

Known Direct Subinterfaces
org.apache.sshd.common.forward.PortForwardingManager, org.apache.sshd.common.session.Session
Imports
java.util.List, .Map, .NavigableSet, org.apache.sshd.common.util.GenericUtils, org.apache.sshd.common.util.net.SshdSocketAddress

Author
Apache MINA SSHD Project

Method Summary

Modifier and TypeMethod and Description
public List<SshdSocketAddress>

Returns:

The local bound SshdSocketAddress-es for the port
getBoundLocalPortForwards
(int
The port number
port
)

public SshdSocketAddress

Returns:

The remote bound SshdSocketAddress for the port - null if none bound
getBoundRemotePortForward
(int
The port number
port
)

public List<Map.Entry<SshdSocketAddress, SshdSocketAddress>>

Returns:

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

public List<Map.Entry<Integer, SshdSocketAddress>>

Returns:

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

public List<SshdSocketAddress>

Returns:

A List snapshot of the currently started local port forward bindings
getStartedLocalPortForwards
()

public NavigableSet<Integer>

Returns:

A NavigableSet snapshot of the currently started remote port forwards
getStartedRemotePortForwards
()

public default boolean

Returns:

true if local port forwarding is started
isLocalPortForwardingStartedForPort
(int
The local port
port
)

Test if local port forwarding is started

public default boolean

Returns:

true if remote port forwarding is started
isRemotePortForwardingStartedForPort
(int
The remote port
port
)

Test if remote port forwarding is started

Method Detail

getBoundLocalPortForwardsback to summary
public List<SshdSocketAddress> getBoundLocalPortForwards(int port)
Parameters
port:int

The port number

Returns:List<SshdSocketAddress>

The local bound SshdSocketAddress-es for the port

See Also
isLocalPortForwardingStartedForPort, getStartedLocalPortForwards()
getBoundRemotePortForwardback to summary
public SshdSocketAddress getBoundRemotePortForward(int port)
Parameters
port:int

The port number

Returns:SshdSocketAddress

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

See Also
isRemotePortForwardingStartedForPort, getStartedRemotePortForwards()
getLocalForwardsBindingsback to summary
public List<Map.Entry<SshdSocketAddress, SshdSocketAddress>> getLocalForwardsBindings()
Returns:List<Map.Entry<SshdSocketAddress, SshdSocketAddress>>

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

getRemoteForwardsBindingsback to summary
public List<Map.Entry<Integer, SshdSocketAddress>> getRemoteForwardsBindings()
Returns:List<Map.Entry<Integer, SshdSocketAddress>>

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

getStartedLocalPortForwardsback to summary
public List<SshdSocketAddress> getStartedLocalPortForwards()
Returns:List<SshdSocketAddress>

A List snapshot of the currently started local port forward bindings

getStartedRemotePortForwardsback to summary
public NavigableSet<Integer> getStartedRemotePortForwards()
Returns:NavigableSet<Integer>

A NavigableSet snapshot of the currently started remote port forwards

isLocalPortForwardingStartedForPortback to summary
public default boolean isLocalPortForwardingStartedForPort(int port)

Test if local port forwarding is started

Parameters
port:int

The local port

Returns:boolean

true if local port forwarding is started

See Also
getBoundLocalPortForwards
isRemotePortForwardingStartedForPortback to summary
public default boolean isRemotePortForwardingStartedForPort(int port)

Test if remote port forwarding is started

Parameters
port:int

The remote port

Returns:boolean

true if remote port forwarding is started

See Also
getBoundRemotePortForward