org.hisp.dhis.response

Enum HttpStatus

java.lang.Object

java.lang.Enum<HttpStatus>

org.hisp.dhis.response.HttpStatus

All Implemented Interfaces:

Serializable, Comparable<HttpStatus>

public enum HttpStatus
extends Enum<HttpStatus>

Enumeration of HTTP status codes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpStatus.Series Enumeration of HTTP status series.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACCEPTED
ALREADY_REPORTED
BAD_GATEWAY
BAD_REQUEST
BANDWIDTH_LIMIT_EXCEEDED
CHECKPOINT
CONTINUE
CREATED
EXPECTATION_FAILED
FAILED_DEPENDENCY
FORBIDDEN
FOUND
GATEWAY_TIMEOUT
GONE
HTTP_VERSION_NOT_SUPPORTED
IM_USED
INSUFFICIENT_STORAGE
INTERNAL_SERVER_ERROR
LENGTH_REQUIRED
LOCKED
LOOP_DETECTED
METHOD_NOT_ALLOWED
MOVED_PERMANENTLY
MULTI_STATUS
MULTIPLE_CHOICES
NETWORK_AUTHENTICATION_REQUIRED
NO_CONTENT
NON_AUTHORITATIVE_INFORMATION
NOT_ACCEPTABLE
NOT_EXTENDED
NOT_FOUND
NOT_IMPLEMENTED
NOT_MODIFIED
OK
PARTIAL_CONTENT
PAYLOAD_TOO_LARGE
PAYMENT_REQUIRED
PERMANENT_REDIRECT
PRECONDITION_FAILED
PROCESSING
PROXY_AUTHENTICATION_REQUIRED
REQUEST_HEADER_FIELDS_TOO_LARGE
REQUEST_TIMEOUT
REQUESTED_RANGE_NOT_SATISFIABLE
RESET_CONTENT
SEE_OTHER
SERVICE_UNAVAILABLE
SWITCHING_PROTOCOLS
TEMPORARY_REDIRECT
TOO_MANY_REQUESTS
UNAUTHORIZED
UNAVAILABLE_FOR_LEGAL_REASONS
UNPROCESSABLE_ENTITY
UNSUPPORTED_MEDIA_TYPE
UPGRADE_REQUIRED
URI_TOO_LONG
VARIANT_ALSO_NEGOTIATES

Method Summary

