Package net.lenni0451.commons.httpclient.constants

Class StatusCodes

  • public class StatusCodes
extends java.lang.Object

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int 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.
      static int ALREADY_REPORTED
      Used inside a WebDAV response element to avoid repeatedly enumerating the internal members of multiple bindings to the same collection.
      static int 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.
      static int 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).
      static int CONFLICT
      This response is sent when a request conflicts with the current state of the server.
      static int CONTINUE
      This interim response indicates that the client should continue the request or ignore the response if the request is already finished.
      static int CREATED
      The request succeeded, and a new resource was created as a result.
      static int 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.
      static int EXPECTATION_FAILED
      This response code means the expectation indicated by the Expect request header field cannot be met by the server.
      static int FAILED_DEPENDENCY
      The request failed due to failure of a previous request.
      static int 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.
      static int GATEWAY_TIMEOUT
      This error response is given when the server is acting as a gateway and cannot get a response in time.
      static int GONE
      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.
      static int HTTP_VERSION_NOT_SUPPORTED
      The HTTP version used in the request is not supported by the server.
      static int IM_A_TEAPOT
      The server refuses the attempt to brew coffee with a teapot.
      static int 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.
      static int 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.
      static int INTERNAL_SERVER_ERROR
      The server has encountered a situation it does not know how to handle.
      static int LENGTH_REQUIRED
      Server rejected the request because the Content-Length header field is not defined and the server requires it.
      static int LOCKED
      The resource that is being accessed is locked.
      static int LOOP_DETECTED
      The server detected an infinite loop while processing the request.
      static int 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.
      static int 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.
      static int MOVED_PERMANENTLY
      The URL of the requested resource has been changed permanently.
      static int MOVED_TEMPORARILY
      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.
      static int MULTI_STATUS
      Conveys information about multiple resources, for situations where multiple status codes might be appropriate.
      static int MULTIPLE_CHOICES
      The request has more than one possible response.
      static int NETWORK_AUTHENTICATION_REQUIRED
      Indicates that the client needs to authenticate to gain network access.
      static int 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.
      static int 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.
      static int 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.
      static int NOT_EXTENDED
      Further extensions to the request are required for the server to fulfill it.
      static int NOT_FOUND
      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.
      static int NOT_IMPLEMENTED
      The request method is not supported by the server and cannot be handled.
      static int 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.
      static int OK
      The request succeeded.
      static int PARTIAL_CONTENT
      This response code is used when the Range header is sent from the client to request only part of a resource.
      static int PAYLOAD_TOO_LARGE
      Request entity is larger than limits defined by server.
      The server might close the connection or return an Retry-After header field.
      static int 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.
      static int PERMANENT_REDIRECT
      This means that the resource is now permanently located at another URI, specified by the Location: HTTP 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.
      static int PRECONDITION_FAILED
      The client has indicated preconditions in its headers which the server does not meet.
      static int 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.
      static int PROCESSING
      This code indicates that the server has received and is processing the request, but no response is available yet.
      static int PROXY_AUTHENTICATION_REQUIRED
      This is similar to 401 Unauthorized but authentication is needed to be done by a proxy.
      static int 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.
      static int 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.
      static int 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.
      This response is used much more since some browsers, like Chrome, Firefox 27+, or IE9, use HTTP pre-connection mechanisms to speed up surfing.
      Also note that some servers merely shut down the connection without sending this message.
      static int RESET_CONTENT
      Tells the user agent to reset the document which sent this request.
      static int SEE_OTHER
      The server sent this response to direct the client to get the requested resource at another URI with a GET request.
      static int 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.
      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.
      static java.util.Map<java.lang.Integer,​java.lang.String> STATUS_CODES
      A map of all status codes and their messages.
      static int 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.
      static int 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.
      This has the same semantics as the 302 Found 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.
      static int TOO_EARLY
      Indicates that the server is unwilling to risk processing a request that might be replayed.
      static int TOO_MANY_REQUESTS
      The user has sent too many requests in a given amount of time ("rate limiting").
      static int UNAUTHORIZED
      Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated".
      That is, the client must authenticate itself to get the requested response.
      static int UNAVAILABLE_FOR_LEGAL_REASONS
      The user agent requested a resource that cannot legally be provided, such as a web page censored by a government.
      static int UNPROCESSABLE_CONTENT
      The request was well-formed but was unable to be followed due to semantic errors.
      static int UNSUPPORTED_MEDIA_TYPE
      The media format of the requested data is not supported by the server, so the server is rejecting the request.
      static int UNUSED
      This response code is no longer used; it is just reserved.
      static int 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.
      The server sends an Upgrade header in a 426 response to indicate the required protocol(s).
      static int URI_TOO_LONG
      The URI requested by the client is longer than the server is willing to interpret.
      static int USE_PROXY
      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.
      static int VARIANT_ALSO_NEGOTIATES
      The server has an internal configuration error: the chosen variant resource is configured to engage in transparent content negotiation itself, and is therefore not a proper end point in the negotiation process.

    • Constructor Summary

      Constructors 
      Constructor Description
      StatusCodes()  

    • Method Summary

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • CONTINUE

        public static final int CONTINUE
        This interim response indicates that the client should continue the request or ignore the response if the request is already finished.
        See Also:
        Constant Field Values

      • SWITCHING_PROTOCOLS

        public static final int 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.
        See Also:
        Constant Field Values

      • PROCESSING

        public static final int PROCESSING
        This code indicates that the server has received and is processing the request, but no response is available yet.
        See Also:
        Constant Field Values

      • EARLY_HINTS

        public static final int 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.
        See Also:
        Constant Field Values

      • OK

        public static final int OK
        The request succeeded. The result meaning of "success" depends on the HTTP method:
        Method Result
        GET The resource has been fetched and transmitted in the message body.
        HEAD The representation headers are included in the response without any message body.
        PUT/POST The resource describing the result of the action is transmitted in the message body.
        TRACE The message body contains the request message as received by the server.
        See Also:
        Constant Field Values

      • CREATED

        public static final int 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.
        See Also:
        Constant Field Values

      • ACCEPTED

        public static final int 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.
        See Also:
        Constant Field Values

      • NON_AUTHORITATIVE_INFORMATION

        public static final int 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.
        See Also:
        Constant Field Values

      • NO_CONTENT

        public static final int 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.
        See Also:
        Constant Field Values

      • RESET_CONTENT

        public static final int RESET_CONTENT
        Tells the user agent to reset the document which sent this request.
        See Also:
        Constant Field Values

      • PARTIAL_CONTENT

        public static final int PARTIAL_CONTENT
        This response code is used when the Range header is sent from the client to request only part of a resource.
        See Also:
        Constant Field Values

      • MULTI_STATUS

        public static final int MULTI_STATUS
        Conveys information about multiple resources, for situations where multiple status codes might be appropriate.
        See Also:
        Constant Field Values

      • ALREADY_REPORTED

        public static final int ALREADY_REPORTED
        Used inside a WebDAV response element to avoid repeatedly enumerating the internal members of multiple bindings to the same collection.
        See Also:
        Constant Field Values

      • IM_USED

        public static final int 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.
        See Also:
        Constant Field Values

      • MULTIPLE_CHOICES

        public static final int MULTIPLE_CHOICES
        The request has more than one possible response. The user agent or user should choose one of them. (There is no standardized way of choosing one of the responses, but HTML links to the possibilities are recommended so the user can pick.)
        See Also:
        Constant Field Values

      • MOVED_PERMANENTLY

        public static final int MOVED_PERMANENTLY
        The URL of the requested resource has been changed permanently. The new URL is given in the response.
        See Also:
        Constant Field Values

      • MOVED_TEMPORARILY

        public static final int MOVED_TEMPORARILY
        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 Also:
        Constant Field Values

      • SEE_OTHER

        public static final int SEE_OTHER
        The server sent this response to direct the client to get the requested resource at another URI with a GET request.
        See Also:
        Constant Field Values

      • NOT_MODIFIED

        public static final int 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.
        See Also:
        Constant Field Values

      • USE_PROXY

        public static final int USE_PROXY
        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.
        See Also:
        Constant Field Values

      • UNUSED

        public static final int UNUSED
        This response code is no longer used; it is just reserved. It was used in a previous version of the HTTP/1.1 specification.
        See Also:
        Constant Field Values

      • TEMPORARY_REDIRECT

        public static final int 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.
        This has the same semantics as the 302 Found 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.
        See Also:
        Constant Field Values

      • PERMANENT_REDIRECT

        public static final int PERMANENT_REDIRECT
        This means that the resource is now permanently located at another URI, specified by the Location: HTTP 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.
        See Also:
        Constant Field Values

      • BAD_REQUEST

        public static final int 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).
        See Also:
        Constant Field Values

      • UNAUTHORIZED

        public static final int UNAUTHORIZED
        Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated".
        That is, the client must authenticate itself to get the requested response.
        See Also:
        Constant Field Values

      • PAYMENT_REQUIRED

        public static final int 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.
        See Also:
        Constant Field Values

      • FORBIDDEN

        public static final int 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.
        See Also:
        Constant Field Values

      • NOT_FOUND

        public static final int NOT_FOUND
        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.
        See Also:
        Constant Field Values

      • METHOD_NOT_ALLOWED

        public static final int 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.
        See Also:
        Constant Field Values

      • PROXY_AUTHENTICATION_REQUIRED

        public static final int PROXY_AUTHENTICATION_REQUIRED
        This is similar to 401 Unauthorized but authentication is needed to be done by a proxy.
        See Also:
        Constant Field Values

      • REQUEST_TIMEOUT

        public static final int 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.
        This response is used much more since some browsers, like Chrome, Firefox 27+, or IE9, use HTTP pre-connection mechanisms to speed up surfing.
        Also note that some servers merely shut down the connection without sending this message.
        See Also:
        Constant Field Values

      • CONFLICT

        public static final int CONFLICT
        This response is sent when a request conflicts with the current state of the server.
        See Also:
        Constant Field Values

      • GONE

        public static final int GONE
        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.
        See Also:
        Constant Field Values

      • LENGTH_REQUIRED

        public static final int LENGTH_REQUIRED
        Server rejected the request because the Content-Length header field is not defined and the server requires it.
        See Also:
        Constant Field Values

      • PRECONDITION_FAILED

        public static final int PRECONDITION_FAILED
        The client has indicated preconditions in its headers which the server does not meet.
        See Also:
        Constant Field Values

      • PAYLOAD_TOO_LARGE

        public static final int PAYLOAD_TOO_LARGE
        Request entity is larger than limits defined by server.
        The server might close the connection or return an Retry-After header field.
        See Also:
        Constant Field Values

      • URI_TOO_LONG

        public static final int URI_TOO_LONG
        The URI requested by the client is longer than the server is willing to interpret.
        See Also:
        Constant Field Values

      • UNSUPPORTED_MEDIA_TYPE

        public static final int UNSUPPORTED_MEDIA_TYPE
        The media format of the requested data is not supported by the server, so the server is rejecting the request.
        See Also:
        Constant Field Values

      • RANGE_NOT_SATISFIABLE

        public static final int 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.
        See Also:
        Constant Field Values

      • EXPECTATION_FAILED

        public static final int EXPECTATION_FAILED
        This response code means the expectation indicated by the Expect request header field cannot be met by the server.
        See Also:
        Constant Field Values

      • IM_A_TEAPOT

        public static final int IM_A_TEAPOT
        The server refuses the attempt to brew coffee with a teapot.
        See Also:
        Constant Field Values

      • MISDIRECTED_REQUEST

        public static final int 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.
        See Also:
        Constant Field Values

      • UNPROCESSABLE_CONTENT

        public static final int UNPROCESSABLE_CONTENT
        The request was well-formed but was unable to be followed due to semantic errors.
        See Also:
        Constant Field Values

      • LOCKED

        public static final int LOCKED
        The resource that is being accessed is locked.
        See Also:
        Constant Field Values

      • FAILED_DEPENDENCY

        public static final int FAILED_DEPENDENCY
        The request failed due to failure of a previous request.
        See Also:
        Constant Field Values

      • TOO_EARLY

        public static final int TOO_EARLY
        Indicates that the server is unwilling to risk processing a request that might be replayed.
        See Also:
        Constant Field Values

      • UPGRADE_REQUIRED

        public static final int 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.
        The server sends an Upgrade header in a 426 response to indicate the required protocol(s).
        See Also:
        Constant Field Values

      • PRECONDITION_REQUIRED

        public static final int 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.
        See Also:
        Constant Field Values

      • TOO_MANY_REQUESTS

        public static final int TOO_MANY_REQUESTS
        The user has sent too many requests in a given amount of time ("rate limiting").
        See Also:
        Constant Field Values

      • REQUEST_HEADER_FIELDS_TOO_LARGE

        public static final int 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.
        See Also:
        Constant Field Values

      • UNAVAILABLE_FOR_LEGAL_REASONS

        public static final int UNAVAILABLE_FOR_LEGAL_REASONS
        The user agent requested a resource that cannot legally be provided, such as a web page censored by a government.
        See Also:
        Constant Field Values

      • INTERNAL_SERVER_ERROR

        public static final int INTERNAL_SERVER_ERROR
        The server has encountered a situation it does not know how to handle.
        See Also:
        Constant Field Values

      • NOT_IMPLEMENTED

        public static final int 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.
        See Also:
        Constant Field Values

      • BAD_GATEWAY

        public static final int 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.
        See Also:
        Constant Field Values

      • SERVICE_UNAVAILABLE

        public static final int 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.
        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.
        See Also:
        Constant Field Values

      • GATEWAY_TIMEOUT

        public static final int GATEWAY_TIMEOUT
        This error response is given when the server is acting as a gateway and cannot get a response in time.
        See Also:
        Constant Field Values

      • HTTP_VERSION_NOT_SUPPORTED

        public static final int HTTP_VERSION_NOT_SUPPORTED
        The HTTP version used in the request is not supported by the server.
        See Also:
        Constant Field Values

      • VARIANT_ALSO_NEGOTIATES

        public static final int VARIANT_ALSO_NEGOTIATES
        The server has an internal configuration error: the chosen variant resource is configured to engage in transparent content negotiation itself, and is therefore not a proper end point in the negotiation process.
        See Also:
        Constant Field Values

      • INSUFFICIENT_STORAGE

        public static final int 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.
        See Also:
        Constant Field Values

      • LOOP_DETECTED

        public static final int LOOP_DETECTED
        The server detected an infinite loop while processing the request.
        See Also:
        Constant Field Values

      • NOT_EXTENDED

        public static final int NOT_EXTENDED
        Further extensions to the request are required for the server to fulfill it.
        See Also:
        Constant Field Values

      • NETWORK_AUTHENTICATION_REQUIRED

        public static final int NETWORK_AUTHENTICATION_REQUIRED
        Indicates that the client needs to authenticate to gain network access.
        See Also:
        Constant Field Values

      • STATUS_CODES

        public static final java.util.Map<java.lang.Integer,​java.lang.String> STATUS_CODES
        A map of all status codes and their messages.

    • Constructor Detail

      • StatusCodes

        public StatusCodes()