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 java.net.URI;
31  
32  import org.apache.http.HttpResponse;
33  import org.apache.http.ProtocolException;
34  import org.apache.http.protocol.HttpContext;
35  
36  /**
37   * A handler 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.0
46   *
47   * @deprecated (4.1)  use {@link RedirectStrategy}
48   */
49  @Deprecated
50  public interface RedirectHandler {
51  
52      /**
53       * Determines if a request should be redirected to a new location
54       * given the response from the target server.
55       *
56       * @param response the response received from the target server
57       * @param context the context for the request execution
58       *
59       * @return <code>true</code> if the request should be redirected, <code>false</code>
60       * otherwise
61       */
62      boolean isRedirectRequested(HttpResponse response, HttpContext context);
63  
64      /**
65       * Determines the location request is expected to be redirected to
66       * given the response from the target server and the current request
67       * execution context.
68       *
69       * @param response the response received from the target server
70       * @param context the context for the request execution
71       *
72       * @return redirect URI
73       */
74      URI getLocationURI(HttpResponse response, HttpContext context)
75              throws ProtocolException;
76  
77  }