net.sf.sshapi

Class AbstractLifecycleComponentWithEvents

java.lang.Object

net.sf.sshapi.AbstractLifecycleComponent

net.sf.sshapi.AbstractLifecycleComponentWithEvents

All Implemented Interfaces:

SshLifecycleComponent

Direct Known Subclasses:

AbstractDataProducingComponent, AbstractFileTransferClient, AbstractSftpClient, LibsshShell

public abstract class AbstractLifecycleComponentWithEvents
extends AbstractLifecycleComponent

Abstract implementation of an AbstractLifecycleComponent that fires events when the lifecycle methods are called. Most SSHAPI lifecycle components will extend this.

Constructor Summary

Constructors

Constructor and Description
AbstractLifecycleComponentWithEvents()

Method Summary

Modifier and Type	Method and Description
protected void	checkOpen()
void	close() Close this component.
boolean	isOpen() Get if this component is currently open.
protected abstract void	onClose()
protected abstract void	onOpen()
void	open() Open the component.

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

Constructor Detail

AbstractLifecycleComponentWithEvents

public AbstractLifecycleComponentWithEvents()

Method Detail

isOpen

public final boolean isOpen()

Description copied from interface: SshLifecycleComponent

Get if this component is currently open.

Returns:

open

See Also:

SshLifecycleComponent.open(), SshLifecycleComponent.close()

open

public final void open()
                throws SshException

Description copied from interface: SshLifecycleComponent

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

Throws:

SshException

See Also:

#close()}

checkOpen

protected final void checkOpen()

close

public final void close()
                 throws SshException

Description copied from interface: SshLifecycleComponent

Close this component.

Throws:

SshException

onOpen

protected abstract void onOpen()
                        throws SshException

Throws:

SshException

onClose

protected abstract void onClose()
                         throws SshException

Throws:

SshException