Package dk.mada.jaxrs.model.api

Enum Class StatusCode

java.lang.Object

java.lang.Enum<StatusCode>

dk.mada.jaxrs.model.api.StatusCode

All Implemented Interfaces:

Serializable, Comparable<StatusCode>, Constable

public enum StatusCode
extends Enum<StatusCode>

HTTP status codes. The HttpURLConnection constants in enumeration-form. And then some from https://developer.mozilla.org/en-US/docs/Web/HTTP/Status and https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
HTTP_ACCEPTED	Accepted.
HTTP_ALREADY_REPORTED	Already Reported.
HTTP_BAD_GATEWAY	Bad Gateway.
HTTP_BAD_METHOD	Method Not Allowed.
HTTP_BAD_REQUEST	Bad Request.
HTTP_CLIENT_TIMEOUT	Request Time-Out.
HTTP_CONFLICT	Conflict.
HTTP_CONTINUE	Continue.
HTTP_CREATED	Created.
HTTP_DEFAULT	Special code to hold the state for the OpenApi default entry.
HTTP_EARLY_HINTS	Early hints.
HTTP_ENTITY_TOO_LARGE	Request Entity Too Large.
HTTP_EXPECTATION_FAILED	Expectation Failed.
HTTP_FAILED_DEPENDENCY	Failed dependency.
HTTP_FORBIDDEN	Forbidden.
HTTP_GATEWAY_TIMEOUT	Gateway Timeout.
HTTP_GONE	Gone.
HTTP_IM_A_TEAPOT	I'm a teapot.
HTTP_IM_USED	IM Used.
HTTP_INSUFFICIENT_STORAGE	Insufficient Storage.
HTTP_INTERNAL_ERROR	Internal Server Error.
HTTP_LENGTH_REQUIRED	Length Required.
HTTP_LOCKED	Locked.
HTTP_LOOP_DETECTED	Loop Detected.
HTTP_MISDIRECTED_REQUEST	Misdirected Request.
HTTP_MOVED_PERM	Moved Permanently.
HTTP_MOVED_TEMP	Temporary Redirect.
HTTP_MULT_CHOICE	Multiple Choices.
HTTP_MULTI_STATUS	Multi-Status.
HTTP_NETWORK_AUTHENTICATION_REQUIRED	Network Authentication Required.
HTTP_NO_CONTENT	No Content.
HTTP_NOT_ACCEPTABLE	Not Acceptable.
HTTP_NOT_AUTHORITATIVE	Non-Authoritative Information.
HTTP_NOT_EXTENDED	Not Extended.
HTTP_NOT_FOUND	Not Found.
HTTP_NOT_IMPLEMENTED	Not Implemented.
HTTP_NOT_MODIFIED	Not Modified.
HTTP_OK	OK.
HTTP_PARTIAL	Partial Content.
HTTP_PAYMENT_REQUIRED	Payment Required.
HTTP_PERMANENT_REDIRECT	Permanent Redirect.
HTTP_PRECON_FAILED	Precondition Failed.
HTTP_PRECONDITION_REQUIRED	Precondition Required.
HTTP_PROCESSING	Processing.
HTTP_PROXY_AUTH	Proxy Authentication Required.
HTTP_RANGE_NOT_SATISFIABLE	Range Not Satisfiable.
HTTP_REQ_TOO_LONG	Request-URI Too Large.
HTTP_REQUEST_HEADER_FIELDS_TOO_LARGE	Request Header Fields Too Large.
HTTP_RESET	Reset Content.
HTTP_SEE_OTHER	See Other.
HTTP_SWITCHING_PROTOCOLS	Switching Protocols.
HTTP_TEMPORARY_REDIRECT	Temporary Redirect.
HTTP_TOO_EARLY	Too early.
HTTP_TOO_MANY_REQUESTS	Too Many Requests.
HTTP_UNAUTHORIZED	Unauthorized.
HTTP_UNAVAILABLE	Service Unavailable.
HTTP_UNAVAILABLE_FOR_LEGAL_REASONS	Unavailable For Legal Reasons.
HTTP_UNPROCESSABLE_ENTITY	Unprocessable Entity.
HTTP_UNSUPPORTED_TYPE	Unsupported Media Type.
HTTP_UNUSED	Unused, reserved.
HTTP_UPGRADE_REQUIRED	Upgrade Required.
HTTP_USE_PROXY	Use Proxy.
HTTP_VARIANT_ALSO_NEGOTIATES	Variant Also Negotiates.
HTTP_VERSION	HTTP Version Not Supported.

