Package javax.ws.rs
Class WebApplicationException
- java.lang.Object
-
- java.lang.Throwable
-
- java.lang.Exception
-
- java.lang.RuntimeException
-
- javax.ws.rs.WebApplicationException
-
- Direct Known Subclasses:
ClientErrorException
,RedirectionException
,ServerErrorException
public class WebApplicationException extends java.lang.RuntimeException
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:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description WebApplicationException()
Construct 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(java.lang.String message)
Construct a new instance with a blank message and default HTTP status code of 500.WebApplicationException(java.lang.String message, int status)
Construct a new instance with a blank message and specified HTTP status code.WebApplicationException(java.lang.String message, java.lang.Throwable cause)
Construct a new instance with a blank message and default HTTP status code of 500.WebApplicationException(java.lang.String message, java.lang.Throwable cause, int status)
Construct a new instance with a blank message and specified HTTP status code.WebApplicationException(java.lang.String message, java.lang.Throwable cause, Response response)
Construct a new instance using the supplied response.WebApplicationException(java.lang.String message, java.lang.Throwable cause, Response.Status status)
Construct a new instance with a blank message and specified HTTP status code.WebApplicationException(java.lang.String message, Response response)
Construct a new instance using the supplied response.WebApplicationException(java.lang.String message, Response.Status status)
Construct a new instance with a blank message and specified HTTP status code.WebApplicationException(java.lang.Throwable cause)
Construct a new instance with a blank message and default HTTP status code of 500.WebApplicationException(java.lang.Throwable cause, int status)
Construct a new instance with a blank message and specified HTTP status code.WebApplicationException(java.lang.Throwable cause, Response response)
Construct a new instance using the supplied response.WebApplicationException(java.lang.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.WebApplicationException(Response.Status status)
Construct a new instance with a blank message and specified HTTP status code.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Response
getResponse()
Get the HTTP response.
-
-
-
Constructor Detail
-
WebApplicationException
public WebApplicationException()
Construct a new instance with a blank message and default HTTP status code of 500.
-
WebApplicationException
public WebApplicationException(java.lang.String message)
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
public WebApplicationException(Response response)
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
public WebApplicationException(java.lang.String message, Response response)
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
public WebApplicationException(java.lang.String message, int status)
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
public WebApplicationException(Response.Status 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.- Throws:
java.lang.IllegalArgumentException
- if status isnull
.
-
WebApplicationException
public WebApplicationException(java.lang.String message, Response.Status status)
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:
java.lang.IllegalArgumentException
- if status isnull
.- Since:
- 2.0
-
WebApplicationException
public WebApplicationException(java.lang.Throwable cause)
Construct a new instance with a blank message and default HTTP status code of 500.- Parameters:
cause
- the underlying cause of the exception.
-
WebApplicationException
public WebApplicationException(java.lang.String message, java.lang.Throwable cause)
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
public WebApplicationException(java.lang.Throwable cause, Response response)
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).cause
- the underlying cause of the exception.
-
WebApplicationException
public WebApplicationException(java.lang.String message, java.lang.Throwable cause, Response response)
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).cause
- the underlying cause of the exception.- Since:
- 2.0
-
WebApplicationException
public WebApplicationException(java.lang.Throwable cause, 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.cause
- the underlying cause of the exception.
-
WebApplicationException
public WebApplicationException(java.lang.String message, java.lang.Throwable cause, int status)
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.cause
- the underlying cause of the exception.- Since:
- 2.0
-
WebApplicationException
public WebApplicationException(java.lang.Throwable cause, Response.Status status) throws java.lang.IllegalArgumentException
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.cause
- the underlying cause of the exception.- Throws:
java.lang.IllegalArgumentException
- if status isnull
.
-
WebApplicationException
public WebApplicationException(java.lang.String message, java.lang.Throwable cause, Response.Status status) throws java.lang.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).status
- the HTTP status code that will be returned to the client.cause
- the underlying cause of the exception.- Throws:
java.lang.IllegalArgumentException
- Since:
- 2.0
-
-
Method Detail
-
getResponse
public Response getResponse()
Get the HTTP response.- Returns:
- the HTTP response.
-
-