Module io.helidon.common.http

Package io.helidon.common.http

Class Http.Status

java.lang.Object

io.helidon.common.http.Http.Status

Enclosing class:

Http

public static class Http.Status
extends Object

Commonly used status codes defined by HTTP, see HTTP/1.1 documentation for the complete list. Additional status codes can be added by applications by call create(int) or create(int, String) with unkown status code, or with text that differs from the predefined status codes.

Although the constants are instances of this class, they can be compared using instance equality, as the only way to obtain an instance is through methods create(int) create(int, String), which ensures the same instance is returned for known status codes and reason phrases.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Http.Status.Family	An enumeration representing the class of status code.

Field Summary

Fields

Modifier and Type	Field	Description
static final Http.Status	ACCEPTED_202	202 Accepted, see HTTP/1.1 documentation .
static final Http.Status	BAD_GATEWAY_502	502 Bad Gateway, see HTTP/1.1 documentation.
static final Http.Status	BAD_REQUEST_400	400 Bad Request, see HTTP/1.1 documentation.
static final Http.Status	CONFLICT_409	409 Conflict, see HTTP/1.1 documentation.
static final Http.Status	CONTINUE_100	100 Continue, see HTTP/1.1 documentations.
static final Http.Status	CREATED_201	201 Created, see HTTP/1.1 documentation.
static final Http.Status	EXPECTATION_FAILED_417	417 Expectation Failed, see HTTP/1.1 documentation.
static final Http.Status	FORBIDDEN_403	403 Forbidden, see HTTP/1.1 documentation.
static final Http.Status	FOUND_302	302 Found, see HTTP/1.1 documentation.
static final Http.Status	GATEWAY_TIMEOUT_504	504 Gateway Timeout, see HTTP/1.1 documentation.
static final Http.Status	GONE_410	410 Gone, see HTTP/1.1 documentation.
static final Http.Status	HTTP_VERSION_NOT_SUPPORTED	Deprecated, for removal: This API element is subject to removal in a future version. use HTTP_VERSION_NOT_SUPPORTED_505 instead (inconsistent name)
static final Http.Status	HTTP_VERSION_NOT_SUPPORTED_505	505 HTTP Version Not Supported, see HTTP/1.1 documentation.
static final Http.Status	I_AM_A_TEAPOT_418	418 I'm a teapot, see Hyper Text Coffee Pot Control Protocol (HTCPCP/1.0).
static final Http.Status	INTERNAL_SERVER_ERROR_500	500 Internal Server Error, see HTTP/1.1 documentation.
static final Http.Status	LENGTH_REQUIRED_411	411 Length Required, see HTTP/1.1 documentation.
static final Http.Status	METHOD_NOT_ALLOWED_405	405 Method Not Allowed, see HTTP/1.1 documentation.
static final Http.Status	MOVED_PERMANENTLY_301	301 Moved Permanently, see HTTP/1.1 documentation.
static final Http.Status	NO_CONTENT_204	204 No Content, see HTTP/1.1 documentation.
static final Http.Status	NOT_ACCEPTABLE_406	406 Not Acceptable, see HTTP/1.1 documentation.
static final Http.Status	NOT_FOUND_404	404 Not Found, see HTTP/1.1 documentation.
static final Http.Status	NOT_IMPLEMENTED_501	501 Not Implemented, see HTTP/1.1 documentation.
static final Http.Status	NOT_MODIFIED_304	304 Not Modified, see HTTP/1.1 documentation.
static final Http.Status	OK_200	200 OK, see HTTP/1.1 documentation.
static final Http.Status	PARTIAL_CONTENT_206	206 Reset Content, see HTTP/1.1 documentation.
static final Http.Status	PAYMENT_REQUIRED_402	402 Payment Required, see HTTP/1.1 documentation.
static final Http.Status	PRECONDITION_FAILED_412	412 Precondition Failed, see HTTP/1.1 documentation.
static final Http.Status	PROXY_AUTHENTICATION_REQUIRED_407	407 Proxy Authentication Required, see HTTP/1.1 documentation.
static final Http.Status	REQUEST_ENTITY_TOO_LARGE_413	413 Request Entity Too Large, see HTTP/1.1 documentation.
static final Http.Status	REQUEST_TIMEOUT_408	408 Request Timeout, see HTTP/1.1 documentation.
static final Http.Status	REQUEST_URI_TOO_LONG_414	414 Request-URI Too Long, see HTTP/1.1 documentation.
static final Http.Status	REQUESTED_RANGE_NOT_SATISFIABLE_416	416 Requested Range Not Satisfiable, see HTTP/1.1 documentation.
static final Http.Status	RESET_CONTENT_205	205 Reset Content, see HTTP/1.1 documentation.
static final Http.Status	SEE_OTHER_303	303 See Other, see HTTP/1.1 documentation.
static final Http.Status	SERVICE_UNAVAILABLE_503	503 Service Unavailable, see HTTP/1.1 documentation.
static final Http.Status	SWITCHING_PROTOCOLS_101	101 Switching Protocols, see HTTP/1.1 documentations.
static final Http.Status	TEMPORARY_REDIRECT_307	307 Temporary Redirect, see HTTP/1.1 documentation.
static final Http.Status	UNAUTHORIZED_401	401 Unauthorized, see HTTP/1.1 documentation.
static final Http.Status	UNSUPPORTED_MEDIA_TYPE_415	415 Unsupported Media Type, see HTTP/1.1 documentation.
static final Http.Status	USE_PROXY_305	305 Use Proxy, see HTTP/1.1 documentation.