Method Summary

Modifier and Type	Method	Description
String	asOpenApiStatus()	Returns the code in the same form as expected by OpenApi.
int	code()	Returns the status code value.
static StatusCode	of(String code)	Convert OpenApi wire status code a model StatusCode.
static StatusCode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static StatusCode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

HTTP_DEFAULT

public static final StatusCode HTTP_DEFAULT

Special code to hold the state for the OpenApi default entry.

See Also:

• OpenApi response definition

HTTP_CONTINUE

public static final StatusCode HTTP_CONTINUE

Continue.

HTTP_SWITCHING_PROTOCOLS

public static final StatusCode HTTP_SWITCHING_PROTOCOLS

Switching Protocols.

HTTP_PROCESSING

public static final StatusCode HTTP_PROCESSING

Processing.

HTTP_EARLY_HINTS

public static final StatusCode HTTP_EARLY_HINTS

Early hints.

HTTP_OK

public static final StatusCode HTTP_OK

OK.

HTTP_CREATED

public static final StatusCode HTTP_CREATED

Created.

HTTP_ACCEPTED

public static final StatusCode HTTP_ACCEPTED

Accepted.

HTTP_NOT_AUTHORITATIVE

public static final StatusCode HTTP_NOT_AUTHORITATIVE

Non-Authoritative Information.

HTTP_NO_CONTENT

public static final StatusCode HTTP_NO_CONTENT

No Content.

HTTP_RESET

public static final StatusCode HTTP_RESET

Reset Content.

HTTP_PARTIAL

public static final StatusCode HTTP_PARTIAL

Partial Content.

HTTP_MULTI_STATUS

public static final StatusCode HTTP_MULTI_STATUS

Multi-Status.

HTTP_ALREADY_REPORTED

public static final StatusCode HTTP_ALREADY_REPORTED

Already Reported.

HTTP_IM_USED

public static final StatusCode HTTP_IM_USED

IM Used.

HTTP_MULT_CHOICE

public static final StatusCode HTTP_MULT_CHOICE

Multiple Choices.

HTTP_MOVED_PERM

public static final StatusCode HTTP_MOVED_PERM

Moved Permanently.

HTTP_MOVED_TEMP

public static final StatusCode HTTP_MOVED_TEMP

Temporary Redirect.

HTTP_SEE_OTHER

public static final StatusCode HTTP_SEE_OTHER

See Other.

HTTP_NOT_MODIFIED

public static final StatusCode HTTP_NOT_MODIFIED

Not Modified.

HTTP_USE_PROXY

public static final StatusCode HTTP_USE_PROXY

Use Proxy.

HTTP_UNUSED

public static final StatusCode HTTP_UNUSED

Unused, reserved.

HTTP_TEMPORARY_REDIRECT

public static final StatusCode HTTP_TEMPORARY_REDIRECT

Temporary Redirect.

HTTP_PERMANENT_REDIRECT

public static final StatusCode HTTP_PERMANENT_REDIRECT

Permanent Redirect.

HTTP_BAD_REQUEST

public static final StatusCode HTTP_BAD_REQUEST

Bad Request.

HTTP_UNAUTHORIZED

public static final StatusCode HTTP_UNAUTHORIZED

Unauthorized.

HTTP_PAYMENT_REQUIRED

public static final StatusCode HTTP_PAYMENT_REQUIRED

Payment Required.

HTTP_FORBIDDEN

public static final StatusCode HTTP_FORBIDDEN

Forbidden.

HTTP_NOT_FOUND

public static final StatusCode HTTP_NOT_FOUND

Not Found.

HTTP_BAD_METHOD

public static final StatusCode HTTP_BAD_METHOD

Method Not Allowed.

HTTP_NOT_ACCEPTABLE

public static final StatusCode HTTP_NOT_ACCEPTABLE

Not Acceptable.

HTTP_PROXY_AUTH

public static final StatusCode HTTP_PROXY_AUTH

Proxy Authentication Required.

HTTP_CLIENT_TIMEOUT

public static final StatusCode HTTP_CLIENT_TIMEOUT

Request Time-Out.

HTTP_CONFLICT

public static final StatusCode HTTP_CONFLICT

Conflict.

HTTP_GONE

public static final StatusCode HTTP_GONE

Gone.

HTTP_LENGTH_REQUIRED

public static final StatusCode HTTP_LENGTH_REQUIRED

Length Required.

HTTP_PRECON_FAILED

