public class WebApplicationException
extends java.lang.RuntimeException
This exception may be thrown by a resource method, provider or
StreamingOutput
implementation if a specific
HTTP error response needs to be produced. Only effective if thrown prior to
the response being committed.
Modifier and Type | Field and Description |
---|---|
private Response |
response |
private static long |
serialVersionUID |
Constructor and Description |
---|
WebApplicationException()
Construct a new instance with a default HTTP status code of 500
and a default message generated from the HTTP status code and the associated HTTP status reason phrase.
|
WebApplicationException(int status)
Construct a new instance with the supplied HTTP status code
and a default message generated from the HTTP status code and the associated HTTP status reason phrase.
|
WebApplicationException(Response.Status status)
Construct a new instance with the supplied HTTP status
and a default message generated from the HTTP status code and the associated HTTP status reason phrase.
|
WebApplicationException(Response response)
Construct a new instance using the supplied response
and a default message generated from the response's HTTP status code and the associated HTTP status reason phrase.
|
WebApplicationException(java.lang.String message)
Construct a new instance with the supplied message and a default HTTP status code of 500.
|
WebApplicationException(java.lang.String message,
int status)
Construct a new instance with a supplied message and HTTP status code.
|
WebApplicationException(java.lang.String message,
Response.Status status)
Construct a new instance with the supplied message and HTTP status.
|
WebApplicationException(java.lang.String message,
Response response)
Construct a new instance using the supplied message and response.
|
WebApplicationException(java.lang.String message,
java.lang.Throwable cause)
Construct a new instance with the supplied message, root cause and default HTTP status code of 500.
|
WebApplicationException(java.lang.String message,
java.lang.Throwable cause,
int status)
Construct a new instance with the supplied message, root cause and HTTP status code.
|
WebApplicationException(java.lang.String message,
java.lang.Throwable cause,
Response.Status status)
Construct a new instance with a the supplied message, root cause and HTTP status code.
|
WebApplicationException(java.lang.String message,
java.lang.Throwable cause,
Response response)
Construct a new instance with the supplied message, root cause and response.
|
WebApplicationException(java.lang.Throwable cause)
Construct a new instance with the supplied root cause, default HTTP status code of 500
and a default message generated from the HTTP status code and the associated HTTP status reason phrase.
|
WebApplicationException(java.lang.Throwable cause,
int status)
Construct a new instance with the supplied root cause, HTTP status code
and a default message generated from the HTTP status code and the associated HTTP status reason phrase.
|
WebApplicationException(java.lang.Throwable cause,
Response.Status status)
Construct a new instance with the supplied root cause, HTTP status code
and a default message generated from the HTTP status code and the associated HTTP status reason phrase.
|
WebApplicationException(java.lang.Throwable cause,
Response response)
Construct a new instance with the supplied root cause, response
and a default message generated from the response's HTTP status code and the associated HTTP status reason phrase.
|
Modifier and Type | Method and Description |
---|---|
private static java.lang.String |
computeExceptionMessage(Response response) |
Response |
getResponse()
Get the HTTP response.
|
(package private) static Response |
validate(Response response,
Response.Status.Family expectedStatusFamily)
Validate that a
Response object has an expected HTTP response
status code set. |
(package private) static Response |
validate(Response response,
Response.Status expectedStatus)
Validate that a
Response object has an expected HTTP response
status code set. |
private static final long serialVersionUID
private final Response response
public WebApplicationException()
public WebApplicationException(java.lang.String message)
message
- the detail message (which is saved for later retrieval
by the Throwable.getMessage()
method).public WebApplicationException(Response response)
response
- the response that will be returned to the client, a value
of null will be replaced with an internal server error response (status
code 500).public WebApplicationException(java.lang.String message, Response response)
message
- the detail message (which is saved for later retrieval
by the Throwable.getMessage()
method).response
- the response that will be returned to the client, a value
of null will be replaced with an internal server error response (status
code 500).public WebApplicationException(int status)
status
- the HTTP status code that will be returned to the client.public WebApplicationException(java.lang.String message, int status)
message
- the detail message (which is saved for later retrieval
by the Throwable.getMessage()
method).status
- the HTTP status code that will be returned to the client.public WebApplicationException(Response.Status status)
status
- the HTTP status code that will be returned to the client.java.lang.IllegalArgumentException
- if status is null
.public WebApplicationException(java.lang.String message, Response.Status status)
message
- the detail message (which is saved for later retrieval
by the Throwable.getMessage()
method).status
- the HTTP status code that will be returned to the client.java.lang.IllegalArgumentException
- if status is null
.public WebApplicationException(java.lang.Throwable cause)
cause
- the underlying cause of the exception.public WebApplicationException(java.lang.String message, java.lang.Throwable cause)
message
- the detail message (which is saved for later retrieval
by the Throwable.getMessage()
method).cause
- the underlying cause of the exception.public WebApplicationException(java.lang.Throwable cause, Response response)
response
- the response that will be returned to the client,
a value of null will be replaced with an internal server error
response (status code 500).cause
- the underlying cause of the exception.public WebApplicationException(java.lang.String message, java.lang.Throwable cause, Response response)
message
- the detail message (which is saved for later retrieval
by the Throwable.getMessage()
method).response
- the response that will be returned to the client,
a value of null will be replaced with an internal server error
response (status code 500).cause
- the underlying cause of the exception.public WebApplicationException(java.lang.Throwable cause, int status)
status
- the HTTP status code that will be returned to the client.cause
- the underlying cause of the exception.public WebApplicationException(java.lang.String message, java.lang.Throwable cause, int status)
message
- the detail message (which is saved for later retrieval
by the Throwable.getMessage()
method).status
- the HTTP status code that will be returned to the client.cause
- the underlying cause of the exception.public WebApplicationException(java.lang.Throwable cause, Response.Status status) throws java.lang.IllegalArgumentException
status
- the HTTP status code that will be returned to the client.cause
- the underlying cause of the exception.java.lang.IllegalArgumentException
- if status is null
.public WebApplicationException(java.lang.String message, java.lang.Throwable cause, Response.Status status) throws java.lang.IllegalArgumentException
message
- the detail message (which is saved for later retrieval
by the Throwable.getMessage()
method).status
- the HTTP status code that will be returned to the client.cause
- the underlying cause of the exception.java.lang.IllegalArgumentException
private static java.lang.String computeExceptionMessage(Response response)
public Response getResponse()
static Response validate(Response response, Response.Status expectedStatus)
Response
object has an expected HTTP response
status code set.response
- response object.expectedStatus
- expected response status code.java.lang.IllegalArgumentException
- if the response validation failed.static Response validate(Response response, Response.Status.Family expectedStatusFamily)
Response
object has an expected HTTP response
status code set.response
- response object.expectedStatusFamily
- expected response status code family.java.lang.IllegalArgumentException
- if the response validation failed.