Uses of Interface
com.ibm.cloud.objectstorage.event.ProgressListener

Packages that use ProgressListener

Package	Description
com.ibm.cloud.objectstorage
com.ibm.cloud.objectstorage.event
com.ibm.cloud.objectstorage.internal
com.ibm.cloud.objectstorage.services.aspera.transfer
com.ibm.cloud.objectstorage.services.aspera.transfer.internal
com.ibm.cloud.objectstorage.services.s3.model	Classes modeling the various types represented by Amazon S3.
com.ibm.cloud.objectstorage.services.s3.transfer	Transfer management.
com.ibm.cloud.objectstorage.services.s3.transfer.internal
com.ibm.cloud.objectstorage.test.util

Uses of ProgressListener in com.ibm.cloud.objectstorage

Methods in com.ibm.cloud.objectstorage that return ProgressListener

Modifier and Type	Method and Description
ProgressListener	AmazonWebServiceRequest.getGeneralProgressListener() Returns the optional progress listener for receiving updates about the progress of the request.
abstract ProgressListener	RequestConfig.getProgressListener()

Methods in com.ibm.cloud.objectstorage with parameters of type ProgressListener

Modifier and Type	Method and Description
void	AmazonWebServiceRequest.setGeneralProgressListener(ProgressListener progressListener) Sets the optional progress listener for receiving updates about the progress of the request.
<T extends AmazonWebServiceRequest> T	AmazonWebServiceRequest.withGeneralProgressListener(ProgressListener progressListener) Sets the optional progress listener for receiving updates about the progress of the request, and returns a reference to this object so that method calls can be chained together.

Uses of ProgressListener in com.ibm.cloud.objectstorage.event

Classes in com.ibm.cloud.objectstorage.event that implement ProgressListener

Modifier and Type	Class and Description
static class	ProgressListener.ExceptionReporter A utility class for capturing and reporting the first exception thrown by a given progress listener.
static class	ProgressListener.NoOpProgressListener
class	ProgressListenerChain An implementation of ProgressListener interface that delegates progressChanged callback to multiple listeners.
class	ProgressTracker Default implementation for progress tracking.
class	SyncProgressListener Abstract adapter class for a progress listener that is delivered with progress event synchronously.

Fields in com.ibm.cloud.objectstorage.event declared as ProgressListener

Modifier and Type	Field and Description
static ProgressListener	ProgressListener.NOOP

Methods in com.ibm.cloud.objectstorage.event that return ProgressListener

Modifier and Type	Method and Description
ProgressListener	ProgressInputStream.getListener()

Methods in com.ibm.cloud.objectstorage.event that return types with arguments of type ProgressListener

Modifier and Type	Method and Description
protected List<ProgressListener>	ProgressListenerChain.getListeners() Returns the listeners associated with this listener chain.

Methods in com.ibm.cloud.objectstorage.event with parameters of type ProgressListener

Modifier and Type	Method and Description
void	ProgressListenerChain.addProgressListener(ProgressListener listener)
static InputStream	ProgressInputStream.inputStreamForRequest(InputStream is, ProgressListener progressListener)
static InputStream	ProgressInputStream.inputStreamForResponse(InputStream is, ProgressListener progressListener) Returns an input stream for response progress tracking purposes.
static boolean	DeliveryMode.Check.isSyncCallSafe(ProgressListener listener)
static Future<?>	SDKProgressPublisher.publishProgress(ProgressListener listener, ProgressEventType type) Used to deliver a progress event to the given listener.
static Future<?>	SDKProgressPublisher.publishRequestBytesTransferred(ProgressListener listener, long bytes) Convenient method to publish a request byte transfer event to the given listener.
static Future<?>	SDKProgressPublisher.publishRequestContentLength(ProgressListener listener, long bytes) Convenient method to publish a request content length event to the given listener.
static Future<?>	SDKProgressPublisher.publishRequestReset(ProgressListener listener, long bytesReset) Convenient method to publish a request reset event to the given listener.
static Future<?>	SDKProgressPublisher.publishResponseBytesDiscarded(ProgressListener listener, long bytesDiscarded) Convenient method to publish a response bytes discard event to the given listener.
static Future<?>	SDKProgressPublisher.publishResponseBytesTransferred(ProgressListener listener, long bytes) Convenient method to publish a response byte transfer event to the given listener.
static Future<?>	SDKProgressPublisher.publishResponseContentLength(ProgressListener listener, long bytes) Convenient method to publish a response content length event to the given listener.
static Future<?>	SDKProgressPublisher.publishResponseReset(ProgressListener listener, long bytesReset) Convenient method to publish a response reset event to the given listener.
void	ProgressListenerChain.removeProgressListener(ProgressListener listener)
static ProgressListener.ExceptionReporter	ProgressListener.ExceptionReporter.wrap(ProgressListener listener) Returns a wrapper for the given listener to capture the first exception thrown.

Constructors in com.ibm.cloud.objectstorage.event with parameters of type ProgressListener

Constructor and Description
ExceptionReporter(ProgressListener listener)
ProgressInputStream(InputStream is, ProgressListener listener)
ProgressInputStream(InputStream is, ProgressListener listener, int notifyThresHold)
ProgressListenerChain(ProgressEventFilter progressEventFilter, ProgressListener... listeners) Create a listener chain with a ProgressEventFilter.
ProgressListenerChain(ProgressListener... listeners) Create a listener chain that directly passes all the progress events to the specified listeners.

Uses of ProgressListener in com.ibm.cloud.objectstorage.internal

Methods in com.ibm.cloud.objectstorage.internal that return ProgressListener

Modifier and Type	Method and Description
ProgressListener	AmazonWebServiceRequestAdapter.getProgressListener()

