RedirectHandler.java revision 417f3b92ba4549b2f22340e3107d869d2b9c5bb8 
1/*
2 * $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/client/RedirectHandler.java $
3 * $Revision: 538647 $
4 * $Date: 2007-05-16 09:41:42 -0700 (Wed, 16 May 2007) $
5 *
6 * ====================================================================
7 * Licensed to the Apache Software Foundation (ASF) under one
8 * or more contributor license agreements.  See the NOTICE file
9 * distributed with this work for additional information
10 * regarding copyright ownership.  The ASF licenses this file
11 * to you under the Apache License, Version 2.0 (the
12 * "License"); you may not use this file except in compliance
13 * with the License.  You may obtain a copy of the License at
14 *
15 *   http://www.apache.org/licenses/LICENSE-2.0
16 *
17 * Unless required by applicable law or agreed to in writing,
18 * software distributed under the License is distributed on an
19 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
20 * KIND, either express or implied.  See the License for the
21 * specific language governing permissions and limitations
22 * under the License.
23 * ====================================================================
24 *
25 * This software consists of voluntary contributions made by many
26 * individuals on behalf of the Apache Software Foundation.  For more
27 * information on the Apache Software Foundation, please see
28 * <http://www.apache.org/>.
29 *
30 */
31
32package org.apache.http.client;
33
34import java.net.URI;
35
36import org.apache.http.HttpResponse;
37import org.apache.http.ProtocolException;
38import org.apache.http.protocol.HttpContext;
39
40/**
41 * A handler for determining if an HTTP request should be redirected to
42 * a new location in response to an HTTP response received from the target
43 * server.
44 *
45 * <p>
46 * Classes implementing this interface must synchronize access to shared
47 * data as methods of this interfrace may be executed from multiple threads
48 * </p>
49 *
50 * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
51 */
52public interface RedirectHandler {
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 response the response received from the target server
59     * @param context the context for the request execution
60     *
61     * @return <code>true</code> if the request should be redirected, <code>false</code>
62     * otherwise
63     */
64    boolean isRedirectRequested(HttpResponse response, HttpContext context);
65
66    /**
67     * Determines the location request is expected to be redirected to
68     * given the response from the target server and the current request
69     * execution context.
70     *
71     * @param response the response received from the target server
72     * @param context the context for the request execution
73     *
74     * @return redirect URI
75     */
76    URI getLocationURI(HttpResponse response, HttpContext context)
77            throws ProtocolException;
78
79}
80