org.springframework.http.HttpStatus Maven / Gradle / Ivy
/*
* Copyright 2002-2023 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
*
* https://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;
import org.springframework.lang.Nullable;
/**
* Enumeration of HTTP status codes.
*
* The HTTP status code series can be retrieved via {@link #series()}.
*
* @author Arjen Poutsma
* @author Sebastien Deleuze
* @author Brian Clozel
* @since 3.0
* @see HttpStatus.Series
* @see HTTP Status Code Registry
* @see List of HTTP status codes - Wikipedia
*/
public enum HttpStatus implements HttpStatusCode {
// 1xx Informational
/**
* {@code 100 Continue}.
* @see HTTP/1.1: Semantics and Content, section 6.2.1
*/
CONTINUE(100, Series.INFORMATIONAL, "Continue"),
/**
* {@code 101 Switching Protocols}.
* @see HTTP/1.1: Semantics and Content, section 6.2.2
*/
SWITCHING_PROTOCOLS(101, Series.INFORMATIONAL, "Switching Protocols"),
/**
* {@code 102 Processing}.
* @see WebDAV
*/
PROCESSING(102, Series.INFORMATIONAL, "Processing"),
/**
* {@code 103 Early Hints}.
* @see An HTTP Status Code for Indicating Hints
* @since 6.0.5
*/
EARLY_HINTS(103, Series.INFORMATIONAL, "Early Hints"),
/**
* {@code 103 Checkpoint}.
* @see A proposal for supporting
* resumable POST/PUT HTTP requests in HTTP/1.0
* @deprecated in favor of {@link #EARLY_HINTS} which will be returned from {@code HttpStatus.valueOf(103)}
*/
@Deprecated(since = "6.0.5")
CHECKPOINT(103, Series.INFORMATIONAL, "Checkpoint"),
// 2xx Success
/**
* {@code 200 OK}.
* @see HTTP/1.1: Semantics and Content, section 6.3.1
*/
OK(200, Series.SUCCESSFUL, "OK"),
/**
* {@code 201 Created}.
* @see HTTP/1.1: Semantics and Content, section 6.3.2
*/
CREATED(201, Series.SUCCESSFUL, "Created"),
/**
* {@code 202 Accepted}.
* @see HTTP/1.1: Semantics and Content, section 6.3.3
*/
ACCEPTED(202, Series.SUCCESSFUL, "Accepted"),
/**
* {@code 203 Non-Authoritative Information}.
* @see HTTP/1.1: Semantics and Content, section 6.3.4
*/
NON_AUTHORITATIVE_INFORMATION(203, Series.SUCCESSFUL, "Non-Authoritative Information"),
/**
* {@code 204 No Content}.
* @see HTTP/1.1: Semantics and Content, section 6.3.5
*/
NO_CONTENT(204, Series.SUCCESSFUL, "No Content"),
/**
* {@code 205 Reset Content}.
* @see HTTP/1.1: Semantics and Content, section 6.3.6
*/
RESET_CONTENT(205, Series.SUCCESSFUL, "Reset Content"),
/**
* {@code 206 Partial Content}.
* @see HTTP/1.1: Range Requests, section 4.1
*/
PARTIAL_CONTENT(206, Series.SUCCESSFUL, "Partial Content"),
/**
* {@code 207 Multi-Status}.
* @see WebDAV
*/
MULTI_STATUS(207, Series.SUCCESSFUL, "Multi-Status"),
/**
* {@code 208 Already Reported}.
* @see WebDAV Binding Extensions
*/
ALREADY_REPORTED(208, Series.SUCCESSFUL, "Already Reported"),
/**
* {@code 226 IM Used}.
* @see Delta encoding in HTTP
*/
IM_USED(226, Series.SUCCESSFUL, "IM Used"),
// 3xx Redirection
/**
* {@code 300 Multiple Choices}.
* @see HTTP/1.1: Semantics and Content, section 6.4.1
*/
MULTIPLE_CHOICES(300, Series.REDIRECTION, "Multiple Choices"),
/**
* {@code 301 Moved Permanently}.
* @see HTTP/1.1: Semantics and Content, section 6.4.2
*/
MOVED_PERMANENTLY(301, Series.REDIRECTION, "Moved Permanently"),
/**
* {@code 302 Found}.
* @see HTTP/1.1: Semantics and Content, section 6.4.3
*/
FOUND(302, Series.REDIRECTION, "Found"),
/**
* {@code 302 Moved Temporarily}.
* @see HTTP/1.0, section 9.3
* @deprecated in favor of {@link #FOUND} which will be returned from {@code HttpStatus.valueOf(302)}
*/
@Deprecated
MOVED_TEMPORARILY(302, Series.REDIRECTION, "Moved Temporarily"),
/**
* {@code 303 See Other}.
* @see HTTP/1.1: Semantics and Content, section 6.4.4
*/
SEE_OTHER(303, Series.REDIRECTION, "See Other"),
/**
* {@code 304 Not Modified}.
* @see HTTP/1.1: Conditional Requests, section 4.1
*/
NOT_MODIFIED(304, Series.REDIRECTION, "Not Modified"),
/**
* {@code 305 Use Proxy}.
* @see HTTP/1.1: Semantics and Content, section 6.4.5
* @deprecated due to security concerns regarding in-band configuration of a proxy
*/
@Deprecated
USE_PROXY(305, Series.REDIRECTION, "Use Proxy"),
/**
* {@code 307 Temporary Redirect}.
* @see HTTP/1.1: Semantics and Content, section 6.4.7
*/
TEMPORARY_REDIRECT(307, Series.REDIRECTION, "Temporary Redirect"),
/**
* {@code 308 Permanent Redirect}.
* @see RFC 7238
*/
PERMANENT_REDIRECT(308, Series.REDIRECTION, "Permanent Redirect"),
// --- 4xx Client Error ---
/**
* {@code 400 Bad Request}.
* @see HTTP/1.1: Semantics and Content, section 6.5.1
*/
BAD_REQUEST(400, Series.CLIENT_ERROR, "Bad Request"),
/**
* {@code 401 Unauthorized}.
* @see HTTP/1.1: Authentication, section 3.1
*/
UNAUTHORIZED(401, Series.CLIENT_ERROR, "Unauthorized"),
/**
* {@code 402 Payment Required}.
* @see HTTP/1.1: Semantics and Content, section 6.5.2
*/
PAYMENT_REQUIRED(402, Series.CLIENT_ERROR, "Payment Required"),
/**
* {@code 403 Forbidden}.
* @see HTTP/1.1: Semantics and Content, section 6.5.3
*/
FORBIDDEN(403, Series.CLIENT_ERROR, "Forbidden"),
/**
* {@code 404 Not Found}.
* @see HTTP/1.1: Semantics and Content, section 6.5.4
*/
NOT_FOUND(404, Series.CLIENT_ERROR, "Not Found"),
/**
* {@code 405 Method Not Allowed}.
* @see HTTP/1.1: Semantics and Content, section 6.5.5
*/
METHOD_NOT_ALLOWED(405, Series.CLIENT_ERROR, "Method Not Allowed"),
/**
* {@code 406 Not Acceptable}.
* @see HTTP/1.1: Semantics and Content, section 6.5.6
*/
NOT_ACCEPTABLE(406, Series.CLIENT_ERROR, "Not Acceptable"),
/**
* {@code 407 Proxy Authentication Required}.
* @see HTTP/1.1: Authentication, section 3.2
*/
PROXY_AUTHENTICATION_REQUIRED(407, Series.CLIENT_ERROR, "Proxy Authentication Required"),
/**
* {@code 408 Request Timeout}.
* @see HTTP/1.1: Semantics and Content, section 6.5.7
*/
REQUEST_TIMEOUT(408, Series.CLIENT_ERROR, "Request Timeout"),
/**
* {@code 409 Conflict}.
* @see HTTP/1.1: Semantics and Content, section 6.5.8
*/
CONFLICT(409, Series.CLIENT_ERROR, "Conflict"),
/**
* {@code 410 Gone}.
* @see
* HTTP/1.1: Semantics and Content, section 6.5.9
*/
GONE(410, Series.CLIENT_ERROR, "Gone"),
/**
* {@code 411 Length Required}.
* @see
* HTTP/1.1: Semantics and Content, section 6.5.10
*/
LENGTH_REQUIRED(411, Series.CLIENT_ERROR, "Length Required"),
/**
* {@code 412 Precondition failed}.
* @see
* HTTP/1.1: Conditional Requests, section 4.2
*/
PRECONDITION_FAILED(412, Series.CLIENT_ERROR, "Precondition Failed"),
/**
* {@code 413 Payload Too Large}.
* @since 4.1
* @see
* HTTP/1.1: Semantics and Content, section 6.5.11
*/
PAYLOAD_TOO_LARGE(413, Series.CLIENT_ERROR, "Payload Too Large"),
/**
* {@code 413 Request Entity Too Large}.
* @see HTTP/1.1, section 10.4.14
* @deprecated in favor of {@link #PAYLOAD_TOO_LARGE} which will be
* returned from {@code HttpStatus.valueOf(413)}
*/
@Deprecated
REQUEST_ENTITY_TOO_LARGE(413, Series.CLIENT_ERROR, "Request Entity Too Large"),
/**
* {@code 414 URI Too Long}.
* @since 4.1
* @see
* HTTP/1.1: Semantics and Content, section 6.5.12
*/
URI_TOO_LONG(414, Series.CLIENT_ERROR, "URI Too Long"),
/**
* {@code 414 Request-URI Too Long}.
* @see HTTP/1.1, section 10.4.15
* @deprecated in favor of {@link #URI_TOO_LONG} which will be returned from {@code HttpStatus.valueOf(414)}
*/
@Deprecated
REQUEST_URI_TOO_LONG(414, Series.CLIENT_ERROR, "Request-URI Too Long"),
/**
* {@code 415 Unsupported Media Type}.
* @see
* HTTP/1.1: Semantics and Content, section 6.5.13
*/
UNSUPPORTED_MEDIA_TYPE(415, Series.CLIENT_ERROR, "Unsupported Media Type"),
/**
* {@code 416 Requested Range Not Satisfiable}.
* @see HTTP/1.1: Range Requests, section 4.4
*/
REQUESTED_RANGE_NOT_SATISFIABLE(416, Series.CLIENT_ERROR, "Requested range not satisfiable"),
/**
* {@code 417 Expectation Failed}.
* @see
* HTTP/1.1: Semantics and Content, section 6.5.14
*/
EXPECTATION_FAILED(417, Series.CLIENT_ERROR, "Expectation Failed"),
/**
* {@code 418 I'm a teapot}.
* @see HTCPCP/1.0
*/
I_AM_A_TEAPOT(418, Series.CLIENT_ERROR, "I'm a teapot"),
/**
* @deprecated See
*
* WebDAV Draft Changes
*/
@Deprecated
INSUFFICIENT_SPACE_ON_RESOURCE(419, Series.CLIENT_ERROR, "Insufficient Space On Resource"),
/**
* @deprecated See
*
* WebDAV Draft Changes
*/
@Deprecated
METHOD_FAILURE(420, Series.CLIENT_ERROR, "Method Failure"),
/**
* @deprecated
* See
* WebDAV Draft Changes
*/
@Deprecated
DESTINATION_LOCKED(421, Series.CLIENT_ERROR, "Destination Locked"),
/**
* {@code 422 Unprocessable Entity}.
* @see WebDAV
*/
UNPROCESSABLE_ENTITY(422, Series.CLIENT_ERROR, "Unprocessable Entity"),
/**
* {@code 423 Locked}.
* @see WebDAV
*/
LOCKED(423, Series.CLIENT_ERROR, "Locked"),
/**
* {@code 424 Failed Dependency}.
* @see WebDAV
*/
FAILED_DEPENDENCY(424, Series.CLIENT_ERROR, "Failed Dependency"),
/**
* {@code 425 Too Early}.
* @since 5.2
* @see RFC 8470
*/
TOO_EARLY(425, Series.CLIENT_ERROR, "Too Early"),
/**
* {@code 426 Upgrade Required}.
* @see Upgrading to TLS Within HTTP/1.1
*/
UPGRADE_REQUIRED(426, Series.CLIENT_ERROR, "Upgrade Required"),
/**
* {@code 428 Precondition Required}.
* @see Additional HTTP Status Codes
*/
PRECONDITION_REQUIRED(428, Series.CLIENT_ERROR, "Precondition Required"),
/**
* {@code 429 Too Many Requests}.
* @see Additional HTTP Status Codes
*/
TOO_MANY_REQUESTS(429, Series.CLIENT_ERROR, "Too Many Requests"),
/**
* {@code 431 Request Header Fields Too Large}.
* @see Additional HTTP Status Codes
*/
REQUEST_HEADER_FIELDS_TOO_LARGE(431, Series.CLIENT_ERROR, "Request Header Fields Too Large"),
/**
* {@code 451 Unavailable For Legal Reasons}.
* @see
* An HTTP Status Code to Report Legal Obstacles
* @since 4.3
*/
UNAVAILABLE_FOR_LEGAL_REASONS(451, Series.CLIENT_ERROR, "Unavailable For Legal Reasons"),
// --- 5xx Server Error ---
/**
* {@code 500 Internal Server Error}.
* @see HTTP/1.1: Semantics and Content, section 6.6.1
*/
INTERNAL_SERVER_ERROR(500, Series.SERVER_ERROR, "Internal Server Error"),
/**
* {@code 501 Not Implemented}.
* @see HTTP/1.1: Semantics and Content, section 6.6.2
*/
NOT_IMPLEMENTED(501, Series.SERVER_ERROR, "Not Implemented"),
/**
* {@code 502 Bad Gateway}.
* @see HTTP/1.1: Semantics and Content, section 6.6.3
*/
BAD_GATEWAY(502, Series.SERVER_ERROR, "Bad Gateway"),
/**
* {@code 503 Service Unavailable}.
* @see HTTP/1.1: Semantics and Content, section 6.6.4
*/
SERVICE_UNAVAILABLE(503, Series.SERVER_ERROR, "Service Unavailable"),
/**
* {@code 504 Gateway Timeout}.
* @see HTTP/1.1: Semantics and Content, section 6.6.5
*/
GATEWAY_TIMEOUT(504, Series.SERVER_ERROR, "Gateway Timeout"),
/**
* {@code 505 HTTP Version Not Supported}.
* @see HTTP/1.1: Semantics and Content, section 6.6.6
*/
HTTP_VERSION_NOT_SUPPORTED(505, Series.SERVER_ERROR, "HTTP Version not supported"),
/**
* {@code 506 Variant Also Negotiates}
* @see Transparent Content Negotiation
*/
VARIANT_ALSO_NEGOTIATES(506, Series.SERVER_ERROR, "Variant Also Negotiates"),
/**
* {@code 507 Insufficient Storage}
* @see WebDAV
*/
INSUFFICIENT_STORAGE(507, Series.SERVER_ERROR, "Insufficient Storage"),
/**
* {@code 508 Loop Detected}
* @see WebDAV Binding Extensions
*/
LOOP_DETECTED(508, Series.SERVER_ERROR, "Loop Detected"),
/**
* {@code 509 Bandwidth Limit Exceeded}
*/
BANDWIDTH_LIMIT_EXCEEDED(509, Series.SERVER_ERROR, "Bandwidth Limit Exceeded"),
/**
* {@code 510 Not Extended}
* @see HTTP Extension Framework
*/
NOT_EXTENDED(510, Series.SERVER_ERROR, "Not Extended"),
/**
* {@code 511 Network Authentication Required}.
* @see Additional HTTP Status Codes
*/
NETWORK_AUTHENTICATION_REQUIRED(511, Series.SERVER_ERROR, "Network Authentication Required");
private static final HttpStatus[] VALUES;
static {
VALUES = values();
}
private final int value;
private final Series series;
private final String reasonPhrase;
HttpStatus(int value, Series series, String reasonPhrase) {
this.value = value;
this.series = series;
this.reasonPhrase = reasonPhrase;
}
@Override
public int value() {
return this.value;
}
/**
* Return the HTTP status series of this status code.
* @see HttpStatus.Series
*/
public Series series() {
return this.series;
}
/**
* Return the reason phrase of this status code.
*/
public String getReasonPhrase() {
return this.reasonPhrase;
}
@Override
public boolean is1xxInformational() {
return (series() == Series.INFORMATIONAL);
}
@Override
public boolean is2xxSuccessful() {
return (series() == Series.SUCCESSFUL);
}
@Override
public boolean is3xxRedirection() {
return (series() == Series.REDIRECTION);
}
@Override
public boolean is4xxClientError() {
return (series() == Series.CLIENT_ERROR);
}
@Override
public boolean is5xxServerError() {
return (series() == Series.SERVER_ERROR);
}
@Override
public boolean isError() {
return (is4xxClientError() || is5xxServerError());
}
/**
* Return a string representation of this status code.
*/
@Override
public String toString() {
return this.value + " " + name();
}
/**
* Return the {@code HttpStatus} enum constant 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) {
HttpStatus status = resolve(statusCode);
if (status == null) {
throw new IllegalArgumentException("No matching constant for [" + statusCode + "]");
}
return status;
}
/**
* Resolve the given status code to an {@code HttpStatus}, if possible.
* @param statusCode the HTTP status code (potentially non-standard)
* @return the corresponding {@code HttpStatus}, or {@code null} if not found
* @since 5.0
*/
@Nullable
public static HttpStatus resolve(int statusCode) {
// Use cached VALUES instead of values() to prevent array allocation.
for (HttpStatus status : VALUES) {
if (status.value == statusCode) {
return status;
}
}
return null;
}
/**
* Enumeration of HTTP status series.
*
Retrievable via {@link HttpStatus#series()}.
*/
public enum Series {
INFORMATIONAL(1),
SUCCESSFUL(2),
REDIRECTION(3),
CLIENT_ERROR(4),
SERVER_ERROR(5);
private final int value;
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;
}
/**
* Return the {@code Series} enum constant for the supplied {@code HttpStatus}.
* @param status a standard HTTP status enum constant
* @return the {@code Series} enum constant for the supplied {@code HttpStatus}
* @deprecated as of 5.3, in favor of invoking {@link HttpStatus#series()} directly
*/
@Deprecated
public static Series valueOf(HttpStatus status) {
return status.series;
}
/**
* Return the {@code Series} enum constant for the supplied status code.
* @param statusCode the HTTP status code (potentially non-standard)
* @return the {@code Series} enum constant for the supplied status code
* @throws IllegalArgumentException if this enum has no corresponding constant
*/
public static Series valueOf(int statusCode) {
Series series = resolve(statusCode);
if (series == null) {
throw new IllegalArgumentException("No matching constant for [" + statusCode + "]");
}
return series;
}
/**
* Resolve the given status code to an {@code HttpStatus.Series}, if possible.
* @param statusCode the HTTP status code (potentially non-standard)
* @return the corresponding {@code Series}, or {@code null} if not found
* @since 5.1.3
*/
@Nullable
public static Series resolve(int statusCode) {
int seriesCode = statusCode / 100;
for (Series series : values()) {
if (series.value == seriesCode) {
return series;
}
}
return null;
}
}
}