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 org.apache.http.HttpResponse;
031import org.apache.http.protocol.HttpContext;
032
033/**
034 * Strategy interface that allows API users to plug in their own logic to
035 * control whether or not a retry should automatically be done, how many times
036 * it should be retried and so on.
037 *
038 * @since 4.2
039 */
040public interface ServiceUnavailableRetryStrategy {
041
042    /**
043     * Determines if a method should be retried given the response from the target server.
044     *
045     * @param response the response from the target server
046     * @param executionCount the number of times this method has been
047     * unsuccessfully executed
048     * @param context the context for the request execution
049
050     * @return {@code true} if the method should be retried, {@code false}
051     * otherwise
052     */
053    boolean retryRequest(HttpResponse response, int executionCount, HttpContext context);
054
055    /**
056     * @return The interval between the subsequent auto-retries.
057     */
058    long getRetryInterval();
059
060}