Response.Status (Jakarta EE 8 Specification APIs)

java.lang.Object
- java.lang.Enum<Response.Status>
- - javax.ws.rs.core.Response.Status

All Implemented Interfaces:

Serializable, Comparable<Response.Status>, Response.StatusType

Enclosing class:

Response
```
public static enum Response.Status
extends Enum<Response.Status>
implements Response.StatusType
```
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 creating an implementation of Response.StatusType.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Response.Status.Family
An enumeration representing the class of status code.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Response.Status.Family` An enumeration representing the class of status code.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ACCEPTED` 202 Accepted, see HTTP/1.1 documentation.
`BAD_GATEWAY` 502 Bad Gateway, see HTTP/1.1 documentation.
`BAD_REQUEST` 400 Bad Request, see HTTP/1.1 documentation.
`CONFLICT` 409 Conflict, see HTTP/1.1 documentation.
`CREATED` 201 Created, see HTTP/1.1 documentation.
`EXPECTATION_FAILED` 417 Expectation Failed, see HTTP/1.1 documentation.
`FORBIDDEN` 403 Forbidden, see HTTP/1.1 documentation.
`FOUND` 302 Found, see HTTP/1.1 documentation.
`GATEWAY_TIMEOUT` 504 Gateway Timeout, see HTTP/1.1 documentation.
`GONE` 410 Gone, see HTTP/1.1 documentation.
`HTTP_VERSION_NOT_SUPPORTED` 505 HTTP Version Not Supported, see HTTP/1.1 documentation.
`INTERNAL_SERVER_ERROR` 500 Internal Server Error, see HTTP/1.1 documentation.
`LENGTH_REQUIRED` 411 Length Required, see HTTP/1.1 documentation.
`METHOD_NOT_ALLOWED` 405 Method Not Allowed, see HTTP/1.1 documentation.
`MOVED_PERMANENTLY` 301 Moved Permanently, see HTTP/1.1 documentation.
`NETWORK_AUTHENTICATION_REQUIRED` 511 Network Authentication Required, see RFC 6585: Additional HTTP Status Codes.
`NO_CONTENT` 204 No Content, see HTTP/1.1 documentation.
`NOT_ACCEPTABLE` 406 Not Acceptable, see HTTP/1.1 documentation.
`NOT_FOUND` 404 Not Found, see HTTP/1.1 documentation.
`NOT_IMPLEMENTED` 501 Not Implemented, see HTTP/1.1 documentation.
`NOT_MODIFIED` 304 Not Modified, see HTTP/1.1 documentation.
`OK` 200 OK, see HTTP/1.1 documentation.
`PARTIAL_CONTENT` 206 Reset Content, see HTTP/1.1 documentation.
`PAYMENT_REQUIRED` 402 Payment Required, see HTTP/1.1 documentation.
`PRECONDITION_FAILED` 412 Precondition Failed, see HTTP/1.1 documentation.
`PRECONDITION_REQUIRED` 428 Precondition required, see RFC 6585: Additional HTTP Status Codes.
`PROXY_AUTHENTICATION_REQUIRED` 407 Proxy Authentication Required, see HTTP/1.1 documentation.
`REQUEST_ENTITY_TOO_LARGE` 413 Request Entity Too Large, see HTTP/1.1 documentation.
`REQUEST_HEADER_FIELDS_TOO_LARGE` 431 Request Header Fields Too Large, see RFC 6585: Additional HTTP Status Codes.
`REQUEST_TIMEOUT` 408 Request Timeout, see HTTP/1.1 documentation.
`REQUEST_URI_TOO_LONG` 414 Request-URI Too Long, see HTTP/1.1 documentation.
`REQUESTED_RANGE_NOT_SATISFIABLE` 416 Requested Range Not Satisfiable, see HTTP/1.1 documentation.
`RESET_CONTENT` 205 Reset Content, see HTTP/1.1 documentation.
`SEE_OTHER` 303 See Other, see HTTP/1.1 documentation.
`SERVICE_UNAVAILABLE` 503 Service Unavailable, see HTTP/1.1 documentation.
`TEMPORARY_REDIRECT` 307 Temporary Redirect, see HTTP/1.1 documentation.
`TOO_MANY_REQUESTS` 429 Too Many Requests, see RFC 6585: Additional HTTP Status Codes.
`UNAUTHORIZED` 401 Unauthorized, see HTTP/1.1 documentation.
`UNSUPPORTED_MEDIA_TYPE` 415 Unsupported Media Type, see HTTP/1.1 documentation.
`USE_PROXY` 305 Use Proxy, see HTTP/1.1 documentation.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Response.Status`	`fromStatusCode(int statusCode)` Convert a numerical status code into the corresponding Status.
`Response.Status.Family`	`getFamily()` Get the class of status code.
`String`	`getReasonPhrase()` Get the reason phrase.
`int`	`getStatusCode()` Get the associated status code.
`String`	`toString()` Get the reason phrase.
`static Response.Status`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static Response.Status[]`	`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

Methods inherited from interface javax.ws.rs.core.Response.StatusType
toEnum

- Enum Constant Detail
  - OK
```
public static final Response.Status OK
```
    200 OK, see HTTP/1.1 documentation.
  - CREATED
```
public static final Response.Status CREATED
```
    201 Created, see HTTP/1.1 documentation.
  - ACCEPTED
```
public static final Response.Status ACCEPTED
```
    202 Accepted, see HTTP/1.1 documentation.
  - NO_CONTENT
```
public static final Response.Status NO_CONTENT
```
    204 No Content, see HTTP/1.1 documentation.
  - RESET_CONTENT
```
public static final Response.Status RESET_CONTENT
```
    205 Reset Content, see HTTP/1.1 documentation.
    
    Since:
    
    2.0
  - PARTIAL_CONTENT
```
public static final Response.Status PARTIAL_CONTENT
```
    206 Reset Content, see HTTP/1.1 documentation.
    
    Since:
    
    2.0
  - MOVED_PERMANENTLY
```
public static final Response.Status MOVED_PERMANENTLY
```
    301 Moved Permanently, see HTTP/1.1 documentation.
  - FOUND
```
public static final Response.Status FOUND
```
    302 Found, see HTTP/1.1 documentation.
    
    Since:
    
    2.0
  - SEE_OTHER
```
public static final Response.Status SEE_OTHER
```
    303 See Other, see HTTP/1.1 documentation.
  - NOT_MODIFIED
```
public static final Response.Status NOT_MODIFIED
```
    304 Not Modified, see HTTP/1.1 documentation.
  - USE_PROXY
```
public static final Response.Status USE_PROXY
```
    305 Use Proxy, see HTTP/1.1 documentation.
    
    Since:
    
    2.0
  - TEMPORARY_REDIRECT
```
public static final Response.Status TEMPORARY_REDIRECT
```
    307 Temporary Redirect, see HTTP/1.1 documentation.
  - BAD_REQUEST
```
public static final Response.Status BAD_REQUEST
```
    400 Bad Request, see HTTP/1.1 documentation.
  - UNAUTHORIZED
```
public static final Response.Status UNAUTHORIZED
```
    401 Unauthorized, see HTTP/1.1 documentation.
  - PAYMENT_REQUIRED
```
public static final Response.Status PAYMENT_REQUIRED
```
    402 Payment Required, see HTTP/1.1 documentation.
    
    Since:
    
    2.0
  - FORBIDDEN
```
public static final Response.Status FORBIDDEN
```
    403 Forbidden, see HTTP/1.1 documentation.
  - NOT_FOUND
```
public static final Response.Status NOT_FOUND
```
    404 Not Found, see HTTP/1.1 documentation.
  - METHOD_NOT_ALLOWED
```
public static final Response.Status METHOD_NOT_ALLOWED
```
    405 Method Not Allowed, see HTTP/1.1 documentation.
    
    Since:
    
    2.0
  - NOT_ACCEPTABLE
```
public static final Response.Status NOT_ACCEPTABLE
```
    406 Not Acceptable, see HTTP/1.1 documentation.
  - PROXY_AUTHENTICATION_REQUIRED
```
public static final Response.Status PROXY_AUTHENTICATION_REQUIRED
```
    407 Proxy Authentication Required, see HTTP/1.1 documentation.
    
    Since:
    
    2.0
  - REQUEST_TIMEOUT
```
public static final Response.Status REQUEST_TIMEOUT
```
    408 Request Timeout, see HTTP/1.1 documentation.
    
    Since:
    
    2.0
  - CONFLICT
```
public static final Response.Status CONFLICT
```
    409 Conflict, see HTTP/1.1 documentation.
  - GONE
```
public static final Response.Status GONE
```
    410 Gone, see HTTP/1.1 documentation.
  - LENGTH_REQUIRED
```
public static final Response.Status LENGTH_REQUIRED
```
    411 Length Required, see HTTP/1.1 documentation.
    
    Since:
    
    2.0
  - PRECONDITION_FAILED
```
public static final Response.Status PRECONDITION_FAILED
```
    412 Precondition Failed, see HTTP/1.1 documentation.
  - REQUEST_ENTITY_TOO_LARGE
```
public static final Response.Status REQUEST_ENTITY_TOO_LARGE
```
    413 Request Entity Too Large, see HTTP/1.1 documentation.
    
    Since:
    
    2.0
  - REQUEST_URI_TOO_LONG
```
public static final Response.Status REQUEST_URI_TOO_LONG
```
    414 Request-URI Too Long, see HTTP/1.1 documentation.
    
    Since:
    
    2.0
  - UNSUPPORTED_MEDIA_TYPE
```
public static final Response.Status UNSUPPORTED_MEDIA_TYPE
```
    415 Unsupported Media Type, see HTTP/1.1 documentation.
  - REQUESTED_RANGE_NOT_SATISFIABLE
```
public static final Response.Status REQUESTED_RANGE_NOT_SATISFIABLE
```
    416 Requested Range Not Satisfiable, see HTTP/1.1 documentation.
    
    Since:
    
    2.0
  - EXPECTATION_FAILED
```
public static final Response.Status EXPECTATION_FAILED
```
    417 Expectation Failed, see HTTP/1.1 documentation.
    
    Since:
    
    2.0
  - PRECONDITION_REQUIRED
```
public static final Response.Status PRECONDITION_REQUIRED
```
    428 Precondition required, see RFC 6585: Additional HTTP Status Codes.
    
    Since:
    
    2.1
  - TOO_MANY_REQUESTS
```
public static final Response.Status TOO_MANY_REQUESTS
```
    429 Too Many Requests, see RFC 6585: Additional HTTP Status Codes.
    
    Since:
    
    2.1
  - REQUEST_HEADER_FIELDS_TOO_LARGE
```
public static final Response.Status REQUEST_HEADER_FIELDS_TOO_LARGE
```
    431 Request Header Fields Too Large, see RFC 6585: Additional HTTP Status Codes.
    
    Since:
    
    2.1
  - INTERNAL_SERVER_ERROR
```
public static final Response.Status INTERNAL_SERVER_ERROR
```
    500 Internal Server Error, see HTTP/1.1 documentation.
  - NOT_IMPLEMENTED
```
public static final Response.Status NOT_IMPLEMENTED
```
    501 Not Implemented, see HTTP/1.1 documentation.
    
    Since:
    
    2.0
  - BAD_GATEWAY
```
public static final Response.Status BAD_GATEWAY
```
    502 Bad Gateway, see HTTP/1.1 documentation.
    
    Since:
    
    2.0
  - SERVICE_UNAVAILABLE
```
public static final Response.Status SERVICE_UNAVAILABLE
```
    503 Service Unavailable, see HTTP/1.1 documentation.
  - GATEWAY_TIMEOUT
```
public static final Response.Status GATEWAY_TIMEOUT
```
    504 Gateway Timeout, see HTTP/1.1 documentation.
    
    Since:
    
    2.0
  - HTTP_VERSION_NOT_SUPPORTED
```
public static final Response.Status HTTP_VERSION_NOT_SUPPORTED
```
    505 HTTP Version Not Supported, see HTTP/1.1 documentation.
    
    Since:
    
    2.0
  - NETWORK_AUTHENTICATION_REQUIRED
```
public static final Response.Status NETWORK_AUTHENTICATION_REQUIRED
```
    511 Network Authentication Required, see RFC 6585: Additional HTTP Status Codes.
    
    Since:
    
    2.1
- Method Detail
  - values
```
public static Response.Status[] 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 (Response.Status c : Response.Status.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Response.Status 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
  - getFamily
```
public Response.Status.Family getFamily()
```
    Get the class of status code.
    
    Specified by:
    
    getFamily in interface Response.StatusType
    
    Returns:
    
    the class of status code.
  - getStatusCode
```
public int getStatusCode()
```
    Get the associated status code.
    
    Specified by:
    
    getStatusCode in interface Response.StatusType
    
    Returns:
    
    the status code.
  - getReasonPhrase
```
public String getReasonPhrase()
```
    Get the reason phrase.
    
    Specified by:
    
    getReasonPhrase in interface Response.StatusType
    
    Returns:
    
    the reason phrase.
  - toString
```
public String toString()
```
    Get the reason phrase.
    
    Overrides:
    
    toString in class Enum<Response.Status>
    
    Returns:
    
    the reason phrase.
  - fromStatusCode
```
public static Response.Status fromStatusCode(int statusCode)
```
    Convert a numerical status code into the corresponding Status.
    
    Parameters:
    
    statusCode - the numerical status code.
    
    Returns:
    
    the matching Status or null is no matching Status is defined.

Enum Response.Status

Nested Class Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Methods inherited from interface javax.ws.rs.core.Response.StatusType

Enum Constant Detail

OK

CREATED

ACCEPTED

NO_CONTENT

RESET_CONTENT

PARTIAL_CONTENT

MOVED_PERMANENTLY

FOUND

SEE_OTHER

NOT_MODIFIED

USE_PROXY

TEMPORARY_REDIRECT

BAD_REQUEST

UNAUTHORIZED

PAYMENT_REQUIRED

FORBIDDEN

NOT_FOUND

METHOD_NOT_ALLOWED

NOT_ACCEPTABLE

PROXY_AUTHENTICATION_REQUIRED

REQUEST_TIMEOUT

CONFLICT

GONE

LENGTH_REQUIRED

PRECONDITION_FAILED

REQUEST_ENTITY_TOO_LARGE

REQUEST_URI_TOO_LONG

UNSUPPORTED_MEDIA_TYPE

REQUESTED_RANGE_NOT_SATISFIABLE

EXPECTATION_FAILED

PRECONDITION_REQUIRED

TOO_MANY_REQUESTS

REQUEST_HEADER_FIELDS_TOO_LARGE

INTERNAL_SERVER_ERROR

NOT_IMPLEMENTED

BAD_GATEWAY

SERVICE_UNAVAILABLE

GATEWAY_TIMEOUT

HTTP_VERSION_NOT_SUPPORTED

NETWORK_AUTHENTICATION_REQUIRED

Method Detail

values

valueOf

getFamily

getStatusCode

getReasonPhrase

toString

fromStatusCode