org.glassfish.jersey.server.mvc.spi

Class AbstractErrorTemplateMapper<T extends Throwable>

java.lang.Object

org.glassfish.jersey.server.mvc.spi.AbstractErrorTemplateMapper<T>

Type Parameters:

T - A type of the exception processed by the exception mapper.

All Implemented Interfaces:

javax.ws.rs.ext.ExceptionMapper<T>, ExtendedExceptionMapper<T>

@Singleton
public abstract class AbstractErrorTemplateMapper<T extends Throwable>
extends Object
implements ExtendedExceptionMapper<T>

Default implementation of ExtendedExceptionMapper used to declare special handling for exception types that should be processed by MVC.

Extensions should override getErrorStatus(Throwable) and getErrorModel(Throwable) to provide a response status and model derived from a raised throwable.

By default every exception is mapped and used as a model in a viewable and passed to the MVC runtime for further processing.

Since:

2.3

Author:

Michal Gajdos

Constructor Summary

Constructors

Constructor and Description
AbstractErrorTemplateMapper()

Method Summary

Modifier and Type	Method and Description
protected Object	getErrorModel(T throwable) Get a model for error template.
protected javax.ws.rs.core.Response.Status	getErrorStatus(T throwable) Get a response status of to-be-processed error template.
boolean	isMappable(T throwable) Determine whether this provider is able to process a supplied exception instance.
javax.ws.rs.core.Response	toResponse(T throwable)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractErrorTemplateMapper

public AbstractErrorTemplateMapper()

Method Detail

isMappable

public final boolean isMappable(T throwable)

Description copied from interface: ExtendedExceptionMapper

Determine whether this provider is able to process a supplied exception instance.

This method is called only on those exception mapping providers that are able to process the type of the exception as defined by the JAX-RS ExceptionMapper contract. By returning false this method can reject any given exception instance and change the default JAX-RS exception mapper selection behaviour.

Specified by:

isMappable in interface ExtendedExceptionMapper<T extends Throwable>

Parameters:

throwable - exception instance which should be processed.

Returns:

true if the mapper is able to map the particular exception instance, false otherwise.

toResponse

public final javax.ws.rs.core.Response toResponse(T throwable)

Specified by:

toResponse in interface javax.ws.rs.ext.ExceptionMapper<T extends Throwable>

getErrorModel

protected Object getErrorModel(T throwable)

Get a model for error template. Default value is the throwable itself.

Parameters:

throwable - throwable raised during processing a resource method.

Returns:

a model for error template.

getErrorStatus

protected javax.ws.rs.core.Response.Status getErrorStatus(T throwable)

Get a response status of to-be-processed error template. Default value is Response.Status#OK.

Parameters:

throwable - throwable raised during processing a resource method.

Returns:

response status of error response.