Package org.springframework.http
Enum HttpStatus
- java.lang.Object
- java.lang.Enum<HttpStatus>
- org.springframework.http.HttpStatus
- All Implemented Interfaces:
Serializable
,Comparable<HttpStatus>
public enum HttpStatus extends Enum<HttpStatus>
Enumeration of HTTP status codes.The HTTP status code series can be retrieved via
series()
.- Since:
- 3.0
- Author:
- Arjen Poutsma, Sebastien Deleuze, Brian Clozel
- See Also:
HttpStatus.Series
, HTTP Status Code Registry, List of HTTP status codes - Wikipedia
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
HttpStatus.Series
Enumeration of HTTP status series.
Enum Constant Summary
Enum Constants Enum Constant Description ACCEPTED
202 Accepted
.ALREADY_REPORTED
208 Already Reported
.BAD_GATEWAY
502 Bad Gateway
.BAD_REQUEST
400 Bad Request
.BANDWIDTH_LIMIT_EXCEEDED
509 Bandwidth Limit Exceeded
CHECKPOINT
103 Checkpoint
.CONFLICT
409 Conflict
.CONTINUE
100 Continue
.CREATED
201 Created
.DESTINATION_LOCKED
Deprecated.EXPECTATION_FAILED
417 Expectation Failed
.FAILED_DEPENDENCY
424 Failed Dependency
.FORBIDDEN
403 Forbidden
.FOUND
302 Found
.GATEWAY_TIMEOUT
504 Gateway Timeout
.GONE
410 Gone
.HTTP_VERSION_NOT_SUPPORTED
505 HTTP Version Not Supported
.I_AM_A_TEAPOT
418 I'm a teapot
.IM_USED
226 IM Used
.INSUFFICIENT_SPACE_ON_RESOURCE
Deprecated.INSUFFICIENT_STORAGE
507 Insufficient Storage
INTERNAL_SERVER_ERROR
500 Internal Server Error
.LENGTH_REQUIRED
411 Length Required
.LOCKED
423 Locked
.LOOP_DETECTED
508 Loop Detected
METHOD_FAILURE
Deprecated.METHOD_NOT_ALLOWED
405 Method Not Allowed
.MOVED_PERMANENTLY
301 Moved Permanently
.MOVED_TEMPORARILY
Deprecated.in favor ofFOUND
which will be returned fromHttpStatus.valueOf(302)
MULTI_STATUS
207 Multi-Status
.MULTIPLE_CHOICES
300 Multiple Choices
.NETWORK_AUTHENTICATION_REQUIRED
511 Network Authentication Required
.NO_CONTENT
204 No Content
.NON_AUTHORITATIVE_INFORMATION
203 Non-Authoritative Information
.NOT_ACCEPTABLE
406 Not Acceptable
.NOT_EXTENDED
510 Not Extended
NOT_FOUND
404 Not Found
.NOT_IMPLEMENTED
501 Not Implemented
.NOT_MODIFIED
304 Not Modified
.OK
200 OK
.PARTIAL_CONTENT
206 Partial Content
.PAYLOAD_TOO_LARGE
413 Payload Too Large
.PAYMENT_REQUIRED
402 Payment Required
.PERMANENT_REDIRECT
308 Permanent Redirect
.PRECONDITION_FAILED
412 Precondition failed
.PRECONDITION_REQUIRED
428 Precondition Required
.PROCESSING
102 Processing
.PROXY_AUTHENTICATION_REQUIRED
407 Proxy Authentication Required
.REQUEST_ENTITY_TOO_LARGE
Deprecated.in favor ofPAYLOAD_TOO_LARGE
which will be returned fromHttpStatus.valueOf(413)
REQUEST_HEADER_FIELDS_TOO_LARGE
431 Request Header Fields Too Large
.REQUEST_TIMEOUT
408 Request Timeout
.REQUEST_URI_TOO_LONG
Deprecated.in favor ofURI_TOO_LONG
which will be returned fromHttpStatus.valueOf(414)
REQUESTED_RANGE_NOT_SATISFIABLE
416 Requested Range Not Satisfiable
.RESET_CONTENT
205 Reset Content
.SEE_OTHER
303 See Other
.SERVICE_UNAVAILABLE
503 Service Unavailable
.SWITCHING_PROTOCOLS
101 Switching Protocols
.TEMPORARY_REDIRECT
307 Temporary Redirect
.TOO_EARLY
425 Too Early
.TOO_MANY_REQUESTS
429 Too Many Requests
.UNAUTHORIZED
401 Unauthorized
.UNAVAILABLE_FOR_LEGAL_REASONS
451 Unavailable For Legal Reasons
.UNPROCESSABLE_ENTITY
422 Unprocessable Entity
.UNSUPPORTED_MEDIA_TYPE
415 Unsupported Media Type
.UPGRADE_REQUIRED
426 Upgrade Required
.URI_TOO_LONG
414 URI Too Long
.USE_PROXY
Deprecated.due to security concerns regarding in-band configuration of a proxyVARIANT_ALSO_NEGOTIATES
506 Variant Also Negotiates
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getReasonPhrase()
Return the reason phrase of this status code.boolean
is1xxInformational()
Whether this status code is in the HTTP seriesHttpStatus.Series.INFORMATIONAL
.boolean
is2xxSuccessful()
Whether this status code is in the HTTP seriesHttpStatus.Series.SUCCESSFUL
.boolean
is3xxRedirection()
Whether this status code is in the HTTP seriesHttpStatus.Series.REDIRECTION
.boolean
is4xxClientError()
Whether this status code is in the HTTP seriesHttpStatus.Series.CLIENT_ERROR
.boolean
is5xxServerError()
Whether this status code is in the HTTP seriesHttpStatus.Series.SERVER_ERROR
.boolean
isError()
Whether this status code is in the HTTP seriesHttpStatus.Series.CLIENT_ERROR
orHttpStatus.Series.SERVER_ERROR
.static HttpStatus
resolve(int statusCode)
Resolve the given status code to anHttpStatus
, if possible.HttpStatus.Series
series()
Return the HTTP status series of this status code.String
toString()
Return a string representation of this status code.int
value()
Return the integer value of this status code.static HttpStatus
valueOf(int statusCode)
Return the enum constant of this type with the specified numeric value.static HttpStatus
valueOf(String name)
Returns the enum constant of this type with the specified name.static HttpStatus[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
Enum Constant Detail
CONTINUE
public static final HttpStatus CONTINUE
100 Continue
.
SWITCHING_PROTOCOLS
public static final HttpStatus SWITCHING_PROTOCOLS
101 Switching Protocols
.
PROCESSING
public static final HttpStatus PROCESSING
102 Processing
.- See Also:
- WebDAV
CHECKPOINT
public static final HttpStatus CHECKPOINT
103 Checkpoint
.
OK
public static final HttpStatus OK
200 OK
.
CREATED
public static final HttpStatus CREATED
201 Created
.
ACCEPTED
public static final HttpStatus ACCEPTED
202 Accepted
.
NON_AUTHORITATIVE_INFORMATION
public static final HttpStatus NON_AUTHORITATIVE_INFORMATION
203 Non-Authoritative Information
.
NO_CONTENT
public static final HttpStatus NO_CONTENT
204 No Content
.
RESET_CONTENT
public static final HttpStatus RESET_CONTENT
205 Reset Content
.
PARTIAL_CONTENT
public static final HttpStatus PARTIAL_CONTENT
206 Partial Content
.
MULTI_STATUS
public static final HttpStatus MULTI_STATUS
207 Multi-Status
.- See Also:
- WebDAV
ALREADY_REPORTED
public static final HttpStatus ALREADY_REPORTED
208 Already Reported
.- See Also:
- WebDAV Binding Extensions
IM_USED
public static final HttpStatus IM_USED
226 IM Used
.- See Also:
- Delta encoding in HTTP
MULTIPLE_CHOICES
public static final HttpStatus MULTIPLE_CHOICES
300 Multiple Choices
.
MOVED_PERMANENTLY
public static final HttpStatus MOVED_PERMANENTLY
301 Moved Permanently
.
FOUND
public static final HttpStatus FOUND
302 Found
.
MOVED_TEMPORARILY
@Deprecated public static final HttpStatus MOVED_TEMPORARILY
Deprecated.in favor ofFOUND
which will be returned fromHttpStatus.valueOf(302)
302 Moved Temporarily
.- See Also:
- HTTP/1.0, section 9.3
SEE_OTHER
public static final HttpStatus SEE_OTHER
303 See Other
.
NOT_MODIFIED
public static final HttpStatus NOT_MODIFIED
304 Not Modified
.
USE_PROXY
@Deprecated public static final HttpStatus USE_PROXY
Deprecated.due to security concerns regarding in-band configuration of a proxy305 Use Proxy
.
TEMPORARY_REDIRECT
public static final HttpStatus TEMPORARY_REDIRECT
307 Temporary Redirect
.
PERMANENT_REDIRECT
public static final HttpStatus PERMANENT_REDIRECT
308 Permanent Redirect
.- See Also:
- RFC 7238
BAD_REQUEST
public static final HttpStatus BAD_REQUEST
400 Bad Request
.
UNAUTHORIZED
public static final HttpStatus UNAUTHORIZED
401 Unauthorized
.
PAYMENT_REQUIRED
public static final HttpStatus PAYMENT_REQUIRED
402 Payment Required
.
FORBIDDEN
public static final HttpStatus FORBIDDEN
403 Forbidden
.
NOT_FOUND
public static final HttpStatus NOT_FOUND
404 Not Found
.
METHOD_NOT_ALLOWED
public static final HttpStatus METHOD_NOT_ALLOWED
405 Method Not Allowed
.
NOT_ACCEPTABLE
public static final HttpStatus NOT_ACCEPTABLE
406 Not Acceptable
.
PROXY_AUTHENTICATION_REQUIRED
public static final HttpStatus PROXY_AUTHENTICATION_REQUIRED
407 Proxy Authentication Required
.
REQUEST_TIMEOUT
public static final HttpStatus REQUEST_TIMEOUT
408 Request Timeout
.
CONFLICT
public static final HttpStatus CONFLICT
409 Conflict
.
GONE
public static final HttpStatus GONE
410 Gone
.
LENGTH_REQUIRED
public static final HttpStatus LENGTH_REQUIRED
411 Length Required
.
PRECONDITION_FAILED
public static final HttpStatus PRECONDITION_FAILED
412 Precondition failed
.
PAYLOAD_TOO_LARGE
public static final HttpStatus PAYLOAD_TOO_LARGE
413 Payload Too Large
.- Since:
- 4.1
- See Also:
- HTTP/1.1: Semantics and Content, section 6.5.11
REQUEST_ENTITY_TOO_LARGE
@Deprecated public static final HttpStatus REQUEST_ENTITY_TOO_LARGE
Deprecated.in favor ofPAYLOAD_TOO_LARGE
which will be returned fromHttpStatus.valueOf(413)
413 Request Entity Too Large
.- See Also:
- HTTP/1.1, section 10.4.14
URI_TOO_LONG
public static final HttpStatus URI_TOO_LONG
414 URI Too Long
.- Since:
- 4.1
- See Also:
- HTTP/1.1: Semantics and Content, section 6.5.12
REQUEST_URI_TOO_LONG
@Deprecated public static final HttpStatus REQUEST_URI_TOO_LONG
Deprecated.in favor ofURI_TOO_LONG
which will be returned fromHttpStatus.valueOf(414)
414 Request-URI Too Long
.- See Also:
- HTTP/1.1, section 10.4.15
UNSUPPORTED_MEDIA_TYPE
public static final HttpStatus UNSUPPORTED_MEDIA_TYPE
415 Unsupported Media Type
.
REQUESTED_RANGE_NOT_SATISFIABLE
public static final HttpStatus REQUESTED_RANGE_NOT_SATISFIABLE
416 Requested Range Not Satisfiable
.
EXPECTATION_FAILED
public static final HttpStatus EXPECTATION_FAILED
417 Expectation Failed
.
I_AM_A_TEAPOT
public static final HttpStatus I_AM_A_TEAPOT
418 I'm a teapot
.- See Also:
- HTCPCP/1.0
INSUFFICIENT_SPACE_ON_RESOURCE
@Deprecated public static final HttpStatus INSUFFICIENT_SPACE_ON_RESOURCE
Deprecated.
METHOD_FAILURE
@Deprecated public static final HttpStatus METHOD_FAILURE
Deprecated.
DESTINATION_LOCKED
@Deprecated public static final HttpStatus DESTINATION_LOCKED
Deprecated.
UNPROCESSABLE_ENTITY
public static final HttpStatus UNPROCESSABLE_ENTITY
422 Unprocessable Entity
.- See Also:
- WebDAV
LOCKED
public static final HttpStatus LOCKED
423 Locked
.- See Also:
- WebDAV
FAILED_DEPENDENCY
public static final HttpStatus FAILED_DEPENDENCY
424 Failed Dependency
.- See Also:
- WebDAV
TOO_EARLY
public static final HttpStatus TOO_EARLY
425 Too Early
.- Since:
- 5.2
- See Also:
- RFC 8470
UPGRADE_REQUIRED
public static final HttpStatus UPGRADE_REQUIRED
426 Upgrade Required
.- See Also:
- Upgrading to TLS Within HTTP/1.1
PRECONDITION_REQUIRED
public static final HttpStatus PRECONDITION_REQUIRED
428 Precondition Required
.- See Also:
- Additional HTTP Status Codes
TOO_MANY_REQUESTS
public static final HttpStatus TOO_MANY_REQUESTS
429 Too Many Requests
.- See Also:
- Additional HTTP Status Codes
REQUEST_HEADER_FIELDS_TOO_LARGE
public static final HttpStatus REQUEST_HEADER_FIELDS_TOO_LARGE
431 Request Header Fields Too Large
.- See Also:
- Additional HTTP Status Codes
UNAVAILABLE_FOR_LEGAL_REASONS
public static final HttpStatus UNAVAILABLE_FOR_LEGAL_REASONS
451 Unavailable For Legal Reasons
.- Since:
- 4.3
- See Also:
- An HTTP Status Code to Report Legal Obstacles
INTERNAL_SERVER_ERROR
public static final HttpStatus INTERNAL_SERVER_ERROR
500 Internal Server Error
.
NOT_IMPLEMENTED
public static final HttpStatus NOT_IMPLEMENTED
501 Not Implemented
.
BAD_GATEWAY
public static final HttpStatus BAD_GATEWAY
502 Bad Gateway
.
SERVICE_UNAVAILABLE
public static final HttpStatus SERVICE_UNAVAILABLE
503 Service Unavailable
.
GATEWAY_TIMEOUT
public static final HttpStatus GATEWAY_TIMEOUT
504 Gateway Timeout
.
HTTP_VERSION_NOT_SUPPORTED
public static final HttpStatus HTTP_VERSION_NOT_SUPPORTED
505 HTTP Version Not Supported
.
VARIANT_ALSO_NEGOTIATES
public static final HttpStatus VARIANT_ALSO_NEGOTIATES
506 Variant Also Negotiates
- See Also:
- Transparent Content Negotiation
INSUFFICIENT_STORAGE
public static final HttpStatus INSUFFICIENT_STORAGE
507 Insufficient Storage
- See Also:
- WebDAV
LOOP_DETECTED
public static final HttpStatus LOOP_DETECTED
508 Loop Detected
- See Also:
- WebDAV Binding Extensions
BANDWIDTH_LIMIT_EXCEEDED
public static final HttpStatus BANDWIDTH_LIMIT_EXCEEDED
509 Bandwidth Limit Exceeded
NOT_EXTENDED
public static final HttpStatus NOT_EXTENDED
510 Not Extended
- See Also:
- HTTP Extension Framework
NETWORK_AUTHENTICATION_REQUIRED
public static final HttpStatus NETWORK_AUTHENTICATION_REQUIRED
511 Network Authentication Required
.- See Also:
- Additional HTTP Status Codes
Method Detail
values
public static HttpStatus[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (HttpStatus c : HttpStatus.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
valueOf
public static HttpStatus valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
value
public int value()
Return the integer value of this status code.
getReasonPhrase
public String getReasonPhrase()
Return the reason phrase of this status code.
series
public HttpStatus.Series series()
Return the HTTP status series of this status code.- See Also:
HttpStatus.Series
is1xxInformational
public boolean is1xxInformational()
Whether this status code is in the HTTP seriesHttpStatus.Series.INFORMATIONAL
. This is a shortcut for checking the value ofseries()
.- Since:
- 4.0
- See Also:
series()
is2xxSuccessful
public boolean is2xxSuccessful()
Whether this status code is in the HTTP seriesHttpStatus.Series.SUCCESSFUL
. This is a shortcut for checking the value ofseries()
.- Since:
- 4.0
- See Also:
series()
is3xxRedirection
public boolean is3xxRedirection()
Whether this status code is in the HTTP seriesHttpStatus.Series.REDIRECTION
. This is a shortcut for checking the value ofseries()
.- Since:
- 4.0
- See Also:
series()
is4xxClientError
public boolean is4xxClientError()
Whether this status code is in the HTTP seriesHttpStatus.Series.CLIENT_ERROR
. This is a shortcut for checking the value ofseries()
.- Since:
- 4.0
- See Also:
series()
is5xxServerError
public boolean is5xxServerError()
Whether this status code is in the HTTP seriesHttpStatus.Series.SERVER_ERROR
. This is a shortcut for checking the value ofseries()
.- Since:
- 4.0
- See Also:
series()
isError
public boolean isError()
Whether this status code is in the HTTP seriesHttpStatus.Series.CLIENT_ERROR
orHttpStatus.Series.SERVER_ERROR
. This is a shortcut for checking the value ofseries()
.- Since:
- 5.0
- See Also:
is4xxClientError()
,is5xxServerError()
toString
public String toString()
Return a string representation of this status code.- Overrides:
toString
in classEnum<HttpStatus>
valueOf
public static HttpStatus valueOf(int statusCode)
Return the enum constant of this type with the specified numeric value.- Parameters:
statusCode
- the numeric value of the enum to be returned- Returns:
- the enum constant with the specified numeric value
- Throws:
IllegalArgumentException
- if this enum has no constant for the specified numeric value
resolve
@Nullable public static HttpStatus resolve(int statusCode)
Resolve the given status code to anHttpStatus
, if possible.- Parameters:
statusCode
- the HTTP status code (potentially non-standard)- Returns:
- the corresponding
HttpStatus
, ornull
if not found - Since:
- 5.0