com.ibm.cloud.objectstorage.services.s3.transfer.internal

Class AbstractTransfer

java.lang.Object

com.ibm.cloud.objectstorage.services.s3.transfer.internal.AbstractTransfer

All Implemented Interfaces:

Transfer

Direct Known Subclasses:

CopyImpl, DownloadImpl, MultipleFileTransfer, PresignedUrlDownloadImpl, UploadImpl

public abstract class AbstractTransfer
extends Object
implements Transfer

Abstract transfer implementation.

Nested Class Summary

Nested classes/interfaces inherited from interface com.ibm.cloud.objectstorage.services.s3.transfer.Transfer

Transfer.TransferState

Field Summary

Fields

Modifier and Type	Field and Description
protected ProgressListenerChain	listenerChain Hook for adding/removing more progress listeners.
protected TransferMonitor	monitor
protected Transfer.TransferState	state The current state of this transfer.
protected Collection<TransferStateChangeListener>	stateChangeListeners Collection of listeners to be notified for changes to the state of this transfer via setState()

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.
void	addProgressListener(ProgressListener listener) Deprecated. Replaced by AbstractTransfer.addProgressListener(ProgressListener)
void	addStateChangeListener(TransferStateChangeListener listener) Adds the given state change listener to the collection of listeners.
protected void	fireProgressEvent(ProgressEventType eventType)
String	getDescription() Returns a human-readable description of this transfer.
TransferMonitor	getMonitor()
TransferProgress	getProgress() Returns progress information about this transfer.
Transfer.TransferState	getState() Returns the current state of this transfer.
boolean	isDone() Returns whether or not the transfer is finished (i.e.
void	notifyStateChangeListeners(Transfer.TransferState state) Notifies all the registered state change listeners of the state update.
void	removeProgressListener(ProgressListener listener) Removes the specified progress listener from the list of progress listeners receiving updates about this transfer's progress.
void	removeProgressListener(ProgressListener listener) Deprecated. Replaced by AbstractTransfer.removeProgressListener(ProgressListener)
void	removeStateChangeListener(TransferStateChangeListener listener) Removes the given state change listener from the collection of listeners.
protected void	rethrowExecutionException(ExecutionException e) Examines the cause of the specified ExecutionException and either rethrows it directly (if it's a type of AmazonClientException) or wraps it in an AmazonClientException and rethrows it.
void	setMonitor(TransferMonitor monitor) Sets the monitor used to poll for transfer completion.
void	setState(Transfer.TransferState state) Sets the current state of this transfer.
protected AmazonClientException	unwrapExecutionException(ExecutionException e) Unwraps the root exception that caused the specified ExecutionException and returns it.
void	waitForCompletion() Waits for this transfer to complete.
AmazonClientException	waitForException() Waits for this transfer to finish and returns any error that occurred, or returns null if no errors occurred.

Methods inherited from class java.lang.Object

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

Field Detail

state

protected volatile Transfer.TransferState state

The current state of this transfer.

monitor

protected TransferMonitor monitor

listenerChain

protected final ProgressListenerChain listenerChain

Hook for adding/removing more progress listeners.

stateChangeListeners

protected final Collection<TransferStateChangeListener> stateChangeListeners

Collection of listeners to be notified for changes to the state of this transfer via setState()

Method Detail

isDone

public final boolean isDone()

Returns whether or not the transfer is finished (i.e. completed successfully, failed, or was canceled). This method should never block.

Specified by:

isDone in interface Transfer

Returns:

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

waitForCompletion

public void waitForCompletion()
                       throws AmazonClientException,
                              AmazonServiceException,
                              InterruptedException

Waits for this transfer to complete. This is a blocking call; the current thread is suspended until this transfer completes.

Specified by:

waitForCompletion in interface Transfer

Throws:

AmazonClientException - If any errors were encountered in the client while making the request or handling the response.

AmazonServiceException - If any errors occurred in Amazon S3 while processing the request.

InterruptedException - If this thread is interrupted while waiting for the transfer to complete.

waitForException

public AmazonClientException waitForException()
                                       throws InterruptedException

Waits for this transfer to finish and returns any error that occurred, or returns null if no errors occurred. This is a blocking call; the current thread will be suspended until this transfer either fails or completes successfully.

Specified by:

waitForException in interface Transfer

Returns:

Any error that occurred while processing this transfer. Otherwise returns null if no errors occurred.

Throws:

InterruptedException - If this thread is interrupted while waiting for the transfer to complete.

getDescription

public String getDescription()

Returns a human-readable description of this transfer.

Specified by:

getDescription in interface Transfer

Returns:

A human-readable description of this transfer.

getState

public Transfer.TransferState getState()

Returns the current state of this transfer.

Specified by:

getState in interface Transfer

Returns:

The current state of this transfer.

setState

public void setState(Transfer.TransferState state)

Sets the current state of this transfer.

notifyStateChangeListeners

public void notifyStateChangeListeners(Transfer.TransferState state)

Notifies all the registered state change listeners of the state update.

addProgressListener

public void addProgressListener(ProgressListener listener)

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

Specified by:

addProgressListener in interface Transfer

Parameters:

listener - The progress listener to add.

removeProgressListener

public void removeProgressListener(ProgressListener listener)

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

Specified by:

removeProgressListener in interface Transfer

Parameters:

listener - The progress listener to remove.

addProgressListener

@Deprecated
public void addProgressListener(ProgressListener listener)

Deprecated. Replaced by AbstractTransfer.addProgressListener(ProgressListener)

Specified by:

addProgressListener in interface Transfer

removeProgressListener

@Deprecated
public void removeProgressListener(ProgressListener listener)

Deprecated. Replaced by AbstractTransfer.removeProgressListener(ProgressListener)

Specified by:

removeProgressListener in interface Transfer

addStateChangeListener

public void addStateChangeListener(TransferStateChangeListener listener)

Adds the given state change listener to the collection of listeners.

removeStateChangeListener

public void removeStateChangeListener(TransferStateChangeListener listener)

Removes the given state change listener from the collection of listeners.

getProgress

public TransferProgress getProgress()

Returns progress information about this transfer.

Specified by:

getProgress in interface Transfer

Returns:

The progress information about this transfer.

setMonitor

public void setMonitor(TransferMonitor monitor)

Sets the monitor used to poll for transfer completion.

getMonitor

public TransferMonitor getMonitor()

fireProgressEvent

protected void fireProgressEvent(ProgressEventType eventType)

rethrowExecutionException

protected void rethrowExecutionException(ExecutionException e)

Examines the cause of the specified ExecutionException and either rethrows it directly (if it's a type of AmazonClientException) or wraps it in an AmazonClientException and rethrows it.

Parameters:

e - The execution exception to examine.

unwrapExecutionException

protected AmazonClientException unwrapExecutionException(ExecutionException e)

Unwraps the root exception that caused the specified ExecutionException and returns it. If it was not an instance of AmazonClientException, it is wrapped as an AmazonClientException.

Parameters:

e - The ExecutionException to unwrap.

Returns:

The root exception that caused the specified ExecutionException.