Open Source Repository

Home /spring/spring-web-3.0.5 | Repository Home


org/springframework/http/HttpStatus.java
/*
 * Copyright 2002-2009 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.http;

/**
 * Java 5 enumeration of HTTP status codes.
 *
 <p>The HTTP status code series can be retrieved via {@link #series()}.
 *
 @author Arjen Poutsma
 @see HttpStatus.Series
 @see <a href="http://www.iana.org/assignments/http-status-codes">HTTP Status Code Registry</a>
 */
public enum HttpStatus {

  // 1xx Informational

  /**
   * {@code 100 Continue}.
   @see <a href="http://tools.ietf.org/html/rfc2616#section-10.1.1">HTTP/1.1</a>
   */
  CONTINUE(100),
  /**
   * {@code 101 Switching Protocols}.
   @see <a href="http://tools.ietf.org/html/rfc2616#section-10.1.2">HTTP/1.1</a>
   */
  SWITCHING_PROTOCOLS(101),
  /**
   * {@code 102 Processing}.
   @see <a href="http://tools.ietf.org/html/rfc2518#section-10.1">WebDAV</a>
   */
  PROCESSING(102),

  // 2xx Success

  /**
   * {@code 200 OK}.
   @see <a href="http://tools.ietf.org/html/rfc2616#section-10.2.1">HTTP/1.1</a>
   */
  OK(200),
  /**
   * {@code 201 Created}.
   @see <a href="http://tools.ietf.org/html/rfc2616#section-10.2.2">HTTP/1.1</a>
   */
  CREATED(201),
  /**
   * {@code 202 Accepted}.
   @see <a href="http://tools.ietf.org/html/rfc2616#section-10.2.3">HTTP/1.1</a>
   */
  ACCEPTED(202),
  /**
   * {@code 203 Non-Authoritative Information}.
   @see <a href="http://tools.ietf.org/html/rfc2616#section-10.2.4">HTTP/1.1</a>
   */
  NON_AUTHORITATIVE_INFORMATION(203),
  /**
   * {@code 204 No Content}.
   @see <a href="http://tools.ietf.org/html/rfc2616#section-10.2.5">HTTP/1.1</a>
   */
  NO_CONTENT(204),
  /**
   * {@code 205 Reset Content}.
   @see <a href="http://tools.ietf.org/html/rfc2616#section-10.2.6">HTTP/1.1</a>
   */
  RESET_CONTENT(205),
  /**
   * {@code 206 Partial Content}.
   @see <a href="http://tools.ietf.org/html/rfc2616#section-10.2.7">HTTP/1.1</a>
   */
  PARTIAL_CONTENT(206),
  /**
   * {@code 207 Multi-Status}.
   @see <a href="http://tools.ietf.org/html/rfc4918#section-13">WebDAV</a>
   */
  MULTI_STATUS(207),
  /**
   * {@code 208 Already Reported}.
   @see <a href="http://tools.ietf.org/html/draft-ietf-webdav-bind-27#section-7.1">WebDAV Binding Extensions</a>
   */
  ALREADY_REPORTED(208),
  /**
   * {@code 226 IM Used}.
   @see <a href="http://tools.ietf.org/html/rfc3229#section-10.4.1">Delta encoding in HTTP</a>
   */
  IM_USED(226),

  // 3xx Redirection

  /**
   * {@code 300 Multiple Choices}.
   @see <a href="http://tools.ietf.org/html/rfc2616#section-10.3.1">HTTP/1.1</a>
   */
  MULTIPLE_CHOICES(300),
  /**
   * {@code 301 Moved Permanently}.
   @see <a href="http://tools.ietf.org/html/rfc2616#section-10.3.2">HTTP/1.1</a>
   */
  MOVED_PERMANENTLY(301),
  /**
   * {@code 302 Found}.
   @see <a href="http://tools.ietf.org/html/rfc2616#section-10.3.3">HTTP/1.1</a>
   */
  FOUND(302),
  /**
   * {@code 302 Moved Temporarily}.
   @see <a href="http://tools.ietf.org/html/rfc1945#section-9.3">HTTP/1.0</a>
   */
  MOVED_TEMPORARILY(302),
  /**
   * {@code 303 See Other}.
   @see <a href="http://tools.ietf.org/html/rfc2616#section-10.3.4">HTTP/1.1</a>
   */
  SEE_OTHER(303),
  /**
   * {@code 304 Not Modified}.
   @see <a href="http://tools.ietf.org/html/rfc2616#section-10.3.5">HTTP/1.1</a>
   */
  NOT_MODIFIED(304),
  /**
   * {@code 305 Use Proxy}.
   @see <a href="http://tools.ietf.org/html/rfc2616#section-10.3.6">HTTP/1.1</a>
   */
  USE_PROXY(305),
  /**
   * {@code 307 Temporary Redirect}.
   @see <a href="http://tools.ietf.org/html/rfc2616#section-10.3.8">HTTP/1.1</a>
   */
  TEMPORARY_REDIRECT(307),

