All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.seppiko.commons.utils.http.HttpStatus Maven / Gradle / Ivy

There is a newer version: 2.11.0
Show newest version
/*
 * Copyright 2023 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.seppiko.commons.utils.http;

/**
 * Enumeration of HTTP status codes.
 *
 * 

The HTTP status code series can be retrieved via {@link #series()}. * * @author Leonard Woo * @see HTTP Status Code Registry * List of HTTP status codes - * Wikipedia */ public enum HttpStatus { // 1xx Informational /** * {@code 100 Continue}. * * @see HTTP/1.1: Semantics and * Content, section 6.2.1 */ CONTINUE(100, Series.INFORMATIONAL, "Continue"), /** * {@code 101 Switching Protocols}. * * @see HTTP/1.1: Semantics and * Content, section 6.2.2 */ SWITCHING_PROTOCOLS(101, Series.INFORMATIONAL, "Switching Protocols"), /** * {@code 102 Processing}. * * @see WebDAV */ PROCESSING(102, Series.INFORMATIONAL, "Processing"), /** * {@code 103 Checkpoint}. * * @see A proposal * for supporting resumable POST/PUT HTTP requests in HTTP/1.0 */ CHECKPOINT(103, Series.INFORMATIONAL, "Checkpoint"), // 2xx Success /** * {@code 200 OK}. * * @see HTTP/1.1: Semantics and * Content, section 6.3.1 */ OK(200, Series.SUCCESSFUL, "OK"), /** * {@code 201 Created}. * * @see HTTP/1.1: Semantics and * Content, section 6.3.2 */ CREATED(201, Series.SUCCESSFUL, "Created"), /** * {@code 202 Accepted}. * * @see HTTP/1.1: Semantics and * Content, section 6.3.3 */ ACCEPTED(202, Series.SUCCESSFUL, "Accepted"), /** * {@code 203 Non-Authoritative Information}. * * @see HTTP/1.1: Semantics and * Content, section 6.3.4 */ NON_AUTHORITATIVE_INFORMATION(203, Series.SUCCESSFUL, "Non-Authoritative Information"), /** * {@code 204 No Content}. * * @see HTTP/1.1: Semantics and * Content, section 6.3.5 */ NO_CONTENT(204, Series.SUCCESSFUL, "No Content"), /** * {@code 205 Reset Content}. * * @see HTTP/1.1: Semantics and * Content, section 6.3.6 */ RESET_CONTENT(205, Series.SUCCESSFUL, "Reset Content"), /** * {@code 206 Partial Content}. * * @see HTTP/1.1: Range Requests, * section 4.1 */ PARTIAL_CONTENT(206, Series.SUCCESSFUL, "Partial Content"), /** * {@code 207 Multi-Status}. * * @see WebDAV */ MULTI_STATUS(207, Series.SUCCESSFUL, "Multi-Status"), /** * {@code 208 Already Reported}. * * @see WebDAV Binding Extensions */ ALREADY_REPORTED(208, Series.SUCCESSFUL, "Already Reported"), /** * {@code 226 IM Used}. * * @see Delta encoding in HTTP */ IM_USED(226, Series.SUCCESSFUL, "IM Used"), // 3xx Redirection /** * {@code 300 Multiple Choices}. * * @see HTTP/1.1: Semantics and * Content, section 6.4.1 */ MULTIPLE_CHOICES(300, Series.REDIRECTION, "Multiple Choices"), /** * {@code 301 Moved Permanently}. * * @see HTTP/1.1: Semantics and * Content, section 6.4.2 */ MOVED_PERMANENTLY(301, Series.REDIRECTION, "Moved Permanently"), /** * {@code 302 Found}. * * @see HTTP/1.1: Semantics and * Content, section 6.4.3 */ FOUND(302, Series.REDIRECTION, "Found"), /** * {@code 303 See Other}. * * @see HTTP/1.1: Semantics and * Content, section 6.4.4 */ SEE_OTHER(303, Series.REDIRECTION, "See Other"), /** * {@code 304 Not Modified}. * * @see HTTP/1.1: Conditional Requests, * section 4.1 */ NOT_MODIFIED(304, Series.REDIRECTION, "Not Modified"), /** * {@code 307 Temporary Redirect}. * * @see HTTP/1.1: Semantics and * Content, section 6.4.7 */ TEMPORARY_REDIRECT(307, Series.REDIRECTION, "Temporary Redirect"), /** * {@code 308 Permanent Redirect}. * * @see RFC 7238 */ PERMANENT_REDIRECT(308, Series.REDIRECTION, "Permanent Redirect"), // --- 4xx Client Error --- /** * {@code 400 Bad Request}. * * @see HTTP/1.1: Semantics and * Content, section 6.5.1 */ BAD_REQUEST(400, Series.CLIENT_ERROR, "Bad Request"), /** * {@code 401 Unauthorized}. * * @see HTTP/1.1: Authentication, * section 3.1 */ UNAUTHORIZED(401, Series.CLIENT_ERROR, "Unauthorized"), /** * {@code 402 Payment Required}. * * @see HTTP/1.1: Semantics and * Content, section 6.5.2 */ PAYMENT_REQUIRED(402, Series.CLIENT_ERROR, "Payment Required"), /** * {@code 403 Forbidden}. * * @see HTTP/1.1: Semantics and * Content, section 6.5.3 */ FORBIDDEN(403, Series.CLIENT_ERROR, "Forbidden"), /** * {@code 404 Not Found}. * * @see HTTP/1.1: Semantics and * Content, section 6.5.4 */ NOT_FOUND(404, Series.CLIENT_ERROR, "Not Found"), /** * {@code 405 Method Not Allowed}. * * @see HTTP/1.1: Semantics and * Content, section 6.5.5 */ METHOD_NOT_ALLOWED(405, Series.CLIENT_ERROR, "Method Not Allowed"), /** * {@code 406 Not Acceptable}. * * @see HTTP/1.1: Semantics and * Content, section 6.5.6 */ NOT_ACCEPTABLE(406, Series.CLIENT_ERROR, "Not Acceptable"), /** * {@code 407 Proxy Authentication Required}. * * @see HTTP/1.1: Authentication, * section 3.2 */ PROXY_AUTHENTICATION_REQUIRED(407, Series.CLIENT_ERROR, "Proxy Authentication Required"), /** * {@code 408 Request Timeout}. * * @see HTTP/1.1: Semantics and * Content, section 6.5.7 */ REQUEST_TIMEOUT(408, Series.CLIENT_ERROR, "Request Timeout"), /** * {@code 409 Conflict}. * * @see HTTP/1.1: Semantics and * Content, section 6.5.8 */ CONFLICT(409, Series.CLIENT_ERROR, "Conflict"), /** * {@code 410 Gone}. * * @see HTTP/1.1: Semantics and * Content, section 6.5.9 */ GONE(410, Series.CLIENT_ERROR, "Gone"), /** * {@code 411 Length Required}. * * @see HTTP/1.1: Semantics and * Content, section 6.5.10 */ LENGTH_REQUIRED(411, Series.CLIENT_ERROR, "Length Required"), /** * {@code 412 Precondition failed}. * * @see HTTP/1.1: Conditional Requests, * section 4.2 */ PRECONDITION_FAILED(412, Series.CLIENT_ERROR, "Precondition Failed"), /** * {@code 413 Payload Too Large}. * * @since 4.1 * @see HTTP/1.1: Semantics and * Content, section 6.5.11 */ PAYLOAD_TOO_LARGE(413, Series.CLIENT_ERROR, "Payload Too Large"), /** * {@code 414 URI Too Long}. * * @since 4.1 * @see HTTP/1.1: Semantics and * Content, section 6.5.12 */ URI_TOO_LONG(414, Series.CLIENT_ERROR, "URI Too Long"), /** * {@code 415 Unsupported Media Type}. * * @see HTTP/1.1: Semantics and * Content, section 6.5.13 */ UNSUPPORTED_MEDIA_TYPE(415, Series.CLIENT_ERROR, "Unsupported Media Type"), /** * {@code 416 Requested Range Not Satisfiable}. * * @see HTTP/1.1: Range Requests, * section 4.4 */ REQUESTED_RANGE_NOT_SATISFIABLE(416, Series.CLIENT_ERROR, "Requested range not satisfiable"), /** * {@code 417 Expectation Failed}. * * @see HTTP/1.1: Semantics and * Content, section 6.5.14 */ EXPECTATION_FAILED(417, Series.CLIENT_ERROR, "Expectation Failed"), /** * {@code 418 I'm a teapot}. * * @see HTCPCP/1.0 */ I_AM_A_TEAPOT(418, Series.CLIENT_ERROR, "I'm a teapot"), /** * {@code 422 Unprocessable Entity}. * * @see WebDAV */ UNPROCESSABLE_ENTITY(422, Series.CLIENT_ERROR, "Unprocessable Entity"), /** * {@code 423 Locked}. * * @see WebDAV */ LOCKED(423, Series.CLIENT_ERROR, "Locked"), /** * {@code 424 Failed Dependency}. * * @see WebDAV */ FAILED_DEPENDENCY(424, Series.CLIENT_ERROR, "Failed Dependency"), /** * {@code 425 Too Early}. * * @since 5.2 * @see RFC 8470 */ TOO_EARLY(425, Series.CLIENT_ERROR, "Too Early"), /** * {@code 426 Upgrade Required}. * * @see Upgrading to TLS Within * HTTP/1.1 */ UPGRADE_REQUIRED(426, Series.CLIENT_ERROR, "Upgrade Required"), /** * {@code 428 Precondition Required}. * * @see Additional HTTP Status Codes */ PRECONDITION_REQUIRED(428, Series.CLIENT_ERROR, "Precondition Required"), /** * {@code 429 Too Many Requests}. * * @see Additional HTTP Status Codes */ TOO_MANY_REQUESTS(429, Series.CLIENT_ERROR, "Too Many Requests"), /** * {@code 431 Request Header Fields Too Large}. * * @see Additional HTTP Status Codes */ REQUEST_HEADER_FIELDS_TOO_LARGE(431, Series.CLIENT_ERROR, "Request Header Fields Too Large"), /** * {@code 451 Unavailable For Legal Reasons}. * * @see An * HTTP Status Code to Report Legal Obstacles * @since 4.3 */ UNAVAILABLE_FOR_LEGAL_REASONS(451, Series.CLIENT_ERROR, "Unavailable For Legal Reasons"), // --- 5xx Server Error --- /** * {@code 500 Internal Server Error}. * * @see HTTP/1.1: Semantics and * Content, section 6.6.1 */ INTERNAL_SERVER_ERROR(500, Series.SERVER_ERROR, "Internal Server Error"), /** * {@code 501 Not Implemented}. * * @see HTTP/1.1: Semantics and * Content, section 6.6.2 */ NOT_IMPLEMENTED(501, Series.SERVER_ERROR, "Not Implemented"), /** * {@code 502 Bad Gateway}. * * @see HTTP/1.1: Semantics and * Content, section 6.6.3 */ BAD_GATEWAY(502, Series.SERVER_ERROR, "Bad Gateway"), /** * {@code 503 Service Unavailable}. * * @see HTTP/1.1: Semantics and * Content, section 6.6.4 */ SERVICE_UNAVAILABLE(503, Series.SERVER_ERROR, "Service Unavailable"), /** * {@code 504 Gateway Timeout}. * * @see HTTP/1.1: Semantics and * Content, section 6.6.5 */ GATEWAY_TIMEOUT(504, Series.SERVER_ERROR, "Gateway Timeout"), /** * {@code 505 HTTP Version Not Supported}. * * @see HTTP/1.1: Semantics and * Content, section 6.6.6 */ HTTP_VERSION_NOT_SUPPORTED(505, Series.SERVER_ERROR, "HTTP Version not supported"), /** * {@code 506 Variant Also Negotiates} * * @see Transparent Content * Negotiation */ VARIANT_ALSO_NEGOTIATES(506, Series.SERVER_ERROR, "Variant Also Negotiates"), /** * {@code 507 Insufficient Storage} * * @see WebDAV */ INSUFFICIENT_STORAGE(507, Series.SERVER_ERROR, "Insufficient Storage"), /** * {@code 508 Loop Detected} * * @see WebDAV Binding Extensions */ LOOP_DETECTED(508, Series.SERVER_ERROR, "Loop Detected"), /** {@code 509 Bandwidth Limit Exceeded} */ BANDWIDTH_LIMIT_EXCEEDED(509, Series.SERVER_ERROR, "Bandwidth Limit Exceeded"), /** * {@code 510 Not Extended} * * @see HTTP Extension Framework */ NOT_EXTENDED(510, Series.SERVER_ERROR, "Not Extended"), /** * {@code 511 Network Authentication Required}. * * @see Additional HTTP Status Codes */ NETWORK_AUTHENTICATION_REQUIRED(511, Series.SERVER_ERROR, "Network Authentication Required"), /** UNKNOWN status code */ UNKNOWN(999, Series.UNKNOWN, "UNKNOWN"); private static final HttpStatus[] VALUES; static { VALUES = values(); } private final int code; private final Series series; private final String message; HttpStatus(int code, Series series, String message) { this.code = code; this.series = series; this.message = message; } /** * Return the {@link HttpStatus} enum constant with the specified numeric value. * * @param statusCode the numeric value of the enum to be returned * @return HttpStatus enum object * @throws IllegalArgumentException if this enum has no constant for the specified numeric value */ public static HttpStatus valueOf(int statusCode) throws IllegalArgumentException { HttpStatus status = resolve(statusCode); if (status == UNKNOWN) { throw new IllegalArgumentException("No matching constant for [" + statusCode + "]"); } return status; } /** * Resolve the given status code to an {@link HttpStatus}, if possible. * * @param statusCode the HTTP status code (potentially non-standard) * @return the corresponding {@link HttpStatus}, or {@link #UNKNOWN} if not found */ public static HttpStatus resolve(final int statusCode) { if (Series.resolve(statusCode) != Series.UNKNOWN) { for (HttpStatus status : VALUES) { if (statusCode == status.code) { return status; } } } return UNKNOWN; } /** * Return the integer value of this status code. * * @return status code */ public int getCode() { return code; } /** * Return the HTTP status series of this status code. * * @see HttpStatus.Series * @return HTTP status series */ public Series series() { return this.series; } /** * Return the message of this status code. * * @return message */ public String getMessage() { return message; } /** * Whether this status code is in the HTTP series {@link HttpStatus.Series#INFORMATIONAL}. * *

This is a shortcut for checking the value of {@link #series()}. * * @return true */ public boolean is1xxInformational() { return (series() == Series.INFORMATIONAL); } /** * Whether this status code is in the HTTP series {@link HttpStatus.Series#SUCCESSFUL}. * *

This is a shortcut for checking the value of {@link #series()}. * * @return true */ public boolean is2xxSuccessful() { return (series() == Series.SUCCESSFUL); } /** * Whether this status code is in the HTTP series {@link HttpStatus.Series#REDIRECTION}. * *

This is a shortcut for checking the value of {@link #series()}. * * @return true */ public boolean is3xxRedirection() { return (series() == Series.REDIRECTION); } /** * Whether this status code is in the HTTP series {@link HttpStatus.Series#CLIENT_ERROR}. * *

This is a shortcut for checking the value of {@link #series()}. * * @return true */ public boolean is4xxClientError() { return (series() == Series.CLIENT_ERROR); } /** * Whether this status code is in the HTTP series {@link HttpStatus.Series#SERVER_ERROR}. * *

This is a shortcut for checking the value of {@link #series()}. * * @return true */ public boolean is5xxServerError() { return (series() == Series.SERVER_ERROR); } /** * Whether this status code is in the HTTP series {@link HttpStatus.Series#CLIENT_ERROR} or {@link * HttpStatus.Series#SERVER_ERROR}. * *

This is a shortcut for checking the value of {@link #series()}. * * @return true */ public boolean isError() { return (is4xxClientError() || is5xxServerError()); } /** * Return a string representation of this status code. * * @return {code} {messages} */ @Override public String toString() { return code + " " + message; } /** * Enumeration of HTTP status series. * *

Retrievable via {@link HttpStatus#series()}. */ public enum Series { /** HTTP Status Code 1xx */ INFORMATIONAL(1), /** HTTP Status Code 2xx */ SUCCESSFUL(2), /** HTTP Status Code 3xx */ REDIRECTION(3), /** HTTP Status Code 4xx */ CLIENT_ERROR(4), /** HTTP Status Code 5xx */ SERVER_ERROR(5), /** Unknown HTTP Status Code */ UNKNOWN(9); private final int value; Series(int value) { this.value = value; } /** * Return the {@link Series} enum constant for the supplied status code. * * @param statusCode the HTTP status code (potentially non-standard) * @return the {@link Series} enum constant for the supplied status code * @throws IllegalArgumentException if this enum has no corresponding constant */ public static Series valueOf(int statusCode) throws IllegalArgumentException { Series series = resolve(statusCode); if (series == UNKNOWN) { throw new IllegalArgumentException("No matching constant for [" + statusCode + "]"); } return series; } /** * Resolve the given status code to an {@link HttpStatus.Series}, if possible. * * @param statusCode the HTTP status code (potentially non-standard) * @return the corresponding {@link Series}, if not found return {@link #UNKNOWN} */ public static Series resolve(final int statusCode) { final int seriesCode = statusCode / 100; for (Series series : values()) { if (seriesCode == series.value) { return series; } } return UNKNOWN; } /** * Return the integer value of this status series. * * @return http status value. */ public int value() { return this.value; } } }





© 2015 - 2025 Weber Informatics LLC | Privacy Policy