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

Class LoggingTransferListener

java.lang.Object

software.amazon.awssdk.transfer.s3.progress.LoggingTransferListener

All Implemented Interfaces:

TransferListener

@SdkPublicApi
public final class LoggingTransferListener
extends Object
implements TransferListener

An example implementation of TransferListener that logs a progress bar at the INFO level. This implementation effectively rate-limits how frequently updates are logged by only logging when a new "tick" advances in the progress bar. By default, the progress bar has 20 ticks, meaning an update is only logged, at most, once every 5%.

Nested Class Summary

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

TransferListener.Context

Method Summary

Modifier and Type	Method	Description
void	bytesTransferred(TransferListener.Context.BytesTransferred context)	Additional bytes have been submitted or received.
static LoggingTransferListener	create()	Create an instance of LoggingTransferListener with the default configuration.
static LoggingTransferListener	create(int maxTicks)	Create an instance of LoggingTransferListener with a custom maxTicks value.
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

Method Details

create

public static LoggingTransferListener create(int maxTicks)

Create an instance of LoggingTransferListener with a custom maxTicks value.

Parameters:

maxTicks - the number of ticks in the logged progress bar

create

public static LoggingTransferListener create()

Create an instance of LoggingTransferListener with the default configuration.

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