  // --- 4xx Client Error ---

  /**
   * {@code 400 Bad Request}.
   @see <a href="http://tools.ietf.org/html/rfc2616#section-10.4.1">HTTP/1.1</a>
   */
  BAD_REQUEST(400),
  /**
   * {@code 401 Unauthorized}.
   @see <a href="http://tools.ietf.org/html/rfc2616#section-10.4.2">HTTP/1.1</a>
   */
  UNAUTHORIZED(401),
  /**
   * {@code 402 Payment Required}.
   @see <a href="http://tools.ietf.org/html/rfc2616#section-10.4.3">HTTP/1.1</a>
   */
  PAYMENT_REQUIRED(402),
  /**
   * {@code 403 Forbidden}.
   @see <a href="http://tools.ietf.org/html/rfc2616#section-10.4.4">HTTP/1.1</a>
   */
  FORBIDDEN(403),
  /**
   * {@code 404 Not Found}.
   @see <a href="http://tools.ietf.org/html/rfc2616#section-10.4.5">HTTP/1.1</a>
   */
  NOT_FOUND(404),
  /**
   * {@code 405 Method Not Allowed}.
   @see <a href="http://tools.ietf.org/html/rfc2616#section-10.4.6">HTTP/1.1</a>
   */
  METHOD_NOT_ALLOWED(405),
  /**
   * {@code 406 Not Acceptable}.
   @see <a href="http://tools.ietf.org/html/rfc2616#section-10.4.7">HTTP/1.1</a>
   */
  NOT_ACCEPTABLE(406),
  /**
   * {@code 407 Proxy Authentication Required}.
   @see <a href="http://tools.ietf.org/html/rfc2616#section-10.4.8">HTTP/1.1</a>
   */
  PROXY_AUTHENTICATION_REQUIRED(407),
  /**
   * {@code 408 Request Timeout}.
   @see <a href="http://tools.ietf.org/html/rfc2616#section-10.4.9">HTTP/1.1</a>
   */
  REQUEST_TIMEOUT(408),
  /**
   * {@code 409 Conflict}.
   @see <a href="http://tools.ietf.org/html/rfc2616#section-10.4.10">HTTP/1.1</a>
   */
  CONFLICT(409),
  /**
   * {@code 410 Gone}.
   @see <a href="http://tools.ietf.org/html/rfc2616#section-10.4.11">HTTP/1.1</a>
   */
  GONE(410),
  /**
   * {@code 411 Length Required}.
   @see <a href="http://tools.ietf.org/html/rfc2616#section-10.4.12">HTTP/1.1</a>
   */
  LENGTH_REQUIRED(411),
  /**
   * {@code 412 Precondition failed}.
   @see <a href="http://tools.ietf.org/html/rfc2616#section-10.4.13">HTTP/1.1</a>
   */
  PRECONDITION_FAILED(412),
  /**
   * {@code 413 Request Entity Too Large}.
   @see <a href="http://tools.ietf.org/html/rfc2616#section-10.4.14">HTTP/1.1</a>
   */  
  REQUEST_ENTITY_TOO_LARGE(413),
  /**
   * {@code 414 Request-URI Too Long}.
   @see <a href="http://tools.ietf.org/html/rfc2616#section-10.4.15">HTTP/1.1</a>
   */
  REQUEST_URI_TOO_LONG(414),
  /**
   * {@code 415 Unsupported Media Type}.
   @see <a href="http://tools.ietf.org/html/rfc2616#section-10.4.16">HTTP/1.1</a>
   */
  UNSUPPORTED_MEDIA_TYPE(415),
  /**
   * {@code 416 Requested Range Not Satisfiable}.
   @see <a href="http://tools.ietf.org/html/rfc2616#section-10.4.17">HTTP/1.1</a>
   */
  REQUESTED_RANGE_NOT_SATISFIABLE(416),
  /**
   * {@code 417 Expectation Failed}.
   @see <a href="http://tools.ietf.org/html/rfc2616#section-10.4.18">HTTP/1.1</a>
   */
  EXPECTATION_FAILED(417),
  /**
   * {@code 419 Insufficient Space on Resource}.
   @see <a href="http://tools.ietf.org/html/draft-ietf-webdav-protocol-05#section-10.4">WebDAV Draft</a>
   */
  INSUFFICIENT_SPACE_ON_RESOURCE(419),
  /**
   * {@code 420 Method Failure}.
   @see <a href="http://tools.ietf.org/html/draft-ietf-webdav-protocol-05#section-10.5">WebDAV Draft</a>
   */
  METHOD_FAILURE(420),
  /**
   * {@code 421 Destination Locked}.
   @see <a href="http://tools.ietf.org/html/draft-ietf-webdav-protocol-05#section-10.6">WebDAV Draft</a>
   */
  DESTINATION_LOCKED(421),
  /**
   * {@code 422 Unprocessable Entity}.
   @see <a href="http://tools.ietf.org/html/rfc4918#section-11.2">WebDAV</a>
   */
  UNPROCESSABLE_ENTITY(422),
  /**
   * {@code 423 Locked}.
   @see <a href="http://tools.ietf.org/html/rfc4918#section-11.3">WebDAV</a>
   */
  LOCKED(423),
  /**
   * {@code 424 Failed Dependency}.
   @see <a href="http://tools.ietf.org/html/rfc4918#section-11.4">WebDAV</a>
   */
  FAILED_DEPENDENCY(424),
  /**
   * {@code 426 Upgrade Required}.
   @see <a href="http://tools.ietf.org/html/rfc2817#section-6">Upgrading to TLS Within HTTP/1.1</a>
   */
  UPGRADE_REQUIRED(426),

