javax.ws.rs

Class WebApplicationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

javax.ws.rs.WebApplicationException

All Implemented Interfaces:

java.io.Serializable

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

Field Summary

Fields

Modifier and Type	Field and Description
private Response	response
private static long	serialVersionUID

Constructor Summary

Constructors

Constructor and 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(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(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, 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, 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.Status 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.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.Status 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.

Method Summary

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.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

response

private final Response 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 the Throwable.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 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).

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 the Throwable.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 is null.

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 the Throwable.getMessage() method).

status - the HTTP status code that will be returned to the client.

Throws:

java.lang.IllegalArgumentException - if status is null.

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 the Throwable.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 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.

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 the Throwable.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 is null.

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 the Throwable.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

computeExceptionMessage

private static java.lang.String computeExceptionMessage(Response response)

getResponse

public Response getResponse()

Get the HTTP response.

Returns:

the HTTP response.

validate

static Response validate(Response response,
                         Response.Status expectedStatus)

Validate that a Response object has an expected HTTP response status code set.

Parameters:

response - response object.

expectedStatus - expected response status code.

Returns:

validated response object.

Throws:

java.lang.IllegalArgumentException - if the response validation failed.

Since:

2.0

validate

static Response validate(Response response,
                         Response.Status.Family expectedStatusFamily)

Validate that a Response object has an expected HTTP response status code set.

Parameters:

response - response object.

expectedStatusFamily - expected response status code family.

Returns:

validated response object.

Throws:

java.lang.IllegalArgumentException - if the response validation failed.

Since:

2.0