Package org.dmfs.httpessentials

Interface HttpStatus

All Known Implementing Classes:

NoneHttpStatus, SimpleHttpStatus, StatusLineHttpStatus

public interface HttpStatus

Interface of an HTTP status. Instances must be immutable. By convention, all instances MUST return the status code when hashCode() is called.

Field Summary

Fields

Modifier and Type	Field	Description
static final HttpStatus	ACCEPTED	HTTP status: 202 Accepted
static final HttpStatus	BAD_GATEWAY	HTTP status: 502 Bad Gateway
static final HttpStatus	BAD_REQUEST	HTTP status: 400 Bad Request
static final HttpStatus	CONFLICT	HTTP status: 409 Conflict
static final HttpStatus	CONTINUE	HTTP status: 100 Continue
static final HttpStatus	CREATED	HTTP status: 201 Created
static final HttpStatus	EXPECTATION_FAILED	HTTP status: 417 Expectation Failed
static final HttpStatus	FAILED_DEPENDENCY	HTTP status: 424 Failed Dependency (WebDAV)
static final HttpStatus	FORBIDDEN	HTTP status: 403 Forbidden
static final HttpStatus	FOUND	HTTP status: 302 Found
static final HttpStatus	GATEWAY_TIMEOUT	HTTP status: 504 Gateway Timeout
static final HttpStatus	GONE	HTTP status: 410 Gone
static final HttpStatus	HTTP_VERSION_NOT_SUPPORTED	HTTP status: 505 HTTP Version Not Supported
static final HttpStatus	INSUFFICIENT_STORAGE	HTTP status: 507 Insufficient Storage (WebDAV)
static final HttpStatus	INTERNAL_SERVER_ERROR	HTTP status: 500 Internal Server Error
static final HttpStatus	LENGTH_REQUIRED	HTTP status: 411 Length Required
static final HttpStatus	LOCKED	HTTP status: 423 Locked (WebDAV)
static final HttpStatus	METHOD_NOT_ALLOWED	HTTP status: 405 Method Not Allowed
static final HttpStatus	MOVED_PERMANENTLY	HTTP status: 301 Moved Permanently
static final HttpStatus	MULTIPLE_CHOICES	HTTP status: 300 Multiple Choices
static final HttpStatus	MULTISTATUS	HTTP status: 207 Multistatus (WebDAV)
static final HttpStatus	NO_CONTENT	HTTP status: 204 No Content
static final HttpStatus	NON_AUTHORITATIVE_INFORMATION	HTTP status: 203 Non-Authoritative Information
static final HttpStatus	NONE	A dummy HTTP status which can be used to return "no status".
static final HttpStatus	NOT_ACCEPTABLE	HTTP status: 406 Not Acceptable
static final HttpStatus	NOT_FOUND	HTTP status: 404 Not Found
static final HttpStatus	NOT_IMPLEMENTED	HTTP status: 501 Not Implemented
static final HttpStatus	NOT_MODIFIED	HTTP status: 304 Not Modified
static final HttpStatus	OK	HTTP status: 200 OK
static final HttpStatus	PARTIAL_CONTENT	HTTP status: 206 Partial Content
static final HttpStatus	PAYLOAD_TOO_LARGE	HTTP status: 413 Payload Too Large
static final HttpStatus	PAYMENT_REQUIRED	HTTP status: 402 Payment Required
static final HttpStatus	PERMANENT_REDIRECT	HTTP status: 308 Permanent Redirect
static final HttpStatus	PRECONDITION_FAILED	HTTP status: 412 Precondition Failed
static final HttpStatus	PROCESSING	HTTP status: 102 Processing (WebDAV)
static final HttpStatus	PROXY_AUTHENTICATION_REQUIRED	HTTP status: 407 Proxy Authentication Required
static final HttpStatus	REQUEST_ENTITY_TOO_LARGE	Deprecated.
static final HttpStatus	REQUEST_TIMEOUT	HTTP status: 408 Request Timeout
static final HttpStatus	REQUEST_URI_TOO_LONG	Deprecated.
static final HttpStatus	RESET_CONTENT	HTTP status: 205 Reset Content
static final HttpStatus	SEE_OTHER	HTTP status: 303 See Other
static final HttpStatus	SERVICE_UNAVAILABLE	HTTP status: 503 Service Unavailable
static final HttpStatus	SWITCHING_PROTOCOLS	HTTP status: 101 Switching Protocols
static final HttpStatus	TEMPORARY_REDIRECT	HTTP status: 307 Temporary Redirect
static final HttpStatus	UNAUTHORIZED	HTTP status: 401 Unauthorized
static final HttpStatus	UNPROCESSABLE_ENTITY	HTTP status: 422 Unprocessable Entity (WebDAV)
static final HttpStatus	UNSUPPORTED_MEDIA_TYPE	HTTP status: 415 Unsupported Media Type
static final HttpStatus	UPGRADE_REQUIRED	HTTP status: 426 Upgrade Required
static final HttpStatus	URI_TOO_LONG	HTTP status: 414 URI Too Long
static final HttpStatus	USE_PROXY	HTTP status: 305 Use Proxy
static final HttpStatus	VARIANT_ALSO_NEGOTIATES	HTTP status: 506 Variant Also Negotiates (experimental)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
int	hashCode()
boolean	isClientError()	Returns whether this status represents a client error status code.
boolean	isInformational()	Returns whether this represents an informational status code.
boolean	isRedirect()	Returns whether this status represents a redirection status code.
boolean	isServerError()	Returns whether this status represents a server error status code.
boolean	isSuccess()	Returns whether this status represents a success status code.
String	reason()	Returns the reason phrase of this status code.
int	statusCode()	Returns the status code.

