HttpStatus.java

/*
 * ====================================================================
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 *
 */

package com.foxinmy.weixin4j.http;

/**
 * Constants enumerating the HTTP status codes. All status codes defined in
 * RFC1945 (HTTP/1.0), RFC2616 (HTTP/1.1), and RFC2518 (WebDAV) are listed.
 *
 *
 * @since 4.0
 */
public final class HttpStatus {

	// --- 1xx Informational ---

	/** <tt>100 Continue</tt> (HTTP/1.1 - RFC 2616) */
	public static final int SC_CONTINUE = 100;
	/** <tt>101 Switching Protocols</tt> (HTTP/1.1 - RFC 2616) */
	public static final int SC_SWITCHING_PROTOCOLS = 101;
	/** <tt>102 Processing</tt> (WebDAV - RFC 2518) */
	public static final int SC_PROCESSING = 102;

	// --- 2xx Success ---

	/** <tt>200 OK</tt> (HTTP/1.0 - RFC 1945) */
	public static final int SC_OK = 200;
	/** <tt>201 Created</tt> (HTTP/1.0 - RFC 1945) */
	public static final int SC_CREATED = 201;
	/** <tt>202 Accepted</tt> (HTTP/1.0 - RFC 1945) */
	public static final int SC_ACCEPTED = 202;
	/** <tt>203 Non Authoritative Information</tt> (HTTP/1.1 - RFC 2616) */
	public static final int SC_NON_AUTHORITATIVE_INFORMATION = 203;
	/** <tt>204 No Content</tt> (HTTP/1.0 - RFC 1945) */
	public static final int SC_NO_CONTENT = 204;
	/** <tt>205 Reset Content</tt> (HTTP/1.1 - RFC 2616) */
	public static final int SC_RESET_CONTENT = 205;
	/** <tt>206 Partial Content</tt> (HTTP/1.1 - RFC 2616) */
	public static final int SC_PARTIAL_CONTENT = 206;
	/**
	 * <tt>207 Multi-Status</tt> (WebDAV - RFC 2518) or <tt>207 Partial Update
	 * OK</tt> (HTTP/1.1 - draft-ietf-http-v11-spec-rev-01?)
	 */
	public static final int SC_MULTI_STATUS = 207;

	// --- 3xx Redirection ---

	/** <tt>300 Mutliple Choices</tt> (HTTP/1.1 - RFC 2616) */
	public static final int SC_MULTIPLE_CHOICES = 300;
	/** <tt>301 Moved Permanently</tt> (HTTP/1.0 - RFC 1945) */
	public static final int SC_MOVED_PERMANENTLY = 301;
	/**
	 * <tt>302 Moved Temporarily</tt> (Sometimes <tt>Found</tt>) (HTTP/1.0 - RFC
	 * 1945)
	 */
	public static final int SC_MOVED_TEMPORARILY = 302;
	/** <tt>303 See Other</tt> (HTTP/1.1 - RFC 2616) */
	public static final int SC_SEE_OTHER = 303;
	/** <tt>304 Not Modified</tt> (HTTP/1.0 - RFC 1945) */
	public static final int SC_NOT_MODIFIED = 304;
	/** <tt>305 Use Proxy</tt> (HTTP/1.1 - RFC 2616) */
	public static final int SC_USE_PROXY = 305;
	/** <tt>307 Temporary Redirect</tt> (HTTP/1.1 - RFC 2616) */
	public static final int SC_TEMPORARY_REDIRECT = 307;

	// --- 4xx Client Error ---

	/** <tt>400 Bad Request</tt> (HTTP/1.1 - RFC 2616) */
	public static final int SC_BAD_REQUEST = 400;
	/** <tt>401 Unauthorized</tt> (HTTP/1.0 - RFC 1945) */
	public static final int SC_UNAUTHORIZED = 401;
	/** <tt>402 Payment Required</tt> (HTTP/1.1 - RFC 2616) */
	public static final int SC_PAYMENT_REQUIRED = 402;
	/** <tt>403 Forbidden</tt> (HTTP/1.0 - RFC 1945) */
	public static final int SC_FORBIDDEN = 403;
	/** <tt>404 Not Found</tt> (HTTP/1.0 - RFC 1945) */
	public static final int SC_NOT_FOUND = 404;
	/** <tt>405 Method Not Allowed</tt> (HTTP/1.1 - RFC 2616) */
	public static final int SC_METHOD_NOT_ALLOWED = 405;
	/** <tt>406 Not Acceptable</tt> (HTTP/1.1 - RFC 2616) */
	public static final int SC_NOT_ACCEPTABLE = 406;
	/** <tt>407 Proxy Authentication Required</tt> (HTTP/1.1 - RFC 2616) */
	public static final int SC_PROXY_AUTHENTICATION_REQUIRED = 407;
	/** <tt>408 Request Timeout</tt> (HTTP/1.1 - RFC 2616) */
	public static final int SC_REQUEST_TIMEOUT = 408;
	/** <tt>409 Conflict</tt> (HTTP/1.1 - RFC 2616) */
	public static final int SC_CONFLICT = 409;
	/** <tt>410 Gone</tt> (HTTP/1.1 - RFC 2616) */
	public static final int SC_GONE = 410;
	/** <tt>411 Length Required</tt> (HTTP/1.1 - RFC 2616) */
	public static final int SC_LENGTH_REQUIRED = 411;
	/** <tt>412 Precondition Failed</tt> (HTTP/1.1 - RFC 2616) */
	public static final int SC_PRECONDITION_FAILED = 412;
	/** <tt>413 Request Entity Too Large</tt> (HTTP/1.1 - RFC 2616) */
	public static final int SC_REQUEST_TOO_LONG = 413;
	/** <tt>414 Request-URI Too Long</tt> (HTTP/1.1 - RFC 2616) */
	public static final int SC_REQUEST_URI_TOO_LONG = 414;
	/** <tt>415 Unsupported Media Type</tt> (HTTP/1.1 - RFC 2616) */
	public static final int SC_UNSUPPORTED_MEDIA_TYPE = 415;
	/** <tt>416 Requested Range Not Satisfiable</tt> (HTTP/1.1 - RFC 2616) */
	public static final int SC_REQUESTED_RANGE_NOT_SATISFIABLE = 416;
	/** <tt>417 Expectation Failed</tt> (HTTP/1.1 - RFC 2616) */
	public static final int SC_EXPECTATION_FAILED = 417;

