io.rxmicro.http.HttpStatuses Maven / Gradle / Ivy
/*
* Copyright (c) 2020. https://rxmicro.io
*
* 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 io.rxmicro.http;
import java.util.Map;
import static java.util.Map.entry;
/**
* Wide used HTTP statuses and its short descriptions.
*
*
* Read more: https://en.wikipedia.org/wiki/List_of_HTTP_status_codes
*
* @author nedis
* @since 0.1
*/
public final class HttpStatuses {
@SuppressWarnings("JavacQuirks")
private static final Map STATUES = Map.ofEntries(
// ------------- Informational -------------
entry(100, "Continue"),
entry(101, "Switching Protocols"),
entry(102, "Processing"),
entry(103, "Early Hints"),
// ---------------- Success ----------------
entry(200, "OK"),
entry(201, "Created"),
entry(202, "Accepted"),
entry(203, "Non-Authoritative Information"),
entry(204, "No Content"),
entry(205, "Reset Content"),
entry(206, "Partial Content"),
entry(207, "Multi-Status"),
entry(208, "Already Reported"),
entry(226, "IM Used"),
// -------------- Redirection --------------
entry(300, "Multiple Choices"),
entry(301, "Moved Permanently"),
entry(302, "Found"),
entry(303, "See Other"),
entry(304, "Not Modified"),
entry(305, "Use Proxy"),
entry(306, "Switch Proxy"),
entry(307, "Temporary Redirect"),
entry(308, "Permanent Redirect"),
// ------------- Client errors -------------
entry(400, "Bad Request"),
entry(401, "Unauthorized"),
entry(402, "Payment Required"),
entry(403, "Forbidden"),
entry(404, "Not Found"),
entry(405, "Method Not Allowed"),
entry(406, "Not Acceptable"),
entry(407, "Proxy Authentication Required"),
entry(408, "Request Timeout"),
entry(409, "Conflict"),
entry(410, "Gone"),
entry(411, "Length Required"),
entry(412, "Precondition Failed"),
entry(413, "Payload Too Large"),
entry(414, "URI Too Long"),
entry(415, "Unsupported Media Type"),
entry(416, "Range Not Satisfiable"),
entry(417, "Expectation Failed"),
entry(418, "I'm a teapot"),
entry(421, "Misdirected Request"),
entry(422, "Unprocessable Entity"),
entry(423, "Locked"),
entry(424, "Failed Dependency"),
entry(425, "Too Early"),
entry(426, "Upgrade Required"),
entry(428, "Precondition Required"),
entry(429, "Too Many Requests"),
entry(431, "Request Header Fields Too Large"),
entry(451, "Unavailable For Legal Reasons "),
// ------------- Server errors -------------
entry(500, "Internal Server Error"),
entry(501, "Not Implemented"),
entry(502, "Bad Gateway"),
entry(503, "Service Unavailable"),
entry(504, "Gateway Timeout"),
entry(505, "HTTP Version Not Supported"),
entry(506, "Variant Also Negotiates"),
entry(507, "Insufficient Storage"),
entry(508, "Loop Detected"),
entry(510, "Not Extended"),
entry(511, "Network Authentication Required")
);
private static final int MIN_SUPPORTED_HTTP_STATUS = 100;
private static final int MAX_SUPPORTED_HTTP_STATUS = 599;
/**
* Returns the short description for the specified status code.
*
* @param status the specified status code
* @return the short description for the specified status code or
* `Unofficial code: ${statusCode}` if the short description not defined
* @throws IllegalArgumentException if the specified status code is not in range [100-599]
*/
public static String getErrorMessage(final int status) {
if (status < MIN_SUPPORTED_HTTP_STATUS || status > MAX_SUPPORTED_HTTP_STATUS) {
throw new IllegalArgumentException("Invalid status code: " + status);
} else {
return STATUES.getOrDefault(status, "Unofficial code: " + status);
}
}
private HttpStatuses() {
}
}