Field Details

NONE

static final HttpStatus NONE

A dummy HTTP status which can be used to return "no status". This is the null object.

CONTINUE

static final HttpStatus CONTINUE

HTTP status: 100 Continue

SWITCHING_PROTOCOLS

static final HttpStatus SWITCHING_PROTOCOLS

HTTP status: 101 Switching Protocols

PROCESSING

static final HttpStatus PROCESSING

HTTP status: 102 Processing (WebDAV)

Note that this has been removed from the WebDAV specification in RFC 4918, see RFC 4918, section 21.4

OK

static final HttpStatus OK

HTTP status: 200 OK

CREATED

static final HttpStatus CREATED

HTTP status: 201 Created

ACCEPTED

static final HttpStatus ACCEPTED

HTTP status: 202 Accepted

NON_AUTHORITATIVE_INFORMATION

static final HttpStatus NON_AUTHORITATIVE_INFORMATION

HTTP status: 203 Non-Authoritative Information

NO_CONTENT

static final HttpStatus NO_CONTENT

HTTP status: 204 No Content

RESET_CONTENT

static final HttpStatus RESET_CONTENT

HTTP status: 205 Reset Content

PARTIAL_CONTENT

static final HttpStatus PARTIAL_CONTENT

HTTP status: 206 Partial Content

MULTISTATUS

static final HttpStatus MULTISTATUS

HTTP status: 207 Multistatus (WebDAV)

MULTIPLE_CHOICES

static final HttpStatus MULTIPLE_CHOICES

HTTP status: 300 Multiple Choices

MOVED_PERMANENTLY

static final HttpStatus MOVED_PERMANENTLY

HTTP status: 301 Moved Permanently

FOUND

static final HttpStatus FOUND

HTTP status: 302 Found

SEE_OTHER

static final HttpStatus SEE_OTHER

HTTP status: 303 See Other

NOT_MODIFIED

static final HttpStatus NOT_MODIFIED

HTTP status: 304 Not Modified

USE_PROXY

static final HttpStatus USE_PROXY

HTTP status: 305 Use Proxy

TEMPORARY_REDIRECT

static final HttpStatus TEMPORARY_REDIRECT

HTTP status: 307 Temporary Redirect

PERMANENT_REDIRECT

static final HttpStatus PERMANENT_REDIRECT

HTTP status: 308 Permanent Redirect

BAD_REQUEST

static final HttpStatus BAD_REQUEST

HTTP status: 400 Bad Request

UNAUTHORIZED

static final HttpStatus UNAUTHORIZED

HTTP status: 401 Unauthorized

PAYMENT_REQUIRED

static final HttpStatus PAYMENT_REQUIRED

HTTP status: 402 Payment Required

FORBIDDEN

static final HttpStatus FORBIDDEN

HTTP status: 403 Forbidden

NOT_FOUND

static final HttpStatus NOT_FOUND

HTTP status: 404 Not Found

METHOD_NOT_ALLOWED

static final HttpStatus METHOD_NOT_ALLOWED

HTTP status: 405 Method Not Allowed

NOT_ACCEPTABLE

static final HttpStatus NOT_ACCEPTABLE

HTTP status: 406 Not Acceptable

PROXY_AUTHENTICATION_REQUIRED

