e-hubert commented on a change in pull request #178: WIP: HTTPCLIENT-2019: Introduce HttpRequestRetryStrategy URL: https://github.com/apache/httpcomponents-client/pull/178#discussion_r351492056
########## File path: httpclient5/src/main/java/org/apache/hc/client5/http/impl/DefaultHttpRequestRetryStrategy.java ########## @@ -0,0 +1,241 @@ +/* + * ==================================================================== + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + * ==================================================================== + * + * This software consists of voluntary contributions made by many + * individuals on behalf of the Apache Software Foundation. For more + * information on the Apache Software Foundation, please see + * <http://www.apache.org/>. + * + */ + +package org.apache.hc.client5.http.impl; + +import java.io.IOException; +import java.io.InterruptedIOException; +import java.net.ConnectException; +import java.net.UnknownHostException; +import java.util.Arrays; +import java.util.Collection; +import java.util.Date; +import java.util.HashSet; +import java.util.Set; + +import javax.net.ssl.SSLException; + +import org.apache.hc.client5.http.HttpRequestRetryStrategy; +import org.apache.hc.client5.http.utils.DateUtils; +import org.apache.hc.core5.annotation.Contract; +import org.apache.hc.core5.annotation.ThreadingBehavior; +import org.apache.hc.core5.concurrent.CancellableDependency; +import org.apache.hc.core5.http.ConnectionClosedException; +import org.apache.hc.core5.http.Header; +import org.apache.hc.core5.http.HttpHeaders; +import org.apache.hc.core5.http.HttpRequest; +import org.apache.hc.core5.http.HttpResponse; +import org.apache.hc.core5.http.HttpStatus; +import org.apache.hc.core5.http.Methods; +import org.apache.hc.core5.http.protocol.HttpContext; +import org.apache.hc.core5.util.Args; +import org.apache.hc.core5.util.TimeValue; + +/** + * Default implementation of the {@link HttpRequestRetryStrategy} interface. + * + * @since 5.0 + */ +@Contract(threading = ThreadingBehavior.STATELESS) +public class DefaultHttpRequestRetryStrategy implements HttpRequestRetryStrategy { + + public static final DefaultHttpRequestRetryStrategy INSTANCE = new DefaultHttpRequestRetryStrategy(); + + /** + * Maximum number of allowed retries + */ + private final int maxRetries; + + /** + * Retry interval between subsequent retries + */ + private final TimeValue defaultRetryInterval; + + /** + * Derived {@code IOExceptions} which shall not be retried + */ + private final Set<Class<? extends IOException>> nonRetriableClasses; + + /** + * HTTP status codes which shall be retried + */ + private final Set<Integer> retriableCodes; + + protected DefaultHttpRequestRetryStrategy( + final int maxRetries, + final TimeValue defaultRetryInterval, + final Collection<Class<? extends IOException>> clazzes, + final Collection<Integer> codes) { + Args.positive(maxRetries, "maxRetries"); + Args.positive(defaultRetryInterval.getDuration(), "defaultRetryInterval"); + this.maxRetries = maxRetries; + this.defaultRetryInterval = defaultRetryInterval; + this.nonRetriableClasses = new HashSet<>(); + this.nonRetriableClasses.addAll(clazzes); + this.retriableCodes = new HashSet<>(); + this.retriableCodes.addAll(codes); + } + + /** + * Create the HTTP request retry strategy using the following list of + * non-retriable IOException classes:<br> + * <ul> + * <li>InterruptedIOException</li> + * <li>UnknownHostException</li> + * <li>ConnectException</li> + * <li>ConnectionClosedException</li> + * <li>SSLException</li> + * </ul> + * + * and retriable HTTP status codes:<br> + * <ul> + * <li>SC_TOO_MANY_REQUESTS (429)</li> + * <li>SC_SERVICE_UNAVAILABLE (503)</li> + * </ul> + * + * @param maxRetries how many times to retry; 0 means no retries + * @param defaultRetryInterval the default retry interval between + * subsequent retries if the {@code Retry-After} header is not set + * or invalid. + */ + public DefaultHttpRequestRetryStrategy( + final int maxRetries, + final TimeValue defaultRetryInterval) { + this(maxRetries, defaultRetryInterval, + Arrays.asList( + InterruptedIOException.class, + UnknownHostException.class, + ConnectException.class, + ConnectionClosedException.class, + SSLException.class), Review comment: Would it be possible to use the opportunity to replace SSLException.class with its JDK subclasses SSLProtocolException.class, SSLKeyException.class, SSLHandshakeException, SSLPeerUnverifiedException? This way users upgrading from Java 8 and using the default retry implmentation of HC do not experience a behavioral change due to a change in the OpenJDK implementation now wrapping underlying SocketExceptions on an SSLSocket in an SSLException while still ensuring concrete SSLExceptions are not retried. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@hc.apache.org For additional commands, e-mail: dev-h...@hc.apache.org
