HttpStatus.java

/**
 * Created by Christian Leicht Jørgensen on 11-04-2016. <br />
 * Visit <a href="https://leicht-thruesen.com">Leicht & Thruesen</a> for more information. <br /> <br />
 * <p>
 * Based on HTTP/1.1 specifications for RFC 7231.<br />
 *
 * @see <a href="https://tools.ietf.org/html/rfc7231">IETF RFC 7231</a>
 */
public class HttpStatus {

    /**
     * The client SHOULD continue with its request.
     * This interim response is used to inform the client that the initial part of the request has been received and has not yet been rejected by the server.
     * The client SHOULD continue by sending the remainder of the request or, if the request has already been completed, ignore this response.
     * The server MUST send a final response after the request has been completed.
     */
    @SuppressWarnings("unused")
    public static final int CONTINUE = 100;

    /**
     * The server understands and is willing to comply with the client's request, via the Upgrade message header field, for a change in the application protocol being used on this connection.
     * The server will switch protocols to those defined by the response's Upgrade header field immediately after the empty line which terminates the 101 response.
     */
    @SuppressWarnings("unused")
    public static final int SWITCHING_PROTOCOLS = 101;

    /**
     * The request has succeeded.
     */
    @SuppressWarnings("unused")
    public static final int AUTHORIZED = 200;

    /**
     * The request has been fulfilled and resulted in a new resource being created.
     */
    @SuppressWarnings("unused")
    public static final int CREATED = 201;

    /**
     * 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 for re-sending a status code from an asynchronous operation such as this.
     */
    @SuppressWarnings("unused")
    public static final int ACCEPTED = 202;

    /**
     * The returned metainformation in the entity-header is not the definitive set as available from the origin server, but is gathered from a local or a third-party copy.
     * The set presented MAY be a subset or superset of the original version.
     * For example, including local annotation information about the resource might result in a superset of the metainformation known by the origin server.
     * Use of this response code is not required and is only appropriate when the response would otherwise be 200 (OK).
     */
    @SuppressWarnings("unused")
    public static final int NON_AUTHORITATIVE_INFORMATION = 203;

    /**
     * The server has fulfilled the request but does not need to return an entity-body, and might want to return updated metainformation.
     * The response MAY include new or updated metainformation in the form of entity-headers, which if present SHOULD be associated with the requested variant.
     */
    @SuppressWarnings("unused")
    public static final int NO_CONTENT = 204;

    /**
     * The server has fulfilled the request and the user agent SHOULD reset the document view which caused the request to be sent.
     * This response is primarily intended to allow input for actions to take place via user input, followed by a clearing of the form in which the input is given so that the user can easily initiate another input action.
     * The response MUST NOT include an entity.
     */
    @SuppressWarnings("unused")
    public static final int RESET_CONTENT = 205;

    /**
     * The server has fulfilled the partial GET request for the resource.
     * The request MUST have included a Range header field indicating the desired range, and MAY have included an If-Range header field to make the request conditional.
     */
    @SuppressWarnings("unused")
    public static final int PARTIAL_CONTENT = 206;

    /**
     * The requested resource corresponds to any one of a set of representations, each with its own specific location, and agent- driven negotiation information is being provided so that the user (or user agent) can select a preferred representation and redirect its request to that location.
     */
    @SuppressWarnings("unused")
    public static final int MULTIPLE_CHOICES = 300;

    /**
     * The requested resource has been assigned a new permanent URI and any future references to this resource SHOULD use one of the returned URIs.
     * Clients with link editing capabilities ought to automatically re-link references to the Request-URI to one or more of the new references returned by the server, where possible.
     * This response is cacheable unless indicated otherwise.
     */
    @SuppressWarnings("unused")
    public static final int MOVED_PERMANENTLY = 301;

    /**
     * The requested resource resides temporarily under a different URI.
     * Since the redirection might be altered on occasion, the client SHOULD continue to use the Request-URI for future requests.
     * This response is only cacheable if indicated by a Cache-Control or Expires header field.
     */
    @SuppressWarnings("unused")
    public static final int FOUND = 302;

    /**
     * The response to the request can be found under a different URI and SHOULD be retrieved using a GET method on that resource.
     */
    @SuppressWarnings("unused")
    public static final int SEE_OTHER = 303;

    /**
     * If the client has performed a conditional GET request and access is allowed, but the document has not been modified, the server SHOULD respond with this status code.
     * The 304 response MUST NOT contain a message-body, and thus is always terminated by the first empty line after the header fields.
     */
    @SuppressWarnings("unused")
    public static final int NOT_MODITIFIED = 304;

    /**
     * The requested resource MUST be accessed through the proxy given by the Location field.
     * The Location field gives the URI of the proxy. The recipient is expected to repeat this single request via the proxy.
     * 305 responses MUST only be generated by origin servers.
     */
    @SuppressWarnings("unused")
    public static final int USE_PROXY = 305;

    /**
     * The requested resource resides temporarily under a different URI.
     * Since the redirection MAY be altered on occasion, the client SHOULD continue to use the Request-URI for future requests.
     * This response is only cacheable if indicated by a Cache-Control or Expires header field.
     */
    @SuppressWarnings("unused")
    public static final int TEMPORARY_REDIRECT = 307;

    /**
     * The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.
     */
    @SuppressWarnings("unused")
    public static final int BAD_REQUEST = 400;

    /**
     * The request requires user authentication.
     */
    @SuppressWarnings("unused")
    public static final int UNAUTHORIZED = 401;