static final HttpStatus PROXY_AUTHENTICATION_REQUIRED

HTTP status: 407 Proxy Authentication Required

REQUEST_TIMEOUT

static final HttpStatus REQUEST_TIMEOUT

HTTP status: 408 Request Timeout

CONFLICT

static final HttpStatus CONFLICT

HTTP status: 409 Conflict

GONE

static final HttpStatus GONE

HTTP status: 410 Gone

LENGTH_REQUIRED

static final HttpStatus LENGTH_REQUIRED

HTTP status: 411 Length Required

PRECONDITION_FAILED

static final HttpStatus PRECONDITION_FAILED

HTTP status: 412 Precondition Failed

PAYLOAD_TOO_LARGE

static final HttpStatus PAYLOAD_TOO_LARGE

HTTP status: 413 Payload Too Large

REQUEST_ENTITY_TOO_LARGE

@Deprecated
static final HttpStatus REQUEST_ENTITY_TOO_LARGE

Deprecated.

Old name of PAYLOAD_TOO_LARGE.

URI_TOO_LONG

static final HttpStatus URI_TOO_LONG

HTTP status: 414 URI Too Long

REQUEST_URI_TOO_LONG

@Deprecated
static final HttpStatus REQUEST_URI_TOO_LONG

Deprecated.

Old name of URI_TOO_LONG.

UNSUPPORTED_MEDIA_TYPE

static final HttpStatus UNSUPPORTED_MEDIA_TYPE

HTTP status: 415 Unsupported Media Type

EXPECTATION_FAILED

static final HttpStatus EXPECTATION_FAILED

HTTP status: 417 Expectation Failed

UNPROCESSABLE_ENTITY

static final HttpStatus UNPROCESSABLE_ENTITY

HTTP status: 422 Unprocessable Entity (WebDAV)

LOCKED

static final HttpStatus LOCKED

HTTP status: 423 Locked (WebDAV)

FAILED_DEPENDENCY

static final HttpStatus FAILED_DEPENDENCY

HTTP status: 424 Failed Dependency (WebDAV)

UPGRADE_REQUIRED

static final HttpStatus UPGRADE_REQUIRED

HTTP status: 426 Upgrade Required

INTERNAL_SERVER_ERROR

static final HttpStatus INTERNAL_SERVER_ERROR

HTTP status: 500 Internal Server Error

NOT_IMPLEMENTED

static final HttpStatus NOT_IMPLEMENTED

HTTP status: 501 Not Implemented

BAD_GATEWAY

static final HttpStatus BAD_GATEWAY

HTTP status: 502 Bad Gateway

SERVICE_UNAVAILABLE

static final HttpStatus SERVICE_UNAVAILABLE

HTTP status: 503 Service Unavailable

GATEWAY_TIMEOUT

static final HttpStatus GATEWAY_TIMEOUT

HTTP status: 504 Gateway Timeout

HTTP_VERSION_NOT_SUPPORTED

static final HttpStatus HTTP_VERSION_NOT_SUPPORTED

HTTP status: 505 HTTP Version Not Supported

VARIANT_ALSO_NEGOTIATES

static final HttpStatus VARIANT_ALSO_NEGOTIATES

HTTP status: 506 Variant Also Negotiates (experimental)

INSUFFICIENT_STORAGE

static final HttpStatus INSUFFICIENT_STORAGE

HTTP status: 507 Insufficient Storage (WebDAV)

Method Details

statusCode

int statusCode()

Returns the status code.

Returns:

reason

String reason()

Returns the reason phrase of this status code.

Note: the reason phrase doesn't contain the status code itself.

Returns:

The reason phrase or null if the status code is unknown.

isInformational

boolean isInformational()

Returns whether this represents an informational status code.

Returns:

true if this represents an informational status code, false otherwise.

isSuccess

boolean isSuccess()

Returns whether this status represents a success status code.

Returns:

true if this represents a success status code, false otherwise.

isRedirect

boolean isRedirect()

Returns whether this status represents a redirection status code.

Returns:

true if this represents a redirection status code, false otherwise.

isClientError

boolean isClientError()

Returns whether this status represents a client error status code.

Returns:

true if this represents a client error status code, false otherwise.

isServerError

boolean isServerError()

Returns whether this status represents a server error status code.

Returns:

true if this represents a server error status code, false otherwise.

hashCode

int hashCode()

Overrides:

hashCode in class Object

equals

boolean equals(Object obj)

Overrides:

equals in class Object