com.jcraft.jsch

Interface SftpProgressMonitor

public interface SftpProgressMonitor

A callback to get information about the progress of a file transfer operation.

An application will implement this interface to get information about a running file transfer, and maybe show it to the user. For example, it might wrap an ProgressMonitor.

Additionally, this interface enables the application to stop the transfer by returning false from the count method.

Several of the ChannelSftp's put and get methods take an object of this type, and will call its methods as defined here.

See Also:

ChannelSftp

Field Summary

Fields

Modifier and Type	Field and Description
static int	GET Direction constant for download.
static int	PUT Direction constant for upload.
static long	UNKNOWN_SIZE

Method Summary

Modifier and Type	Method and Description
boolean	count(long count) Will be called periodically as more data is transfered.
void	end() Will be called when the transfer ended, either because all the data was transferred, or because the transfer was cancelled.
void	init(int op, String src, String dest, long max) Will be called when a new operation starts.

Field Detail

PUT

static final int PUT

Direction constant for upload.

See Also:

Constant Field Values

GET

static final int GET

Direction constant for download.

See Also:

Constant Field Values

UNKNOWN_SIZE

static final long UNKNOWN_SIZE

See Also:

Constant Field Values

Method Detail

init

void init(int op,
          String src,
          String dest,
          long max)

Will be called when a new operation starts.

Parameters:

op - a code indicating the direction of transfer, one of PUT and GET

dest - the destination file name.

max - the final count (i.e. length of file to transfer).

count

boolean count(long count)

Will be called periodically as more data is transfered.

Parameters:

count - the number of bytes transferred so far

Returns:

true if the transfer should go on, false if the transfer should be cancelled.

end

void end()

Will be called when the transfer ended, either because all the data was transferred, or because the transfer was cancelled.