flux.file

Interface FileTransferInfo

public interface FileTransferInfo

Contains information about a file being transferred by a file action.

Author:

Copyright 2000-2025 Flux Corporation. All rights reserved.

Method Summary

Modifier and Type	Method and Description
long	bytesPerSecond() Returns the number of bytes transferred per second.
java.lang.String	getAbsoluteFilename() Returns the absolute filename of the file being transferred.
java.lang.String	getDestinationHost() Returns the host name of the destination host.
java.lang.String	getFilename() Returns the filename of the file being transferred.
int	getPercentageCompleted() Returns the estimated progress of the file transfer, expressed as a percentage.
java.lang.String	getSourceHost() Returns the host name of the source of the file transfer.
java.lang.String	getSourceProtocol() Returns the file transfer protocol used to copy the file from the source host.
long	getStartTime() Returns the time this file transfer began.
java.lang.String	getTargetProtocol() Returns the file transfer protocol used to copy the file to the target host.
long	getTotalBytes() Returns the total size of the file being transferred, in bytes.
long	getTransferredBytes() Returns the bytes transferred successfully of the current file being transferred.

Method Detail

bytesPerSecond

long bytesPerSecond()

Returns the number of bytes transferred per second.

Returns:

The number of bytes transferred per second.

getAbsoluteFilename

java.lang.String getAbsoluteFilename()

Returns the absolute filename of the file being transferred.

Returns:

The absolute filename of the file being transferred.

getDestinationHost

java.lang.String getDestinationHost()

Returns the host name of the destination host. The string "localhost" is returned if the destination is the local filesystem of the Flux engine transferring the file.

Returns:

The host name of the destination host. The string "localhost" is returned if the destination is the local filesystem of the Flux engine transferring the file.

getFilename

java.lang.String getFilename()

Returns the filename of the file being transferred. Filename does not include the full absolute path.

Returns:

The filename of the file being transferred. Filename does not include the full absolute path.

getPercentageCompleted

int getPercentageCompleted()

Returns the estimated progress of the file transfer, expressed as a percentage. The result is a number between 0 and 100.

Returns:

The estimated progress of the file transfer.

getSourceHost

java.lang.String getSourceHost()

Returns the host name of the source of the file transfer. The string "localhost" is returned if the source is the local filesystem of the Flux engine transferring the file.

Returns:

The host name of the source of the file transfer. The string "localhost" is returned if the source is the local filesystem of the Flux engine transferring the file.

getSourceProtocol

java.lang.String getSourceProtocol()

Returns the file transfer protocol used to copy the file from the source host.

Returns:

The file transfer protocol used to copy the file from the source host.

getStartTime

long getStartTime()

Returns the time this file transfer began. The time is expressed as the number of milliseconds since 1970 January 1 00:00:00 GMT.

Returns:

The time this file transfer began.

getTargetProtocol

java.lang.String getTargetProtocol()

Returns the file transfer protocol used to copy the file to the target host.

Returns:

The file transfer protocol used to copy the file to the target host.

getTotalBytes

long getTotalBytes()

Returns the total size of the file being transferred, in bytes.

Returns:

The total size of the file being transferred, in bytes.

getTransferredBytes

long getTransferredBytes()

Returns the bytes transferred successfully of the current file being transferred.

Returns:

The bytes transferred successfully of the current file being transferred.