Top Description Methods
io.undertow.servlet.api

public Interface ExceptionHandler

Known Direct Implementers
io.undertow.servlet.api.LoggingExceptionHandler
Imports
jakarta.servlet.ServletRequest, .ServletResponse, io.undertow.server.HttpServerExchange

An exception handler allows you to perform custom actions when an exception propagates out of the servlet handler chain. The default handler will simply log the exception, however it is possible to write custom handlers to handle the error however you want. A common use for this would be to change the log format for exceptions, or possibly suppress the logging for certain exceptions types.

Implementations of this interface may also choose to suppress error page handler, and handle error page generation internally by returning true

Author
Stuart Douglas

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true true if the error was handled by this method
handleThrowable
(final HttpServerExchange
The exchange
exchange
,
ServletRequest
The request
request
,
ServletResponse
The response
response
,
Throwable
The exception
throwable
)

Handles an exception.

Method Detail

handleThrowableback to summary
public boolean handleThrowable(final HttpServerExchange exchange, ServletRequest request, ServletResponse response, Throwable throwable)

Handles an exception. If this method returns true then the request/response cycle is considered to be finished, and no further action will take place, if this returns false then standard error page redirect will take place. The default implementation of this simply logs the exception and returns false, allowing error page and async context error handling to proceed as normal.

Parameters
exchange:HttpServerExchange

The exchange

request:ServletRequest

The request

response:ServletResponse

The response

throwable:Throwable

The exception

Returns:boolean

true true if the error was handled by this method