Response.java 5.49 KB
Newer Older
Tom Tromey committed
1
/* Response.java --
2
   Copyright (C) 2004, 2006 Free Software Foundation, Inc.
Tom Tromey committed
3 4 5 6 7 8 9

This file is part of GNU Classpath.

GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
10

Tom Tromey committed
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40
GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.

Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module.  An independent module is a module which is not derived from
or based on this library.  If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so.  If you do not wish to do so, delete this
exception statement from your version. */


package gnu.java.net.protocol.http;

41
import java.io.InputStream;
Tom Tromey committed
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63
import java.util.Date;

/**
 * An HTTP response.
 *
 * @author Chris Burdess (dog@gnu.org)
 */
public class Response
{

  /**
   * The HTTP major version of the server issuing the response.
   */
  protected final int majorVersion;

  /**
   * The HTTP minor version of the server issuing the response.
   */
  protected final int minorVersion;

  /**
   * The HTTP status code of the response.
64
   */
Tom Tromey committed
65 66 67 68 69 70 71 72 73 74 75 76 77
  protected final int code;

  /**
   * Human-readable text of the response.
   */
  protected final String message;

  /**
   * The response headers.
   */
  protected final Headers headers;

  /**
78 79 80 81 82
   * An InputStream that returns the body of the response.
   */
  protected final InputStream body;

  /**
Tom Tromey committed
83 84 85
   * Constructs a new response with the specified parameters.
   */
  protected Response(int majorVersion, int minorVersion, int code,
86
                     String message, Headers headers, InputStream body)
Tom Tromey committed
87 88 89 90 91 92
  {
    this.majorVersion = majorVersion;
    this.minorVersion = minorVersion;
    this.code = code;
    this.message = message;
    this.headers = headers;
93
    this.body = body;
Tom Tromey committed
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
  }

  /**
   * Returns the HTTP major version of the server issuing the response.
   * @see #majorVersion
   */
  public int getMajorVersion()
  {
    return majorVersion;
  }

  /**
   * Returns the HTTP minor version of the server issuing the response.
   * @see #minorVersion
   */
  public int getMinorVersion()
  {
    return minorVersion;
  }

  /**
   * Returns the HTTP status code of the response.
   * @see #code
117
   */
Tom Tromey committed
118 119 120 121 122 123
  public int getCode()
  {
    return code;
  }

  /**
124 125 126 127 128 129 130 131 132
   * Returns the class of the response.  This is the most significant
   * digit of the status code.
   * <dl>
   * <dt><code>1xx</code></dt> <dd>Informational response</dd>
   * <dt><code>2xx</code></dt> <dd>Success</dd>
   * <dt><code>3xx</code></dt> <dd>Redirection</dd>
   * <dt><code>4xx</code></dt> <dd>Client error</dd>
   * <dt><code>5xx</code></dt> <dd>Server error</dd>
   * </dl>
Tom Tromey committed
133 134 135
   */
  public int getCodeClass()
  {
136
    return code / 100;
Tom Tromey committed
137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174
  }

  /**
   * Returns the human-readable text of the response.
   * @see #message
   */
  public String getMessage()
  {
    return message;
  }

  /**
   * Returns the headers in the response.
   */
  public Headers getHeaders()
  {
    return headers;
  }

  /**
   * Returns the header value for the specified name.
   * @param name the header name
   */
  public String getHeader(String name)
  {
    return headers.getValue(name);
  }

  /**
   * Returns the header value for the specified name as an integer.
   * @param name the header name
   */
  public int getIntHeader(String name)
  {
    return headers.getIntValue(name);
  }

  /**
175 176 177 178 179 180 181 182 183
   * Returns the header value for the specified name as a long.
   * @param name the header name
   */
  public long getLongHeader(String name)
  {
    return headers.getLongValue(name);
  }

  /**
Tom Tromey committed
184 185 186 187 188 189 190
   * Returns the header value for the specified name as a date.
   * @param name the header name
   */
  public Date getDateHeader(String name)
  {
    return headers.getDateValue(name);
  }
191

192 193
  /**
   * Tests whether this response indicates a redirection.
194
   *
195 196 197 198 199 200
   * @return <code>true</code> if, <code>false</code> otherwise.
   */
  public boolean isRedirect()
  {
    return (code != 304 && getCodeClass() == 3);
  }
201

202 203 204 205
  /**
   * Tests whether this response indicates an error.
   * Errors are the response codes <code>4xx</code> - Client error and
   * <code>5xx</code> - Server error.
206
   *
207 208 209 210 211 212
   * @return <code>true</code> if, <code>false</code> otherwise.
   */
  public boolean isError()
  {
    return (getCodeClass() == 4 || getCodeClass() == 5);
  }
Tom Tromey committed
213

214 215 216 217 218 219 220 221 222
  /**
   * Returns an InputStream that returns the body of the response.
   *
   * @return the body of the response
   */
  public InputStream getBody()
  {
    return body;
  }
Tom Tromey committed
223
}