Modifier and Type	Method and Description
String	getReasonPhrase() Return the reason phrase of this status code.
boolean	is1xxInformational() Whether this status code is in the HTTP series Informational.
boolean	is2xxSuccessful() Whether this status code is in the HTTP series Successful.
boolean	is3xxRedirection() Whether this status code is in the HTTP series Redirection.
boolean	is4xxClientError() Whether this status code is in the HTTP series Client error.
boolean	is5xxServerError() Whether this status code is in the HTTP series Server error.
boolean	isError() Whether this status code is in the HTTP series Client error.
static HttpStatus	resolve(int statusCode) Resolve the given status code to an HttpStatus, if possible.
HttpStatus.Series	series() Return the HTTP status series of this status code.
String	toString() Return a string representation of this status code.
int	value() Return the integer value of this status code.
static HttpStatus	valueOf(int statusCode) Return the enum constant of this type with the specified numeric value.
static HttpStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static HttpStatus[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CONTINUE

public static final HttpStatus CONTINUE

SWITCHING_PROTOCOLS

public static final HttpStatus SWITCHING_PROTOCOLS

PROCESSING

public static final HttpStatus PROCESSING

CHECKPOINT

public static final HttpStatus CHECKPOINT

OK

public static final HttpStatus OK

CREATED

public static final HttpStatus CREATED

ACCEPTED

public static final HttpStatus ACCEPTED

NON_AUTHORITATIVE_INFORMATION

public static final HttpStatus NON_AUTHORITATIVE_INFORMATION

NO_CONTENT

public static final HttpStatus NO_CONTENT

RESET_CONTENT

public static final HttpStatus RESET_CONTENT

PARTIAL_CONTENT

public static final HttpStatus PARTIAL_CONTENT

MULTI_STATUS

public static final HttpStatus MULTI_STATUS

ALREADY_REPORTED

public static final HttpStatus ALREADY_REPORTED

IM_USED

public static final HttpStatus IM_USED

MULTIPLE_CHOICES

public static final HttpStatus MULTIPLE_CHOICES

MOVED_PERMANENTLY

public static final HttpStatus MOVED_PERMANENTLY

FOUND

public static final HttpStatus FOUND

SEE_OTHER

public static final HttpStatus SEE_OTHER

NOT_MODIFIED

public static final HttpStatus NOT_MODIFIED

TEMPORARY_REDIRECT

public static final HttpStatus TEMPORARY_REDIRECT

PERMANENT_REDIRECT

public static final HttpStatus PERMANENT_REDIRECT

BAD_REQUEST

public static final HttpStatus BAD_REQUEST

UNAUTHORIZED

public static final HttpStatus UNAUTHORIZED

PAYMENT_REQUIRED

public static final HttpStatus PAYMENT_REQUIRED

FORBIDDEN

public static final HttpStatus FORBIDDEN

NOT_FOUND

public static final HttpStatus NOT_FOUND

METHOD_NOT_ALLOWED

public static final HttpStatus METHOD_NOT_ALLOWED

NOT_ACCEPTABLE

public static final HttpStatus NOT_ACCEPTABLE

PROXY_AUTHENTICATION_REQUIRED

public static final HttpStatus PROXY_AUTHENTICATION_REQUIRED

REQUEST_TIMEOUT

public static final HttpStatus REQUEST_TIMEOUT

GONE

public static final HttpStatus GONE

LENGTH_REQUIRED

public static final HttpStatus LENGTH_REQUIRED

PRECONDITION_FAILED

public static final HttpStatus PRECONDITION_FAILED

PAYLOAD_TOO_LARGE

public static final HttpStatus PAYLOAD_TOO_LARGE

URI_TOO_LONG

public static final HttpStatus URI_TOO_LONG

UNSUPPORTED_MEDIA_TYPE

public static final HttpStatus UNSUPPORTED_MEDIA_TYPE

REQUESTED_RANGE_NOT_SATISFIABLE

public static final HttpStatus REQUESTED_RANGE_NOT_SATISFIABLE

EXPECTATION_FAILED

public static final HttpStatus EXPECTATION_FAILED

UNPROCESSABLE_ENTITY

public static final HttpStatus UNPROCESSABLE_ENTITY

LOCKED

public static final HttpStatus LOCKED

FAILED_DEPENDENCY

public static final HttpStatus FAILED_DEPENDENCY

UPGRADE_REQUIRED

public static final HttpStatus UPGRADE_REQUIRED

TOO_MANY_REQUESTS

public static final HttpStatus TOO_MANY_REQUESTS

REQUEST_HEADER_FIELDS_TOO_LARGE

public static final HttpStatus REQUEST_HEADER_FIELDS_TOO_LARGE

UNAVAILABLE_FOR_LEGAL_REASONS

public static final HttpStatus UNAVAILABLE_FOR_LEGAL_REASONS

INTERNAL_SERVER_ERROR

public static final HttpStatus INTERNAL_SERVER_ERROR

NOT_IMPLEMENTED

public static final HttpStatus NOT_IMPLEMENTED

BAD_GATEWAY

public static final HttpStatus BAD_GATEWAY

SERVICE_UNAVAILABLE

public static final HttpStatus SERVICE_UNAVAILABLE

GATEWAY_TIMEOUT

public static final HttpStatus GATEWAY_TIMEOUT

HTTP_VERSION_NOT_SUPPORTED

public static final HttpStatus HTTP_VERSION_NOT_SUPPORTED

VARIANT_ALSO_NEGOTIATES

public static final HttpStatus VARIANT_ALSO_NEGOTIATES

INSUFFICIENT_STORAGE

public static final HttpStatus INSUFFICIENT_STORAGE

LOOP_DETECTED

public static final HttpStatus LOOP_DETECTED

BANDWIDTH_LIMIT_EXCEEDED

public static final HttpStatus BANDWIDTH_LIMIT_EXCEEDED

NOT_EXTENDED

public static final HttpStatus NOT_EXTENDED

NETWORK_AUTHENTICATION_REQUIRED

public static final HttpStatus NETWORK_AUTHENTICATION_REQUIRED

Method Detail

values

public static HttpStatus[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (HttpStatus c : HttpStatus.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static HttpStatus valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

value

public int value()

Return the integer value of this status code.

getReasonPhrase

public String getReasonPhrase()

Return the reason phrase of this status code.

series

public HttpStatus.Series series()

Return the HTTP status series of this status code.

See Also:

HttpStatus.Series

is1xxInformational

public boolean is1xxInformational()

Whether this status code is in the HTTP series Informational.

is2xxSuccessful

public boolean is2xxSuccessful()

Whether this status code is in the HTTP series Successful.

is3xxRedirection

public boolean is3xxRedirection()

Whether this status code is in the HTTP series Redirection.

is4xxClientError

public boolean is4xxClientError()

Whether this status code is in the HTTP series Client error.

is5xxServerError

public boolean is5xxServerError()

Whether this status code is in the HTTP series Server error.

isError

public boolean isError()

Whether this status code is in the HTTP series Client error.

toString

public String toString()

Return a string representation of this status code.

Overrides:

toString in class Enum<HttpStatus>

valueOf

public static HttpStatus valueOf(int statusCode)

Return the enum constant of this type with the specified numeric value.

Parameters:

statusCode - the numeric value of the enum to be returned

Returns:

the enum constant with the specified numeric value

Throws:

IllegalArgumentException - if this enum has no constant for the specified numeric value

resolve

public static HttpStatus resolve(int statusCode)

Resolve the given status code to an HttpStatus, if possible.

Parameters:

statusCode - the HTTP status code (potentially non-standard)

Returns:

the corresponding HttpStatus, or null if not found