Method Summary

Modifier and Type	Method	Description
int	code()	Get the associated integer value representing the status code.
String	codeText()	Text of the code().
static Http.Status	create(int statusCode)	Convert a numerical status code into the corresponding Status.
static Http.Status	create(int statusCode, String reasonPhrase)	Convert a numerical status code into the corresponding Status.
boolean	equals(Object o)
Http.Status.Family	family()	Get the class of status code.
int	hashCode()
String	reasonPhrase()	Get the reason phrase.
String	text()	Text of the status as used in HTTP/1, such as "200 OK".
String	toString()	Get the response status as string.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

CONTINUE_100

public static final Http.Status CONTINUE_100

100 Continue, see HTTP/1.1 documentations.

SWITCHING_PROTOCOLS_101

public static final Http.Status SWITCHING_PROTOCOLS_101

101 Switching Protocols, see HTTP/1.1 documentations.

OK_200

public static final Http.Status OK_200

200 OK, see HTTP/1.1 documentation.

CREATED_201

public static final Http.Status CREATED_201

201 Created, see HTTP/1.1 documentation.

ACCEPTED_202

public static final Http.Status ACCEPTED_202

202 Accepted, see HTTP/1.1 documentation .

NO_CONTENT_204

public static final Http.Status NO_CONTENT_204

204 No Content, see HTTP/1.1 documentation.

RESET_CONTENT_205

public static final Http.Status RESET_CONTENT_205

205 Reset Content, see HTTP/1.1 documentation.

Since:

2.0

PARTIAL_CONTENT_206

public static final Http.Status PARTIAL_CONTENT_206

206 Reset Content, see HTTP/1.1 documentation.

Since:

2.0

MOVED_PERMANENTLY_301

public static final Http.Status MOVED_PERMANENTLY_301

301 Moved Permanently, see HTTP/1.1 documentation.

FOUND_302

public static final Http.Status FOUND_302

302 Found, see HTTP/1.1 documentation.

Since:

2.0

SEE_OTHER_303

public static final Http.Status SEE_OTHER_303

303 See Other, see HTTP/1.1 documentation.

NOT_MODIFIED_304

public static final Http.Status NOT_MODIFIED_304

304 Not Modified, see HTTP/1.1 documentation.

USE_PROXY_305

public static final Http.Status USE_PROXY_305

305 Use Proxy, see HTTP/1.1 documentation.

Since:

2.0

TEMPORARY_REDIRECT_307

public static final Http.Status TEMPORARY_REDIRECT_307

307 Temporary Redirect, see HTTP/1.1 documentation.

BAD_REQUEST_400

public static final Http.Status BAD_REQUEST_400

400 Bad Request, see HTTP/1.1 documentation.

UNAUTHORIZED_401

public static final Http.Status UNAUTHORIZED_401

401 Unauthorized, see HTTP/1.1 documentation.

PAYMENT_REQUIRED_402

public static final Http.Status PAYMENT_REQUIRED_402

402 Payment Required, see HTTP/1.1 documentation.

Since:

2.0

FORBIDDEN_403

public static final Http.Status FORBIDDEN_403

403 Forbidden, see HTTP/1.1 documentation.

NOT_FOUND_404

public static final Http.Status NOT_FOUND_404

404 Not Found, see HTTP/1.1 documentation.

METHOD_NOT_ALLOWED_405

public static final Http.Status METHOD_NOT_ALLOWED_405

405 Method Not Allowed, see HTTP/1.1 documentation.

Since:

2.0

NOT_ACCEPTABLE_406

public static final Http.Status NOT_ACCEPTABLE_406

406 Not Acceptable, see HTTP/1.1 documentation.

PROXY_AUTHENTICATION_REQUIRED_407

public static final Http.Status PROXY_AUTHENTICATION_REQUIRED_407

407 Proxy Authentication Required, see HTTP/1.1 documentation.

Since:

2.0

REQUEST_TIMEOUT_408

public static final Http.Status REQUEST_TIMEOUT_408

408 Request Timeout, see HTTP/1.1 documentation.

Since:

2.0

