net.sf.sshapi.forwarding

Interface SshPortForward

All Superinterfaces:

SshLifecycleComponent

All Known Implementing Classes:

AbstractPortForward, LibsshLocalForward

public interface SshPortForward
extends SshLifecycleComponent

Maintains state of either a local or remote port forward. The SshSession#createLocalForward(String, int, String, int) and SshSession#createRemoteForward(String, int, String, int) methods both create instances of of this class. That object may then be used to start and stop the actal tunell.

Field Summary

Fields

Modifier and Type	Field and Description
static int	LOCAL_FORWARDING Constant used to specify whether the event relates to a local forwarding
static int	REMOTE_FORWARDING Constant used to specify whether the event relates to a remote forwarding
static int	X11_FORWARDING Constant used to specify whether the event relates to an X11 forwarding

Method Summary

Modifier and Type	Method and Description
void	close() Close the tunnel.
int	getTimeout() Get a timeout in milliseconds for opening the forward
boolean	isOpen() Get if the tunnel is open or closed
void	open() Open the tunnel.
void	setTimeout(int timeout) Set a timeout in milliseconds for opening the forward

Methods inherited from interface net.sf.sshapi.SshLifecycleComponent

addListener, removeListener

Field Detail

LOCAL_FORWARDING

static final int LOCAL_FORWARDING

Constant used to specify whether the event relates to a local forwarding

See Also:

Constant Field Values

REMOTE_FORWARDING

static final int REMOTE_FORWARDING

Constant used to specify whether the event relates to a remote forwarding

See Also:

Constant Field Values

X11_FORWARDING

static final int X11_FORWARDING

Constant used to specify whether the event relates to an X11 forwarding

See Also:

Constant Field Values

Method Detail

setTimeout

void setTimeout(int timeout)

Set a timeout in milliseconds for opening the forward

Parameters:

timeout - timeout

getTimeout

int getTimeout()

Get a timeout in milliseconds for opening the forward

Returns:

timeout

open

void open()
   throws SshException

Open the tunnel.

Specified by:

open in interface SshLifecycleComponent

Throws:

SshException - on any error

See Also:

#close()}

close

void close()
    throws SshException

Close the tunnel.

Specified by:

close in interface SshLifecycleComponent

Throws:

SshException - on any error

isOpen

boolean isOpen()

Get if the tunnel is open or closed

Specified by:

isOpen in interface SshLifecycleComponent

Returns:

open

See Also:

SshLifecycleComponent.open(), SshLifecycleComponent.close()