/*
 * Copyright 2002-2019 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 series().

Author:Arjen Poutsma, Sebastien Deleuze, Brian Clozel
See Also:
Since:3.0
/** * Enumeration of HTTP status codes. * * <p>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 <a href="https://www.iana.org/assignments/http-status-codes">HTTP Status Code Registry</a> * @see <a href="https://en.wikipedia.org/wiki/List_of_HTTP_status_codes">List of HTTP status codes - Wikipedia</a> */
public enum HttpStatus { // 1xx Informational
100 Continue.
See Also:
/** * {@code 100 Continue}. * @see <a href="https://tools.ietf.org/html/rfc7231#section-6.2.1">HTTP/1.1: Semantics and Content, section 6.2.1</a> */
CONTINUE(100, Series.INFORMATIONAL, "Continue"),
101 Switching Protocols.
See Also:
/** * {@code 101 Switching Protocols}. * @see <a href="https://tools.ietf.org/html/rfc7231#section-6.2.2">HTTP/1.1: Semantics and Content, section 6.2.2</a> */
SWITCHING_PROTOCOLS(101, Series.INFORMATIONAL, "Switching Protocols"),
102 Processing.
See Also:
/** * {@code 102 Processing}. * @see <a href="https://tools.ietf.org/html/rfc2518#section-10.1">WebDAV</a> */
PROCESSING(102, Series.INFORMATIONAL, "Processing"),
103 Checkpoint.
See Also:
/** * {@code 103 Checkpoint}. * @see <a href="https://code.google.com/p/gears/wiki/ResumableHttpRequestsProposal">A proposal for supporting * resumable POST/PUT HTTP requests in HTTP/1.0</a> */
CHECKPOINT(103, Series.INFORMATIONAL, "Checkpoint"), // 2xx Success
200 OK.
See Also:
/** * {@code 200 OK}. * @see <a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">HTTP/1.1: Semantics and Content, section 6.3.1</a> */
OK(200, Series.SUCCESSFUL, "OK"),
201 Created.
See Also:
/** * {@code 201 Created}. * @see <a href="https://tools.ietf.org/html/rfc7231#section-6.3.2">HTTP/1.1: Semantics and Content, section 6.3.2</a> */
CREATED(201, Series.SUCCESSFUL, "Created"),
202 Accepted.
See Also:
/** * {@code 202 Accepted}. * @see <a href="https://tools.ietf.org/html/rfc7231#section-6.3.3">HTTP/1.1: Semantics and Content, section 6.3.3</a> */
ACCEPTED(202, Series.SUCCESSFUL, "Accepted"),
203 Non-Authoritative Information.
See Also:
/** * {@code 203 Non-Authoritative Information}. * @see <a href="https://tools.ietf.org/html/rfc7231#section-6.3.4">HTTP/1.1: Semantics and Content, section 6.3.4</a> */
NON_AUTHORITATIVE_INFORMATION(203, Series.SUCCESSFUL, "Non-Authoritative Information"),
204 No Content.
See Also:
/** * {@code 204 No Content}. * @see <a href="https://tools.ietf.org/html/rfc7231#section-6.3.5">HTTP/1.1: Semantics and Content, section 6.3.5</a> */
NO_CONTENT(204, Series.SUCCESSFUL, "No Content"),
205 Reset Content.
See Also:
/** * {@code 205 Reset Content}. * @see <a href="https://tools.ietf.org/html/rfc7231#section-6.3.6">HTTP/1.1: Semantics and Content, section 6.3.6</a> */
RESET_CONTENT(205, Series.SUCCESSFUL, "Reset Content"),
206 Partial Content.
See Also:
/** * {@code 206 Partial Content}. * @see <a href="https://tools.ietf.org/html/rfc7233#section-4.1">HTTP/1.1: Range Requests, section 4.1</a> */
PARTIAL_CONTENT(206, Series.SUCCESSFUL, "Partial Content"),
207 Multi-Status.
See Also:
/** * {@code 207 Multi-Status}. * @see <a href="https://tools.ietf.org/html/rfc4918#section-13">WebDAV</a> */
MULTI_STATUS(207, Series.SUCCESSFUL, "Multi-Status"),
208 Already Reported.
See Also:
/** * {@code 208 Already Reported}. * @see <a href="https://tools.ietf.org/html/rfc5842#section-7.1">WebDAV Binding Extensions</a> */
ALREADY_REPORTED(208, Series.SUCCESSFUL, "Already Reported"),
226 IM Used.
See Also:
/** * {@code 226 IM Used}. * @see <a href="https://tools.ietf.org/html/rfc3229#section-10.4.1">Delta encoding in HTTP</a> */
IM_USED(226, Series.SUCCESSFUL, "IM Used"), // 3xx Redirection
300 Multiple Choices.
See Also:
/** * {@code 300 Multiple Choices}. * @see <a href="https://tools.ietf.org/html/rfc7231#section-6.4.1">HTTP/1.1: Semantics and Content, section 6.4.1</a> */
MULTIPLE_CHOICES(300, Series.REDIRECTION, "Multiple Choices"),
301 Moved Permanently.
See Also:
/** * {@code 301 Moved Permanently}. * @see <a href="https://tools.ietf.org/html/rfc7231#section-6.4.2">HTTP/1.1: Semantics and Content, section 6.4.2</a> */
MOVED_PERMANENTLY(301, Series.REDIRECTION, "Moved Permanently"),
302 Found.
See Also:
/** * {@code 302 Found}. * @see <a href="https://tools.ietf.org/html/rfc7231#section-6.4.3">HTTP/1.1: Semantics and Content, section 6.4.3</a> */
FOUND(302, Series.REDIRECTION, "Found"),
302 Moved Temporarily.
See Also:
Deprecated:in favor of FOUND which will be returned from HttpStatus.valueOf(302)
/** * {@code 302 Moved Temporarily}. * @see <a href="https://tools.ietf.org/html/rfc1945#section-9.3">HTTP/1.0, section 9.3</a> * @deprecated in favor of {@link #FOUND} which will be returned from {@code HttpStatus.valueOf(302)} */
@Deprecated MOVED_TEMPORARILY(302, Series.REDIRECTION, "Moved Temporarily"),
303 See Other.
See Also:
/** * {@code 303 See Other}. * @see <a href="https://tools.ietf.org/html/rfc7231#section-6.4.4">HTTP/1.1: Semantics and Content, section 6.4.4</a> */
SEE_OTHER(303, Series.REDIRECTION, "See Other"),
304 Not Modified.
See Also:
/** * {@code 304 Not Modified}. * @see <a href="https://tools.ietf.org/html/rfc7232#section-4.1">HTTP/1.1: Conditional Requests, section 4.1</a> */
NOT_MODIFIED(304, Series.REDIRECTION, "Not Modified"),
305 Use Proxy.
See Also:
Deprecated:due to security concerns regarding in-band configuration of a proxy
/** * {@code 305 Use Proxy}. * @see <a href="https://tools.ietf.org/html/rfc7231#section-6.4.5">HTTP/1.1: Semantics and Content, section 6.4.5</a> * @deprecated due to security concerns regarding in-band configuration of a proxy */
@Deprecated USE_PROXY(305, Series.REDIRECTION, "Use Proxy"),
307 Temporary Redirect.
See Also:
/** * {@code 307 Temporary Redirect}. * @see <a href="https://tools.ietf.org/html/rfc7231#section-6.4.7">HTTP/1.1: Semantics and Content, section 6.4.7</a> */
TEMPORARY_REDIRECT(307, Series.REDIRECTION, "Temporary Redirect"),
308 Permanent Redirect.
See Also:
/** * {@code 308 Permanent Redirect}. * @see <a href="https://tools.ietf.org/html/rfc7238">RFC 7238</a> */
PERMANENT_REDIRECT(308, Series.REDIRECTION, "Permanent Redirect"), // --- 4xx Client Error ---
400 Bad Request.
See Also:
/** * {@code 400 Bad Request}. * @see <a href="https://tools.ietf.org/html/rfc7231#section-6.5.1">HTTP/1.1: Semantics and Content, section 6.5.1</a> */
BAD_REQUEST(400, Series.CLIENT_ERROR, "Bad Request"),
401 Unauthorized.
See Also:
/** * {@code 401 Unauthorized}. * @see <a href="https://tools.ietf.org/html/rfc7235#section-3.1">HTTP/1.1: Authentication, section 3.1</a> */
UNAUTHORIZED(401, Series.CLIENT_ERROR, "Unauthorized"),
402 Payment Required.
See Also:
/** * {@code 402 Payment Required}. * @see <a href="https://tools.ietf.org/html/rfc7231#section-6.5.2">HTTP/1.1: Semantics and Content, section 6.5.2</a> */
PAYMENT_REQUIRED(402, Series.CLIENT_ERROR, "Payment Required"),
403 Forbidden.
See Also:
/** * {@code 403 Forbidden}. * @see <a href="https://tools.ietf.org/html/rfc7231#section-6.5.3">HTTP/1.1: Semantics and Content, section 6.5.3</a> */
FORBIDDEN(403, Series.CLIENT_ERROR, "Forbidden"),
404 Not Found.
See Also:
/** * {@code 404 Not Found}. * @see <a href="https://tools.ietf.org/html/rfc7231#section-6.5.4">HTTP/1.1: Semantics and Content, section 6.5.4</a> */
NOT_FOUND(404, Series.CLIENT_ERROR, "Not Found"),
405 Method Not Allowed.
See Also:
/** * {@code 405 Method Not Allowed}. * @see <a href="https://tools.ietf.org/html/rfc7231#section-6.5.5">HTTP/1.1: Semantics and Content, section 6.5.5</a> */
METHOD_NOT_ALLOWED(405, Series.CLIENT_ERROR, "Method Not Allowed"),
406 Not Acceptable.
See Also:
/** * {@code 406 Not Acceptable}. * @see <a href="https://tools.ietf.org/html/rfc7231#section-6.5.6">HTTP/1.1: Semantics and Content, section 6.5.6</a> */
NOT_ACCEPTABLE(406, Series.CLIENT_ERROR, "Not Acceptable"),
407 Proxy Authentication Required.
See Also:
/** * {@code 407 Proxy Authentication Required}. * @see <a href="https://tools.ietf.org/html/rfc7235#section-3.2">HTTP/1.1: Authentication, section 3.2</a> */
PROXY_AUTHENTICATION_REQUIRED(407, Series.CLIENT_ERROR, "Proxy Authentication Required"),
408 Request Timeout.
See Also:
/** * {@code 408 Request Timeout}. * @see <a href="https://tools.ietf.org/html/rfc7231#section-6.5.7">HTTP/1.1: Semantics and Content, section 6.5.7</a> */
REQUEST_TIMEOUT(408, Series.CLIENT_ERROR, "Request Timeout"),
409 Conflict.
See Also:
/** * {@code 409 Conflict}. * @see <a href="https://tools.ietf.org/html/rfc7231#section-6.5.8">HTTP/1.1: Semantics and Content, section 6.5.8</a> */
CONFLICT(409, Series.CLIENT_ERROR, "Conflict"),
410 Gone.
See Also:
/** * {@code 410 Gone}. * @see <a href="https://tools.ietf.org/html/rfc7231#section-6.5.9"> * HTTP/1.1: Semantics and Content, section 6.5.9</a> */
GONE(410, Series.CLIENT_ERROR, "Gone"),
411 Length Required.
See Also:
/** * {@code 411 Length Required}. * @see <a href="https://tools.ietf.org/html/rfc7231#section-6.5.10"> * HTTP/1.1: Semantics and Content, section 6.5.10</a> */
LENGTH_REQUIRED(411, Series.CLIENT_ERROR, "Length Required"),
412 Precondition failed.
See Also:
/** * {@code 412 Precondition failed}. * @see <a href="https://tools.ietf.org/html/rfc7232#section-4.2"> * HTTP/1.1: Conditional Requests, section 4.2</a> */
PRECONDITION_FAILED(412, Series.CLIENT_ERROR, "Precondition Failed"),
413 Payload Too Large.
See Also:
Since:4.1
/** * {@code 413 Payload Too Large}. * @since 4.1 * @see <a href="https://tools.ietf.org/html/rfc7231#section-6.5.11"> * HTTP/1.1: Semantics and Content, section 6.5.11</a> */
PAYLOAD_TOO_LARGE(413, Series.CLIENT_ERROR, "Payload Too Large"),
413 Request Entity Too Large.
See Also:
Deprecated:in favor of PAYLOAD_TOO_LARGE which will be returned from HttpStatus.valueOf(413)
/** * {@code 413 Request Entity Too Large}. * @see <a href="https://tools.ietf.org/html/rfc2616#section-10.4.14">HTTP/1.1, section 10.4.14</a> * @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"),
414 URI Too Long.
See Also:
Since:4.1
/** * {@code 414 URI Too Long}. * @since 4.1 * @see <a href="https://tools.ietf.org/html/rfc7231#section-6.5.12"> * HTTP/1.1: Semantics and Content, section 6.5.12</a> */
URI_TOO_LONG(414, Series.CLIENT_ERROR, "URI Too Long"),
414 Request-URI Too Long.
See Also:
Deprecated:in favor of URI_TOO_LONG which will be returned from HttpStatus.valueOf(414)
/** * {@code 414 Request-URI Too Long}. * @see <a href="https://tools.ietf.org/html/rfc2616#section-10.4.15">HTTP/1.1, section 10.4.15</a> * @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"),
415 Unsupported Media Type.
See Also:
/** * {@code 415 Unsupported Media Type}. * @see <a href="https://tools.ietf.org/html/rfc7231#section-6.5.13"> * HTTP/1.1: Semantics and Content, section 6.5.13</a> */
UNSUPPORTED_MEDIA_TYPE(415, Series.CLIENT_ERROR, "Unsupported Media Type"),
416 Requested Range Not Satisfiable.
See Also:
/** * {@code 416 Requested Range Not Satisfiable}. * @see <a href="https://tools.ietf.org/html/rfc7233#section-4.4">HTTP/1.1: Range Requests, section 4.4</a> */
REQUESTED_RANGE_NOT_SATISFIABLE(416, Series.CLIENT_ERROR, "Requested range not satisfiable"),
417 Expectation Failed.
See Also:
/** * {@code 417 Expectation Failed}. * @see <a href="https://tools.ietf.org/html/rfc7231#section-6.5.14"> * HTTP/1.1: Semantics and Content, section 6.5.14</a> */
EXPECTATION_FAILED(417, Series.CLIENT_ERROR, "Expectation Failed"),
418 I'm a teapot.
See Also:
/** * {@code 418 I'm a teapot}. * @see <a href="https://tools.ietf.org/html/rfc2324#section-2.3.2">HTCPCP/1.0</a> */
I_AM_A_TEAPOT(418, Series.CLIENT_ERROR, "I'm a teapot"),
Deprecated:See WebDAV Draft Changes
/** * @deprecated See * <a href="https://tools.ietf.org/rfcdiff?difftype=--hwdiff&url2=draft-ietf-webdav-protocol-06.txt"> * WebDAV Draft Changes</a> */
@Deprecated INSUFFICIENT_SPACE_ON_RESOURCE(419, Series.CLIENT_ERROR, "Insufficient Space On Resource"),
Deprecated:See WebDAV Draft Changes
/** * @deprecated See * <a href="https://tools.ietf.org/rfcdiff?difftype=--hwdiff&url2=draft-ietf-webdav-protocol-06.txt"> * WebDAV Draft Changes</a> */
@Deprecated METHOD_FAILURE(420, Series.CLIENT_ERROR, "Method Failure"),
Deprecated: See WebDAV Draft Changes
/** * @deprecated * See <a href="https://tools.ietf.org/rfcdiff?difftype=--hwdiff&url2=draft-ietf-webdav-protocol-06.txt"> * WebDAV Draft Changes</a> */
@Deprecated DESTINATION_LOCKED(421, Series.CLIENT_ERROR, "Destination Locked"),
422 Unprocessable Entity.
See Also:
/** * {@code 422 Unprocessable Entity}. * @see <a href="https://tools.ietf.org/html/rfc4918#section-11.2">WebDAV</a> */
UNPROCESSABLE_ENTITY(422, Series.CLIENT_ERROR, "Unprocessable Entity"),
423 Locked.
See Also:
/** * {@code 423 Locked}. * @see <a href="https://tools.ietf.org/html/rfc4918#section-11.3">WebDAV</a> */
LOCKED(423, Series.CLIENT_ERROR, "Locked"),
424 Failed Dependency.
See Also:
/** * {@code 424 Failed Dependency}. * @see <a href="https://tools.ietf.org/html/rfc4918#section-11.4">WebDAV</a> */
FAILED_DEPENDENCY(424, Series.CLIENT_ERROR, "Failed Dependency"),
425 Too Early.
See Also:
Since:5.2
/** * {@code 425 Too Early}. * @since 5.2 * @see <a href="https://tools.ietf.org/html/rfc8470">RFC 8470</a> */
TOO_EARLY(425, Series.CLIENT_ERROR, "Too Early"),
426 Upgrade Required.
See Also:
/** * {@code 426 Upgrade Required}. * @see <a href="https://tools.ietf.org/html/rfc2817#section-6">Upgrading to TLS Within HTTP/1.1</a> */
UPGRADE_REQUIRED(426, Series.CLIENT_ERROR, "Upgrade Required"),
428 Precondition Required.
See Also:
/** * {@code 428 Precondition Required}. * @see <a href="https://tools.ietf.org/html/rfc6585#section-3">Additional HTTP Status Codes</a> */
PRECONDITION_REQUIRED(428, Series.CLIENT_ERROR, "Precondition Required"),
429 Too Many Requests.
See Also:
/** * {@code 429 Too Many Requests}. * @see <a href="https://tools.ietf.org/html/rfc6585#section-4">Additional HTTP Status Codes</a> */
TOO_MANY_REQUESTS(429, Series.CLIENT_ERROR, "Too Many Requests"),
431 Request Header Fields Too Large.
See Also:
/** * {@code 431 Request Header Fields Too Large}. * @see <a href="https://tools.ietf.org/html/rfc6585#section-5">Additional HTTP Status Codes</a> */
REQUEST_HEADER_FIELDS_TOO_LARGE(431, Series.CLIENT_ERROR, "Request Header Fields Too Large"),
451 Unavailable For Legal Reasons.
See Also:
Since:4.3
/** * {@code 451 Unavailable For Legal Reasons}. * @see <a href="https://tools.ietf.org/html/draft-ietf-httpbis-legally-restricted-status-04"> * An HTTP Status Code to Report Legal Obstacles</a> * @since 4.3 */
UNAVAILABLE_FOR_LEGAL_REASONS(451, Series.CLIENT_ERROR, "Unavailable For Legal Reasons"), // --- 5xx Server Error ---
500 Internal Server Error.
See Also:
/** * {@code 500 Internal Server Error}. * @see <a href="https://tools.ietf.org/html/rfc7231#section-6.6.1">HTTP/1.1: Semantics and Content, section 6.6.1</a> */
INTERNAL_SERVER_ERROR(500, Series.SERVER_ERROR, "Internal Server Error"),
501 Not Implemented.
See Also:
/** * {@code 501 Not Implemented}. * @see <a href="https://tools.ietf.org/html/rfc7231#section-6.6.2">HTTP/1.1: Semantics and Content, section 6.6.2</a> */
NOT_IMPLEMENTED(501, Series.SERVER_ERROR, "Not Implemented"),
502 Bad Gateway.
See Also:
/** * {@code 502 Bad Gateway}. * @see <a href="https://tools.ietf.org/html/rfc7231#section-6.6.3">HTTP/1.1: Semantics and Content, section 6.6.3</a> */
BAD_GATEWAY(502, Series.SERVER_ERROR, "Bad Gateway"),
503 Service Unavailable.
See Also:
/** * {@code 503 Service Unavailable}. * @see <a href="https://tools.ietf.org/html/rfc7231#section-6.6.4">HTTP/1.1: Semantics and Content, section 6.6.4</a> */
SERVICE_UNAVAILABLE(503, Series.SERVER_ERROR, "Service Unavailable"),
504 Gateway Timeout.
See Also:
/** * {@code 504 Gateway Timeout}. * @see <a href="https://tools.ietf.org/html/rfc7231#section-6.6.5">HTTP/1.1: Semantics and Content, section 6.6.5</a> */
GATEWAY_TIMEOUT(504, Series.SERVER_ERROR, "Gateway Timeout"),
505 HTTP Version Not Supported.
See Also:
/** * {@code 505 HTTP Version Not Supported}. * @see <a href="https://tools.ietf.org/html/rfc7231#section-6.6.6">HTTP/1.1: Semantics and Content, section 6.6.6</a> */
HTTP_VERSION_NOT_SUPPORTED(505, Series.SERVER_ERROR, "HTTP Version not supported"),
506 Variant Also Negotiates
See Also:
/** * {@code 506 Variant Also Negotiates} * @see <a href="https://tools.ietf.org/html/rfc2295#section-8.1">Transparent Content Negotiation</a> */
VARIANT_ALSO_NEGOTIATES(506, Series.SERVER_ERROR, "Variant Also Negotiates"),
507 Insufficient Storage
See Also:
/** * {@code 507 Insufficient Storage} * @see <a href="https://tools.ietf.org/html/rfc4918#section-11.5">WebDAV</a> */
INSUFFICIENT_STORAGE(507, Series.SERVER_ERROR, "Insufficient Storage"),
508 Loop Detected
See Also:
/** * {@code 508 Loop Detected} * @see <a href="https://tools.ietf.org/html/rfc5842#section-7.2">WebDAV Binding Extensions</a> */
LOOP_DETECTED(508, Series.SERVER_ERROR, "Loop Detected"),
509 Bandwidth Limit Exceeded
/** * {@code 509 Bandwidth Limit Exceeded} */
BANDWIDTH_LIMIT_EXCEEDED(509, Series.SERVER_ERROR, "Bandwidth Limit Exceeded"),
510 Not Extended
See Also:
/** * {@code 510 Not Extended} * @see <a href="https://tools.ietf.org/html/rfc2774#section-7">HTTP Extension Framework</a> */
NOT_EXTENDED(510, Series.SERVER_ERROR, "Not Extended"),
511 Network Authentication Required.
See Also:
/** * {@code 511 Network Authentication Required}. * @see <a href="https://tools.ietf.org/html/rfc6585#section-6">Additional HTTP Status Codes</a> */
NETWORK_AUTHENTICATION_REQUIRED(511, Series.SERVER_ERROR, "Network Authentication Required"); 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; }
Return the integer value of this status code.
/** * Return the integer value of this status code. */
public int value() { return this.value; }
Return the HTTP status series of this status code.
See Also:
  • Series
