Package org.forgerock.http.protocol

Class Status

java.lang.Object
org.forgerock.http.protocol.Status
public final class Status extends Object
The status-code element is a three-digit integer code giving the result of the attempt to understand and satisfy the request.

HTTP status codes are extensible. HTTP clients are not required to understand the meaning of all registered status codes, though such understanding is obviously desirable. However, a client MUST understand the class of any status code, as indicated by the first digit, and treat an unrecognized status code as being equivalent to the x00 status code of that class, with the exception that a recipient MUST NOT cache a response with an unrecognized status code.

For example, if an unrecognized status code of 471 is received by a client, the client can assume that there was something wrong with its request and treat the response as if it had received a 400 (Bad Request) status code. The response message will usually contain a representation that explains the status.

The first digit of the status-code defines the class of response. The last two digits do not have any categorization role. There are five values for the first digit:

  • 1xx (Informational): The request was received, continuing process
  • 2xx (Successful): The request was successfully received, understood, and accepted
  • 3xx (Redirection): Further action needs to be taken in order to complete the request
  • 4xx (Client Error): The request contains bad syntax or cannot be fulfilled
  • 5xx (Server Error): The server failed to fulfill an apparently valid request

The reason phrases are only recommendations they can be replaced by local equivalents without affecting the protocol.

