javax.ws.rs.ext

Interface ExceptionMapper<E extends Throwable>

Type Parameters:

E - exception type supported by the provider.

All Known Implementing Classes:

FooExceptionMapper, ResteasyViolationExceptionMapper

public interface ExceptionMapper<E extends Throwable>

Contract for a provider that maps Java exceptions to Response.

Providers implementing ExceptionMapper contract must be either programmatically registered in a JAX-RS runtime or must be annotated with @Provider annotation to be automatically discovered by the JAX-RS runtime during a provider scanning phase.

Since:

1.0

Author:

Paul Sandoz, Marc Hadley

See Also:

Provider, Response

Method Summary

Methods

Modifier and Type	Method and Description
Response	toResponse(E exception) Map an exception to a Response.

Method Detail

toResponse

Response toResponse(E exception)

Map an exception to a Response. Returning null results in a Response.Status.NO_CONTENT response. Throwing a runtime exception results in a Response.Status.INTERNAL_SERVER_ERROR response.

Parameters:

exception - the exception to map to a response.

Returns:

a response mapped from the supplied exception.