com.ibm.cloud.objectstorage.services.aspera.transfer

Class AsperaTransactionImpl

java.lang.Object

com.ibm.cloud.objectstorage.services.aspera.transfer.AsperaTransactionImpl

All Implemented Interfaces:

AsperaTransaction, AsperaTransfer

public class AsperaTransactionImpl
extends Object
implements AsperaTransaction

Class which provides access to the progress & status of a transfer. This object is returned to the user when any transfer process is started.

Nested Class Summary

Nested classes/interfaces inherited from interface com.ibm.cloud.objectstorage.services.aspera.transfer.AsperaTransaction

AsperaTransaction.AsperaTransactionState

Field Summary

Fields

Modifier and Type	Field and Description
protected ProgressListenerChain	listenerChain Hook for adding/removing more progress listeners.
protected static InternalLogApi	log

Constructor Summary

Constructors

Constructor and Description
AsperaTransactionImpl(String xferid, String bucketName, String key, String fileName, TransferProgress transferProgress, ProgressListenerChain listenerChain)

Method Summary

Modifier and Type	Method and Description
void	addProgressListener(ProgressListener listener) Adds the specified progress listener to the list of listeners receiving updates about this transfer's progress.
boolean	cancel() Cancel the AsperaTransaction transfer
protected void	finalize()
String	getBucketName() The name of the bucket where the object is being transfered from/to.
String	getKey() The key under which this object is stored in Amazon S3.
TransferProgress	getProgress() Returns progress information about this transfer.
ProgressListenerChain	getProgressListenerChain()
com.ibm.aspera.faspmanager2.ITransferListener	getTransferListener()
boolean	isDone() Returns whether or not the transfer is finished (i.e.
boolean	onQueue() Returns whether or not the transfer is queueing.
boolean	pause() Pause the AsperaTransaction transfer
boolean	progress() Returns whether or not the transfer is in a state of progress
void	removeProgressListener(ProgressListener listener) Removes the specified progress listener from the list of progress listeners receiving updates about this transfer's progress.
boolean	resume() Resume the AsperaTransaction transfer
AsperaResult	waitForCompletion()

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final InternalLogApi log

listenerChain

protected final ProgressListenerChain listenerChain

Hook for adding/removing more progress listeners.

Constructor Detail

AsperaTransactionImpl

public AsperaTransactionImpl(String xferid,
                             String bucketName,
                             String key,
                             String fileName,
                             TransferProgress transferProgress,
                             ProgressListenerChain listenerChain)

Method Detail

pause

public boolean pause()

Description copied from interface: AsperaTransfer

Pause the AsperaTransaction transfer

Specified by:

pause in interface AsperaTransfer

resume

public boolean resume()

Description copied from interface: AsperaTransfer

Resume the AsperaTransaction transfer

Specified by:

resume in interface AsperaTransfer

cancel

public boolean cancel()

Description copied from interface: AsperaTransfer

Cancel the AsperaTransaction transfer

Specified by:

cancel in interface AsperaTransfer

isDone

public boolean isDone()

Description copied from interface: AsperaTransfer

Returns whether or not the transfer is finished (i.e. completed successfully or failed).

Specified by:

isDone in interface AsperaTransfer

Returns:

Returns true if this transfer is finished (i.e. completed successfully or failed). Returns false if otherwise.

progress

public boolean progress()

Description copied from interface: AsperaTransfer

Returns whether or not the transfer is in a state of progress

Specified by:

progress in interface AsperaTransfer

Returns:

Returns true if this transfer is progressing. Returns false if otherwise.

onQueue

public boolean onQueue()

Description copied from interface: AsperaTransfer

Returns whether or not the transfer is queueing.

Specified by:

onQueue in interface AsperaTransfer

Returns:

Returns true if this transfer is queueing. Returns false if otherwise.

getBucketName

public String getBucketName()

Description copied from interface: AsperaTransfer

The name of the bucket where the object is being transfered from/to.

Specified by:

getBucketName in interface AsperaTransfer

Returns:

The name of the bucket where the object is being transfered from/to.

getKey

public String getKey()

Description copied from interface: AsperaTransfer

The key under which this object is stored in Amazon S3.

Specified by:

getKey in interface AsperaTransfer

Returns:

The key under which this object is stored in Amazon S3.

waitForCompletion

public AsperaResult waitForCompletion()
                               throws AsperaTransferException,
                                      InterruptedException

Specified by:

waitForCompletion in interface AsperaTransaction

Throws:

AsperaTransferException

InterruptedException

addProgressListener

public void addProgressListener(ProgressListener listener)

Description copied from interface: AsperaTransaction

Adds the specified progress listener to the list of listeners receiving updates about this transfer's progress.

Specified by:

addProgressListener in interface AsperaTransaction

Parameters:

listener - The progress listener to add.

removeProgressListener

public void removeProgressListener(ProgressListener listener)

Description copied from interface: AsperaTransaction

Removes the specified progress listener from the list of progress listeners receiving updates about this transfer's progress.

Specified by:

removeProgressListener in interface AsperaTransaction

Parameters:

listener - The progress listener to remove.

getProgressListenerChain

public ProgressListenerChain getProgressListenerChain()

Specified by:

getProgressListenerChain in interface AsperaTransaction

getProgress

public TransferProgress getProgress()

Description copied from interface: AsperaTransaction

Returns progress information about this transfer.

Specified by:

getProgress in interface AsperaTransaction

Returns:

The progress information about this transfer.

getTransferListener

public com.ibm.aspera.faspmanager2.ITransferListener getTransferListener()

Specified by:

getTransferListener in interface AsperaTransaction

finalize

protected void finalize()

Overrides:

finalize in class Object