View Javadoc

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.http.client;
29  
30  import org.apache.http.HttpRequest;
31  import org.apache.http.HttpResponse;
32  import org.apache.http.ProtocolException;
33  import org.apache.http.client.methods.HttpUriRequest;
34  import org.apache.http.protocol.HttpContext;
35  
36  /**
37   * A strategy for determining if an HTTP request should be redirected to
38   * a new location in response to an HTTP response received from the target
39   * server.
40   * <p>
41   * Implementations of this interface must be thread-safe. Access to shared
42   * data must be synchronized as methods of this interface may be executed
43   * from multiple threads.
44   *
45   * @since 4.1
46   */
47  public interface RedirectStrategy {
48  
49      /**
50       * Determines if a request should be redirected to a new location
51       * given the response from the target server.
52       *
53       * @param request the executed request
54       * @param response the response received from the target server
55       * @param context the context for the request execution
56       *
57       * @return <code>true</code> if the request should be redirected, <code>false</code>
58       * otherwise
59       */
60      boolean isRedirected(
61              HttpRequest request,
62              HttpResponse response,
63              HttpContext context) throws ProtocolException;
64  
65      /**
66       * Determines the redirect location given the response from the target
67       * server and the current request execution context and generates a new
68       * request to be sent to the location.
69       *
70       * @param request the executed request
71       * @param response the response received from the target server
72       * @param context the context for the request execution
73       *
74       * @return redirected request
75       */
76      HttpUriRequest getRedirect(
77              HttpRequest request,
78              HttpResponse response,
79              HttpContext context) throws ProtocolException;
80  
81  }