/** * 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.
/** * Return the reason phrase of this status code. */
public String getReasonPhrase() { return this.reasonPhrase; }
Whether this status code is in the HTTP series Series.INFORMATIONAL.

This is a shortcut for checking the value of series().

See Also:
Since:4.0
/** * Whether this status code is in the HTTP series * {@link org.springframework.http.HttpStatus.Series#INFORMATIONAL}. * <p>This is a shortcut for checking the value of {@link #series()}. * @since 4.0 * @see #series() */
public boolean is1xxInformational() { return (series() == Series.INFORMATIONAL); }
Whether this status code is in the HTTP series Series.SUCCESSFUL.

This is a shortcut for checking the value of series().

See Also:
Since:4.0
/** * Whether this status code is in the HTTP series * {@link org.springframework.http.HttpStatus.Series#SUCCESSFUL}. * <p>This is a shortcut for checking the value of {@link #series()}. * @since 4.0 * @see #series() */
public boolean is2xxSuccessful() { return (series() == Series.SUCCESSFUL); }
Whether this status code is in the HTTP series Series.REDIRECTION.

This is a shortcut for checking the value of series().

See Also:
Since:4.0
/** * Whether this status code is in the HTTP series * {@link org.springframework.http.HttpStatus.Series#REDIRECTION}. * <p>This is a shortcut for checking the value of {@link #series()}. * @since 4.0 * @see #series() */
public boolean is3xxRedirection() { return (series() == Series.REDIRECTION); }
Whether this status code is in the HTTP series Series.CLIENT_ERROR.

