abs.ixi.client.file.sfcm

Class FileTransferFuture

java.lang.Object

abs.ixi.client.file.sfcm.FileTransferFuture

public class FileTransferFuture
extends Object

File transfer process is asynchronous in nature; therefore any transfer request (inbound/outbound) returns a FileTransferFuture which can be used to find out if the transfer is complete. It can also be used cancel associated transfer request.

The class implementation is thread-safe.

Author:

Yogi

Constructor Summary

Constructors

Constructor and Description
FileTransferFuture()

Method Summary

Modifier and Type	Method and Description
boolean	cancel() Cancel the associated file transfer.
void	completed() Mark the file transfer task completed
void	failed() Mark the file transfer task failed
void	inProgress() mark the file transfer is started.
boolean	isComplete() Check if the associated file transfer is complete
boolean	isError() Check if there is any error occured for this file transfer

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileTransferFuture

public FileTransferFuture()

Method Detail

inProgress

public void inProgress()

mark the file transfer is started.

isComplete

public boolean isComplete()

Check if the associated file transfer is complete

Returns:

true if the file transfer is complete otherwise false

completed

public void completed()

Mark the file transfer task completed

failed

public void failed()

Mark the file transfer task failed

isError

public boolean isError()

Check if there is any error occured for this file transfer

Returns:

true if there was an error during this file transfer

cancel

public boolean cancel()

Cancel the associated file transfer. File transfer can be cancelled if it is not started yet.

Returns:

true if the cancellation was successfull otherwise false