Enum Class StatusCode

java.lang.Object
java.lang.Enum<StatusCode>
com.soklet.core.StatusCode
All Implemented Interfaces:
Serializable, Comparable<StatusCode>, Constable
public enum StatusCode extends Enum<StatusCode>
Formal enumeration of valid HTTP status codes.

See https://developer.mozilla.org/en-US/docs/Web/HTTP/Status for details.

Author:
Mark Allen

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    HTTP_100
    This interim response indicates that the client should continue the request or ignore the response if the request is already finished.
    HTTP_101
    This code is sent in response to an Upgrade request header from the client and indicates the protocol the server is switching to.
    HTTP_102
    This code was used in WebDAV contexts to indicate that a request has been received by the server, but no status was available at the time of the response.
    HTTP_103
    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.
    HTTP_200
    The request succeeded.
    HTTP_201
    The request succeeded, and a new resource was created as a result.
    HTTP_202
    The request has been received but not yet acted upon.
    HTTP_203
    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.
    HTTP_204
    There is no content to send for this request, but the headers are useful.
    HTTP_205
    Tells the user agent to reset the document which sent this request.
    HTTP_206
    This response code is used in response to a range request when the client has requested a part or parts of a resource.
    HTTP_207
    (WebDAV) Conveys information about multiple resources, for situations where multiple status codes might be appropriate.
    HTTP_208
    (WebDAV) Used inside a <dav:propstat> response element to avoid repeatedly enumerating the internal members of multiple bindings to the same collection.
    HTTP_226
    (HTTP Delta encoding) 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.
    HTTP_300
    In agent-driven content negotiation, the request has more than one possible response and the user agent or user should choose one of them.
    HTTP_301
    The URL of the requested resource has been changed permanently.
    HTTP_302
    This response code means that the URI of requested resource has been changed temporarily.
    HTTP_303
    The server sent this response to direct the client to get the requested resource at another URI with a GET request.
    HTTP_304
    This is used for caching purposes.
    HTTP_305
    Deprecated.
    HTTP_306
    Deprecated.
    HTTP_307
    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.
    HTTP_308
    This means that the resource is now permanently located at another URI, specified by the Location response header.
    HTTP_400
    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).
    HTTP_401
    Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated".
    HTTP_402
    The initial purpose of this code was for digital payment systems, however this status code is rarely used and no standard convention exists.
    HTTP_403
    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.
    HTTP_404
    The server cannot find the requested resource.
    HTTP_405
    The request method is known by the server but is not supported by the target resource.
    HTTP_406
    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.
    HTTP_407
    This is similar to 401 Unauthorized but authentication is needed to be done by a proxy.
    HTTP_408
    This response is sent on an idle connection by some servers, even without any previous request by the client.
    HTTP_409
    This response is sent when a request conflicts with the current state of the server.
    HTTP_410
    This response is sent when the requested content has been permanently deleted from server, with no forwarding address.
    HTTP_411
    Server rejected the request because the Content-Length header field is not defined and the server requires it.
    HTTP_412
    In conditional requests, the client has indicated preconditions in its headers which the server does not meet.
    HTTP_413
    The request body is larger than limits defined by server.
    HTTP_414
    The URI requested by the client is longer than the server is willing to interpret.
    HTTP_415
    The media format of the requested data is not supported by the server, so the server is rejecting the request.
    HTTP_416
    The ranges specified by the Range header field in the request cannot be fulfilled.
    HTTP_417
    This response code means the expectation indicated by the Expect request header field cannot be met by the server.
    HTTP_418
    The server refuses the attempt to brew coffee with a teapot.
    HTTP_421
    The request was directed at a server that is not able to produce a response.
    HTTP_422
    (WebDAV) The request was well-formed but was unable to be followed due to semantic errors.
    HTTP_423
    (WebDAV) The resource that is being accessed is locked.
    HTTP_424
    (WebDAV) The request failed due to failure of a previous request.
    HTTP_425
    Indicates that the server is unwilling to risk processing a request that might be replayed.
    HTTP_426
    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.
    HTTP_428
    The origin server requires the request to be conditional.
    HTTP_429
    The user has sent too many requests in a given amount of time (rate limiting).
    HTTP_431
    The server is unwilling to process the request because its header fields are too large.
    HTTP_451
    The user agent requested a resource that cannot legally be provided, such as a web page censored by a government.
    HTTP_500
    The server has encountered a situation it does not know how to handle.
    HTTP_501
    The request method is not supported by the server and cannot be handled.
    HTTP_502
    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.
    HTTP_503
    The server is not ready to handle the request.
    HTTP_504
    This error response is given when the server is acting as a gateway and cannot get a response in time.
    HTTP_505
    The HTTP version used in the request is not supported by the server.
    HTTP_506
    The server has an internal configuration error: during content negotiation, the chosen variant is configured to engage in content negotiation itself, which results in circular references when creating responses.
    HTTP_507
    (WebDAV) The method could not be performed on the resource because the server is unable to store the representation needed to successfully complete the request.
    HTTP_508
    (WebDAV) The server detected an infinite loop while processing the request.
    HTTP_510
    The client request declares an HTTP Extension (RFC 2774) that should be used to process the request, but the extension is not supported.
    HTTP_511
    Indicates that the client needs to authenticate to gain network access.

  • Method Summary

    Modifier and Type
    Method
    Description
    static Optional<StatusCode>
    fromStatusCode(Integer statusCode)
    Given an HTTP status code, return the corresponding enum value.
    String
    getReasonPhrase()
    An English-language description for this HTTP status code.
    Integer
    getStatusCode()
    The HTTP status code that corresponds to this enum value.
    String
    toString()
     
    static StatusCode
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static StatusCode[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • HTTP_100

      public static final StatusCode HTTP_100
      This interim response indicates that the client should continue the request or ignore the response if the request is already finished.

    • HTTP_101

      public static final StatusCode HTTP_101
      This code is sent in response to an Upgrade request header from the client and indicates the protocol the server is switching to.

    • HTTP_102

      public static final StatusCode HTTP_102
      This code was used in WebDAV contexts to indicate that a request has been received by the server, but no status was available at the time of the response.

    • HTTP_103

      public static final StatusCode HTTP_103
      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.

    • HTTP_200

      public static final StatusCode HTTP_200
      The request succeeded. The result and meaning of "success" depends on the HTTP method:

      • GET: The resource has been fetched and transmitted in the message body.
      • HEAD: Representation headers are included in the response without any message body.
      • PUT or POST: The resource describing the result of the action is transmitted in the message body.
      • TRACE: The message body contains the request as received by the server.

    • HTTP_201

      public static final StatusCode HTTP_201
      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.

    • HTTP_202

      public static final StatusCode HTTP_202
      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.

    • HTTP_203

      public static final StatusCode HTTP_203
      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.

    • HTTP_204

      public static final StatusCode HTTP_204
      There is no content to send for this request, but the headers are useful.

      The user agent may update its cached headers for this resource with the new ones.

    • HTTP_205

      public static final StatusCode HTTP_205
      Tells the user agent to reset the document which sent this request.

    • HTTP_206

      public static final StatusCode HTTP_206
      This response code is used in response to a range request when the client has requested a part or parts of a resource.

      Soklet does not currently support range requests out-of-the-box.

    • HTTP_207

      public static final StatusCode HTTP_207
      (WebDAV) Conveys information about multiple resources, for situations where multiple status codes might be appropriate.

    • HTTP_208

      public static final StatusCode HTTP_208
      (WebDAV) Used inside a <dav:propstat> response element to avoid repeatedly enumerating the internal members of multiple bindings to the same collection.

    • HTTP_226

      public static final StatusCode HTTP_226
      (HTTP Delta encoding) 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.

    • HTTP_300

      public static final StatusCode HTTP_300
      In agent-driven content negotiation, the request has more than one possible response and the user agent or user should choose one of them.

      There is no standardized way for clients to automatically choose one of the responses, so this is rarely used.

    • HTTP_301

      public static final StatusCode HTTP_301
      The URL of the requested resource has been changed permanently.

      The new URL is given in the response.

    • HTTP_302

      public static final StatusCode HTTP_302
      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, so the same URI should be used by the client in future requests.

    • HTTP_303

      public static final StatusCode HTTP_303
      The server sent this response to direct the client to get the requested resource at another URI with a GET request.

    • HTTP_304

      public static final StatusCode HTTP_304
      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.

    • HTTP_305

      @Deprecated public static final StatusCode HTTP_305
      Deprecated.
      Defined in a previous version of the HTTP specification to indicate that a requested response must be accessed by a proxy.

      It has been deprecated due to security concerns regarding in-band configuration of a proxy.

    • HTTP_306

      @Deprecated public static final StatusCode HTTP_306
      Deprecated.
      This response code is no longer used; but is reserved.

      It was used in a previous version of the HTTP/1.1 specification.

    • HTTP_307

      public static final StatusCode HTTP_307
      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.

      This has the same semantics as the 302 Found response code, with the exception that the user agent must not change the HTTP method used: if a POST was used in the first request, a POST must be used in the redirected request.

    • HTTP_308

      public static final StatusCode HTTP_308
      This means that the resource is now permanently located at another URI, specified by the Location response header.

      This has the same semantics as the 301 Moved Permanently HTTP response code, with the exception that the user agent must not change the HTTP method used: if a POST was used in the first request, a POST must be used in the second request.

    • HTTP_400

      public static final StatusCode HTTP_400
      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).

    • HTTP_401

      public static final StatusCode HTTP_401
      Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated".

      That is, the client must authenticate itself to get the requested response.

    • HTTP_402

      public static final StatusCode HTTP_402
      The initial purpose of this code was for digital payment systems, however this status code is rarely used and no standard convention exists.

    • HTTP_403

      public static final StatusCode HTTP_403
      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.

    • HTTP_404

      public static final StatusCode HTTP_404
      The server cannot find the requested resource.

      In the browser, this means the URL is not recognized. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 Forbidden to hide the existence of a resource from an unauthorized client. This response code is probably the most well known due to its frequent occurrence on the web.

    • HTTP_405

      public static final StatusCode HTTP_405
      The request method is known by the server but is not supported by the target resource.

      For example, an API may not allow DELETE on a resource, or the TRACE method entirely.

    • HTTP_406

      public static final StatusCode HTTP_406
      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.

    • HTTP_407

      public static final StatusCode HTTP_407
      This is similar to 401 Unauthorized but authentication is needed to be done by a proxy.

    • HTTP_408

      public static final StatusCode HTTP_408
      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. This response is used much more since some browsers use HTTP pre-connection mechanisms to speed up browsing. Some servers may shut down a connection without sending this message.

    • HTTP_409

      public static final StatusCode HTTP_409
      This response is sent when a request conflicts with the current state of the server.

      In WebDAV remote web authoring, 409 responses are errors sent to the client so that a user might be able to resolve a conflict and resubmit the request.

    • HTTP_410

      public static final StatusCode HTTP_410
      This response is sent when the requested content has been permanently deleted from server, with no forwarding address.

      Clients are expected to remove their caches and links to the resource. The HTTP specification intends this status code to be used for "limited-time, promotional services". APIs should not feel compelled to indicate resources that have been deleted with this status code.

    • HTTP_411

      public static final StatusCode HTTP_411
      Server rejected the request because the Content-Length header field is not defined and the server requires it.

    • HTTP_412

      public static final StatusCode HTTP_412
      In conditional requests, the client has indicated preconditions in its headers which the server does not meet.

    • HTTP_413

      public static final StatusCode HTTP_413
      The request body is larger than limits defined by server.

      The server might close the connection or return a Retry-After header field.

    • HTTP_414

      public static final StatusCode HTTP_414
      The URI requested by the client is longer than the server is willing to interpret.

    • HTTP_415

      public static final StatusCode HTTP_415
      The media format of the requested data is not supported by the server, so the server is rejecting the request.

    • HTTP_416

      public static final StatusCode HTTP_416
      The ranges 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 resource's data.

    • HTTP_417

      public static final StatusCode HTTP_417
      This response code means the expectation indicated by the Expect request header field cannot be met by the server.

    • HTTP_418

      public static final StatusCode HTTP_418
      The server refuses the attempt to brew coffee with a teapot.

    • HTTP_421

      public static final StatusCode HTTP_421
      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.

    • HTTP_422

      public static final StatusCode HTTP_422
      (WebDAV) The request was well-formed but was unable to be followed due to semantic errors.

    • HTTP_423

      public static final StatusCode HTTP_423
      (WebDAV) The resource that is being accessed is locked.

    • HTTP_424

      public static final StatusCode HTTP_424
      (WebDAV) The request failed due to failure of a previous request.

    • HTTP_425

      public static final StatusCode HTTP_425
      Indicates that the server is unwilling to risk processing a request that might be replayed.

    • HTTP_426

      public static final StatusCode HTTP_426
      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 sends an Upgrade header in a 426 response to indicate the required protocol(s).

    • HTTP_428

      public static final StatusCode HTTP_428
      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.

    • HTTP_429

      public static final StatusCode HTTP_429
      The user has sent too many requests in a given amount of time (rate limiting).

    • HTTP_431

      public static final StatusCode HTTP_431
      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.

    • HTTP_451

      public static final StatusCode HTTP_451
      The user agent requested a resource that cannot legally be provided, such as a web page censored by a government.

    • HTTP_500

      public static final StatusCode HTTP_500
      The server has encountered a situation it does not know how to handle.

      This error is generic, indicating that the server cannot find a more appropriate 5XX status code to respond with.

    • HTTP_501

      public static final StatusCode HTTP_501
      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.

    • HTTP_502

      public static final StatusCode HTTP_502
      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.

    • HTTP_503

      public static final StatusCode HTTP_503
      The server is not ready to handle the request.

      Common causes are a server that is down for maintenance or that is overloaded.

      Note that together with this response, a user-friendly page explaining the problem should be sent. This response should be used for temporary conditions and the Retry-After HTTP header should, if possible, contain the estimated time before the recovery of the service.

      The webmaster must also take care about the caching-related headers that are sent along with this response, as these temporary condition responses should usually not be cached.

    • HTTP_504

      public static final StatusCode HTTP_504
      This error response is given when the server is acting as a gateway and cannot get a response in time.

    • HTTP_505

      public static final StatusCode HTTP_505
      The HTTP version used in the request is not supported by the server.

    • HTTP_506

      public static final StatusCode HTTP_506
      The server has an internal configuration error: during content negotiation, the chosen variant is configured to engage in content negotiation itself, which results in circular references when creating responses.

    • HTTP_507

      public static final StatusCode HTTP_507
      (WebDAV) The method could not be performed on the resource because the server is unable to store the representation needed to successfully complete the request.

    • HTTP_508

      public static final StatusCode HTTP_508
      (WebDAV) The server detected an infinite loop while processing the request.

    • HTTP_510

      public static final StatusCode HTTP_510
      The client request declares an HTTP Extension (RFC 2774) that should be used to process the request, but the extension is not supported.

    • HTTP_511

      public static final StatusCode HTTP_511
      Indicates that the client needs to authenticate to gain network access.

  • Method Details

    • values

      public static StatusCode[] 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

      public static StatusCode valueOf(String name)
      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 name
      NullPointerException - if the argument is null

    • fromStatusCode

      @Nonnull public static Optional<StatusCode> fromStatusCode(@Nonnull Integer statusCode)
      Given an HTTP status code, return the corresponding enum value.
      Parameters:
      statusCode - the HTTP status code
      Returns:
      the enum value that corresponds to the provided HTTP status code, or Optional.empty() if none exists

    • toString

      public String toString()
      Overrides:
      toString in class Enum<StatusCode>

    • getStatusCode

      @Nonnull public Integer getStatusCode()
      The HTTP status code that corresponds to this enum value.
      Returns:
      the HTTP status code

    • getReasonPhrase

      @Nonnull public String getReasonPhrase()
      An English-language description for this HTTP status code.

      For example, HTTP_404 has reason phrase Not Found.

      Returns:
      English description for this HTTP status code