    /**
     * This code is reserved for future use.
     */
    @SuppressWarnings("unused")
    public static final int PAYMENT_REQUIRED = 402;

    /**
     * The server understood the request, but is refusing to fulfill it. Authorization will not help and the request SHOULD NOT be repeated. I
     */
    @SuppressWarnings("unused")
    public static final int FORBIDDEN = 403;

    /**
     * The server has not found anything matching the Request-URI.
     * No indication is given of whether the condition is temporary or permanent.
     */
    @SuppressWarnings("unused")
    public static final int NOT_FOUND = 404;

    /**
     * The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.
     * The response MUST include an Allow header containing a list of valid methods for the requested resource.
     */
    @SuppressWarnings("unused")
    public static final int METHOD_NOT_ALLOWED = 405;

    /**
     * The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request.
     */
    @SuppressWarnings("unused")
    public static final int NOT_ACCEPTABLE = 406;

    /**
     * This code is similar to 401 (Unauthorized), but indicates that the client must first authenticate itself with the proxy.
     */
    @SuppressWarnings("unused")
    public static final int PROXY_AUTHENTICATION_REQUIRED = 407;

    /**
     * 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.
     */
    @SuppressWarnings("unused")
    public static final int REQUEST_TIMEOUT = 408;

    /**
     * The request could not be completed due to a conflict with the current state of the resource.
     * This code is only allowed in situations where it is expected that the user might be able to resolve the conflict and resubmit the request.
     * The response body SHOULD include enough information for the user to recognize the source of the conflict.
     * Ideally, the response entity would include enough information for the user or user agent to fix the problem; however, that might not be possible and is not required.
     */
    @SuppressWarnings("unused")
    public static final int CONFLICT = 409;

    /**
     * The requested resource is no longer available at the server and no forwarding address is known.
     * This condition is expected to be considered permanent.
     * Clients with link editing capabilities SHOULD delete references to the Request-URI after user approval.
     * If the server does not know, or has no facility to determine, whether or not the condition is permanent, the status code 404 (Not Found) SHOULD be used instead.
     * This response is cacheable unless indicated otherwise.
     */
    @SuppressWarnings("unused")
    public static final int GONE = 410;

    /**
     * The server refuses to accept the request without a defined Content- Length.
     * 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.
     */
    @SuppressWarnings("unused")
    public static final int LENGTH_REQUIRED = 411;

    /**
     * The precondition given in one or more of the request-header fields evaluated to false when it was tested on the server.
     * This response code allows the client to place preconditions on the current resource metainformation (header field data) and thus prevent the requested method from being applied to a resource other than the one intended.
     */
    @SuppressWarnings("unused")
    public static final int PRECONDITION_FAILED = 412;

    /**
     * The server is refusing to process a request because the request entity 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 include a Retry- After header field to indicate that it is temporary and after what time the client MAY try again.
     */
    @SuppressWarnings("unused")
    public static final int REQUEST_ENTITY_TOO_LARGE = 413;

    /**
     * The server is refusing to service the request because the Request-URI 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 URI "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 security holes present in some servers using fixed-length buffers for reading or manipulating the Request-URI.
     */
    @SuppressWarnings("unused")
    public static final int REQUEST_URI_TOO_LONG = 414;

    /**
     * The server is refusing to service the request because the entity of the request is in a format not supported by the requested resource for the requested method.
     */
    @SuppressWarnings("unused")
    public static final int UNSUPPORTED_MEDIA_TYPE = 415;

    /**
     * A server SHOULD return a response with this status code if a request included a Range request-header field (section 14.35), and none of the range-specifier values in this field overlap the current extent of the selected resource, and the request did not include an If-Range request-header field. (For byte-ranges, this means that the first- byte-pos of all of the byte-range-spec values were greater than the current length of the selected resource.)
     */
    @SuppressWarnings("unused")
    public static final int REQUESTED_RANGE_NOT_SATISFIABLE = 416;

    /**
     * The expectation given in an Expect request-header field (see section 14.20) could not be met by this server, or, if the server is a proxy, the server has unambiguous evidence that the request could not be met by the next-hop server.
     */
    @SuppressWarnings("unused")
    public static final int EXPECTATION_FAILED = 417;

    /**
     * The server encountered an unexpected condition which prevented it from fulfilling the request.
     */
    @SuppressWarnings("unused")
    public static final int INTERNAL_SERVER_ERROR = 500;

    /**
     * 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.
     */
    @SuppressWarnings("unused")
    public static final int NOT_IMPLEMENTED = 501;

    /**
     * The server, while acting as a gateway or proxy, received an invalid response from the upstream server it accessed in attempting to fulfill the request.
     */
    @SuppressWarnings("unused")
    public static final int BAD_GATEWAY = 502;

    /**
     * The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.
     */
    @SuppressWarnings("unused")
    public static final int SERVICE_UNAVAILABLE = 503;

    /**
     * The server, while acting as a gateway or proxy, did not receive a timely response from the upstream server specified by the URI (e.g. HTTP, FTP, LDAP) or some other auxiliary server (e.g. DNS) it needed to access in attempting to complete the request.
     */
    @SuppressWarnings("unused")
    public static final int GATEWAY_TIMEOUT = 504;

    /**
     * The server does not support, or refuses to support, the HTTP protocol version 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 3.1, other than with this error message.
     * The response SHOULD contain an entity describing why that version is not supported and what other protocols are supported by that server.
     */
    @SuppressWarnings("unused")
    public static final int HTTP_VERSION_NOT_SUPPORTED = 505;
}