Package org.kiwiproject.jaxrs.exception

Class JaxrsExceptionMapper

java.lang.Object

org.kiwiproject.jaxrs.exception.JaxrsExceptionMapper

All Implemented Interfaces:

jakarta.ws.rs.ext.ExceptionMapper<JaxrsException>

@Provider
public class JaxrsExceptionMapper
extends Object
implements jakarta.ws.rs.ext.ExceptionMapper<JaxrsException>

Map a JaxrsException to a Response.

The mapped response has the status of the given JaxrsException and media type JSON.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_ERRORS	The map key under which the list of ErrorMessage objects resides.

Constructor Summary

Constructors

Constructor	Description
JaxrsExceptionMapper()

Method Summary

Modifier and Type	Method	Description
static jakarta.ws.rs.core.Response	buildResponse(JaxrsException exception)	Convert the given JaxrsException to a JSON response.
static jakarta.ws.rs.core.Response.ResponseBuilder	buildResponseBuilder(JaxrsException exception)	Convert the given JaxrsException to a JSON response builder.
static Map<String,Object>	buildResponseEntity(JaxrsException exception)	Convert the given JaxrsException to a map that can be used as a JSON response entity.
static JaxrsException	toJaxrsException(int status, Map<String,Object> entity)	Convert the given HTTP status code and an entity into a JaxrsException.
static JaxrsException	toJaxrsException(jakarta.ws.rs.core.Response response)	Convert the given Response to a JaxrsException.
jakarta.ws.rs.core.Response	toResponse(JaxrsException exception)	Convert the given JaxrsException to a response containing a JSON entity.

Methods inherited from class java.lang.Object

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

Field Details

KEY_ERRORS

public static final String KEY_ERRORS

The map key under which the list of ErrorMessage objects resides.

See Also:

• Constant Field Values

Constructor Details

JaxrsExceptionMapper

public JaxrsExceptionMapper()

Method Details

toResponse

public jakarta.ws.rs.core.Response toResponse(JaxrsException exception)

Convert the given JaxrsException to a response containing a JSON entity.

Specified by:

toResponse in interface jakarta.ws.rs.ext.ExceptionMapper<JaxrsException>

Parameters:

exception - the exception to convert

Returns:

a response

See Also:

• buildResponse(JaxrsException)

buildResponse

public static jakarta.ws.rs.core.Response buildResponse(JaxrsException exception)

Convert the given JaxrsException to a JSON response.

The response entity contains the information in the JaxrsException.

Parameters:

exception - the exception to convert

Returns:

a response

See Also:

• buildResponseEntity(JaxrsException)

buildResponseBuilder

public static jakarta.ws.rs.core.Response.ResponseBuilder buildResponseBuilder(JaxrsException exception)

Convert the given JaxrsException to a JSON response builder.

The response entity contains the information in the JaxrsException.

Parameters:

exception - the exception to convert

Returns:

a response builder

See Also:

• buildResponseEntity(JaxrsException)

buildResponseEntity

public static Map<String,Object> buildResponseEntity(JaxrsException exception)

Convert the given JaxrsException to a map that can be used as a JSON response entity.

The response entity will contain an "errors" key containing the ErrorMessage objects. If the exception contains any other data (JaxrsException.getOtherData()), those key/value pairs are also included in the response entity. See the note in JaxrsException.setOtherData(Map) regarding the behavior if otherData contains an "errors" key.

Parameters:

exception - the exception to convert

Returns:

a map that can be used as a response entity

See Also:

• JaxrsException.getOtherData()
• JaxrsException.setOtherData(Map)

toJaxrsException

public static JaxrsException toJaxrsException(jakarta.ws.rs.core.Response response)

Convert the given Response to a JaxrsException.

Attempts to convert a response entity into errors and other data in the resulting exception using toJaxrsException(int, Map).

Parameters:

response - the response to convert

Returns:

a new exception instance, or null if the response is null

See Also:

• toJaxrsException(int, Map)

toJaxrsException

public static JaxrsException toJaxrsException(int status,
 Map<String,Object> entity)

Convert the given HTTP status code and an entity into a JaxrsException.

Looks for an entry with key "errors" and a list of objects, and attempts to convert them into ErrorMessage objects. The conversion from a generic map to an ErrorMessage is done using ErrorMessage.valueOf(Map).

Any other entries in the map are converted to "other data" in the exception.

Parameters:

status - the HTTP status

entity - the entity as a map

Returns:

a new exception instance

See Also:

• JaxrsException.setErrors(List)
• JaxrsException.setOtherData(Map)