mobile/android/thirdparty/ch/boye/httpclientandroidlib/impl/client/DefaultHttpRequestRetryHandler.java@fc2d59ddac77 (annotated)
mobile/android/thirdparty/ch/boye/httpclientandroidlib/impl/client/DefaultHttpRequestRetryHandler.java
Wed, 31 Dec 2014 07:22:50 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Wed, 31 Dec 2014 07:22:50 +0100
- branch
- TOR_BUG_3246
- changeset 4
- fc2d59ddac77
- permissions
- -rw-r--r--
Correct previous dual key logic pending first delivery installment.
| michael@0 | 1 | /* |
| michael@0 | 2 | * ==================================================================== |
| michael@0 | 3 | * Licensed to the Apache Software Foundation (ASF) under one |
| michael@0 | 4 | * or more contributor license agreements. See the NOTICE file |
| michael@0 | 5 | * distributed with this work for additional information |
| michael@0 | 6 | * regarding copyright ownership. The ASF licenses this file |
| michael@0 | 7 | * to you under the Apache License, Version 2.0 (the |
| michael@0 | 8 | * "License"); you may not use this file except in compliance |
| michael@0 | 9 | * with the License. You may obtain a copy of the License at |
| michael@0 | 10 | * |
| michael@0 | 11 | * http://www.apache.org/licenses/LICENSE-2.0 |
| michael@0 | 12 | * |
| michael@0 | 13 | * Unless required by applicable law or agreed to in writing, |
| michael@0 | 14 | * software distributed under the License is distributed on an |
| michael@0 | 15 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| michael@0 | 16 | * KIND, either express or implied. See the License for the |
| michael@0 | 17 | * specific language governing permissions and limitations |
| michael@0 | 18 | * under the License. |
| michael@0 | 19 | * ==================================================================== |
| michael@0 | 20 | * |
| michael@0 | 21 | * This software consists of voluntary contributions made by many |
| michael@0 | 22 | * individuals on behalf of the Apache Software Foundation. For more |
| michael@0 | 23 | * information on the Apache Software Foundation, please see |
| michael@0 | 24 | * <http://www.apache.org/>. |
| michael@0 | 25 | * |
| michael@0 | 26 | */ |
| michael@0 | 27 | |
| michael@0 | 28 | package ch.boye.httpclientandroidlib.impl.client; |
| michael@0 | 29 | |
| michael@0 | 30 | import java.io.IOException; |
| michael@0 | 31 | import java.io.InterruptedIOException; |
| michael@0 | 32 | import java.net.ConnectException; |
| michael@0 | 33 | import java.net.UnknownHostException; |
| michael@0 | 34 | |
| michael@0 | 35 | import javax.net.ssl.SSLException; |
| michael@0 | 36 | |
| michael@0 | 37 | import ch.boye.httpclientandroidlib.annotation.Immutable; |
| michael@0 | 38 | |
| michael@0 | 39 | import ch.boye.httpclientandroidlib.HttpEntityEnclosingRequest; |
| michael@0 | 40 | import ch.boye.httpclientandroidlib.HttpRequest; |
| michael@0 | 41 | import ch.boye.httpclientandroidlib.client.HttpRequestRetryHandler; |
| michael@0 | 42 | import ch.boye.httpclientandroidlib.protocol.HttpContext; |
| michael@0 | 43 | import ch.boye.httpclientandroidlib.protocol.ExecutionContext; |
| michael@0 | 44 | |
| michael@0 | 45 | /** |
| michael@0 | 46 | * The default {@link HttpRequestRetryHandler} used by request executors. |
| michael@0 | 47 | * |
| michael@0 | 48 | * |
| michael@0 | 49 | * @since 4.0 |
| michael@0 | 50 | */ |
| michael@0 | 51 | @Immutable |
| michael@0 | 52 | public class DefaultHttpRequestRetryHandler implements HttpRequestRetryHandler { |
| michael@0 | 53 | |
| michael@0 | 54 | /** the number of times a method will be retried */ |
| michael@0 | 55 | private final int retryCount; |
| michael@0 | 56 | |
| michael@0 | 57 | /** Whether or not methods that have successfully sent their request will be retried */ |
| michael@0 | 58 | private final boolean requestSentRetryEnabled; |
| michael@0 | 59 | |
| michael@0 | 60 | /** |
| michael@0 | 61 | * Default constructor |
| michael@0 | 62 | */ |
| michael@0 | 63 | public DefaultHttpRequestRetryHandler(int retryCount, boolean requestSentRetryEnabled) { |
| michael@0 | 64 | super(); |
| michael@0 | 65 | this.retryCount = retryCount; |
| michael@0 | 66 | this.requestSentRetryEnabled = requestSentRetryEnabled; |
| michael@0 | 67 | } |
| michael@0 | 68 | |
| michael@0 | 69 | /** |
| michael@0 | 70 | * Default constructor |
| michael@0 | 71 | */ |
| michael@0 | 72 | public DefaultHttpRequestRetryHandler() { |
| michael@0 | 73 | this(3, false); |
| michael@0 | 74 | } |
| michael@0 | 75 | /** |
| michael@0 | 76 | * Used <code>retryCount</code> and <code>requestSentRetryEnabled</code> to determine |
| michael@0 | 77 | * if the given method should be retried. |
| michael@0 | 78 | */ |
| michael@0 | 79 | public boolean retryRequest( |
| michael@0 | 80 | final IOException exception, |
| michael@0 | 81 | int executionCount, |
| michael@0 | 82 | final HttpContext context) { |
| michael@0 | 83 | if (exception == null) { |
| michael@0 | 84 | throw new IllegalArgumentException("Exception parameter may not be null"); |
| michael@0 | 85 | } |
| michael@0 | 86 | if (context == null) { |
| michael@0 | 87 | throw new IllegalArgumentException("HTTP context may not be null"); |
| michael@0 | 88 | } |
| michael@0 | 89 | if (executionCount > this.retryCount) { |
| michael@0 | 90 | // Do not retry if over max retry count |
| michael@0 | 91 | return false; |
| michael@0 | 92 | } |
| michael@0 | 93 | if (exception instanceof InterruptedIOException) { |
| michael@0 | 94 | // Timeout |
| michael@0 | 95 | return false; |
| michael@0 | 96 | } |
| michael@0 | 97 | if (exception instanceof UnknownHostException) { |
| michael@0 | 98 | // Unknown host |
| michael@0 | 99 | return false; |
| michael@0 | 100 | } |
| michael@0 | 101 | if (exception instanceof ConnectException) { |
| michael@0 | 102 | // Connection refused |
| michael@0 | 103 | return false; |
| michael@0 | 104 | } |
| michael@0 | 105 | if (exception instanceof SSLException) { |
| michael@0 | 106 | // SSL handshake exception |
| michael@0 | 107 | return false; |
| michael@0 | 108 | } |
| michael@0 | 109 | |
| michael@0 | 110 | HttpRequest request = (HttpRequest) |
| michael@0 | 111 | context.getAttribute(ExecutionContext.HTTP_REQUEST); |
| michael@0 | 112 | if (handleAsIdempotent(request)) { |
| michael@0 | 113 | // Retry if the request is considered idempotent |
| michael@0 | 114 | return true; |
| michael@0 | 115 | } |
| michael@0 | 116 | |
| michael@0 | 117 | Boolean b = (Boolean) |
| michael@0 | 118 | context.getAttribute(ExecutionContext.HTTP_REQ_SENT); |
| michael@0 | 119 | boolean sent = (b != null && b.booleanValue()); |
| michael@0 | 120 | |
| michael@0 | 121 | if (!sent || this.requestSentRetryEnabled) { |
| michael@0 | 122 | // Retry if the request has not been sent fully or |
| michael@0 | 123 | // if it's OK to retry methods that have been sent |
| michael@0 | 124 | return true; |
| michael@0 | 125 | } |
| michael@0 | 126 | // otherwise do not retry |
| michael@0 | 127 | return false; |
| michael@0 | 128 | } |
| michael@0 | 129 | |
| michael@0 | 130 | /** |
| michael@0 | 131 | * @return <code>true</code> if this handler will retry methods that have |
| michael@0 | 132 | * successfully sent their request, <code>false</code> otherwise |
| michael@0 | 133 | */ |
| michael@0 | 134 | public boolean isRequestSentRetryEnabled() { |
| michael@0 | 135 | return requestSentRetryEnabled; |
| michael@0 | 136 | } |
| michael@0 | 137 | |
| michael@0 | 138 | /** |
| michael@0 | 139 | * @return the maximum number of times a method will be retried |
| michael@0 | 140 | */ |
| michael@0 | 141 | public int getRetryCount() { |
| michael@0 | 142 | return retryCount; |
| michael@0 | 143 | } |
| michael@0 | 144 | |
| michael@0 | 145 | private boolean handleAsIdempotent(final HttpRequest request) { |
| michael@0 | 146 | return !(request instanceof HttpEntityEnclosingRequest); |
| michael@0 | 147 | } |
| michael@0 | 148 | |
| michael@0 | 149 | } |