Uses of ProgressListener in com.ibm.cloud.objectstorage.services.aspera.transfer

Methods in com.ibm.cloud.objectstorage.services.aspera.transfer that return ProgressListener

Modifier and Type	Method and Description
ProgressListener	AsperaTransaction.getProgressListenerChain()

Methods in com.ibm.cloud.objectstorage.services.aspera.transfer with parameters of type ProgressListener

Modifier and Type	Method and Description
void	AsperaTransaction.addProgressListener(ProgressListener listener) Adds the specified progress listener to the list of listeners receiving updates about this transfer's progress.
void	AsperaTransactionImpl.addProgressListener(ProgressListener listener)
Future<AsperaTransaction>	AsperaTransferManager.download(String bucket, File localFileName, String remoteFileName, AsperaConfig sessionDetails, ProgressListener listenerChain)
Future<AsperaTransaction>	AsperaTransferManager.downloadDirectory(String bucketName, String virtualDirectoryKeyPrefix, File directory, AsperaConfig sessionDetails, ProgressListener progressListener)
AsperaTransaction	AsperaTransferManager.processTransfer(String transferSpecStr, String bucketName, String key, String fileName, ProgressListener progressListener) Process the transfer spec to call the underlying Aspera libraries to begin the transfer
void	AsperaTransaction.removeProgressListener(ProgressListener listener) Removes the specified progress listener from the list of progress listeners receiving updates about this transfer's progress.
void	AsperaTransactionImpl.removeProgressListener(ProgressListener listener)
Future<AsperaTransaction>	AsperaTransferManager.upload(String bucket, File localFileName, String remoteFileName, AsperaConfig sessionDetails, ProgressListener progressListener)
Future<AsperaTransaction>	AsperaTransferManager.uploadDirectory(String bucketName, String virtualDirectoryKeyPrefix, File directory, boolean includeSubdirectories, AsperaConfig sessionDetails, ProgressListener progressListener) Subdirectories are included in the upload by default, to exclude ensure you pass through 'false' for includeSubdirectories param

Uses of ProgressListener in com.ibm.cloud.objectstorage.services.aspera.transfer.internal

Constructors in com.ibm.cloud.objectstorage.services.aspera.transfer.internal with parameters of type ProgressListener

Constructor and Description
AsperaDownloadCallable(AsperaTransferManager transferManager, String bucket, File localFileName, String remoteFileName, AsperaConfig sessionDetails, ProgressListener progressListener)
AsperaDownloadDirectoryCallable(AsperaTransferManager transferManager, String bucket, File localDirectory, String virtualDirectory, AsperaConfig sessionDetails, ProgressListener progressListener)
AsperaUploadCallable(AsperaTransferManager transferManager, String bucket, File localFileName, String remoteFileName, AsperaConfig sessionDetails, ProgressListener progressListener)
AsperaUploadDirectoryCallable(AsperaTransferManager transferManager, String bucket, File localDirectory, String virtualDirectory, AsperaConfig sessionDetails, boolean includeSubdirectories, ProgressListener progressListener)

Uses of ProgressListener in com.ibm.cloud.objectstorage.services.s3.model

Classes in com.ibm.cloud.objectstorage.services.s3.model that implement ProgressListener

Modifier and Type	Class and Description
class	LegacyS3ProgressListener Deprecated.

Uses of ProgressListener in com.ibm.cloud.objectstorage.services.s3.transfer

Methods in com.ibm.cloud.objectstorage.services.s3.transfer with parameters of type ProgressListener

Modifier and Type	Method and Description
void	Transfer.addProgressListener(ProgressListener listener) Adds the specified progress listener to the list of listeners receiving updates about this transfer's progress.
void	Transfer.removeProgressListener(ProgressListener listener) Removes the specified progress listener from the list of progress listeners receiving updates about this transfer's progress.

Uses of ProgressListener in com.ibm.cloud.objectstorage.services.s3.transfer.internal

Subinterfaces of ProgressListener in com.ibm.cloud.objectstorage.services.s3.transfer.internal

Modifier and Type	Interface and Description
interface	S3ProgressListener S3 specific listener interface for transfer progress events.

Classes in com.ibm.cloud.objectstorage.services.s3.transfer.internal that implement ProgressListener

Modifier and Type	Class and Description
class	S3ProgressListenerChain S3 specific progress listener chain.
class	S3SyncProgressListener Abstract adapter class for an S3 progress listener that is safe to be delivered with progress event synchronously.
class	TransferProgressUpdatingListener

Methods in com.ibm.cloud.objectstorage.services.s3.transfer.internal with parameters of type ProgressListener

Modifier and Type	Method and Description
void	AbstractTransfer.addProgressListener(ProgressListener listener) Adds the specified progress listener to the list of listeners receiving updates about this transfer's progress.
static Future<?>	S3ProgressPublisher.publishTransferPersistable(ProgressListener listener, PersistableTransfer persistableTransfer) Used to deliver a persistable transfer to the given s3 listener.
void	AbstractTransfer.removeProgressListener(ProgressListener listener) Removes the specified progress listener from the list of progress listeners receiving updates about this transfer's progress.

Constructors in com.ibm.cloud.objectstorage.services.s3.transfer.internal with parameters of type ProgressListener

Constructor and Description
S3ProgressListenerChain(ProgressListener... listeners) Create a listener chain that directly passes all the progress events to the specified listeners.

Uses of ProgressListener in com.ibm.cloud.objectstorage.test.util

Classes in com.ibm.cloud.objectstorage.test.util that implement ProgressListener

Modifier and Type	Class and Description
class	ProgressListenerWithEventCodeVerification Validates the events received by the progress listener.