Enum Class HttpResponseCode
- All Implemented Interfaces:
Serializable,Comparable<HttpResponseCode>,Constable
All http response codes. See here for a full list
with a detailed explanation of each response code.
- Since:
- 4.0
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionThe request has been accepted for processing, but the processing has not been completed.The members of a DAV binding have already been enumerated in a preceding part of the (multistatus) response, and are not being included again.The server was acting as a gateway or proxy and received an invalid response from the upstream server.The server cannot or will not process the request due to an apparent client error (e.g., malformed request syntax, size too large, invalid request message framing, or deceptive request routing).Indicates that the request could not be processed because of conflict in the current state of the resource, such as an edit conflict between multiple simultaneous updates.The server has received the request headers and 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, resulting in the creation of a new resource.Used to return some response headers before final HTTP message.The server cannot meet the requirements of the Expect request-header field.The request failed because it depended on another request and that request failed (e.g., a PROPPATCH).The request contained valid data and was understood by the server, but the server is refusing action.Tells the client to look at (browse to) another URL.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.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.The server has fulfilled a request for the resource, and the response is a representation of the result of one or more instance-manipulations applied to the current instance.The server is unable to store the representation needed to complete the request.A generic error message, given when an unexpected condition was encountered and no more specific message is suitable.The request did not specify the length of its content, which is required by the requested resource.The resource that is being accessed is locked.The server detected an infinite loop while processing the request (instead ofALREADY_REPORTED).A request method is not supported for the requested resource; for example, a GET request on a form that requires data to be presented via POST, or a PUT request on a read-only resource.The request was directed at a server that is not able to produce a response (for example because of connection reuse).This and all future requests should be directed to the given URI.The message body that follows is by default an XML message and can contain a number of separate response codes, depending on how many sub-requests were made.Indicates multiple options for the resource from which the client may choose (via agent-driven content negotiation).The client needs to authenticate to gain network access.The server successfully processed the request and is not returning any content.The server is a transforming proxy (e.g.The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request.Further extensions to the request are required for the server to fulfil it.The requested resource could not be found but may be available in the future.The server either does not recognize the request method, or it lacks the ability to fulfil the request.Indicates that the resource has not been modified since the version specified by the request headers If-Modified-Since or If-None-Match.Standard response for successful HTTP requests.The server is delivering only part of the resource (byte serving) due to a range header sent by the client.The request is larger than the server is willing or able to process.Reserved for future use.The request and all future requests should be repeated using another URI.The server does not meet one of the preconditions that the requester put on the request header fields.The origin server requires the request to be conditional.A WebDAV request may contain many sub-requests involving file operations, requiring a long time to complete the request.The client must first authenticate itself with the proxy.The client has asked for a portion of the file (byte serving), but the server cannot supply that portion.The server is unwilling to process the request because either an individual header field, or all the header fields collectively, are too large.The server timed out waiting for the request.The server successfully processed the request, but is not returning any content.The response to the request can be found under another URI using the GET method.The server cannot handle the request (because it is overloaded or down for maintenance).No longer used.The requester has asked the server to switch protocols and the server has agreed to do so.In this case, the request should be repeated with another URI; however, future requests should still use the original URI.Indicates that the server is unwilling to risk processing a request that might be replayed.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.A server operator has received a legal demand to deny access to a resource or to a set of resources that includes the requested resource.[61] The code 451 was chosen as a reference to the novel Fahrenheit 451 (see the Acknowledgements in the RFC).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, given in the Upgrade header field.The URI provided was too long for the server to process.The requested resource is available only through a proxy, the address for which is provided in the response.Transparent content negotiation for the request results in a circular reference. -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final Map<Integer,HttpResponseCode> private final int -
Constructor Summary
ConstructorsModifierConstructorDescriptionprivateHttpResponseCode(int code) Constructs a new http response code. -
Method Summary
Modifier and TypeMethodDescriptionintcode()Get the numeric representation of the http response code.static @NonNull HttpResponseCodefromNumeric(int numeric) Get the http response code associated from the numeric status code, falling back to OK if the code was not found.static HttpResponseCodeReturns the enum constant of this class with the specified name.static HttpResponseCode[]values()Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
CONTINUE
The server has received the request headers and 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). Sending a large request body to a server after a request has been rejected for inappropriate headers would be inefficient. To have a server check the request's headers, a client must send Expect: 100-continue as a header in its initial request and receive a 100 Continue status code in response before sending the body. If the client receives an error code such as 403 (Forbidden) or 405 (Method Not Allowed) then it shouldn't send the request's body. The response 417 Expectation Failed indicates that the request should be repeated without the Expect header as it indicates that the server doesn't support expectations (this is the case, for example, of HTTP/1.0 servers). -
SWITCHING_PROTOCOLS
The requester has asked the server to switch protocols and the server has agreed to do so. -
PROCESSING
A WebDAV request may contain many sub-requests involving file operations, requiring 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. -
EARLY_HINTS
Used to return some response headers before final HTTP message. -
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, resulting in the creation of a new resource. -
ACCEPTED
The request has been accepted for processing, but the processing has not been completed. The request might or might not be eventually acted upon, and may be disallowed when processing occurs. -
NON_AUTHORITATIVE_INFORMATION
The server is a transforming proxy (e.g. a Web accelerator) that received a 200 OK from its origin, but is returning a modified version of the origin's response. -
NO_CONTENT
The server successfully processed the request and 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 (byte serving) due to a range header sent by the client. The range header is used by HTTP clients to enable resuming of interrupted downloads, or split a download into multiple simultaneous streams. -
MULTI_STATUS
The message body that follows is by default an XML message and can contain a number of separate response codes, depending on how many sub-requests were made. -
ALREADY_REPORTED
The members of a DAV binding have already been enumerated in a preceding part of the (multistatus) response, and are not being included again. -
IM_USED
The server has fulfilled a 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 from which the client may choose (via agent-driven content negotiation). For example, this code could be used to present multiple video format options, to list files with different filename extensions, or to suggest word-sense disambiguation. -
MOVED_PERMANENTLY
This and all future requests should be directed to the given URI. -
FOUND
Tells the client to look at (browse to) another URL. 302 has been superseded by 303 and 307. 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 the GET method. When received in response to a POST (or PUT/DELETE), the client should presume that the server has received the data and should issue a new GET request to the given URI. -
NOT_MODIFIED
Indicates that the resource has not been modified since the version specified by the request headers If-Modified-Since or If-None-Match. In such case, there is no need to retransmit the resource since the client still has a previously-downloaded copy. -
USE_PROXY
The requested resource is available only through a proxy, the address for which is provided in the response. For security reasons, many HTTP clients (such as Mozilla Firefox and Internet Explorer) do not obey this status code. -
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 example, a POST request should be repeated using another POST request. -
PERMANENT_REDIRECT
The request and all future requests should be repeated using another URI. 307 and 308 parallel the behaviors 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 server cannot or will not process the request due to an apparent client error (e.g., malformed request syntax, size too large, invalid request message framing, or deceptive request routing). -
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. See Basic access authentication and Digest access authentication. 401 semantically means "unauthorised", the user does not have valid authentication credentials for the target resource.Note: Some sites incorrectly issue HTTP 401 when an IP address is banned from the website (usually the website domain) and that specific address is refused permission to access a website.
-
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, as proposed, for example, by GNU Taler, but that has not yet happened, and this code is not usually used. Google Developers API uses this status if a particular developer has exceeded the daily limit on requests. Sipgate uses this code if an account does not have sufficient funds to start a call. Shopify uses this code when the store has not paid their fees and is temporarily disabled. Stripe uses this code for failed payments where parameters were correct, for example blocked fraudulent payments. -
FORBIDDEN
The request contained valid data and was understood by the server, but the server is refusing action. This may be due to the user not having the necessary permissions for a resource or needing an account of some sort, or attempting a prohibited action (e.g. creating a duplicate record where only one is allowed). This code is also typically used if the request provided authentication via the WWW-Authenticate header field, but the server did not accept that authentication. The request should not be repeated. -
NOT_FOUND
The requested resource could not be found but may be available in the future. Subsequent requests by the client are permissible. -
METHOD_NOT_ALLOWED
A request method is not supported for the requested resource; for example, a GET request on a form that requires data to be presented via POST, or a PUT request on a read-only resource. -
NOT_ACCEPTABLE
The requested resource is capable of generating only 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 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 current state of the resource, such as an edit conflict between multiple simultaneous updates. -
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 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_FAIL
The server does not meet one of the preconditions that the requester put on the request header fields. -
PAYLOAD_TOO_LARGE
The request is larger than the server is willing or able to process. Previously called "Request Entity Too Large". -
URI_TOO_LONG
The URI provided was too long for the server to process. Often the result of too much data being encoded as a query-string of a GET request, in which case it should be converted to a POST request. Called "Request-URI Too Long" previously. -
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. -
RANGE_NOT_SATISFIABLE
The client has asked for a portion of the file (byte serving), 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. Called "Requested Range Not Satisfiable" previously. -
EXPECTATION_FAILED
The server cannot meet the requirements of the Expect request-header field. -
I_AM_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. The RFC specifies this code should be returned by teapots requested to brew coffee. This HTTP status is used as an Easter egg in some websites, including Google.com. -
MISDIRECTED_REQUEST
The request was directed at a server that is not able to produce a response (for example because of connection reuse). -
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. -
FAILED_DEPENDENCY
The request failed because it depended on another request and that request failed (e.g., a PROPPATCH). -
TOO_EARLY
Indicates that the server is unwilling to risk processing a request that might be replayed. -
UPGRADE_REQUIRED
The client should switch to a different protocol such as TLS/1.0, given in the Upgrade header field. -
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. -
UNAVAILABLE_FOR_LEGAL_REASONS
A server operator has received a legal demand to deny access to a resource or to a set of resources that includes the requested resource.[61] The code 451 was chosen as a reference to the novel Fahrenheit 451 (see the Acknowledgements in the RFC). -
INTERNAL_SERVER_ERROR
A generic error message, given when an unexpected condition was encountered and no more specific message is suitable. -
NOT_IMPLEMENTED
The server either does not recognize the request method, or it lacks the ability to fulfil the request. Usually this implies future availability (e.g., a new feature of a web-service API). -
BAD_GATEWAY
The server was acting as a gateway or proxy and received an invalid response from the upstream server. -
SERVICE_UNAVAILABLE
The server cannot handle the request (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
Transparent content negotiation for the request results in a circular reference. -
INSUFFICIENT_STORAGE
The server is unable to store the representation needed to complete the request. -
LOOP_DETECTED
The server detected an infinite loop while processing the request (instead ofALREADY_REPORTED). -
NOT_EXTENDED
Further extensions to the request are required for the server to fulfil it. -
NETWORK_AUTHENTICATION_REQUIRED
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).
-
-
Field Details
-
BY_CODE
-
code
private final int code
-
-
Constructor Details
-
HttpResponseCode
private HttpResponseCode(int code) Constructs a new http response code.- Parameters:
code- the numeric representation of the response 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
-
fromNumeric
Get the http response code associated from the numeric status code, falling back to OK if the code was not found.- Parameters:
numeric- the numeric version of the response code.- Returns:
- the response code associated with the numeric value, or OK.
-
code
public int code()Get the numeric representation of the http response code.- Returns:
- the numeric representation of the http response code.
-