Top Description Methods
jakarta.ws.rs.ext

public Interface ExceptionMapper<E extends java.lang.Throwable>

Type Parameters
<E>
exception type supported by the provider.
Imports
jakarta.ws.rs.core.Response
Contract for a provider that maps Java exceptions to jakarta.ws.rs.core.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.

Authors
Paul Sandoz, Marc Hadley
Since
1.0
See Also
Provider, jakarta.ws.rs.core.Response

Method Summary

Modifier and TypeMethod and Description
public Response

Returns:

a response mapped from the supplied exception.
toResponse(E
the exception to map to a response.
exception)

Map an exception to a jakarta.ws.rs.core.Response.

Method Detail

toResponseback to summary
public Response toResponse(E exception)

Map an exception to a jakarta.ws.rs.core.Response. Returning null results in a jakarta.ws.rs.core.Response.Status#NO_CONTENT response. Throwing a runtime exception results in a jakarta.ws.rs.core.Response.Status#INTERNAL_SERVER_ERROR response.

Parameters
exception:E

the exception to map to a response.

Returns:Response

a response mapped from the supplied exception.