1/*
2 * Copyright (c) 2004, 2008, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26package java.net;
27
28import java.io.IOException;
29
30/**
31 * Thrown to indicate that a HTTP request needs to be retried
32 * but cannot be retried automatically, due to streaming mode
33 * being enabled.
34 *
35 * @author  Michael McMahon
36 * @since   1.5
37 */
38public
39class HttpRetryException extends IOException {
40    private static final long serialVersionUID = -9186022286469111381L;
41
42    private int responseCode;
43    private String location;
44
45    /**
46     * Constructs a new <code>HttpRetryException</code> from the
47     * specified response code and exception detail message
48     *
49     * @param   detail   the detail message.
50     * @param   code   the HTTP response code from server.
51     */
52    public HttpRetryException(String detail, int code) {
53        super(detail);
54        responseCode = code;
55    }
56
57    /**
58     * Constructs a new <code>HttpRetryException</code> with detail message
59     * responseCode and the contents of the Location response header field.
60     *
61     * @param   detail   the detail message.
62     * @param   code   the HTTP response code from server.
63     * @param   location   the URL to be redirected to
64     */
65    public HttpRetryException(String detail, int code, String location) {
66        super (detail);
67        responseCode = code;
68        this.location = location;
69    }
70
71    /**
72     * Returns the http response code
73     *
74     * @return  The http response code.
75     */
76    public int responseCode() {
77        return responseCode;
78    }
79
80    /**
81     * Returns a string explaining why the http request could
82     * not be retried.
83     *
84     * @return  The reason string
85     */
86    public String getReason() {
87        return super.getMessage();
88    }
89
90    /**
91     * Returns the value of the Location header field if the
92     * error resulted from redirection.
93     *
94     * @return The location string
95     */
96    public String getLocation() {
97        return location;
98    }
99}
100