Package software.amazon.awssdk.transfer.s3.internal.progress

Class TransferListenerInvoker

java.lang.Object

software.amazon.awssdk.transfer.s3.internal.progress.TransferListenerInvoker

All Implemented Interfaces:

TransferListener

@SdkInternalApi
public class TransferListenerInvoker
extends Object
implements TransferListener

An SDK-internal helper class that composes multiple provided TransferListeners together into a single logical chain. Invocations on TransferListenerInvoker will be delegated to the underlying chain, while suppressing (and logging) any exceptions that are thrown.

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awssdk.transfer.s3.progress.TransferListener

TransferListener.Context

Constructor Summary

Constructors

Constructor	Description
TransferListenerInvoker(List<TransferListener> listeners)

Method Summary

Modifier and Type	Method	Description
void	bytesTransferred(TransferListener.Context.BytesTransferred context)	Additional bytes have been submitted or received.
void	transferComplete(TransferListener.Context.TransferComplete context)	The transfer has completed successfully.
void	transferFailed(TransferListener.Context.TransferFailed context)	The transfer failed.
void	transferInitiated(TransferListener.Context.TransferInitiated context)	A new transfer has been initiated.

Methods inherited from class java.lang.Object

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

Constructor Details

TransferListenerInvoker

public TransferListenerInvoker(List<TransferListener> listeners)

Method Details

transferInitiated

public void transferInitiated(TransferListener.Context.TransferInitiated context)

Description copied from interface: TransferListener

A new transfer has been initiated. This method is called exactly once per transfer.

Available context attributes:

1. TransferListener.Context.TransferInitiated.request()
2. TransferListener.Context.TransferInitiated.progressSnapshot()

Specified by:

transferInitiated in interface TransferListener

bytesTransferred

public void bytesTransferred(TransferListener.Context.BytesTransferred context)

Description copied from interface: TransferListener

Additional bytes have been submitted or received. This method may be called many times per transfer, depending on the transfer size and I/O buffer sizes.

Available context attributes:

1. TransferListener.Context.TransferInitiated.request()
2. TransferListener.Context.TransferInitiated.progressSnapshot()

Specified by:

bytesTransferred in interface TransferListener

transferComplete

public void transferComplete(TransferListener.Context.TransferComplete context)

Description copied from interface: TransferListener

The transfer has completed successfully. This method is called exactly once for a successful transfer.

Available context attributes:

1. TransferListener.Context.TransferInitiated.request()
2. TransferListener.Context.TransferInitiated.progressSnapshot()
3. TransferListener.Context.TransferComplete.completedTransfer()

Specified by:

transferComplete in interface TransferListener

transferFailed

public void transferFailed(TransferListener.Context.TransferFailed context)

Description copied from interface: TransferListener

The transfer failed. This method is called exactly once for a failed transfer.

Available context attributes:

1. TransferListener.Context.TransferInitiated.request()
2. TransferListener.Context.TransferInitiated.progressSnapshot()
3. TransferListener.Context.TransferFailed.exception()

Specified by:

transferFailed in interface TransferListener