All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.springframework.http.HttpStatus Maven / Gradle / Ivy

There is a newer version: 6.1.13
Show newest version
/*
 * Copyright 2002-2013 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.
 *
 * 

The HTTP status code series can be retrieved via {@link #series()}. * * @author Arjen Poutsma * @see HttpStatus.Series * @see HTTP Status Code Registry * @see List of HTTP status codes - Wikipedia */ public enum HttpStatus { // 1xx Informational /** * {@code 100 Continue}. * @see HTTP/1.1 */ CONTINUE(100, "Continue"), /** * {@code 101 Switching Protocols}. * @see HTTP/1.1 */ SWITCHING_PROTOCOLS(101, "Switching Protocols"), /** * {@code 102 Processing}. * @see WebDAV */ PROCESSING(102, "Processing"), /** * {@code 103 Checkpoint}. * @see A proposal for supporting * resumable POST/PUT HTTP requests in HTTP/1.0 */ CHECKPOINT(103, "Checkpoint"), // 2xx Success /** * {@code 200 OK}. * @see HTTP/1.1 */ OK(200, "OK"), /** * {@code 201 Created}. * @see HTTP/1.1 */ CREATED(201, "Created"), /** * {@code 202 Accepted}. * @see HTTP/1.1 */ ACCEPTED(202, "Accepted"), /** * {@code 203 Non-Authoritative Information}. * @see HTTP/1.1 */ NON_AUTHORITATIVE_INFORMATION(203, "Non-Authoritative Information"), /** * {@code 204 No Content}. * @see HTTP/1.1 */ NO_CONTENT(204, "No Content"), /** * {@code 205 Reset Content}. * @see HTTP/1.1 */ RESET_CONTENT(205, "Reset Content"), /** * {@code 206 Partial Content}. * @see HTTP/1.1 */ PARTIAL_CONTENT(206, "Partial Content"), /** * {@code 207 Multi-Status}. * @see WebDAV */ MULTI_STATUS(207, "Multi-Status"), /** * {@code 208 Already Reported}. * @see WebDAV Binding Extensions */ ALREADY_REPORTED(208, "Already Reported"), /** * {@code 226 IM Used}. * @see Delta encoding in HTTP */ IM_USED(226, "IM Used"), // 3xx Redirection /** * {@code 300 Multiple Choices}. * @see HTTP/1.1 */ MULTIPLE_CHOICES(300, "Multiple Choices"), /** * {@code 301 Moved Permanently}. * @see HTTP/1.1 */ MOVED_PERMANENTLY(301, "Moved Permanently"), /** * {@code 302 Found}. * @see HTTP/1.1 */ FOUND(302, "Found"), /** * {@code 302 Moved Temporarily}. * @see HTTP/1.0 * @deprecated In favor of {@link #FOUND} which will be returned from {@code HttpStatus.valueOf(302)} */ @Deprecated MOVED_TEMPORARILY(302, "Moved Temporarily"), /** * {@code 303 See Other}. * @see HTTP/1.1 */ SEE_OTHER(303, "See Other"), /** * {@code 304 Not Modified}. * @see HTTP/1.1 */ NOT_MODIFIED(304, "Not Modified"), /** * {@code 305 Use Proxy}. * @see HTTP/1.1 */ USE_PROXY(305, "Use Proxy"), /** * {@code 307 Temporary Redirect}. * @see HTTP/1.1 */ TEMPORARY_REDIRECT(307, "Temporary Redirect"), /** * {@code 308 Resume Incomplete}. * @see A proposal for supporting * resumable POST/PUT HTTP requests in HTTP/1.0 */ RESUME_INCOMPLETE(308, "Resume Incomplete"), // --- 4xx Client Error --- /** * {@code 400 Bad Request}. * @see HTTP/1.1 */ BAD_REQUEST(400, "Bad Request"), /** * {@code 401 Unauthorized}. * @see HTTP/1.1 */ UNAUTHORIZED(401, "Unauthorized"), /** * {@code 402 Payment Required}. * @see HTTP/1.1 */ PAYMENT_REQUIRED(402, "Payment Required"), /** * {@code 403 Forbidden}. * @see HTTP/1.1 */ FORBIDDEN(403, "Forbidden"), /** * {@code 404 Not Found}. * @see HTTP/1.1 */ NOT_FOUND(404, "Not Found"), /** * {@code 405 Method Not Allowed}. * @see HTTP/1.1 */ METHOD_NOT_ALLOWED(405, "Method Not Allowed"), /** * {@code 406 Not Acceptable}. * @see HTTP/1.1 */ NOT_ACCEPTABLE(406, "Not Acceptable"), /** * {@code 407 Proxy Authentication Required}. * @see HTTP/1.1 */ PROXY_AUTHENTICATION_REQUIRED(407, "Proxy Authentication Required"), /** * {@code 408 Request Timeout}. * @see HTTP/1.1 */ REQUEST_TIMEOUT(408, "Request Timeout"), /** * {@code 409 Conflict}. * @see HTTP/1.1 */ CONFLICT(409, "Conflict"), /** * {@code 410 Gone}. * @see HTTP/1.1 */ GONE(410, "Gone"), /** * {@code 411 Length Required}. * @see HTTP/1.1 */ LENGTH_REQUIRED(411, "Length Required"), /** * {@code 412 Precondition failed}. * @see HTTP/1.1 */ PRECONDITION_FAILED(412, "Precondition Failed"), /** * {@code 413 Request Entity Too Large}. * @see HTTP/1.1 */ REQUEST_ENTITY_TOO_LARGE(413, "Request Entity Too Large"), /** * {@code 414 Request-URI Too Long}. * @see HTTP/1.1 */ REQUEST_URI_TOO_LONG(414, "Request-URI Too Long"), /** * {@code 415 Unsupported Media Type}. * @see HTTP/1.1 */ UNSUPPORTED_MEDIA_TYPE(415, "Unsupported Media Type"), /** * {@code 416 Requested Range Not Satisfiable}. * @see HTTP/1.1 */ REQUESTED_RANGE_NOT_SATISFIABLE(416, "Requested range not satisfiable"), /** * {@code 417 Expectation Failed}. * @see HTTP/1.1 */ EXPECTATION_FAILED(417, "Expectation Failed"), /** * {@code 418 I'm a teapot}. * @see HTCPCP/1.0 */ I_AM_A_TEAPOT(418, "I'm a teapot"), /** * @deprecated See WebDAV Draft Changes */ @Deprecated INSUFFICIENT_SPACE_ON_RESOURCE(419, "Insufficient Space On Resource"), /** * @deprecated See WebDAV Draft Changes */ @Deprecated METHOD_FAILURE(420, "Method Failure"), /** * @deprecated See WebDAV Draft Changes */ @Deprecated DESTINATION_LOCKED(421, "Destination Locked"), /** * {@code 422 Unprocessable Entity}. * @see WebDAV */ UNPROCESSABLE_ENTITY(422, "Unprocessable Entity"), /** * {@code 423 Locked}. * @see WebDAV */ LOCKED(423, "Locked"), /** * {@code 424 Failed Dependency}. * @see WebDAV */ FAILED_DEPENDENCY(424, "Failed Dependency"), /** * {@code 426 Upgrade Required}. * @see Upgrading to TLS Within HTTP/1.1 */ UPGRADE_REQUIRED(426, "Upgrade Required"), /** * {@code 428 Precondition Required}. * @see Additional HTTP Status Codes */ PRECONDITION_REQUIRED(428, "Precondition Required"), /** * {@code 429 Too Many Requests}. * @see Additional HTTP Status Codes */ TOO_MANY_REQUESTS(429, "Too Many Requests"), /** * {@code 431 Request Header Fields Too Large}. * @see Additional HTTP Status Codes */ REQUEST_HEADER_FIELDS_TOO_LARGE(431, "Request Header Fields Too Large"), // --- 5xx Server Error --- /** * {@code 500 Internal Server Error}. * @see HTTP/1.1 */ INTERNAL_SERVER_ERROR(500, "Internal Server Error"), /** * {@code 501 Not Implemented}. * @see HTTP/1.1 */ NOT_IMPLEMENTED(501, "Not Implemented"), /** * {@code 502 Bad Gateway}. * @see HTTP/1.1 */ BAD_GATEWAY(502, "Bad Gateway"), /** * {@code 503 Service Unavailable}. * @see HTTP/1.1 */ SERVICE_UNAVAILABLE(503, "Service Unavailable"), /** * {@code 504 Gateway Timeout}. * @see HTTP/1.1 */ GATEWAY_TIMEOUT(504, "Gateway Timeout"), /** * {@code 505 HTTP Version Not Supported}. * @see HTTP/1.1 */ HTTP_VERSION_NOT_SUPPORTED(505, "HTTP Version not supported"), /** * {@code 506 Variant Also Negotiates} * @see Transparent Content Negotiation */ VARIANT_ALSO_NEGOTIATES(506, "Variant Also Negotiates"), /** * {@code 507 Insufficient Storage} * @see WebDAV */ INSUFFICIENT_STORAGE(507, "Insufficient Storage"), /** * {@code 508 Loop Detected} * @see WebDAV Binding Extensions */ LOOP_DETECTED(508, "Loop Detected"), /** * {@code 509 Bandwidth Limit Exceeded} */ BANDWIDTH_LIMIT_EXCEEDED(509, "Bandwidth Limit Exceeded"), /** * {@code 510 Not Extended} * @see HTTP Extension Framework */ NOT_EXTENDED(510, "Not Extended"), /** * {@code 511 Network Authentication Required}. * @see Additional HTTP Status Codes */ NETWORK_AUTHENTICATION_REQUIRED(511, "Network Authentication Required"); private final int value; private final String reasonPhrase; private HttpStatus(int value, String reasonPhrase) { this.value = value; this.reasonPhrase = reasonPhrase; } /** * Return the integer value of this status code. */ public int value() { return this.value; } /** * Return the reason phrase of this status code. */ public String getReasonPhrase() { return reasonPhrase; } /** * 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. *

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; } public static Series valueOf(int status) { int seriesCode = status / 100; for (Series series : values()) { if (series.value == seriesCode) { return series; } } throw new IllegalArgumentException("No matching constant for [" + status + "]"); } public static Series valueOf(HttpStatus status) { return valueOf(status.value); } } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy