org.jooby.Status Maven / Gradle / Ivy
/**
* Apache License
* Version 2.0, January 2004
* http://www.apache.org/licenses/
*
* TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
*
* 1. Definitions.
*
* "License" shall mean the terms and conditions for use, reproduction,
* and distribution as defined by Sections 1 through 9 of this document.
*
* "Licensor" shall mean the copyright owner or entity authorized by
* the copyright owner that is granting the License.
*
* "Legal Entity" shall mean the union of the acting entity and all
* other entities that control, are controlled by, or are under common
* control with that entity. For the purposes of this definition,
* "control" means (i) the power, direct or indirect, to cause the
* direction or management of such entity, whether by contract or
* otherwise, or (ii) ownership of fifty percent (50%) or more of the
* outstanding shares, or (iii) beneficial ownership of such entity.
*
* "You" (or "Your") shall mean an individual or Legal Entity
* exercising permissions granted by this License.
*
* "Source" form shall mean the preferred form for making modifications,
* including but not limited to software source code, documentation
* source, and configuration files.
*
* "Object" form shall mean any form resulting from mechanical
* transformation or translation of a Source form, including but
* not limited to compiled object code, generated documentation,
* and conversions to other media types.
*
* "Work" shall mean the work of authorship, whether in Source or
* Object form, made available under the License, as indicated by a
* copyright notice that is included in or attached to the work
* (an example is provided in the Appendix below).
*
* "Derivative Works" shall mean any work, whether in Source or Object
* form, that is based on (or derived from) the Work and for which the
* editorial revisions, annotations, elaborations, or other modifications
* represent, as a whole, an original work of authorship. For the purposes
* of this License, Derivative Works shall not include works that remain
* separable from, or merely link (or bind by name) to the interfaces of,
* the Work and Derivative Works thereof.
*
* "Contribution" shall mean any work of authorship, including
* the original version of the Work and any modifications or additions
* to that Work or Derivative Works thereof, that is intentionally
* submitted to Licensor for inclusion in the Work by the copyright owner
* or by an individual or Legal Entity authorized to submit on behalf of
* the copyright owner. For the purposes of this definition, "submitted"
* means any form of electronic, verbal, or written communication sent
* to the Licensor or its representatives, including but not limited to
* communication on electronic mailing lists, source code control systems,
* and issue tracking systems that are managed by, or on behalf of, the
* Licensor for the purpose of discussing and improving the Work, but
* excluding communication that is conspicuously marked or otherwise
* designated in writing by the copyright owner as "Not a Contribution."
*
* "Contributor" shall mean Licensor and any individual or Legal Entity
* on behalf of whom a Contribution has been received by Licensor and
* subsequently incorporated within the Work.
*
* 2. Grant of Copyright License. Subject to the terms and conditions of
* this License, each Contributor hereby grants to You a perpetual,
* worldwide, non-exclusive, no-charge, royalty-free, irrevocable
* copyright license to reproduce, prepare Derivative Works of,
* publicly display, publicly perform, sublicense, and distribute the
* Work and such Derivative Works in Source or Object form.
*
* 3. Grant of Patent License. Subject to the terms and conditions of
* this License, each Contributor hereby grants to You a perpetual,
* worldwide, non-exclusive, no-charge, royalty-free, irrevocable
* (except as stated in this section) patent license to make, have made,
* use, offer to sell, sell, import, and otherwise transfer the Work,
* where such license applies only to those patent claims licensable
* by such Contributor that are necessarily infringed by their
* Contribution(s) alone or by combination of their Contribution(s)
* with the Work to which such Contribution(s) was submitted. If You
* institute patent litigation against any entity (including a
* cross-claim or counterclaim in a lawsuit) alleging that the Work
* or a Contribution incorporated within the Work constitutes direct
* or contributory patent infringement, then any patent licenses
* granted to You under this License for that Work shall terminate
* as of the date such litigation is filed.
*
* 4. Redistribution. You may reproduce and distribute copies of the
* Work or Derivative Works thereof in any medium, with or without
* modifications, and in Source or Object form, provided that You
* meet the following conditions:
*
* (a) You must give any other recipients of the Work or
* Derivative Works a copy of this License; and
*
* (b) You must cause any modified files to carry prominent notices
* stating that You changed the files; and
*
* (c) You must retain, in the Source form of any Derivative Works
* that You distribute, all copyright, patent, trademark, and
* attribution notices from the Source form of the Work,
* excluding those notices that do not pertain to any part of
* the Derivative Works; and
*
* (d) If the Work includes a "NOTICE" text file as part of its
* distribution, then any Derivative Works that You distribute must
* include a readable copy of the attribution notices contained
* within such NOTICE file, excluding those notices that do not
* pertain to any part of the Derivative Works, in at least one
* of the following places: within a NOTICE text file distributed
* as part of the Derivative Works; within the Source form or
* documentation, if provided along with the Derivative Works; or,
* within a display generated by the Derivative Works, if and
* wherever such third-party notices normally appear. The contents
* of the NOTICE file are for informational purposes only and
* do not modify the License. You may add Your own attribution
* notices within Derivative Works that You distribute, alongside
* or as an addendum to the NOTICE text from the Work, provided
* that such additional attribution notices cannot be construed
* as modifying the License.
*
* You may add Your own copyright statement to Your modifications and
* may provide additional or different license terms and conditions
* for use, reproduction, or distribution of Your modifications, or
* for any such Derivative Works as a whole, provided Your use,
* reproduction, and distribution of the Work otherwise complies with
* the conditions stated in this License.
*
* 5. Submission of Contributions. Unless You explicitly state otherwise,
* any Contribution intentionally submitted for inclusion in the Work
* by You to the Licensor shall be under the terms and conditions of
* this License, without any additional terms or conditions.
* Notwithstanding the above, nothing herein shall supersede or modify
* the terms of any separate license agreement you may have executed
* with Licensor regarding such Contributions.
*
* 6. Trademarks. This License does not grant permission to use the trade
* names, trademarks, service marks, or product names of the Licensor,
* except as required for reasonable and customary use in describing the
* origin of the Work and reproducing the content of the NOTICE file.
*
* 7. Disclaimer of Warranty. Unless required by applicable law or
* agreed to in writing, Licensor provides the Work (and each
* Contributor provides its Contributions) on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
* implied, including, without limitation, any warranties or conditions
* of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
* PARTICULAR PURPOSE. You are solely responsible for determining the
* appropriateness of using or redistributing the Work and assume any
* risks associated with Your exercise of permissions under this License.
*
* 8. Limitation of Liability. In no event and under no legal theory,
* whether in tort (including negligence), contract, or otherwise,
* unless required by applicable law (such as deliberate and grossly
* negligent acts) or agreed to in writing, shall any Contributor be
* liable to You for damages, including any direct, indirect, special,
* incidental, or consequential damages of any character arising as a
* result of this License or out of the use or inability to use the
* Work (including but not limited to damages for loss of goodwill,
* work stoppage, computer failure or malfunction, or any and all
* other commercial damages or losses), even if such Contributor
* has been advised of the possibility of such damages.
*
* 9. Accepting Warranty or Additional Liability. While redistributing
* the Work or Derivative Works thereof, You may choose to offer,
* and charge a fee for, acceptance of support, warranty, indemnity,
* or other liability obligations and/or rights consistent with this
* License. However, in accepting such obligations, You may act only
* on Your own behalf and on Your sole responsibility, not on behalf
* of any other Contributor, and only if You agree to indemnify,
* defend, and hold each Contributor harmless for any liability
* incurred by, or claims asserted against, such Contributor by reason
* of your accepting any such warranty or additional liability.
*
* END OF TERMS AND CONDITIONS
*
* APPENDIX: How to apply the Apache License to your work.
*
* To apply the Apache License to your work, attach the following
* boilerplate notice, with the fields enclosed by brackets "{}"
* replaced with your own identifying information. (Don't include
* the brackets!) The text should be enclosed in the appropriate
* comment syntax for the file format. We also recommend that a
* file or class name and description of purpose be included on the
* same "printed page" as the copyright notice for easier
* identification within third-party archives.
*
* Copyright 2014 Edgar Espina
*
* 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.jooby;
import java.util.HashMap;
import java.util.Map;
/**
* HTTP status codes.
*
*
* This code has been kindly borrowed from Spring.
*
*
* @author Arjen Poutsma
* @see HTTP Status Code Registry
* @see List of HTTP status codes -
* Wikipedia
*/
public class Status {
private static final Map statusMap = new HashMap<>();
// 1xx Informational
/**
* {@code 100 Continue}.
*
* @see HTTP/1.1
*/
public static final Status CONTINUE = new Status(100, "Continue");
/**
* {@code 101 Switching Protocols}.
*
* @see HTTP/1.1
*/
public static final Status SWITCHING_PROTOCOLS = new Status(101, "Switching Protocols");
/**
* {@code 102 Processing}.
*
* @see WebDAV
*/
public static final Status PROCESSING = new Status(102, "Processing");
/**
* {@code 103 Checkpoint}.
*
* @see A proposal for
* supporting resumable POST/PUT HTTP requests in HTTP/1.0
*/
public static final Status CHECKPOINT = new Status(103, "Checkpoint");
// 2xx Success
/**
* {@code 200 OK}.
*
* @see HTTP/1.1
*/
public static final Status OK = new Status(200, "Success");
/**
* {@code 201 Created}.
*
* @see HTTP/1.1
*/
public static final Status CREATED = new Status(201, "Created");
/**
* {@code 202 Accepted}.
*
* @see HTTP/1.1
*/
public static final Status ACCEPTED = new Status(202, "Accepted");
/**
* {@code 203 Non-Authoritative Information}.
*
* @see HTTP/1.1
*/
public static final Status NON_AUTHORITATIVE_INFORMATION = new Status(203, "Non-Authoritative Information");
/**
* {@code 204 No Content}.
*
* @see HTTP/1.1
*/
public static final Status NO_CONTENT = new Status(204, "No Content");
/**
* {@code 205 Reset Content}.
*
* @see HTTP/1.1
*/
public static final Status RESET_CONTENT = new Status(205, "Reset Content");
/**
* {@code 206 Partial Content}.
*
* @see HTTP/1.1
*/
public static final Status PARTIAL_CONTENT = new Status(206, "Partial Content");
/**
* {@code 207 Multi-Status}.
*
* @see WebDAV
*/
public static final Status MULTI_STATUS = new Status(207, "Multi-Status");
/**
* {@code 208 Already Reported}.
*
* @see WebDAV Binding Extensions
*/
public static final Status ALREADY_REPORTED = new Status(208, "Already Reported");
/**
* {@code 226 IM Used}.
*
* @see Delta encoding in HTTP
*/
public static final Status IM_USED = new Status(226, "IM Used");
// 3xx Redirection
/**
* {@code 300 Multiple Choices}.
*
* @see HTTP/1.1
*/
public static final Status MULTIPLE_CHOICES = new Status(300, "Multiple Choices");
/**
* {@code 301 Moved Permanently}.
*
* @see HTTP/1.1
*/
public static final Status MOVED_PERMANENTLY = new Status(301, "Moved Permanently");
/**
* {@code 302 Found}.
*
* @see HTTP/1.1
*/
public static final Status FOUND = new Status(302, "Found");
/**
* {@code 303 See Other}.
*
* @see HTTP/1.1
*/
public static final Status SEE_OTHER = new Status(303, "See Other");
/**
* {@code 304 Not Modified}.
*
* @see HTTP/1.1
*/
public static final Status NOT_MODIFIED = new Status(304, "Not Modified");
/**
* {@code 305 Use Proxy}.
*
* @see HTTP/1.1
*/
public static final Status USE_PROXY = new Status(305, "Use Proxy");
/**
* {@code 307 Temporary Redirect}.
*
* @see HTTP/1.1
*/
public static final Status TEMPORARY_REDIRECT = new Status(307, "Temporary Redirect");
/**
* {@code 308 Resume Incomplete}.
*
* @see A proposal for
* supporting resumable POST/PUT HTTP requests in HTTP/1.0
*/
public static final Status RESUME_INCOMPLETE = new Status(308, "Resume Incomplete");
// --- 4xx Client Error ---
/**
* {@code 400 Bad Request}.
*
* @see HTTP/1.1
*/
public static final Status BAD_REQUEST = new Status(400, "Bad Request");
/**
* {@code 401 Unauthorized}.
*
* @see HTTP/1.1
*/
public static final Status UNAUTHORIZED = new Status(401, "Unauthorized");
/**
* {@code 402 Payment Required}.
*
* @see HTTP/1.1
*/
public static final Status PAYMENT_REQUIRED = new Status(402, "Payment Required");
/**
* {@code 403 Forbidden}.
*
* @see HTTP/1.1
*/
public static final Status FORBIDDEN = new Status(403, "Forbidden");
/**
* {@code 404 Not Found}.
*
* @see HTTP/1.1
*/
public static final Status NOT_FOUND = new Status(404, "Not Found");
/**
* {@code 405 Method Not Allowed}.
*
* @see HTTP/1.1
*/
public static final Status METHOD_NOT_ALLOWED = new Status(405, "Method Not Allowed");
/**
* {@code 406 Not Acceptable}.
*
* @see HTTP/1.1
*/
public static final Status NOT_ACCEPTABLE = new Status(406, "Not Acceptable");
/**
* {@code 407 Proxy Authentication Required}.
*
* @see HTTP/1.1
*/
public static final Status PROXY_AUTHENTICATION_REQUIRED = new Status(407, "Proxy Authentication Required");
/**
* {@code 408 Request Timeout}.
*
* @see HTTP/1.1
*/
public static final Status REQUEST_TIMEOUT = new Status(408, "Request Timeout");
/**
* {@code 409 Conflict}.
*
* @see HTTP/1.1
*/
public static final Status CONFLICT = new Status(409, "Conflict");
/**
* {@code 410 Gone}.
*
* @see HTTP/1.1
*/
public static final Status GONE = new Status(410, "Gone");
/**
* {@code 411 Length Required}.
*
* @see HTTP/1.1
*/
public static final Status LENGTH_REQUIRED = new Status(411, "Length Required");
/**
* {@code 412 Precondition failed}.
*
* @see HTTP/1.1
*/
public static final Status PRECONDITION_FAILED = new Status(412, "Precondition Failed");
/**
* {@code 413 Request Entity Too Large}.
*
* @see HTTP/1.1
*/
public static final Status REQUEST_ENTITY_TOO_LARGE = new Status(413, "Request Entity Too Large");
/**
* {@code 414 Request-URI Too Long}.
*
* @see HTTP/1.1
*/
public static final Status REQUEST_URI_TOO_LONG = new Status(414, "Request-URI Too Long");
/**
* {@code 415 Unsupported Media Type}.
*
* @see HTTP/1.1
*/
public static final Status UNSUPPORTED_MEDIA_TYPE = new Status(415, "Unsupported Media Type");
/**
* {@code 416 Requested Range Not Satisfiable}.
*
* @see HTTP/1.1
*/
public static final Status REQUESTED_RANGE_NOT_SATISFIABLE = new Status(416, "Requested range not satisfiable");
/**
* {@code 417 Expectation Failed}.
*
* @see HTTP/1.1
*/
public static final Status EXPECTATION_FAILED = new Status(417, "Expectation Failed");
/**
* {@code 418 I'm a teapot}.
*
* @see HTCPCP/1.0
*/
public static final Status I_AM_A_TEAPOT = new Status(418, "I'm a teapot");
/**
* {@code 422 Unprocessable Entity}.
*
* @see WebDAV
*/
public static final Status UNPROCESSABLE_ENTITY = new Status(422, "Unprocessable Entity");
/**
* {@code 423 Locked}.
*
* @see WebDAV
*/
public static final Status LOCKED = new Status(423, "Locked");
/**
* {@code 424 Failed Dependency}.
*
* @see WebDAV
*/
public static final Status FAILED_DEPENDENCY = new Status(424, "Failed Dependency");
/**
* {@code 426 Upgrade Required}.
*
* @see Upgrading to TLS Within
* HTTP/1.1
*/
public static final Status UPGRADE_REQUIRED = new Status(426, "Upgrade Required");
/**
* {@code 428 Precondition Required}.
*
* @see Additional HTTP Status Codes
*/
public static final Status PRECONDITION_REQUIRED = new Status(428, "Precondition Required");
/**
* {@code 429 Too Many Requests}.
*
* @see Additional HTTP Status Codes
*/
public static final Status TOO_MANY_REQUESTS = new Status(429, "Too Many Requests");
/**
* {@code 431 Request Header Fields Too Large}.
*
* @see Additional HTTP Status Codes
*/
public static final Status REQUEST_HEADER_FIELDS_TOO_LARGE = new Status(431, "Request Header Fields Too Large");
// --- 5xx Server Error ---
/**
* {@code 500 Server Error}.
*
* @see HTTP/1.1
*/
public static final Status SERVER_ERROR = new Status(500, "Server Error");
/**
* {@code 501 Not Implemented}.
*
* @see HTTP/1.1
*/
public static final Status NOT_IMPLEMENTED = new Status(501, "Not Implemented");
/**
* {@code 502 Bad Gateway}.
*
* @see HTTP/1.1
*/
public static final Status BAD_GATEWAY = new Status(502, "Bad Gateway");
/**
* {@code 503 Service Unavailable}.
*
* @see HTTP/1.1
*/
public static final Status SERVICE_UNAVAILABLE = new Status(503, "Service Unavailable");
/**
* {@code 504 Gateway Timeout}.
*
* @see HTTP/1.1
*/
public static final Status GATEWAY_TIMEOUT = new Status(504, "Gateway Timeout");
/**
* {@code 505 HTTP Version Not Supported}.
*
* @see HTTP/1.1
*/
public static final Status HTTP_VERSION_NOT_SUPPORTED = new Status(505, "HTTP Version not supported");
/**
* {@code 506 Variant Also Negotiates}
*
* @see Transparent Content
* Negotiation
*/
public static final Status VARIANT_ALSO_NEGOTIATES = new Status(506, "Variant Also Negotiates");
/**
* {@code 507 Insufficient Storage}
*
* @see WebDAV
*/
public static final Status INSUFFICIENT_STORAGE = new Status(507, "Insufficient Storage");
/**
* {@code 508 Loop Detected}
*
* @see WebDAV Binding Extensions
*/
public static final Status LOOP_DETECTED = new Status(508, "Loop Detected");
/**
* {@code 509 Bandwidth Limit Exceeded}
*/
public static final Status BANDWIDTH_LIMIT_EXCEEDED = new Status(509, "Bandwidth Limit Exceeded");
/**
* {@code 510 Not Extended}
*
* @see HTTP Extension Framework
*/
public static final Status NOT_EXTENDED = new Status(510, "Not Extended");
/**
* {@code 511 Network Authentication Required}.
*
* @see Additional HTTP Status Codes
*/
public static final Status NETWORK_AUTHENTICATION_REQUIRED = new Status(511, "Network Authentication Required");
private final int value;
private final String reason;
private Status(final int value, final String reason) {
statusMap.put(Integer.valueOf(value), this);
this.value = value;
this.reason = reason;
}
/**
* @return Return the integer value of this status code.
*/
public int value() {
return this.value;
}
/**
* @return True, for status code >= 400.
*/
public boolean isError() {
return this.value >= 400;
}
/**
* @return the reason phrase of this status code.
*/
public String reason() {
return reason;
}
/**
* Return a string representation of this status code.
*/
@Override
public String toString() {
return reason() + " (" + value + ")";
}
/**
* Return the enum constant of this type with the specified numeric value.
*
* @param statusCode the numeric value of the enum to be returned
* @return the enum constant with the specified numeric value
* @throws IllegalArgumentException if this enum has no constant for the specified numeric value
*/
public static Status valueOf(final int statusCode) {
Integer key = Integer.valueOf(statusCode);
Status status = statusMap.get(key);
return status == null? new Status(key, key.toString()) : status;
}
}