net.sf.sshapi

Interface SshLifecycleComponent

All Known Subinterfaces:

SftpClient, SshChannel, SshDataProducingComponent, SshExtendedStreamChannel, SshFileTransferClient, SshPortForward, SshPortForwardTunnel, SshPublicKeySubsystem, SshSCPClient, SshShell, SshStreamChannel

All Known Implementing Classes:

AbstractDataProducingComponent, AbstractFileTransferClient, AbstractLifecycleComponent, AbstractLifecycleComponentWithEvents, AbstractPortForward, AbstractSCPClient, AbstractSftpClient, LibsshLocalForward, LibsshSCPClient, LibsshShell

public interface SshLifecycleComponent

Many components of SSHAPI implement this interface, as they all follow the open() / close() pattern. This applies to sessions, SFTP clients, port forwards and more.

All of the components may fire events when the lifecycle events occur.

Method Summary

Modifier and Type	Method and Description
void	addListener(SshLifecycleListener listener) Add a listener to those informed when the current phase in this components lifecycle changes.
void	close() Close this component.
boolean	isOpen() Get if this component is currently open.
void	open() Open the component.
void	removeListener(SshLifecycleListener listener) Remove a listener from those informed when the current phase in this components lifecycle changes.

Method Detail

addListener

void addListener(SshLifecycleListener listener)

Add a listener to those informed when the current phase in this components lifecycle changes.

Parameters:

listener - listener

removeListener

void removeListener(SshLifecycleListener listener)

Remove a listener from those informed when the current phase in this components lifecycle changes.

Parameters:

listener - listener

open

void open()
   throws SshException

Open the component. Remember to close() the component when you are finished with it.

Throws:

SshException

See Also:

#close()}

isOpen

boolean isOpen()

Get if this component is currently open.

Returns:

open

See Also:

open(), close()

close

void close()
    throws SshException

Close this component.

Throws:

SshException