net.sf.sshapi.forwarding

Class AbstractPortForward

java.lang.Object

net.sf.sshapi.AbstractLifecycleComponent

net.sf.sshapi.forwarding.AbstractPortForward

All Implemented Interfaces:

SshPortForward, SshLifecycleComponent

Direct Known Subclasses:

LibsshLocalForward

public abstract class AbstractPortForward
extends AbstractLifecycleComponent
implements SshPortForward

Abstract implementation of SshPortForward that maintains the isOpen() state for any sub-classes.

Field Summary

Fields inherited from interface net.sf.sshapi.forwarding.SshPortForward

LOCAL_FORWARDING, REMOTE_FORWARDING, X11_FORWARDING

Constructor Summary

Constructors

Constructor and Description
AbstractPortForward()

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
protected abstract void	onClose()
protected abstract void	onOpen()
void	open() Open the tunnel.
void	setTimeout(int timeout) Set a timeout in milliseconds for opening the forward

Methods inherited from class net.sf.sshapi.AbstractLifecycleComponent

addListener, fireClosed, fireClosing, fireOpened, getListeners, removeListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.sshapi.SshLifecycleComponent

addListener, removeListener

Constructor Detail

AbstractPortForward

public AbstractPortForward()

Method Detail

close

public void close()
           throws SshException

Description copied from interface: SshPortForward

Close the tunnel.

Specified by:

close in interface SshPortForward

Specified by:

close in interface SshLifecycleComponent

Throws:

SshException - on any error

setTimeout

public void setTimeout(int timeout)

Description copied from interface: SshPortForward

Set a timeout in milliseconds for opening the forward

Specified by:

setTimeout in interface SshPortForward

Parameters:

timeout - timeout

getTimeout

public int getTimeout()

Description copied from interface: SshPortForward

Get a timeout in milliseconds for opening the forward

Specified by:

getTimeout in interface SshPortForward

Returns:

timeout

isOpen

public boolean isOpen()

Description copied from interface: SshPortForward

Get if the tunnel is open or closed

Specified by:

isOpen in interface SshPortForward

Specified by:

isOpen in interface SshLifecycleComponent

Returns:

open

See Also:

SshLifecycleComponent.open(), SshLifecycleComponent.close()

open

public final void open()
                throws SshException

Description copied from interface: SshPortForward

Open the tunnel.

Specified by:

open in interface SshPortForward

Specified by:

open in interface SshLifecycleComponent

Throws:

SshException - on any error

See Also:

#close()}

onOpen

protected abstract void onOpen()
                        throws SshException

Throws:

SshException

onClose

protected abstract void onClose()
                         throws SshException

Throws:

SshException