	/**
	 * Static constant for a 418 error. <tt>418 Unprocessable Entity</tt>
	 * (WebDAV drafts?) or <tt>418 Reauthentication Required</tt> (HTTP/1.1
	 * drafts?)
	 */
	// not used
	// public static final int SC_UNPROCESSABLE_ENTITY = 418;

	/**
	 * Static constant for a 419 error.
	 * <tt>419 Insufficient Space on Resource</tt> (WebDAV -
	 * draft-ietf-webdav-protocol-05?) or
	 * <tt>419 Proxy Reauthentication Required</tt> (HTTP/1.1 drafts?)
	 */
	public static final int SC_INSUFFICIENT_SPACE_ON_RESOURCE = 419;
	/**
	 * Static constant for a 420 error. <tt>420 Method Failure</tt> (WebDAV -
	 * draft-ietf-webdav-protocol-05?)
	 */
	public static final int SC_METHOD_FAILURE = 420;
	/** <tt>422 Unprocessable Entity</tt> (WebDAV - RFC 2518) */
	public static final int SC_UNPROCESSABLE_ENTITY = 422;
	/** <tt>423 Locked</tt> (WebDAV - RFC 2518) */
	public static final int SC_LOCKED = 423;
	/** <tt>424 Failed Dependency</tt> (WebDAV - RFC 2518) */
	public static final int SC_FAILED_DEPENDENCY = 424;

	// --- 5xx Server Error ---

	/** <tt>500 Server Error</tt> (HTTP/1.0 - RFC 1945) */
	public static final int SC_INTERNAL_SERVER_ERROR = 500;
	/** <tt>501 Not Implemented</tt> (HTTP/1.0 - RFC 1945) */
	public static final int SC_NOT_IMPLEMENTED = 501;
	/** <tt>502 Bad Gateway</tt> (HTTP/1.0 - RFC 1945) */
	public static final int SC_BAD_GATEWAY = 502;
	/** <tt>503 Service Unavailable</tt> (HTTP/1.0 - RFC 1945) */
	public static final int SC_SERVICE_UNAVAILABLE = 503;
	/** <tt>504 Gateway Timeout</tt> (HTTP/1.1 - RFC 2616) */
	public static final int SC_GATEWAY_TIMEOUT = 504;
	/** <tt>505 HTTP Version Not Supported</tt> (HTTP/1.1 - RFC 2616) */
	public static final int SC_HTTP_VERSION_NOT_SUPPORTED = 505;

	/** <tt>507 Insufficient Storage</tt> (WebDAV - RFC 2518) */
	public static final int SC_INSUFFICIENT_STORAGE = 507;

	private final int statusCode;
	private final String statusText;

	public HttpStatus(int statusCode, String statusText) {
		this.statusCode = statusCode;
		this.statusText = statusText;
	}

	public int getStatusCode() {
		return statusCode;
	}

	public String getStatusText() {
		return statusText;
	}

	/**
	 * Returns the HTTP status series of this status code.
	 * 
	 * @see HttpStatus.Series
	 */
	public Series series() {
		return Series.valueOf(this);
	}

	/**
	 * Java 5 enumeration of HTTP status series.
	 * <p>
	 * Retrievable via {@link HttpStatus#series()}.
	 */
	public static enum Series {

		INFORMATIONAL(1), SUCCESSFUL(2), REDIRECTION(3), CLIENT_ERROR(4), SERVER_ERROR(
				5);

		private final int value;

		private Series(int value) {
			this.value = value;
		}

		/**
		 * Return the integer value of this status series. Ranges from 1 to 5.
		 */
		public int value() {
			return this.value;
		}

		public static Series valueOf(int status) {
			int seriesCode = status / 100;
			for (Series series : values()) {
				if (series.value == seriesCode) {
					return series;
				}
			}
			throw new IllegalArgumentException("No matching constant for ["
					+ status + "]");
		}

		public static Series valueOf(HttpStatus status) {
			return valueOf(status.statusCode);
		}
	}

	@Override
	public String toString() {
		return "[" + statusCode + "," + statusText + "]";
	}
}