Package net.shibboleth.shared.spring.error

Class ExtendedMappingExceptionResolver

java.lang.Object

org.springframework.web.servlet.handler.AbstractHandlerExceptionResolver

org.springframework.web.servlet.handler.SimpleMappingExceptionResolver

net.shibboleth.shared.spring.error.ExtendedMappingExceptionResolver

All Implemented Interfaces:

Ordered, HandlerExceptionResolver

public class ExtendedMappingExceptionResolver
extends SimpleMappingExceptionResolver

Custom Spring exception to view mapper that populates the view model with data obtained via an extension function.

As a default, the view model will include a reference to the active HttpServletRequest and the HTMLEncoder class.

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	MODEL_ATTR_ENCODER	Model attribute carrying the HTMLEncoder class.
private static final String	MODEL_ATTR_REQUEST	Model attribute carrying HttpServletRequest.
private static final String	MODEL_ATTR_RESPONSE	Model attribute carrying HttpServletResponse.
private static final String	MODEL_ATTR_SPRINGCONTEXT	Model attribute carrying WebApplicationContext.
private final Function<HttpServletRequest,Map<String,Object>>	viewModelExtenderFunction	Function to obtain extensions to view model.

Fields inherited from class org.springframework.web.servlet.handler.SimpleMappingExceptionResolver

DEFAULT_EXCEPTION_ATTRIBUTE

Fields inherited from class org.springframework.web.servlet.handler.AbstractHandlerExceptionResolver

logger

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
ExtendedMappingExceptionResolver()	Constructor.
ExtendedMappingExceptionResolver(Function<HttpServletRequest,Map<String,Object>> extender)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected ModelAndView	doResolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
protected ModelAndView	getModelAndView(String viewName, Exception ex, HttpServletRequest request)

Methods inherited from class org.springframework.web.servlet.handler.SimpleMappingExceptionResolver

addStatusCode, applyStatusCodeIfPossible, determineStatusCode, determineViewName, findMatchingViewName, getDepth, getModelAndView, getStatusCodesAsMap, setDefaultErrorView, setDefaultStatusCode, setExceptionAttribute, setExceptionMappings, setExcludedExceptions, setStatusCodes

Methods inherited from class org.springframework.web.servlet.handler.AbstractHandlerExceptionResolver

buildLogMessage, getOrder, hasHandlerMappings, logException, prepareResponse, preventCaching, resolveException, setMappedHandlerClasses, setMappedHandlers, setOrder, setPreventResponseCaching, setWarnLogCategory, shouldApplyTo

Methods inherited from class java.lang.Object

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

Field Details

MODEL_ATTR_REQUEST

@Nonnull
private static final String MODEL_ATTR_REQUEST

Model attribute carrying HttpServletRequest.

See Also:

• Constant Field Values

MODEL_ATTR_RESPONSE

@Nonnull
private static final String MODEL_ATTR_RESPONSE

Model attribute carrying HttpServletResponse.

See Also:

• Constant Field Values

MODEL_ATTR_SPRINGCONTEXT

@Nonnull
private static final String MODEL_ATTR_SPRINGCONTEXT

Model attribute carrying WebApplicationContext.

See Also:

• Constant Field Values

MODEL_ATTR_ENCODER

@Nonnull
private static final String MODEL_ATTR_ENCODER

Model attribute carrying the HTMLEncoder class.

See Also:

• Constant Field Values

viewModelExtenderFunction

@Nullable
private final Function<HttpServletRequest,Map<String,Object>> viewModelExtenderFunction

Function to obtain extensions to view model.

Constructor Details

ExtendedMappingExceptionResolver

public ExtendedMappingExceptionResolver()

Constructor.

ExtendedMappingExceptionResolver

public ExtendedMappingExceptionResolver(@Nullable
 Function<HttpServletRequest,Map<String,Object>> extender)

Constructor.

Parameters:

extender - function to obtain extensions to view model

Method Details

doResolveException

protected ModelAndView doResolveException(@Nonnull
 HttpServletRequest request,
 @Nonnull
 HttpServletResponse response,
 @Nullable
 Object handler,
 @Nonnull
 Exception ex)

Overrides:

doResolveException in class SimpleMappingExceptionResolver

getModelAndView

@Nonnull
protected ModelAndView getModelAndView(@Nonnull
 String viewName,
 @Nonnull
 Exception ex,
 @Nonnull
 HttpServletRequest request)

Overrides:

getModelAndView in class SimpleMappingExceptionResolver