Enum Class HttpStatus
- All Implemented Interfaces:
Serializable, Comparable<HttpStatus>, Constable
- the wikipedia page.
- Hypertext Transfer Protocol -- HTTP/1.1, RFC 2616
- HTTP Extensions for Web Distributed Authoring and Versioning (WebDAV), RFC 4918
- Binding Extensions to Web Distributed Authoring and Versioning (WebDAV), RFC 5842
- Delta encoding in HTTP, RFC 3229
-
Nested Class Summary
Nested classes/interfaces inherited from class Enum
Enum.EnumDesc<E> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionThe request has been accepted for processing, but the processing has not been completed.WebDAV; RFC 5842The server was acting as a gateway or proxy and received an invalid response from the upstream server.The request cannot be fulfilled due to bad syntax.This status code, while used by many servers, is not specified in any RFCs.A Microsoft extension.Nginx internal code used when SSL client certificate error occured to distinguish it from 4XX in a log and an error page redirection.Used in Nginx logs to indicate when the connection has been closed by client while the server is still processing its request, making server unable to send a status code back.Indicates that the request could not be processed because of conflict in the request, such as an edit conflict.This means that the server has received the request headers, and that the client should proceed to send the request body (in the case of a request for which a body needs to be sent; for example, a POST request).The request has been fulfilled and resulted in a new resource being created.Not part of the HTTP standard, but returned by the Twitter Search and Trends API when the client is being rate limited.The server cannot meet the requirements of the Expect request-header field.The request was a valid request, but the server is refusing to respond to it.This is an example of industry practice contradicting the standard.The server was acting as a gateway or proxy and did not receive a timely response from the upstream server.Indicates that the resource requested is no longer available and will not be available again.Nginx internal code used for the plain HTTP requests that are sent to HTTPS port to distinguish it from 4XX in a log and an error page redirection.The server does not support the HTTP protocol version used in the request.This code was defined in 1998 as one of the traditional IETF April Fools' jokes, in RFC 2324, Hyper Text Coffee Pot Control Protocol, and is not expected to be implemented by actual HTTP servers.RFC 3229WebDAV; RFC 4918A generic error message, given when no more specific message is suitableThe request did not specify the length of its content, which is required by the requested resource.The resource that is being accessed is locked.WebDAV; RFC 5842Indicates the method was not executed on a particular resource within its scope because some part of the method's execution failed causing the entire method to be aborted.A request was made of a resource using a request method not supported by that resource; for example, using GET on a form which requires data to be presented via POST, or using PUT on a read-only resource.This and all future requests should be directed to the given URI.WebDAV; RFC 4918Indicates multiple options for the resource that the client may follow.RFC 6585This status code is not specified in any RFCs, but is used by Microsoft Corp.This status code is not specified in any RFCs, but is used by Microsoft Corp.Nginx internal code used when client didn't provide certificate to distinguish it from 4XX in a log and an error page redirection.The server successfully processed the request, but is not returning any content.Used in Nginx logs to indicate that the server has returned no information to the client and closed the connection (useful as a deterrent for malware).The server successfully processed the request, but is returning information that may be from another source.The requested resource is only capable of generating content not acceptable according to the Accept headers sent in the request.RFC 2774The requested resource could not be found but may be available again in the future.The server either does not recognize the request method, or it lacks the ability to fulfill the request.Indicates the resource has not been modified since last requested.Standard response for successful HTTP requests.The server is delivering only part of the resource due to a range header sent by the client.Reserved for future use.The request, and all future requests should be repeated using another URI. 307 and 308 (as proposed) parallel the behaviours of 302 and 301, but do not allow the HTTP method to change.The server does not meet one of the preconditions that the requester put on the request.The origin server requires the request to be conditional.WebDAV: RFC 2518The client must first authenticate itself with the proxy.The request is larger than the server is willing or able to process.The server is unwilling to process the request because either an individual header field, or all the header fields collectively, are too large.[18]Nginx internal code similar to 431 but it was introduced earlier.The client has asked for a portion of the file, but the server cannot supply that portion.The server timed out waiting for the request.The URI provided was too long for the server to process.The server successfully processed the request, but is not returning any content.A Microsoft extension.The response to the request can be found under another URI using a GET method.The server is currently unavailable (because it is overloaded or down for maintenance).Generally, this is a temporary state.No longer used.This means the requester has asked the server to switch protocols and the server is acknowledging that it will do so.In this case, the request should be repeated with another URI; however, future requests should still use the original URI.The user has sent too many requests in a given amount of time.Similar to 403 Forbidden, but specifically for use when authentication is required and has failed or has not yet been provided.Defined in the internet draft "A New HTTP Status Code for Legally-restricted Resources".Defined in drafts of "WebDAV Advanced Collections Protocol",[15] but not present in "Web Distributed Authoring and Versioning (WebDAV) Ordered Collections Protocol".[16]The request was well-formed but was unable to be followed due to semantic errors.The request entity has a media type which the server or resource does not support.The client should switch to a different protocol such as TLS/1.0.RFC 2295 -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptiontoString()static HttpStatusReturns the enum constant of this class with the specified name.static HttpStatus[]values()Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
CONTINUE
This means that the server has received the request headers, and that the client should proceed to send the request body (in the case of a request for which a body needs to be sent; for example, a POST request).
If the request body is large, sending it to a server when a request has already been rejected based upon inappropriate headers is inefficient. To have a server check if the request could be accepted based on the request's headers alone, a client must send Expect: 100-continue as a header in its initial request and check if a 100 Continue status code is received in response before continuing (or receive 417 Expectation Failed and not continue).
-
SWITCHING_PROTOCOLS
This means the requester has asked the server to switch protocols and the server is acknowledging that it will do so. -
PROCESSING
WebDAV: RFC 2518
As a WebDAV request may contain many sub-requests involving file operations, it may take a long time to complete the request. This code indicates that the server has received and is processing the request, but no response is available yet. This prevents the client from timing out and assuming the request was lost.
-
OK
Standard response for successful HTTP requests. The actual response will depend on the request method used. In a GET request, the response will contain an entity corresponding to the requested resource. In a POST request the response will contain an entity describing or containing the result of the action. -
CREATED
The request has been fulfilled and resulted in a new resource being created. -
ACCEPTED
The request has been accepted for processing, but the processing has not been completed. The request might or might not eventually be acted upon, as it might be disallowed when processing actually takes place. -
NON_AUTHORITATIVE_INFORMATION
The server successfully processed the request, but is returning information that may be from another source. -
NO_CONTENT
The server successfully processed the request, but is not returning any content. -
RESET_CONTENT
The server successfully processed the request, but is not returning any content. Unlike a 204 response, this response requires that the requester reset the document view. -
PARTIAL_CONTENT
The server is delivering only part of the resource due to a range header sent by the client. The range header is used by tools like wget to enable resuming of interrupted downloads, or split a download into multiple simultaneous streams. -
MULTI_STATUS
WebDAV; RFC 4918
The message body that follows is an XML message and can contain a number of separate response codes, depending on how many sub-requests were made.
-
ALREADY_REPORTED
WebDAV; RFC 5842
The members of a DAV binding have already been enumerated in a previous reply to this request, and are not being included again.
-
IM_USED
RFC 3229
The server has fulfilled a GET request for the resource, and the response is a representation of the result of one or more instance-manipulations applied to the current instance.
-
MULTIPLE_CHOICES
Indicates multiple options for the resource that the client may follow. It, for instance, could be used to present different format options for video, list files with different extensions, or word sense disambiguation. -
MOVED_PERMANENTLY
This and all future requests should be directed to the given URI. -
FOUND
This is an example of industry practice contradicting the standard. The HTTP/1.0 specification (RFC 1945) required the client to perform a temporary redirect (the original describing phrase was "Moved Temporarily"), but popular browsers implemented 302 with the functionality of a 303 See Other. Therefore, HTTP/1.1 added status codes 303 and 307 to distinguish between the two behaviours. However, some Web applications and frameworks use the 302 status code as if it were the 303. -
SEE_OTHER
The response to the request can be found under another URI using a GET method. When received in response to a POST (or PUT/DELETE), it should be assumed that the server has received the data and the redirect should be issued with a separate GET message. -
NOT_MODIFIED
Indicates the resource has not been modified since last requested. Typically, the HTTP client provides a header like the If-Modified-Since header to provide a time against which to compare. Using this saves bandwidth and reprocessing on both the server and client, as only the header data must be sent and received in comparison to the entirety of the page being re-processed by the server, then sent again using more bandwidth of the server and client. -
USE_PROXY
-
SWITCH_PROXY
No longer used. Originally meant "Subsequent requests should use the specified proxy." -
TEMPORARY_REDIRECT
In this case, the request should be repeated with another URI; however, future requests should still use the original URI. In contrast to how 302 was historically implemented, the request method is not allowed to be changed when reissuing the original request. For instance, a POST request repeated using another POST request. -
PERMANENT_REDIRECT
The request, and all future requests should be repeated using another URI. 307 and 308 (as proposed) parallel the behaviours of 302 and 301, but do not allow the HTTP method to change. So, for example, submitting a form to a permanently redirected resource may continue smoothly. -
BAD_REQUEST
The request cannot be fulfilled due to bad syntax. -
UNAUTHORIZED
Similar to 403 Forbidden, but specifically for use when authentication is required and has failed or has not yet been provided. The response must include a WWW-Authenticate header field containing a challenge applicable to the requested resource. -
PAYMENT_REQUIRED
Reserved for future use. The original intention was that this code might be used as part of some form of digital cash or micropayment scheme, but that has not happened, and this code is not usually used. As an example of its use, however, Apple's MobileMe service generates a 402 error if the MobileMe account is delinquent. -
FORBIDDEN
The request was a valid request, but the server is refusing to respond to it. Unlike a 401 Unauthorized response, authenticating will make no difference. On servers where authentication is required, this commonly means that the provided credentials were successfully authenticated but that the credentials still do not grant the client permission to access the resource (e.g. a recognized user attempting to access restricted content). -
NOT_FOUND
The requested resource could not be found but may be available again in the future. Subsequent requests by the client are permissible. -
METHOD_NOT_ALLOWED
A request was made of a resource using a request method not supported by that resource; for example, using GET on a form which requires data to be presented via POST, or using PUT on a read-only resource. -
NOT_ACCEPTABLE
The requested resource is only capable of generating content not acceptable according to the Accept headers sent in the request. -
PROXY_AUTHENTICATION_REQUIRED
The client must first authenticate itself with the proxy. -
REQUEST_TIMEOUT
The server timed out waiting for the request. According to W3 HTTP specifications: "The client did not produce a request within the time that the server was prepared to wait. The client MAY repeat the request without modifications at any later time." -
CONFLICT
Indicates that the request could not be processed because of conflict in the request, such as an edit conflict. -
GONE
Indicates that the resource requested is no longer available and will not be available again. This should be used when a resource has been intentionally removed and the resource should be purged. Upon receiving a 410 status code, the client should not request the resource again in the future. Clients such as search engines should remove the resource from their indices. Most use cases do not require clients and search engines to purge the resource, and a "404 Not Found" may be used instead. -
LENGTH_REQUIRED
The request did not specify the length of its content, which is required by the requested resource. -
PRECONDITION_FAILED
The server does not meet one of the preconditions that the requester put on the request. -
REQUEST_ENTITY_TOO_LARGE
The request is larger than the server is willing or able to process. -
REQUEST_URI_TOO_LONG
The URI provided was too long for the server to process. -
UNSUPPORTED_MEDIA_TYPE
The request entity has a media type which the server or resource does not support. For example, the client uploads an image as image/svg+xml, but the server requires that images use a different format. -
REQUEST_RANGE_NOT_SATISFIABLE
The client has asked for a portion of the file, but the server cannot supply that portion. For example, if the client asked for a part of the file that lies beyond the end of the file. -
EXPECTATION_FAILED
The server cannot meet the requirements of the Expect request-header field. -
I_M_A_TEAPOT
This code was defined in 1998 as one of the traditional IETF April Fools' jokes, in RFC 2324, Hyper Text Coffee Pot Control Protocol, and is not expected to be implemented by actual HTTP servers. -
ENHANCE_YOUR_CALM
Not part of the HTTP standard, but returned by the Twitter Search and Trends API when the client is being rate limited. Other services may wish to implement the 429 Too Many Requests response code instead. -
UNPROCESSABLE_ENTITY
The request was well-formed but was unable to be followed due to semantic errors. -
LOCKED
The resource that is being accessed is locked. -
METHOD_FAILURE
Indicates the method was not executed on a particular resource within its scope because some part of the method's execution failed causing the entire method to be aborted. -
UNORDERED_COLLECTION
Defined in drafts of "WebDAV Advanced Collections Protocol",[15] but not present in "Web Distributed Authoring and Versioning (WebDAV) Ordered Collections Protocol".[16] -
UPGRADE_REQUIRED
The client should switch to a different protocol such as TLS/1.0. -
PRECONDITION_REQUIRED
The origin server requires the request to be conditional. Intended to prevent "the 'lost update' problem, where a client GETs a resource's state, modifies it, and PUTs it back to the server, when meanwhile a third party has modified the state on the server, leading to a conflict." -
TOO_MANY_REQUESTS
The user has sent too many requests in a given amount of time. Intended for use with rate limiting schemes. -
REQUEST_HEADER_FIELDS_TOO_LARGE
The server is unwilling to process the request because either an individual header field, or all the header fields collectively, are too large.[18] -
NO_RESPONSE
Used in Nginx logs to indicate that the server has returned no information to the client and closed the connection (useful as a deterrent for malware). -
RETRY_WITH
A Microsoft extension. The request should be retried after performing the appropriate action. -
BLOCKED_BY_WINDOWS_PARENTAL_CONTROLS
A Microsoft extension. This error is given when Windows Parental Controls are turned on and are blocking access to the given webpage. -
UNAVAILABLE_FOR_LEGAL_REASONS
Defined in the internet draft "A New HTTP Status Code for Legally-restricted Resources". Intended to be used when resource access is denied for legal reasons, e.g. censorship or government-mandated blocked access. A reference to the 1953 dystopian novel Fahrenheit 451, where books are outlawed. -
REQUEST_HEADER_TOO_LARGE
Nginx internal code similar to 431 but it was introduced earlier. -
CERT_ERROR
Nginx internal code used when SSL client certificate error occured to distinguish it from 4XX in a log and an error page redirection. -
NO_CERT
Nginx internal code used when client didn't provide certificate to distinguish it from 4XX in a log and an error page redirection. -
HTTP_TO_HTTPS
Nginx internal code used for the plain HTTP requests that are sent to HTTPS port to distinguish it from 4XX in a log and an error page redirection. -
CLIENT_CLOSED_REQUEST
Used in Nginx logs to indicate when the connection has been closed by client while the server is still processing its request, making server unable to send a status code back. -
INTERNAL_SERVER_ERROR
A generic error message, given when no more specific message is suitable -
NOT_IMPLEMENTED
The server either does not recognize the request method, or it lacks the ability to fulfill the request. -
BAD_GATEWAY
The server was acting as a gateway or proxy and received an invalid response from the upstream server. -
SERVICE_UNAVAILABLE
The server is currently unavailable (because it is overloaded or down for maintenance).Generally, this is a temporary state. -
GATEWAY_TIMEOUT
The server was acting as a gateway or proxy and did not receive a timely response from the upstream server. -
HTTP_VERSION_NOT_SUPPORTED
The server does not support the HTTP protocol version used in the request. -
VARIANT_ALSO_NEGOTIATES
RFC 2295
Transparent content negotiation for the request results in a circular reference.
-
INSUFFICIENT_STORAGE
WebDAV; RFC 4918
The server is unable to store the representation needed to complete the request.[4]
-
LOOP_DETECTED
WebDAV; RFC 5842
The server detected an infinite loop while processing the request (sent in lieu of 208).
-
BANDWIDTH_LIMIT_EXCEEDED
This status code, while used by many servers, is not specified in any RFCs. -
NOT_EXTENDED
RFC 2774
Further extensions to the request are required for the server to fulfill it.
-
NETWORK_AUTHENTICATION_REQUIRED
RFC 6585
The client needs to authenticate to gain network access. Intended for use by intercepting proxies used to control access to the network (e.g. "captive portals" used to require agreement to Terms of Service before granting full Internet access via a Wi-Fi hotspot).
-
NETWORK_READ_TIMEOUT_ERROR
This status code is not specified in any RFCs, but is used by Microsoft Corp. HTTP proxies to signal a network read timeout behind the proxy to a client in front of the proxy. -
NETWORK_CONNECT_TIMEOUT_ERROR
This status code is not specified in any RFCs, but is used by Microsoft Corp. HTTP proxies to signal a network connect timeout behind the proxy to a client in front of the proxy.
-
-
Field Details
-
code
public final int code
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified nameNullPointerException- if the argument is null
-
toString
- Overrides:
toStringin classEnum<HttpStatus>
-