net.sf.sshapi

Class AbstractFileTransferClient

java.lang.Object

net.sf.sshapi.AbstractLifecycleComponent

net.sf.sshapi.AbstractLifecycleComponentWithEvents

net.sf.sshapi.AbstractFileTransferClient

All Implemented Interfaces:

SshLifecycleComponent

Direct Known Subclasses:

AbstractSCPClient

public abstract class AbstractFileTransferClient
extends AbstractLifecycleComponentWithEvents

Abstract implementation of a file transfer client, providing some useful default methods (currently transfer events).

Constructor Summary

Constructors

Constructor and Description
AbstractFileTransferClient()

Method Summary

Modifier and Type	Method and Description
void	addFileTransferListener(SshFileTransferListener listener) Add a new listener to be informed when file transfers start, progress or stop.
protected void	fireFileTransferFinished(java.lang.String path, java.lang.String targetPath) Inform all listeners a file transfer has finished.
protected void	fireFileTransferProgressed(java.lang.String path, java.lang.String targetPath, long progress) Inform all listeners a file transfer has progressed.
protected void	fireFileTransferStarted(java.lang.String path, java.lang.String targetPath, long length) Inform all listeners a file transfer has started
void	removeFileTransferListener(SshFileTransferListener listener) Remove a new listener from those informed when file transfers start, progress or stop.

Methods inherited from class net.sf.sshapi.AbstractLifecycleComponentWithEvents

checkOpen, close, isOpen, onClose, onOpen, open

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

AbstractFileTransferClient

public AbstractFileTransferClient()

Method Detail

addFileTransferListener

public final void addFileTransferListener(SshFileTransferListener listener)

Add a new listener to be informed when file transfers start, progress or stop.

Parameters:

listener - listener to add

removeFileTransferListener

public final void removeFileTransferListener(SshFileTransferListener listener)

Remove a new listener from those informed when file transfers start, progress or stop.

Parameters:

listener - listener to remove

fireFileTransferStarted

protected void fireFileTransferStarted(java.lang.String path,
                                       java.lang.String targetPath,
                                       long length)

Inform all listeners a file transfer has started

Parameters:

path - path of file

targetPath - target path

length - length of file

fireFileTransferProgressed

protected void fireFileTransferProgressed(java.lang.String path,
                                          java.lang.String targetPath,
                                          long progress)

Inform all listeners a file transfer has progressed.

Parameters:

path - path of file

targetPath - target path

progress - number of bytes progressed

fireFileTransferFinished

protected void fireFileTransferFinished(java.lang.String path,
                                        java.lang.String targetPath)

Inform all listeners a file transfer has finished.

Parameters:

path - path of file

targetPath - target path