1 /*
2 * ====================================================================
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements. See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership. The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License. You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied. See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 * ====================================================================
20 *
21 * This software consists of voluntary contributions made by many
22 * individuals on behalf of the Apache Software Foundation. For more
23 * information on the Apache Software Foundation, please see
24 * <http://www.apache.org/>.
25 *
26 */
27
28 package org.apache.hc.client5.http.protocol;
29
30 import java.net.URI;
31
32 import org.apache.hc.core5.annotation.Contract;
33 import org.apache.hc.core5.annotation.ThreadingBehavior;
34 import org.apache.hc.core5.http.HttpException;
35 import org.apache.hc.core5.http.HttpRequest;
36 import org.apache.hc.core5.http.HttpResponse;
37 import org.apache.hc.core5.http.protocol.HttpContext;
38
39 /**
40 * A strategy for determining if an HTTP request should be redirected to
41 * a new location in response to an HTTP response received from the target
42 * server.
43 * <p>
44 * Implementations of this interface must be thread-safe. Access to shared
45 * data must be synchronized as methods of this interface may be executed
46 * from multiple threads.
47 * </p>
48 *
49 * @since 4.1
50 */
51 @Contract(threading = ThreadingBehavior.STATELESS)
52 public interface RedirectStrategy {
53
54 /**
55 * Determines if a request should be redirected to a new location
56 * given the response from the target server.
57 *
58 * @param request the executed request
59 * @param response the response received from the target server
60 * @param context the context for the request execution
61 * @return {@code true} if the request should be redirected, {@code false}
62 * otherwise
63 */
64 boolean isRedirected(
65 HttpRequest request,
66 HttpResponse response,
67 HttpContext context) throws HttpException;
68
69 URI getLocationURI(
70 final HttpRequest request,
71 final HttpResponse response,
72 final HttpContext context) throws HttpException;
73
74 }