See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    Status.Family
    The first digit of the status-code defines the class of response.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Status
    ACCEPTED
    The 202 (Accepted) status code indicates that the request has been accepted for processing, but the processing has not been completed.
    static final Status
    BAD_GATEWAY
    The 502 (Bad Gateway) status code indicates that the server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request.
    static final Status
    BAD_REQUEST
    The 400 (Bad Request) status code indicates that 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).
    static final Status
    CONFLICT
    The 409 (Conflict) status code indicates that the request could not be completed due to a conflict with the current state of the target resource.
    static final Status
    CONTINUE
    The 100 (Continue) status code indicates that the initial part of a request has been received and has not yet been rejected by the server.
    static final Status
    CREATED
    The 201 (Created) status code indicates that the request has been fulfilled and has resulted in one or more new resources being created.
    static final Status
    EXPECTATION_FAILED
    The 417 (Expectation Failed) status code indicates that the expectation given in the request's Expect header field (Section 5.1.1) could not be met by at least one of the inbound servers.
    static final Status
    FORBIDDEN
    The 403 (Forbidden) status code indicates that the server understood the request but refuses to authorize it.
    static final Status
    FOUND
    The 302 (Found) status code indicates that the target resource resides temporarily under a different URI.
    static final Status
    GATEWAY_TIMEOUT
    The 504 (Gateway Timeout) status code indicates that the server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request.
    static final Status
    GONE
    The 410 (Gone) status code indicates that access to the target resource is no longer available at the origin server and that this condition is likely to be permanent.
    static final Status
    HTTP_VERSION_NOT_SUPPORTED
    The 505 (HTTP Version Not Supported) status code indicates that the server does not support, or refuses to support, the major version of HTTP that was used in the request message.
    static final Status
    INTERNAL_SERVER_ERROR
    The 500 (Internal Server Error) status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.
    static final Status
    LENGTH_REQUIRED
    The 411 (Length Required) status code indicates that the server refuses to accept the request without a defined Content-Length (Section 3.3.2 of [RFC7230]).
    static final Status
    METHOD_NOT_ALLOWED
    The 405 (Method Not Allowed) status code indicates that the method received in the request-line is known by the origin server but not supported by the target resource.
    static final Status
    MOVED_PERMANENTLY
    The 301 (Moved Permanently) status code indicates that the target resource has been assigned a new permanent URI and any future references to this resource ought to use one of the enclosed URIs.
    static final Status
    MULTIPLE_CHOICES
    The 300 (Multiple Choices) status code indicates that the target resource has more than one representation, each with its own more specific identifier, and information about the alternatives is being provided so that the user (or user agent) can select a preferred representation by redirecting its request to one or more of those identifiers.
    static final Status
    NO_CONTENT
    The 204 (No Content) status code indicates that the server has successfully fulfilled the request and that there is no additional content to send in the response payload body.
    static final Status
    NON_AUTHORITATIVE_INFO
    The 203 (Non-Authoritative Information) status code indicates that the request was successful but the enclosed payload has been modified from that of the origin server's 200 (OK) response by a transforming proxy (Section 5.7.2 of [RFC7230]).
    static final Status
    NOT_ACCEPTABLE
    The 406 (Not Acceptable) status code indicates that the target resource does not have a current representation that would be acceptable to the user agent, according to the proactive negotiation header fields received in the request (Section 5.3), and the server is unwilling to supply a default representation.
    static final Status
    NOT_FOUND
    The 404 (Not Found) status code indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists.
    static final Status
    NOT_IMPLEMENTED
    The 501 (Not Implemented) status code indicates that the server does not support the functionality required to fulfill the request.
    static final Status
    OK
    The 200 (OK) status code indicates that the request has succeeded.
    static final Status
    PAYLOAD_TOO_LARGE
    The 413 (Payload Too Large) status code indicates that the server is refusing to process a request because the request payload is larger than the server is willing or able to process.
    static final Status
    PAYMENT_REQUIRED
    The 402 (Payment Required) status code is reserved for future use.
    static final Status
    PROXY_AUTHENTICATION_REQUIRED
    The 407 (Proxy Authentication Required) status code is similar to 401 (Unauthorized), but it indicates that the client needs to authenticate itself in order to use a proxy.
    static final Status
    REQUEST_HEADER_FIELDS_TOO_LARGE
    The 431 status code indicates that the server is unwilling to process the request because its header fields are too large.
    static final Status
    REQUEST_TIMEOUT
    The 408 (Request Timeout) status code indicates that the server did not receive a complete request message within the time that it was prepared to wait.
    static final Status
    RESET_CONTENT
    The 205 (Reset Content) status code indicates that the server has fulfilled the request and desires that the user agent reset the "document view", which caused the request to be sent, to its original state as received from the origin server.
    static final Status
    SEE_OTHER
    The 303 (See Other) status code indicates that the server is redirecting the user agent to a different resource, as indicated by a URI in the Location header field, which is intended to provide an indirect response to the original request.
    static final Status
    SERVICE_UNAVAILABLE
    The 503 (Service Unavailable) status code indicates that the server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay.
    static final Status
    SWITCHING_PROTOCOLS
    The 101 (Switching Protocols) status code indicates that the server understands and is willing to comply with the client's request, via the Upgrade header field (Section 6.7 of [RFC7230]), for a change in the application protocol being used on this connection.
    static final Status
    TEAPOT
    Any attempt to brew coffee with a teapot should result in the error code "418 I'm a teapot".
    static final Status
    TEMPORARY_REDIRECT
    The 307 (Temporary Redirect) status code indicates that the target resource resides temporarily under a different URI and the user agent MUST NOT change the request method if it performs an automatic redirection to that URI.
    static final Status
    TOO_MANY_REQUESTS
    The 429 status code indicates that the user has sent too many requests in a given amount of time ("rate limiting").
    static final Status
    UNAUTHORIZED
    The request requires user authentication.
    static final Status
    UNSUPPORTED_MEDIA_TYPE
    The 415 (Unsupported Media Type) status code indicates that the origin server is refusing to service the request because the payload is in a format not supported by this method on the target resource.
    static final Status
    UNUSED
    The 306 status code was defined in a previous version of this specification, is no longer used, and the code is reserved.
    static final Status
    UPGRADE_REQUIRED
    The 426 (Upgrade Required) status code indicates that 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.
    static final Status
    URI_TOO_LONG
    The 414 (URI Too Long) status code indicates that the server is refusing to service the request because the request-target (Section 5.3 of [RFC7230]) is longer than the server is willing to interpret.
    static final Status
    USE_PROXY
    The 305 (Use Proxy) status code was defined in a previous version of this specification and is now deprecated (Appendix B).

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getCode()
    Returns the three-digit integer code giving the result of the attempt to understand and satisfy the request.
    Status.Family
    getFamily()
    Returns the class of response of this status code.
    String
    getReasonPhrase()
    Returns the reason phrase associated with the status code.
    boolean
    isClientError()
    Is the family of this status a Status.Family.CLIENT_ERROR one ?
    boolean
    isInformational()
    Is the family of this status a Status.Family.INFORMATIONAL one ?
    boolean
    isRedirection()
    Is the family of this status a Status.Family.REDIRECTION one ?
    boolean
    isServerError()
    Is the family of this status a Status.Family.SERVER_ERROR one ?
    boolean
    isSuccessful()
    Is the family of this status a Status.Family.SUCCESSFUL one ?
    String
    toString()
     
    static Status
    valueOf(int code)
    Get a Status from the given integer.
    static Status
    valueOf(int code, String reason)
    Get a Status from the given integer.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Field Details

    • CONTINUE

      public static final Status CONTINUE
      The 100 (Continue) status code indicates that the initial part of a request has been received and has not yet been rejected by the server. The server intends to send a final response after the request has been fully received and acted upon. When the request contains an Expect header field that includes a 100-continue expectation, the 100 response indicates that the server wishes to receive the request payload body, as described in Section 5.1.1. The client ought to continue sending the request and discard the 100 response. If the request did not contain an Expect header field containing the 100-continue expectation, the client can simply discard this interim response.

    • SWITCHING_PROTOCOLS

      public static final Status SWITCHING_PROTOCOLS
      The 101 (Switching Protocols) status code indicates that the server understands and is willing to comply with the client's request, via the Upgrade header field (Section 6.7 of [RFC7230]), for a change in the application protocol being used on this connection. The server MUST generate an Upgrade header field in the response that indicates which protocol(s) will be switched to immediately after the empty line that terminates the 101 response. It is assumed that the server will only agree to switch protocols when it is advantageous to do so. For example, switching to a newer version of HTTP might be advantageous over older versions, and switching to a real-time, synchronous protocol might be advantageous when delivering resources that use such features.

    • OK

      public static final Status OK
      The 200 (OK) status code indicates that the request has succeeded. The payload sent in a 200 response depends on the request method. For the methods defined by this specification, the intended meaning of the payload can be summarized as: GET a representation of the target resource; HEAD the same representation as GET, but without the representation data; POST a representation of the status of, or results obtained from, the action; PUT, DELETE a representation of the status of the action; OPTIONS a representation of the communications options; TRACE a representation of the request message as received by the end server. Aside from responses to CONNECT, a 200 response always has a payload, though an origin server MAY generate a payload body of zero length. If no payload is desired, an origin server ought to send 204 (No Content) instead. For CONNECT, no payload is allowed because the successful result is a tunnel, which begins immediately after the 200 response header section. A 200 response is cacheable by default; i.e., unless otherwise indicated by the method definition or explicit cache controls (see Section 4.2.2 of [RFC7234]).

    • CREATED

      public static final Status CREATED
      The 201 (Created) status code indicates that the request has been fulfilled and has resulted in one or more new resources being created. The primary resource created by the request is identified by either a Location header field in the response or, if no Location field is received, by the effective request URI. The 201 response payload typically describes and links to the resource(s) created. See Section 7.2 for a discussion of the meaning and purpose of validator header fields, such as ETag and Last-Modified, in a 201 response.

    • ACCEPTED

      public static final Status ACCEPTED
      The 202 (Accepted) status code indicates that 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. There is no facility in HTTP for re-sending a status code from an asynchronous operation. The 202 response is intentionally noncommittal. Its purpose is to allow a server to accept a request for some other process (perhaps a batch-oriented process that is only run once per day) without requiring that the user agent's connection to the server persist until the process is completed. The representation sent with this response ought to describe the request's current status and point to (or embed) a status monitor that can provide the user with an estimate of when the request will be fulfilled.

    • NON_AUTHORITATIVE_INFO

      public static final Status NON_AUTHORITATIVE_INFO
      The 203 (Non-Authoritative Information) status code indicates that the request was successful but the enclosed payload has been modified from that of the origin server's 200 (OK) response by a transforming proxy (Section 5.7.2 of [RFC7230]). This status code allows the proxy to notify recipients when a transformation has been applied, since that knowledge might impact later decisions regarding the content. For example, future cache validation requests for the content might only be applicable along the same request path (through the same proxies). The 203 response is similar to the Warning code of 214 Transformation Applied (Section 5.5 of [RFC7234]); which has the advantage of being applicable to responses with any status code. A 203 response is cacheable by default; i.e., unless otherwise indicated by the method definition or explicit cache controls (see Section 4.2.2 of [RFC7234]).

    • NO_CONTENT

      public static final Status NO_CONTENT
      The 204 (No Content) status code indicates that the server has successfully fulfilled the request and that there is no additional content to send in the response payload body. Metadata in the response header fields refer to the target resource and its selected representation after the requested action was applied. For example, if a 204 status code is received in response to a PUT request and the response contains an ETag header field, then the PUT was successful and the ETag field-value contains the entity-tag for the new representation of that target resource. The 204 response allows a server to indicate that the action has been successfully applied to the target resource, while implying that the user agent does not need to traverse away from its current "document view" (if any). The server assumes that the user agent will provide some indication of the success to its user, in accord with its own interface, and apply any new or updated metadata in the response to its active representation. For example, a 204 status code is commonly used with document editing interfaces corresponding to a "save" action, such that the document being saved remains available to the user for editing. It is also frequently used with interfaces that expect automated data transfers to be prevalent, such as within distributed version control systems. A 204 response is terminated by the first empty line after the header fields because it cannot contain a message body. A 204 response is cacheable by default; i.e., unless otherwise indicated by the method definition or explicit cache controls (see Section 4.2.2 of [RFC7234]).

    • RESET_CONTENT

      public static final Status RESET_CONTENT
      The 205 (Reset Content) status code indicates that the server has fulfilled the request and desires that the user agent reset the "document view", which caused the request to be sent, to its original state as received from the origin server. This response is intended to support a common data entry use case where the user receives content that supports data entry (a form, notepad, canvas, etc.), enters or manipulates data in that space, causes the entered data to be submitted in a request, and then the data entry mechanism is reset for the next entry so that the user can easily initiate another input action. Since the 205 status code implies that no additional content will be provided, a server MUST NOT generate a payload in a 205 response. In other words, a server MUST do one of the following for a 205 response: a) indicate a zero-length body for the response by including a Content-Length header field with a value of 0; b) indicate a zero-length payload for the response by including a Transfer-Encoding header field with a value of chunked and a message body consisting of a single chunk of zero-length; or, c) close the connection immediately after sending the blank line terminating the header section.

    • MULTIPLE_CHOICES

      public static final Status MULTIPLE_CHOICES
      The 300 (Multiple Choices) status code indicates that the target resource has more than one representation, each with its own more specific identifier, and information about the alternatives is being provided so that the user (or user agent) can select a preferred representation by redirecting its request to one or more of those identifiers. In other words, the server desires that the user agent engage in reactive negotiation to select the most appropriate representation(s) for its needs (Section 3.4). If the server has a preferred choice, the server SHOULD generate a Location header field containing a preferred choice's URI reference. The user agent MAY use the Location field value for automatic redirection. For request methods other than HEAD, the server SHOULD generate a payload in the 300 response containing a list of representation metadata and URI reference(s) from which the user or user agent can choose the one most preferred. The user agent MAY make a selection from that list automatically if it understands the provided media type. A specific format for automatic selection is not defined by this specification because HTTP tries to remain orthogonal to the definition of its payloads. In practice, the representation is provided in some easily parsed format believed to be acceptable to the user agent, as determined by shared design or content negotiation, or in some commonly accepted hypertext format. A 300 response is cacheable by default; i.e., unless otherwise indicated by the method definition or explicit cache controls (see Section 4.2.2 of [RFC7234]). Note: The original proposal for the 300 status code defined the URI header field as providing a list of alternative representations, such that it would be usable for 200, 300, and 406 responses and be transferred in responses to the HEAD method. However, lack of deployment and disagreement over syntax led to both URI and Alternates (a subsequent proposal) being dropped from this specification. It is possible to communicate the list using a set of Link header fields [RFC5988], each with a relationship of "alternate", though deployment is a chicken-and-egg problem.

    • MOVED_PERMANENTLY

      public static final Status MOVED_PERMANENTLY
      The 301 (Moved Permanently) status code indicates that the target resource has been assigned a new permanent URI and any future references to this resource ought to use one of the enclosed URIs. Clients with link-editing capabilities ought to automatically re-link references to the effective request URI to one or more of the new references sent by the server, where possible. The server SHOULD generate a Location header field in the response containing a preferred URI reference for the new permanent URI. The user agent MAY use the Location field value for automatic redirection. The server's response payload usually contains a short hypertext note with a hyperlink to the new URI(s). Note: For historical reasons, a user agent MAY change the request method from POST to GET for the subsequent request. If this behavior is undesired, the 307 (Temporary Redirect) status code can be used instead. A 301 response is cacheable by default; i.e., unless otherwise indicated by the method definition or explicit cache controls (see Section 4.2.2 of [RFC7234]).

    • FOUND

      public static final Status FOUND
      The 302 (Found) status code indicates that the target resource resides temporarily under a different URI. Since the redirection might be altered on occasion, the client ought to continue to use the effective request URI for future requests. The server SHOULD generate a Location header field in the response containing a URI reference for the different URI. The user agent MAY use the Location field value for automatic redirection. The server's response payload usually contains a short hypertext note with a hyperlink to the different URI(s). Note: For historical reasons, a user agent MAY change the request method from POST to GET for the subsequent request. If this behavior is undesired, the 307 (Temporary Redirect) status code can be used instead.

    • SEE_OTHER

      public static final Status SEE_OTHER
      The 303 (See Other) status code indicates that the server is redirecting the user agent to a different resource, as indicated by a URI in the Location header field, which is intended to provide an indirect response to the original request. A user agent can perform a retrieval request targeting that URI (a GET or HEAD request if using HTTP), which might also be redirected, and present the eventual result as an answer to the original request. Note that the new URI in the Location header field is not considered equivalent to the effective request URI. This status code is applicable to any HTTP method. It is primarily used to allow the output of a POST action to redirect the user agent to a selected resource, since doing so provides the information corresponding to the POST response in a form that can be separately identified, bookmarked, and cached, independent of the original request. A 303 response to a GET request indicates that the origin server does not have a representation of the target resource that can be transferred by the server over HTTP. However, the Location field value refers to a resource that is descriptive of the target resource, such that making a retrieval request on that other resource might result in a representation that is useful to recipients without implying that it represents the original target resource. Note that answers to the questions of what can be represented, what representations are adequate, and what might be a useful description are outside the scope of HTTP. Except for responses to a HEAD request, the representation of a 303 response ought to contain a short hypertext note with a hyperlink to the same URI reference provided in the Location header field.

    • USE_PROXY

      public static final Status USE_PROXY
      The 305 (Use Proxy) status code was defined in a previous version of this specification and is now deprecated (Appendix B).

    • UNUSED

      public static final Status UNUSED
      The 306 status code was defined in a previous version of this specification, is no longer used, and the code is reserved.

    • TEMPORARY_REDIRECT

      public static final Status TEMPORARY_REDIRECT
      The 307 (Temporary Redirect) status code indicates that the target resource resides temporarily under a different URI and the user agent MUST NOT change the request method if it performs an automatic redirection to that URI. Since the redirection can change over time, the client ought to continue using the original effective request URI for future requests. The server SHOULD generate a Location header field in the response containing a URI reference for the different URI. The user agent MAY use the Location field value for automatic redirection. The server's response payload usually contains a short hypertext note with a hyperlink to the different URI(s). Note: This status code is similar to 302 (Found), except that it does not allow changing the request method from POST to GET. This specification defines no equivalent counterpart for 301 (Moved Permanently) ([RFC7238], however, defines the status code 308 (Permanent Redirect) for this purpose).

    • BAD_REQUEST

      public static final Status BAD_REQUEST
      The 400 (Bad Request) status code indicates that 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

      public static final Status UNAUTHORIZED
      The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource. The client MAY repeat the request with a suitable Authorization header field (section 14.8). If the request already included Authorization credentials, then the 401 response indicates that authorization has been refused for those credentials. If the 401 response contains the same challenge as the prior response, and the user agent has already attempted authentication at least once, then the user SHOULD be presented the entity that was given in the response, since that entity might include relevant diagnostic information. HTTP access authentication is explained in "HTTP Authentication: Basic and Digest Access Authentication" (see RFC 2617).
      See Also:

    • PAYMENT_REQUIRED

      public static final Status PAYMENT_REQUIRED
      The 402 (Payment Required) status code is reserved for future use.

    • FORBIDDEN

      public static final Status FORBIDDEN
      The 403 (Forbidden) status code indicates that the server understood the request but refuses to authorize it. A server that wishes to make public why the request has been forbidden can describe that reason in the response payload (if any). If authentication credentials were provided in the request, the server considers them insufficient to grant access. The client SHOULD NOT automatically repeat the request with the same credentials. The client MAY repeat the request with new or different credentials. However, a request might be forbidden for reasons unrelated to the credentials. An origin server that wishes to "hide" the current existence of a forbidden target resource MAY instead respond with a status code of 404 (Not Found).

    • NOT_FOUND

      public static final Status NOT_FOUND
      The 404 (Not Found) status code indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists. A 404 status code does not indicate whether this lack of representation is temporary or permanent; the 410 (Gone) status code is preferred over 404 if the origin server knows, presumably through some configurable means, that the condition is likely to be permanent. A 404 response is cacheable by default; i.e., unless otherwise indicated by the method definition or explicit cache controls (see Section 4.2.2 of [RFC7234]).

    • METHOD_NOT_ALLOWED

      public static final Status METHOD_NOT_ALLOWED
      The 405 (Method Not Allowed) status code indicates that the method received in the request-line is known by the origin server but not supported by the target resource. The origin server MUST generate an Allow header field in a 405 response containing a list of the target resource's currently supported methods. A 405 response is cacheable by default; i.e., unless otherwise indicated by the method definition or explicit cache controls (see Section 4.2.2 of [RFC7234]).

    • NOT_ACCEPTABLE

      public static final Status NOT_ACCEPTABLE
      The 406 (Not Acceptable) status code indicates that the target resource does not have a current representation that would be acceptable to the user agent, according to the proactive negotiation header fields received in the request (Section 5.3), and the server is unwilling to supply a default representation. The server SHOULD generate a payload containing a list of available representation characteristics and corresponding resource identifiers from which the user or user agent can choose the one most appropriate. A user agent MAY automatically select the most appropriate choice from that list. However, this specification does not define any standard for such automatic selection, as described in Section 6.4.1.

    • PROXY_AUTHENTICATION_REQUIRED

      public static final Status PROXY_AUTHENTICATION_REQUIRED
      The 407 (Proxy Authentication Required) status code is similar to 401 (Unauthorized), but it indicates that the client needs to authenticate itself in order to use a proxy. The proxy MUST send a Proxy-Authenticate header field (Section 4.3) containing a challenge applicable to that proxy for the target resource.

    • REQUEST_TIMEOUT

      public static final Status REQUEST_TIMEOUT
      The 408 (Request Timeout) status code indicates that the server did not receive a complete request message within the time that it was prepared to wait. A server SHOULD send the "close" connection option (Section 6.1 of [RFC7230]) in the response, since 408 implies that the server has decided to close the connection rather than continue waiting. If the client has an outstanding request in transit, the client MAY repeat that request on a new connection.

    • CONFLICT

      public static final Status CONFLICT
      The 409 (Conflict) status code indicates that the request could not be completed due to a conflict with the current state of the target resource. This code is used in situations where the user might be able to resolve the conflict and resubmit the request. The server SHOULD generate a payload that includes enough information for a user to recognize the source of the conflict. Conflicts are most likely to occur in response to a PUT request. For example, if versioning were being used and the representation being PUT included changes to a resource that conflict with those made by an earlier (third-party) request, the origin server might use a 409 response to indicate that it can't complete the request. In this case, the response representation would likely contain information useful for merging the differences based on the revision history.

    • GONE

      public static final Status GONE
      The 410 (Gone) status code indicates that access to the target resource is no longer available at the origin server and that this condition is likely to be permanent. If the origin server does not know, or has no facility to determine, whether or not the condition is permanent, the status code 404 (Not Found) ought to be used instead. The 410 response is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable and that the server owners desire that remote links to that resource be removed. Such an event is common for limited-time, promotional services and for resources belonging to individuals no longer associated with the origin server's site. It is not necessary to mark all permanently unavailable resources as "gone" or to keep the mark for any length of time -- that is left to the discretion of the server owner. A 410 response is cacheable by default; i.e., unless otherwise indicated by the method definition or explicit cache controls (see Section 4.2.2 of [RFC7234]).

    • LENGTH_REQUIRED

      public static final Status LENGTH_REQUIRED
      The 411 (Length Required) status code indicates that the server refuses to accept the request without a defined Content-Length (Section 3.3.2 of [RFC7230]). The client MAY repeat the request if it adds a valid Content-Length header field containing the length of the message body in the request message.

    • PAYLOAD_TOO_LARGE

      public static final Status PAYLOAD_TOO_LARGE
      The 413 (Payload Too Large) status code indicates that the server is refusing to process a request because the request payload is larger than the server is willing or able to process. The server MAY close the connection to prevent the client from continuing the request. If the condition is temporary, the server SHOULD generate a Retry-After header field to indicate that it is temporary and after what time the client MAY try again.

    • URI_TOO_LONG

      public static final Status URI_TOO_LONG
      The 414 (URI Too Long) status code indicates that the server is refusing to service the request because the request-target (Section 5.3 of [RFC7230]) is longer than the server is willing to interpret. This rare condition is only likely to occur when a client has improperly converted a POST request to a GET request with long query information, when the client has descended into a "black hole" of redirection (e.g., a redirected URI prefix that points to a suffix of itself) or when the server is under attack by a client attempting to exploit potential security holes. A 414 response is cacheable by default; i.e., unless otherwise indicated by the method definition or explicit cache controls (see Section 4.2.2 of [RFC7234]).

    • UNSUPPORTED_MEDIA_TYPE

      public static final Status UNSUPPORTED_MEDIA_TYPE
      The 415 (Unsupported Media Type) status code indicates that the origin server is refusing to service the request because the payload is in a format not supported by this method on the target resource. The format problem might be due to the request's indicated Content-Type or Content-Encoding, or as a result of inspecting the data directly.

    • EXPECTATION_FAILED

      public static final Status EXPECTATION_FAILED
      The 417 (Expectation Failed) status code indicates that the expectation given in the request's Expect header field (Section 5.1.1) could not be met by at least one of the inbound servers.

    • TEAPOT

      public static final Status TEAPOT
      Any attempt to brew coffee with a teapot should result in the error code "418 I'm a teapot". The resulting entity body MAY be short and stout. 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 tea pots requested to brew coffee.
      See Also:

    • UPGRADE_REQUIRED

      public static final Status UPGRADE_REQUIRED
      The 426 (Upgrade Required) status code indicates that 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. The server MUST send an Upgrade header field in a 426 response to indicate the required protocol(s) (Section 6.7 of [RFC7230]). Example: 
      
 HTTP/1.1 426 Upgrade Required
 Upgrade: HTTP/3.0
 Connection: Upgrade
 Content-Length: 53
 Content-Type: text/plain
      This service requires use of the HTTP/3.0 protocol.

    • TOO_MANY_REQUESTS

      public static final Status TOO_MANY_REQUESTS
      The 429 status code indicates that the user has sent too many requests in a given amount of time ("rate limiting"). The response representations SHOULD include details explaining the condition, and MAY include a Retry-After header indicating how long to wait before making a new request. For example: 
      
 HTTP/1.1 429 Too Many Requests
 Content-Type: text/html
 Retry-After: 3600

 <html>
  <head>
   <title>Too Many Requests</title>
  </head>
  <body>
   <h1>Too Many Requests</h1>
   <p>I only allow 50 requests per hour to this Web site per logged in user. Try again soon.</p>
   </body>
 </html>
      Note that this specification does not define how the origin server identifies the user, nor how it counts requests. For example, an origin server that is limiting request rates can do so based upon counts of requests on a per-resource basis, across the entire server, or even among a set of servers. Likewise, it might identify the user by its authentication credentials, or a stateful cookie. Responses with the 429 status code MUST NOT be stored by a cache.
      See Also:

    • REQUEST_HEADER_FIELDS_TOO_LARGE

      public static final Status REQUEST_HEADER_FIELDS_TOO_LARGE
      The 431 status code indicates that 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.

      It can be used both when the set of request header fields in total is too large, and when a single header field is at fault. In the latter case, the response representation SHOULD specify which header field was too large.

      For example: 

      
    HTTP/1.1 431 Request Header Fields Too Large
    Content-Type: text/html

    <html>
       <head>
          <title>Request Header Fields Too Large</title>
       </head>
       <body>
          <h1>Request Header Fields Too Large</h1>
          <p>The "Example" header was too large.</p>
       </body>
    </html>

      Responses with the 431 status code MUST NOT be stored by a cache.

      See Also:

    • INTERNAL_SERVER_ERROR

      public static final Status INTERNAL_SERVER_ERROR
      The 500 (Internal Server Error) status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

    • NOT_IMPLEMENTED

      public static final Status NOT_IMPLEMENTED
      The 501 (Not Implemented) status code indicates that the server does not support the functionality required to fulfill the request. This is the appropriate response when the server does not recognize the request method and is not capable of supporting it for any resource. A 501 response is cacheable by default; i.e., unless otherwise indicated by the method definition or explicit cache controls (see Section 4.2.2 of [RFC7234]).

    • BAD_GATEWAY

      public static final Status BAD_GATEWAY
      The 502 (Bad Gateway) status code indicates that the server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request.

    • SERVICE_UNAVAILABLE

      public static final Status SERVICE_UNAVAILABLE
      The 503 (Service Unavailable) status code indicates that the server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay. The server MAY send a Retry-After header field (Section 7.1.3) to suggest an appropriate amount of time for the client to wait before retrying the request. Note: The existence of the 503 status code does not imply that a server has to use it when becoming overloaded. Some servers might simply refuse the connection.

    • GATEWAY_TIMEOUT

      public static final Status GATEWAY_TIMEOUT
      The 504 (Gateway Timeout) status code indicates that the server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request.

    • HTTP_VERSION_NOT_SUPPORTED

      public static final Status HTTP_VERSION_NOT_SUPPORTED
      The 505 (HTTP Version Not Supported) status code indicates that the server does not support, or refuses to support, the major version of HTTP that was used in the request message. The server is indicating that it is unable or unwilling to complete the request using the same major version as the client, as described in Section 2.6 of [RFC7230], other than with this error message. The server SHOULD generate a representation for the 505 response that describes why that version is not supported and what other protocols are supported by that server.

  • Method Details

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getCode

      public int getCode()
      Returns the three-digit integer code giving the result of the attempt to understand and satisfy the request.
      Returns:
      the three-digit integer code giving the result of the attempt to understand and satisfy the request.

    • getReasonPhrase

      public String getReasonPhrase()
      Returns the reason phrase associated with the status code. The reason phrase is purely informative and can even be changed without affecting the protocol.
      Returns:
      the reason phrase associated with this status code.

    • getFamily

      public Status.Family getFamily()
      Returns the class of response of this status code.
      Returns:
      the class of response of this status code.

    • isInformational

      public boolean isInformational()
      Is the family of this status a Status.Family.INFORMATIONAL one ?
      Returns:
      true if the family of this status is a Status.Family.INFORMATIONAL one.

    • isSuccessful

      public boolean isSuccessful()
      Is the family of this status a Status.Family.SUCCESSFUL one ?
      Returns:
      true if the family of this status is a Status.Family.SUCCESSFUL one.

    • isRedirection

      public boolean isRedirection()
      Is the family of this status a Status.Family.REDIRECTION one ?
      Returns:
      true if the family of this status is a Status.Family.REDIRECTION one.

    • isClientError

      public boolean isClientError()
      Is the family of this status a Status.Family.CLIENT_ERROR one ?
      Returns:
      true if the family of this status is a Status.Family.CLIENT_ERROR one.

    • isServerError

      public boolean isServerError()
      Is the family of this status a Status.Family.SERVER_ERROR one ?
      Returns:
      true if the family of this status is a Status.Family.SERVER_ERROR one.

    • valueOf

      public static Status valueOf(int code)
      Get a Status from the given integer. First try to match a known (supported by this enum) status code, otherwise try to build a new one.
      Parameters:
      code - the three-digit integer code giving the result of the attempt to understand and satisfy the request. It must be in the range 100 <= code < 1000 and not already used by another Status, otherwise an IllegalArgumentException is thrown.
      Returns:
      the Status

    • valueOf

      public static Status valueOf(int code, String reason)
      Get a Status from the given integer. First try to match a known (supported by this enum) status code, otherwise try to build a new one.
      Parameters:
      code - the three-digit integer code giving the result of the attempt to understand and satisfy the request. It must be in the range 100 <= code < 1000 and not already used by another Status, otherwise an IllegalArgumentException is thrown.
      reason - the reason phrase to describe this Status. It is purely informative.
      Returns:
      the Status