Enum HttpStatus
-
- All Implemented Interfaces:
-
java.io.Serializable
,kotlin.Comparable
public enum HttpStatus extends Enum<HttpStatus>
HTTP response status codes indicating whether a specific HTTP request has been successfully completed.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public class
HttpStatus.Companion
-
Enum Constant Summary
Enum Constants Enum Constant Description CONTINUE
This interim response indicates that the client should continue the request or ignore the response if the request is already finished.
SWITCHING_PROTOCOLS
This code is sent in response to an Upgrade request header from the client and indicates the protocol the server is switching to.
PROCESSING
This code indicates that the server has received and is processing the request, but no response is available yet.
EARLY_HINTS
This status code is primarily intended to be used with the Link header, letting the user agent start preloading resources while the server prepares a response or preconnect to an origin from which the page will need resources.
OK
The request succeeded.
CREATED
The request succeeded, and a new resource was created as a result. This is typically the response sent after POST requests, or some PUT requests.
ACCEPTED
The request has been received but not yet acted upon. It is noncommittal, since there is no way in HTTP to later send an asynchronous response indicating the outcome of the request. It is intended for cases where another process or server handles the request, or for batch processing.
NON_AUTHORITATIVE_INFORMATION
This response code means the returned metadata is not exactly the same as is available from the origin server, but is collected from a local or a third-party copy. This is mostly used for mirrors or backups of another resource. Except for that specific case, the 200 OK response is preferred to this status.
NO_CONTENT
There is no content to send for this request, but the headers may be useful. The user agent may update its cached headers for this resource with the new ones.
RESET_CONTENT
Tells the user agent to reset the document which sent this request.
PARTIAL_CONTENT
This response code is used when the Range header is sent from the client to request only part of a resource.
MULTI_STATUS
Conveys information about multiple resources, for situations where multiple status codes might be appropriate.
ALREADY_REPORTED
Used inside a dav:propstat response element to avoid repeatedly enumerating the internal members of multiple bindings to the same collection.
IM_USED
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
The request has more than one possible response. The user agent or user should choose one of them.
MOVED_PERMANENTLY
The URL of the requested resource has been changed permanently. The new URL is given in the response.
FOUND
This response code means that the URI of requested resource has been changed temporarily. Further changes in the URI might be made in the future. Therefore, this same URI should be used by the client in future requests.
SEE_OTHER
The server sent this response to direct the client to get the requested resource at another URI with a GET request.
NOT_MODIFIED
This is used for caching purposes. It tells the client that the response has not been modified, so the client can continue to use the same cached version of the response.
USE_PROXY
Defined in a previous version of the HTTP specification to indicate that a requested response must be accessed by a proxy.
TEMPORARY_REDIRECT
The server sends this response to direct the client to get the requested resource at another URI with the same method that was used in the prior request.
PERMANENT_REDIRECT
This means that the resource is now permanently located at another URI, specified by the Location: HTTP Response header.
BAD_REQUEST
The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).
UNAUTHORIZED
Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.
PAYMENT_REQUIRED
This response code is reserved for future use. The initial aim for creating this code was using it for digital payment systems, however this status code is used very rarely and no standard convention exists.
FORBIDDEN
The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401 Unauthorized, the client's identity is known to the server.
NOT_FOUND
The server cannot find the requested resource. In the browser, this means the URL is not recognized.
METHOD_NOT_ALLOWED
The request method is known by the server but is not supported by the target resource. For example, an API may not allow calling DELETE to remove a resource.
NOT_ACCEPTABLE
This response is sent when the web server, after performing server-driven content negotiation, doesn't find any content that conforms to the criteria given by the user agent.
PROXY_AUTHENTICATION_REQUIRED
This is similar to
401 Unauthorized
but authentication is needed to be done by a proxy.REQUEST_TIMEOUT
This response is sent on an idle connection by some servers, even without any previous request by the client. It means that the server would like to shut down this unused connection.
CONFLICT
This response is sent when a request conflicts with the current state of the server.
GONE
This response is sent when the requested content has been permanently deleted from server, with no forwarding address.
LENGTH_REQUIRED
Server rejected the request because the Content-Length header field is not defined and the server requires it.
PRECONDITION_FAILED
The client has indicated preconditions in its headers which the server does not meet.
CONTENT_TOO_LARGE
Request entity is larger than limits defined by server. The server might close the connection or return an Retry-After header field.
URI_TOO_LONG
The URI requested by the client is longer than the server is willing to interpret.
UNSUPPORTED_MEDIA_TYPE
The media format of the requested data is not supported by the server, so the server is rejecting the request.
RANGE_NOT_SATISFIABLE
The range specified by the Range header field in the request cannot be fulfilled. It's possible that the range is outside the size of the target URI's data.
EXPECTATION_FAILED
This response code means the expectation indicated by the Expect request header field cannot be met by the server.
IM_A_TEAPOT
The server refuses the attempt to brew coffee with a teapot.
ENHANCE_YOUR_CALM
Unofficial status code, used in Twitter API to indicate that the client is being rate limited for making too many requests.
MISDIRECTED_REQUEST
The request was directed at a server that is not able to produce a response. This can be sent by a server that is not configured to produce responses for the combination of scheme and authority that are included in the request URI.
UNPROCESSABLE_CONTENT
The request was well-formed but was unable to be followed due to semantic errors.
LOCKED
The resource that is being accessed is locked, meaning it can't be accessed.
FAILED_DEPENDENCY
The request failed due to failure of a previous request.
TOO_EARLY
Indicates that the server is unwilling to risk processing a request that might be replayed.
UPGRADE_REQUIRED
The server refuses to perform the request using the current protocol but might be willing to do so after the client upgrades to a different protocol.
PRECONDITION_REQUIRED
The origin server requires the request to be conditional. This response is 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 ("rate limiting").
REQUEST_HEADER_FIELDS_TOO_LARGE
The server is unwilling to process the request because its header fields are too large. The request may be resubmitted after reducing the size of the request header fields.
UNAVAILABLE_FOR_LEGAL_REASONS
The user agent requested a resource that cannot legally be provided, such as a web page censored by a government.
INTERNAL_SERVER_ERROR
The server has encountered a situation it does not know how to handle.
NOT_IMPLEMENTED
The request method is not supported by the server and cannot be handled. The only methods that servers are required to support (and therefore that must not return this code) are GET and HEAD.
BAD_GATEWAY
This error response means that the server, while working as a gateway to get a response needed to handle the request, got an invalid response.
SERVICE_UNAVAILABLE
The server is not ready to handle the request. Common causes are a server that is down for maintenance or that is overloaded.
GATEWAY_TIMEOUT
This error response is given when the server is acting as a gateway and cannot get a response in time.
HTTP_VERSION_NOT_SUPPORTED
The HTTP version used in the request is not supported by the server.
INSUFFICIENT_STORAGE
The method could not be performed on the resource because the server is unable to store the representation needed to successfully complete the request.
LOOP_DETECTED
The server detected an infinite loop while processing the request.
NETWORK_AUTHENTICATION_REQUIRED
Indicates that the client needs to authenticate to gain network access.
UNKNOWN
An unknown status code
-
Method Summary
Modifier and Type Method Description final Boolean
isInformational()
Checks if the status code is informational: the request was received, continuing process final Boolean
isSuccess()
Checks if the status code indicates success: the request was successfully received, understood, and accepted final Boolean
isRedirection()
Checks if the status code indicates a redirection: further action needs to be taken in order to complete the request final Boolean
isClientError()
Checks if the status code indicates a client error: the request contains bad syntax or cannot be fulfilled final Boolean
isServerError()
Checks if the status code indicates a server error: the server failed to fulfil an apparently valid request final Boolean
isError()
Checks if the status code indicates an error. String
toString()
final HttpStatus
valueOf(String value)
Returns the enum constant of this type with the specified name. final Array<HttpStatus>
values()
Returns an array containing the constants of this enum type, in the order they're declared. final Integer
getCode()
final String
getMessage()
final EnumEntries<HttpStatus>
getEntries()
HTTP response status codes indicating whether a specific HTTP request has been successfully completed. -
-
Method Detail
-
isInformational
final Boolean isInformational()
Checks if the status code is informational: the request was received, continuing process
-
isSuccess
final Boolean isSuccess()
Checks if the status code indicates success: the request was successfully received, understood, and accepted
-
isRedirection
final Boolean isRedirection()
Checks if the status code indicates a redirection: further action needs to be taken in order to complete the request
-
isClientError
final Boolean isClientError()
Checks if the status code indicates a client error: the request contains bad syntax or cannot be fulfilled
-
isServerError
final Boolean isServerError()
Checks if the status code indicates a server error: the server failed to fulfil an apparently valid request
-
valueOf
final HttpStatus valueOf(String value)
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.)
-
values
final Array<HttpStatus> values()
Returns an array containing the constants of this enum type, in the order they're declared.
This method may be used to iterate over the constants.
-
getMessage
final String getMessage()
-
getEntries
final EnumEntries<HttpStatus> getEntries()
HTTP response status codes indicating whether a specific HTTP request has been successfully completed.
-
-
-
-