This is a shortcut for checking the value of series().

See Also:
Since:4.0
/** * Whether this status code is in the HTTP series * {@link org.springframework.http.HttpStatus.Series#CLIENT_ERROR}. * <p>This is a shortcut for checking the value of {@link #series()}. * @since 4.0 * @see #series() */
public boolean is4xxClientError() { return (series() == Series.CLIENT_ERROR); }
Whether this status code is in the HTTP series Series.SERVER_ERROR.

This is a shortcut for checking the value of series().

See Also:
Since:4.0
/** * Whether this status code is in the HTTP series * {@link org.springframework.http.HttpStatus.Series#SERVER_ERROR}. * <p>This is a shortcut for checking the value of {@link #series()}. * @since 4.0 * @see #series() */
public boolean is5xxServerError() { return (series() == Series.SERVER_ERROR); }
Whether this status code is in the HTTP series Series.CLIENT_ERROR or Series.SERVER_ERROR.

This is a shortcut for checking the value of series().

See Also:
Since:5.0
/** * Whether this status code is in the HTTP series * {@link org.springframework.http.HttpStatus.Series#CLIENT_ERROR} or * {@link org.springframework.http.HttpStatus.Series#SERVER_ERROR}. * <p>This is a shortcut for checking the value of {@link #series()}. * @since 5.0 * @see #is4xxClientError() * @see #is5xxServerError() */
public boolean isError() { return (is4xxClientError() || is5xxServerError()); }
Return a string representation of this status code.
/** * Return a string representation of this status code. */
@Override public String toString() { return this.value + " " + name(); }
Return the HttpStatus enum constant with the specified numeric value.
Params:
  • statusCode – the numeric value of the enum to be returned
Throws:
Returns:the enum constant with the specified numeric value
/** * 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 HttpStatus, if possible.
Params:
  • statusCode – the HTTP status code (potentially non-standard)
Returns:the corresponding HttpStatus, or null if not found
Since:5.0
/** * 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) { for (HttpStatus status : values()) { if (status.value == statusCode) { return status; } } return null; }
Enumeration of HTTP status series.

Retrievable via HttpStatus.series().

/** * Enumeration of HTTP status series. * <p>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.
/** * Return the integer value of this status series. Ranges from 1 to 5. */
public int value() { return this.value; }
Return the Series enum constant for the supplied HttpStatus.
Params:
  • status – a standard HTTP status enum constant
Returns:the Series enum constant for the supplied HttpStatus
Deprecated:as of 5.3, in favor of invoking HttpStatus.series() directly
/** * 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 Series enum constant for the supplied status code.
Params:
  • statusCode – the HTTP status code (potentially non-standard)
Throws:
Returns:the Series enum constant for the supplied status code
/** * 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 HttpStatus.Series, if possible.
Params:
  • statusCode – the HTTP status code (potentially non-standard)
Returns:the corresponding Series, or null if not found
Since:5.1.3
/** * 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; } } }