001/*
002 * ====================================================================
003 * Licensed to the Apache Software Foundation (ASF) under one
004 * or more contributor license agreements.  See the NOTICE file
005 * distributed with this work for additional information
006 * regarding copyright ownership.  The ASF licenses this file
007 * to you under the Apache License, Version 2.0 (the
008 * "License"); you may not use this file except in compliance
009 * with the License.  You may obtain a copy of the License at
010 *
011 *   http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing,
014 * software distributed under the License is distributed on an
015 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
016 * KIND, either express or implied.  See the License for the
017 * specific language governing permissions and limitations
018 * under the License.
019 * ====================================================================
020 *
021 * This software consists of voluntary contributions made by many
022 * individuals on behalf of the Apache Software Foundation.  For more
023 * information on the Apache Software Foundation, please see
024 * <http://www.apache.org/>.
025 *
026 */
027
028package org.apache.http.client;
029
030import java.io.IOException;
031
032import org.apache.http.protocol.HttpContext;
033
034/**
035 * A handler for determining if an HttpRequest should be retried after a
036 * recoverable exception during execution.
037 * <p>
038 * Implementations of this interface must be thread-safe. Access to shared
039 * data must be synchronized as methods of this interface may be executed
040 * from multiple threads.
041 *
042 * @since 4.0
043 */
044public interface HttpRequestRetryHandler {
045
046    /**
047     * Determines if a method should be retried after an IOException
048     * occurs during execution.
049     *
050     * @param exception the exception that occurred
051     * @param executionCount the number of times this method has been
052     * unsuccessfully executed
053     * @param context the context for the request execution
054     *
055     * @return {@code true} if the method should be retried, {@code false}
056     * otherwise
057     */
058    boolean retryRequest(IOException exception, int executionCount, HttpContext context);
059
060}