Skip to content
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
136 lines (119 sloc) 6.32 KB
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
import io.reactivex.Flowable;
import io.reactivex.Single;
import io.reactivex.functions.Function;
import java.nio.ByteBuffer;
import java.util.Map;
* {@code DownloadResponse} wraps the protocol-layer response from {@link BlobURL#download(BlobRange,
* BlobAccessConditions, boolean,} to automatically retry failed reads from the body as
* appropriate. If the download is interrupted, the {@code DownloadResponse} will make a request to resume the download
* from where it left off, allowing the user to consume the data as one continuous stream, for any interruptions are
* hidden. The retry behavior is defined by the options passed to the {@link #body(ReliableDownloadOptions)}. The
* download will also lock on the blob's etag to ensure consistency.
* <p>
* Note that the retries performed as a part of this reader are composed with those of any retries in an {@link
* HttpPipeline} used in conjunction with this reader. That is, if this object issues a request to resume a download,
* an underlying pipeline may issue several retries as a part of that request. Furthermore, this reader only retries on
* network errors; timeouts and unexpected status codes are not retried. Therefore, the behavior of this reader is
* entirely independent of and in no way coupled to an {@link HttpPipeline}'s retry mechanism.
public final class DownloadResponse {
private final HTTPGetterInfo info;
private final RestResponse<BlobDownloadHeaders, Flowable<ByteBuffer>> rawResponse;
private final Function<HTTPGetterInfo, Single<DownloadResponse>> getter;
// The constructor is package-private because customers should not be creating their own responses.
public DownloadResponse(RestResponse<BlobDownloadHeaders, Flowable<ByteBuffer>> response,
HTTPGetterInfo info, Function<HTTPGetterInfo, Single<DownloadResponse>> getter) {
Utility.assertNotNull("getter", getter);
Utility.assertNotNull("info", info);
Utility.assertNotNull("info.eTag", info.eTag());
this.rawResponse = response; = info;
this.getter = getter;
* Returns the response body which has been modified to enable reliably reading data if desired (if
* {@code options.maxRetryRequests > 0}. If retries are enabled, if a connection fails while reading, the stream
* will make additional requests to reestablish a connection and continue reading.
* @param options
* {@link ReliableDownloadOptions}
* @return A {@code Flowable} which emits the data as {@code ByteBuffer}s.
public Flowable<ByteBuffer> body(ReliableDownloadOptions options) {
ReliableDownloadOptions optionsReal = options == null ? new ReliableDownloadOptions() : options;
if (optionsReal.maxRetryRequests() == 0) {
return this.rawResponse.body();
We pass -1 for currentRetryCount because we want tryContinueFlowable to receive a value of 0 for number of
retries as we have not actually retried yet, only made the initial try. Because applyReliableDownload() will
add 1 before calling into tryContinueFlowable, we set the initial value to -1.
return this.applyReliableDownload(this.rawResponse.body(), -1, optionsReal);
private Flowable<ByteBuffer> tryContinueFlowable(Throwable t, int retryCount, ReliableDownloadOptions options) {
// If all the errors are exhausted, return this error to the user.
if (retryCount > options.maxRetryRequests() || !(t instanceof IOException)) {
return Flowable.error(t);
} else {
We wrap this in a try catch because we don't know the behavior of the getter. Most errors would probably
come from an unsuccessful request, which would be propagated through the onError methods. However, it is
possible the method call that returns a Single is what throws (like how our apis throw some exceptions at
call time rather than at subscription time.
try {
// Get a new response and try reading from it.
return getter.apply(
.flatMapPublisher(response ->
Do not compound the number of retries by passing in another set of downloadOptions; just get
the raw body.
this.applyReliableDownload(this.rawResponse.body(), retryCount, options));
} catch (Exception e) {
// If the getter fails, return the getter failure to the user.
return Flowable.error(e);
private Flowable<ByteBuffer> applyReliableDownload(Flowable<ByteBuffer> data,
int currentRetryCount, ReliableDownloadOptions options) {
return data
.doOnNext(buffer -> {
Update how much data we have received in case we need to retry and propagate to the user the data we
have received.
*/ + buffer.remaining());
if ( != null) { - buffer.remaining());
.onErrorResumeNext(t2 -> {
// Increment the retry count and try again with the new exception.
return tryContinueFlowable(t2, currentRetryCount + 1, options);
public int statusCode() {
return this.rawResponse.statusCode();
public BlobDownloadHeaders headers() {
return this.rawResponse.headers();
public Map<String, String> rawHeaders() {
return this.rawResponse.rawHeaders();
public RestResponse<BlobDownloadHeaders, Flowable<ByteBuffer>> rawResponse() {
return this.rawResponse;
You can’t perform that action at this time.