public static final StatusCode HTTP_PRECON_FAILED

Precondition Failed.

HTTP_ENTITY_TOO_LARGE

public static final StatusCode HTTP_ENTITY_TOO_LARGE

Request Entity Too Large.

HTTP_REQ_TOO_LONG

public static final StatusCode HTTP_REQ_TOO_LONG

Request-URI Too Large.

HTTP_UNSUPPORTED_TYPE

public static final StatusCode HTTP_UNSUPPORTED_TYPE

Unsupported Media Type.

HTTP_RANGE_NOT_SATISFIABLE

public static final StatusCode HTTP_RANGE_NOT_SATISFIABLE

Range Not Satisfiable.

HTTP_EXPECTATION_FAILED

public static final StatusCode HTTP_EXPECTATION_FAILED

Expectation Failed.

HTTP_IM_A_TEAPOT

public static final StatusCode HTTP_IM_A_TEAPOT

I'm a teapot.

HTTP_MISDIRECTED_REQUEST

public static final StatusCode HTTP_MISDIRECTED_REQUEST

Misdirected Request.

HTTP_UNPROCESSABLE_ENTITY

public static final StatusCode HTTP_UNPROCESSABLE_ENTITY

Unprocessable Entity.

HTTP_LOCKED

public static final StatusCode HTTP_LOCKED

Locked.

HTTP_FAILED_DEPENDENCY

public static final StatusCode HTTP_FAILED_DEPENDENCY

Failed dependency.

HTTP_TOO_EARLY

public static final StatusCode HTTP_TOO_EARLY

Too early.

HTTP_UPGRADE_REQUIRED

public static final StatusCode HTTP_UPGRADE_REQUIRED

Upgrade Required.

HTTP_PRECONDITION_REQUIRED

public static final StatusCode HTTP_PRECONDITION_REQUIRED

Precondition Required.

HTTP_TOO_MANY_REQUESTS

public static final StatusCode HTTP_TOO_MANY_REQUESTS

Too Many Requests.

HTTP_REQUEST_HEADER_FIELDS_TOO_LARGE

public static final StatusCode HTTP_REQUEST_HEADER_FIELDS_TOO_LARGE

Request Header Fields Too Large.

HTTP_UNAVAILABLE_FOR_LEGAL_REASONS

public static final StatusCode HTTP_UNAVAILABLE_FOR_LEGAL_REASONS

Unavailable For Legal Reasons.

HTTP_INTERNAL_ERROR

public static final StatusCode HTTP_INTERNAL_ERROR

Internal Server Error.

HTTP_NOT_IMPLEMENTED

public static final StatusCode HTTP_NOT_IMPLEMENTED

Not Implemented.

HTTP_BAD_GATEWAY

public static final StatusCode HTTP_BAD_GATEWAY

Bad Gateway.

HTTP_UNAVAILABLE

public static final StatusCode HTTP_UNAVAILABLE

Service Unavailable.

HTTP_GATEWAY_TIMEOUT

public static final StatusCode HTTP_GATEWAY_TIMEOUT

Gateway Timeout.

HTTP_VERSION

public static final StatusCode HTTP_VERSION

HTTP Version Not Supported.

HTTP_VARIANT_ALSO_NEGOTIATES

public static final StatusCode HTTP_VARIANT_ALSO_NEGOTIATES

Variant Also Negotiates.

HTTP_INSUFFICIENT_STORAGE

public static final StatusCode HTTP_INSUFFICIENT_STORAGE

Insufficient Storage.

HTTP_LOOP_DETECTED

public static final StatusCode HTTP_LOOP_DETECTED

Loop Detected.

HTTP_NOT_EXTENDED

public static final StatusCode HTTP_NOT_EXTENDED

Not Extended.

HTTP_NETWORK_AUTHENTICATION_REQUIRED

public static final StatusCode HTTP_NETWORK_AUTHENTICATION_REQUIRED

Network Authentication Required.

Method Details

values

public static StatusCode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static StatusCode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

code

public int code()

Returns the status code value.

Returns:

the status code value

asOpenApiStatus

public String asOpenApiStatus()

Returns the code in the same form as expected by OpenApi. This means that HTTP_DEFAULT is returned as "default", others as their status code in string form.

Returns:

the OpenApi status code

of

public static StatusCode of(String code)

Convert OpenApi wire status code a model StatusCode. Note the special handling of "default".

Parameters:

code - the OpenApi wire-form of a status code

Returns:

the matching status code