CONFLICT_409

public static final Http.Status CONFLICT_409

409 Conflict, see HTTP/1.1 documentation.

GONE_410

public static final Http.Status GONE_410

410 Gone, see HTTP/1.1 documentation.

LENGTH_REQUIRED_411

public static final Http.Status LENGTH_REQUIRED_411

411 Length Required, see HTTP/1.1 documentation.

Since:

2.0

PRECONDITION_FAILED_412

public static final Http.Status PRECONDITION_FAILED_412

412 Precondition Failed, see HTTP/1.1 documentation.

REQUEST_ENTITY_TOO_LARGE_413

public static final Http.Status REQUEST_ENTITY_TOO_LARGE_413

413 Request Entity Too Large, see HTTP/1.1 documentation.

Since:

2.0

REQUEST_URI_TOO_LONG_414

public static final Http.Status REQUEST_URI_TOO_LONG_414

414 Request-URI Too Long, see HTTP/1.1 documentation.

Since:

2.0

UNSUPPORTED_MEDIA_TYPE_415

public static final Http.Status UNSUPPORTED_MEDIA_TYPE_415

415 Unsupported Media Type, see HTTP/1.1 documentation.

REQUESTED_RANGE_NOT_SATISFIABLE_416

public static final Http.Status REQUESTED_RANGE_NOT_SATISFIABLE_416

416 Requested Range Not Satisfiable, see HTTP/1.1 documentation.

Since:

2.0

EXPECTATION_FAILED_417

public static final Http.Status EXPECTATION_FAILED_417

417 Expectation Failed, see HTTP/1.1 documentation.

Since:

2.0

I_AM_A_TEAPOT_418

public static final Http.Status I_AM_A_TEAPOT_418

418 I'm a teapot, see Hyper Text Coffee Pot Control Protocol (HTCPCP/1.0).

INTERNAL_SERVER_ERROR_500

public static final Http.Status INTERNAL_SERVER_ERROR_500

500 Internal Server Error, see HTTP/1.1 documentation.

NOT_IMPLEMENTED_501

public static final Http.Status NOT_IMPLEMENTED_501

501 Not Implemented, see HTTP/1.1 documentation.

Since:

2.0

BAD_GATEWAY_502

public static final Http.Status BAD_GATEWAY_502

502 Bad Gateway, see HTTP/1.1 documentation.

Since:

2.0

SERVICE_UNAVAILABLE_503

public static final Http.Status SERVICE_UNAVAILABLE_503

503 Service Unavailable, see HTTP/1.1 documentation.

GATEWAY_TIMEOUT_504

public static final Http.Status GATEWAY_TIMEOUT_504

504 Gateway Timeout, see HTTP/1.1 documentation.

Since:

2.0

HTTP_VERSION_NOT_SUPPORTED

@Deprecated(forRemoval=true,
            since="3.0.3")
public static final Http.Status HTTP_VERSION_NOT_SUPPORTED

Deprecated, for removal: This API element is subject to removal in a future version.

use HTTP_VERSION_NOT_SUPPORTED_505 instead (inconsistent name)

505 HTTP Version Not Supported, see HTTP/1.1 documentation.

Since:

2.0

HTTP_VERSION_NOT_SUPPORTED_505

public static final Http.Status HTTP_VERSION_NOT_SUPPORTED_505

505 HTTP Version Not Supported, see HTTP/1.1 documentation.

Since:

3.0.3

Method Details

create

public static Http.Status create(int statusCode)

Convert a numerical status code into the corresponding Status.

For an unknown code, an ad-hoc Http.Status is created.

Parameters:

statusCode - the numerical status code

Returns:

the matching Status; either a constant from this class, or an ad-hoc Http.Status

create

public static Http.Status create(int statusCode,
 String reasonPhrase)

Convert a numerical status code into the corresponding Status.

It either returns an existing Http.Status constant if possible. For an unknown code, or code/reason phrase combination it creates an ad-hoc Http.Status.

Parameters:

statusCode - the numerical status code

reasonPhrase - the reason phrase; if null or a known reason phrase, an instance with the default phrase is returned; otherwise, a new instance is returned

Returns:

the matching Status

code

public int code()

Get the associated integer value representing the status code.

Returns:

the integer value representing the status code.

family

public Http.Status.Family family()

Get the class of status code.

Returns:

the class of status code.

reasonPhrase

public String reasonPhrase()

Get the reason phrase.

Returns:

the reason phrase.

codeText

public String codeText()

Text of the code().

Returns:

code string (number as a string)

toString

public String toString()

Get the response status as string.

Overrides:

toString in class Object

Returns:

the response status string in the form of a partial HTTP response status line, i.e. "Status-Code SP Reason-Phrase".

text

public String text()

Text of the status as used in HTTP/1, such as "200 OK".

Returns:

text of this status

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object