  // --- 5xx Server Error ---

  /**
   * {@code 500 Internal Server Error}.
   @see <a href="http://tools.ietf.org/html/rfc2616#section-10.5.1">HTTP/1.1</a>
   */
  INTERNAL_SERVER_ERROR(500),
  /**
   * {@code 501 Not Implemented}.
   @see <a href="http://tools.ietf.org/html/rfc2616#section-10.5.2">HTTP/1.1</a>
   */
  NOT_IMPLEMENTED(501),
  /**
   * {@code 502 Bad Gateway}.
   @see <a href="http://tools.ietf.org/html/rfc2616#section-10.5.3">HTTP/1.1</a>
   */
  BAD_GATEWAY(502),
  /**
   * {@code 503 Service Unavailable}.
   @see <a href="http://tools.ietf.org/html/rfc2616#section-10.5.4">HTTP/1.1</a>
   */
  SERVICE_UNAVAILABLE(503),
  /**
   * {@code 504 Gateway Timeout}.
   @see <a href="http://tools.ietf.org/html/rfc2616#section-10.5.5">HTTP/1.1</a>
   */
  GATEWAY_TIMEOUT(504),
  /**
   * {@code 505 HTTP Version Not Supported}.
   @see <a href="http://tools.ietf.org/html/rfc2616#section-10.5.6">HTTP/1.1</a>
   */
  HTTP_VERSION_NOT_SUPPORTED(505),
  /**
   * {@code 506 Variant Also Negotiates}
   @see <a href="http://tools.ietf.org/html/rfc2295#section-8.1">Transparent Content Negotiation</a>
   */
  VARIANT_ALSO_NEGOTIATES(506),
  /**
   * {@code 507 Insufficient Storage}
   @see <a href="http://tools.ietf.org/html/rfc4918#section-11.5">WebDAV</a>
   */
  INSUFFICIENT_STORAGE(507),
  /**
   * {@code 508 Loop Detected}
   @see <a href="http://tools.ietf.org/html/draft-ietf-webdav-bind-27#section-7.2">WebDAV Binding Extensions</a>
    */
  LOOP_DETECTED(508),
  /**
   * {@code 510 Not Extended}
   @see <a href="http://tools.ietf.org/html/rfc2774#section-7">HTTP Extension Framework</a>
   */
  NOT_EXTENDED(510);


  private final int value;


  private HttpStatus(int value) {
    this.value = value;
  }

  /**
   * Return the integer value of this status code.
   */
  public int value() {
    return this.value;
  }

  /**
   * Returns the HTTP status series of this status code.
   @see HttpStatus.Series
   */
  public Series series() {
    return Series.valueOf(this);
  }

  /**
   * Return a string representation of this status code.
   */
  @Override
  public String toString() {
    return Integer.toString(value);
  }


  /**
   * Return the enum constant of this type with the specified numeric value.
   @param statusCode the numeric value of the enum to be returned
   @return the enum constant with the specified numeric value
   @throws IllegalArgumentException if this enum has no constant for the specified numeric value
   */
  public static HttpStatus valueOf(int statusCode) {
    for (HttpStatus status : values()) {
      if (status.value == statusCode) {
        return status;
      }
    }
    throw new IllegalArgumentException("No matching constant for [" + statusCode + "]");
  }


  /**
   * Java 5 enumeration of HTTP status series.
   <p>Retrievable via {@link HttpStatus#series()}.
   */
  public static enum Series {

    INFORMATIONAL(1),
    SUCCESSFUL(2),
    REDIRECTION(3),
    CLIENT_ERROR(4),
    SERVER_ERROR(5);

    private final int value;

    private Series(int value) {
      this.value = value;
    }

    /**
     * Return the integer value of this status series. Ranges from 1 to 5.
     */
    public int value() {
      return this.value;
    }

    private static Series valueOf(HttpStatus status) {
      int seriesCode = status.value() 100;
      for (Series series : values()) {
        if (series.value == seriesCode) {
          return series;
        }
      }
      throw new IllegalArgumentException("No matching constant for [" + status + "]");
    }

  }

}