Package org.nuxeo.ecm.platform.web.common.exceptionhandling

Class DefaultNuxeoExceptionHandler

java.lang.Object

org.nuxeo.ecm.platform.web.common.exceptionhandling.DefaultNuxeoExceptionHandler

All Implemented Interfaces:

NuxeoExceptionHandler

Direct Known Subclasses:

SecurityExceptionHandler, ShibbolethSecurityExceptionHandler

public class DefaultNuxeoExceptionHandler
extends Object
implements NuxeoExceptionHandler

Author:

arussel

Field Summary

Fields

Modifier and Type	Field	Description
protected static final com.fasterxml.jackson.databind.ObjectMapper	MAPPER
protected NuxeoExceptionHandlerParameters	parameters

Fields inherited from interface org.nuxeo.ecm.platform.web.common.exceptionhandling.NuxeoExceptionHandler

EXCEPTION_HANDLER_MARKER

Constructor Summary

Constructors

Constructor	Description
DefaultNuxeoExceptionHandler()

Method Summary

Modifier and Type	Method	Description
protected String	getExceptionMessage(String message, int status)
protected ErrorHandler	getHandler(Throwable t)
String	getLoginURL(jakarta.servlet.http.HttpServletRequest request)	Gets the URL to redirect to when a login is needed for an Anonymous user.
protected Principal	getPrincipal(jakarta.servlet.http.HttpServletRequest request)
boolean	handleAnonymousException(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)	Handles the Security Error when the user is anonymous.
void	handleException(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, Throwable t)
void	setParameters(NuxeoExceptionHandlerParameters parameters)
protected void	startHandlingException(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, Throwable t)	Puts a marker in request to avoid looping over the exception handling mechanism
protected void	writeExceptionAsJson(jakarta.servlet.http.HttpServletResponse response, int status, Throwable e)

Methods inherited from class java.lang.Object

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

Field Details

MAPPER

protected static final com.fasterxml.jackson.databind.ObjectMapper MAPPER

parameters

protected NuxeoExceptionHandlerParameters parameters

Constructor Details

DefaultNuxeoExceptionHandler

public DefaultNuxeoExceptionHandler()

Method Details

setParameters

public void setParameters(NuxeoExceptionHandlerParameters parameters)

Specified by:

setParameters in interface NuxeoExceptionHandler

startHandlingException

protected void startHandlingException(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 Throwable t)
                               throws jakarta.servlet.ServletException

Puts a marker in request to avoid looping over the exception handling mechanism

Throws:

jakarta.servlet.ServletException - if request has already been marked as handled. The initial exception is then wrapped.

handleException

public void handleException(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 Throwable t)
                     throws IOException,
jakarta.servlet.ServletException

Specified by:

handleException in interface NuxeoExceptionHandler

Throws:

IOException

jakarta.servlet.ServletException

handleAnonymousException

public boolean handleAnonymousException(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)
                                 throws IOException,
jakarta.servlet.ServletException

Description copied from interface: NuxeoExceptionHandler

Handles the Security Error when the user is anonymous.

Specified by:

handleAnonymousException in interface NuxeoExceptionHandler

Returns:

true if the Security Error is handled so that the calling method won't fallback on the default handler, false otherwise.

Throws:

IOException

jakarta.servlet.ServletException

getLoginURL

public String getLoginURL(jakarta.servlet.http.HttpServletRequest request)

Description copied from interface: NuxeoExceptionHandler

Gets the URL to redirect to when a login is needed for an Anonymous user.

Specified by:

getLoginURL in interface NuxeoExceptionHandler

getHandler

protected ErrorHandler getHandler(Throwable t)

getPrincipal

protected Principal getPrincipal(jakarta.servlet.http.HttpServletRequest request)

writeExceptionAsJson

protected void writeExceptionAsJson(jakarta.servlet.http.HttpServletResponse response,
 int status,
 Throwable e)
                             throws IOException

Throws:

IOException

getExceptionMessage

protected String getExceptionMessage(String message,
 int status)