Package javax.ws.rs
Class WebApplicationException
java.lang.Object
java.lang.Throwable
java.lang.Exception
java.lang.RuntimeException
javax.ws.rs.WebApplicationException
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
ClientErrorException
,RedirectionException
,ServerErrorException
Runtime exception for applications.
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.
- Since:
- 1.0
- See Also:
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionConstruct a new instance with a blank message and default HTTP status code of 500.WebApplicationException
(int status) Construct a new instance with a blank message and specified HTTP status code.WebApplicationException
(String message) Construct a new instance with a blank message and default HTTP status code of 500.WebApplicationException
(String message, int status) Construct a new instance with a blank message and specified HTTP status code.WebApplicationException
(String message, Throwable cause) Construct a new instance with a blank message and default HTTP status code of 500.WebApplicationException
(String message, Throwable cause, int status) Construct a new instance with a blank message and specified HTTP status code.WebApplicationException
(String message, Throwable cause, Response response) Construct a new instance using the supplied response.WebApplicationException
(String message, Throwable cause, Response.Status status) Construct a new instance with a blank message and specified HTTP status code.WebApplicationException
(String message, Response response) Construct a new instance using the supplied response.WebApplicationException
(String message, Response.Status status) Construct a new instance with a blank message and specified HTTP status code.WebApplicationException
(Throwable cause) Construct a new instance with a blank message and default HTTP status code of 500.WebApplicationException
(Throwable cause, int status) Construct a new instance with a blank message and specified HTTP status code.WebApplicationException
(Throwable cause, Response response) Construct a new instance using the supplied response.WebApplicationException
(Throwable cause, Response.Status status) Construct a new instance with a blank message and specified HTTP status code.WebApplicationException
(Response response) Construct a new instance using the supplied response.Construct a new instance with a blank message and specified HTTP status code. -
Method Summary
Modifier and TypeMethodDescriptionprivate static String
computeExceptionMessage
(Response response) Get the HTTP response.(package private) static Response
validate
(Response response, Response.Status expectedStatus) Validate that aResponse
object has an expected HTTP response status code set.(package private) static Response
validate
(Response response, Response.Status.Family expectedStatusFamily) Validate that aResponse
object has an expected HTTP response status code set.Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
response
-
-
Constructor Details
-
WebApplicationException
public WebApplicationException()Construct a new instance with a blank message and default HTTP status code of 500. -
WebApplicationException
Construct a new instance with a blank message and default HTTP status code of 500.- Parameters:
message
- the detail message (which is saved for later retrieval by theThrowable.getMessage()
method).- Since:
- 2.0
-
WebApplicationException
Construct a new instance using the supplied response.- Parameters:
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).
-
WebApplicationException
Construct a new instance using the supplied response.- Parameters:
message
- the detail message (which is saved for later retrieval by theThrowable.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).- Since:
- 2.0
-
WebApplicationException
public WebApplicationException(int status) Construct a new instance with a blank message and specified HTTP status code.- Parameters:
status
- the HTTP status code that will be returned to the client.
-
WebApplicationException
Construct a new instance with a blank message and specified HTTP status code.- Parameters:
message
- the detail message (which is saved for later retrieval by theThrowable.getMessage()
method).status
- the HTTP status code that will be returned to the client.- Since:
- 2.0
-
WebApplicationException
Construct a new instance with a blank message and specified HTTP status code.- Parameters:
status
- the HTTP status code that will be returned to the client.- Throws:
IllegalArgumentException
- if status isnull
.
-
WebApplicationException
Construct a new instance with a blank message and specified HTTP status code.- Parameters:
message
- the detail message (which is saved for later retrieval by theThrowable.getMessage()
method).status
- the HTTP status code that will be returned to the client.- Throws:
IllegalArgumentException
- if status isnull
.- Since:
- 2.0
-
WebApplicationException
Construct a new instance with a blank message and default HTTP status code of 500.- Parameters:
cause
- the underlying cause of the exception.
-
WebApplicationException
Construct a new instance with a blank message and default HTTP status code of 500.- Parameters:
message
- the detail message (which is saved for later retrieval by theThrowable.getMessage()
method).cause
- the underlying cause of the exception.- Since:
- 2.0
-
WebApplicationException
Construct a new instance using the supplied response.- Parameters:
cause
- the underlying cause of the exception.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).
-
WebApplicationException
Construct a new instance using the supplied response.- Parameters:
message
- the detail message (which is saved for later retrieval by theThrowable.getMessage()
method).cause
- the underlying cause of the exception.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).- Since:
- 2.0
-
WebApplicationException
Construct a new instance with a blank message and specified HTTP status code.- Parameters:
cause
- the underlying cause of the exception.status
- the HTTP status code that will be returned to the client.
-
WebApplicationException
Construct a new instance with a blank message and specified HTTP status code.- Parameters:
message
- the detail message (which is saved for later retrieval by theThrowable.getMessage()
method).cause
- the underlying cause of the exception.status
- the HTTP status code that will be returned to the client.- Since:
- 2.0
-
WebApplicationException
public WebApplicationException(Throwable cause, Response.Status status) throws IllegalArgumentException Construct a new instance with a blank message and specified HTTP status code.- Parameters:
cause
- the underlying cause of the exception.status
- the HTTP status code that will be returned to the client.- Throws:
IllegalArgumentException
- if status isnull
.
-
WebApplicationException
public WebApplicationException(String message, Throwable cause, Response.Status status) throws IllegalArgumentException Construct a new instance with a blank message and specified HTTP status code.- Parameters:
message
- the detail message (which is saved for later retrieval by theThrowable.getMessage()
method).cause
- the underlying cause of the exception.status
- the HTTP status code that will be returned to the client.- Throws:
IllegalArgumentException
- Since:
- 2.0
-
-
Method Details
-
computeExceptionMessage
-
getResponse
Get the HTTP response.- Returns:
- the HTTP response.
-
validate
Validate that aResponse
object has an expected HTTP response status code set.- Parameters:
response
- response object.expectedStatus
- expected response status code.- Returns:
- validated response object.
- Throws:
IllegalArgumentException
- if the response validation failed.- Since:
- 2.0
-
validate
Validate that aResponse
object has an expected HTTP response status code set.- Parameters:
response
- response object.expectedStatusFamily
- expected response status code family.- Returns:
- validated response object.
- Throws:
IllegalArgumentException
- if the response validation failed.- Since:
- 2.0
-