Class ExceptionHandlerWrapper
- All Implemented Interfaces:
FacesListener
,SystemEventListener
,FacesWrapper<ExceptionHandler>
,EventListener
- Direct Known Subclasses:
AjaxExceptionHandlerImpl
,AjaxNoAjaxExceptionHandler
Provides a simple implementation of ExceptionHandler
that can be
subclassed by developers wishing to provide specialized behavior to an existing ExceptionHandler
instance.
The default implementation of all methods is to call through to the wrapped ExceptionHandler
instance.
Usage: extend this class and push the implementation being wrapped to the constructor and use getWrapped()
to
access the instance being wrapped.
- Since:
- 2.0
-
Constructor Summary
ConstructorDescriptionDeprecated.Use the other constructor taking the implementation being wrapped.ExceptionHandlerWrapper
(ExceptionHandler wrapped) If this exception handler has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. -
Method Summary
Modifier and TypeMethodDescriptionThe default behavior of this method is to callExceptionHandler.getHandledExceptionQueuedEvent()
on the wrappedExceptionHandler
object.The default behavior of this method is to callExceptionHandler.getHandledExceptionQueuedEvents()
on the wrappedExceptionHandler
object.The default behavior of this method is to callExceptionHandler.getRootCause(Throwable)
on the wrappedExceptionHandler
object.The default behavior of this method is to callExceptionHandler.getUnhandledExceptionQueuedEvents()
on the wrappedExceptionHandler
object.A class that implements this interface uses this method to return an instance of the class being wrapped.void
handle()
The default behavior of this method is to callExceptionHandler.handle()
on the wrappedExceptionHandler
object.boolean
isListenerForSource
(Object source) The default behavior of this method is to callExceptionHandler.isListenerForSource(Object)
on the wrappedExceptionHandler
object.void
processEvent
(SystemEvent event) The default behavior of this method is to callExceptionHandler.processEvent(jakarta.faces.event.SystemEvent)
on the wrappedExceptionHandler
object.
-
Constructor Details
-
ExceptionHandlerWrapper
Deprecated.Use the other constructor taking the implementation being wrapped. -
ExceptionHandlerWrapper
If this exception handler has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. The
getWrapped()
will then return the implementation being wrapped.- Parameters:
wrapped
- The implementation being wrapped.- Since:
- 2.3
-
-
Method Details
-
getWrapped
Description copied from interface:FacesWrapper
A class that implements this interface uses this method to return an instance of the class being wrapped.
- Specified by:
getWrapped
in interfaceFacesWrapper<ExceptionHandler>
- Returns:
- the wrapped instance.
-
getHandledExceptionQueuedEvent
The default behavior of this method is to call
ExceptionHandler.getHandledExceptionQueuedEvent()
on the wrappedExceptionHandler
object.- Specified by:
getHandledExceptionQueuedEvent
in classExceptionHandler
- Returns:
- instance of
ExceptionQueuedEvent
. - See Also:
-
handle
The default behavior of this method is to call
ExceptionHandler.handle()
on the wrappedExceptionHandler
object.- Specified by:
handle
in classExceptionHandler
- Throws:
FacesException
- if and only if a problem occurs while performing the algorithm to handle theException
, not as a means of conveying a handledException
itself.- See Also:
-
isListenerForSource
The default behavior of this method is to call
ExceptionHandler.isListenerForSource(Object)
on the wrappedExceptionHandler
object.- Specified by:
isListenerForSource
in interfaceSystemEventListener
- Specified by:
isListenerForSource
in classExceptionHandler
- Parameters:
source
- the source that is inquiring about the appropriateness of sending an event to this listener instance.- Returns:
- the value as specified above
- See Also:
-
processEvent
The default behavior of this method is to call
ExceptionHandler.processEvent(jakarta.faces.event.SystemEvent)
on the wrappedExceptionHandler
object.- Specified by:
processEvent
in interfaceSystemEventListener
- Specified by:
processEvent
in classExceptionHandler
- Parameters:
event
- theSystemEvent
instance that is being processed.- Throws:
AbortProcessingException
- if lifecycle processing should cease for this request.- See Also:
-
getRootCause
The default behavior of this method is to call
ExceptionHandler.getRootCause(Throwable)
on the wrappedExceptionHandler
object.- Specified by:
getRootCause
in classExceptionHandler
- Parameters:
t
- passed-in wrappedThrowable
.- Returns:
- unwrapped object.
- See Also:
-
getHandledExceptionQueuedEvents
The default behavior of this method is to call
ExceptionHandler.getHandledExceptionQueuedEvents()
on the wrappedExceptionHandler
object.- Specified by:
getHandledExceptionQueuedEvents
in classExceptionHandler
- Returns:
- an
Iterable
over allExceptionQueuedEvent
s. - See Also:
-
getUnhandledExceptionQueuedEvents
The default behavior of this method is to call
ExceptionHandler.getUnhandledExceptionQueuedEvents()
on the wrappedExceptionHandler
object.- Specified by:
getUnhandledExceptionQueuedEvents
in classExceptionHandler
- Returns:
- the unhandled set of
ExceptionQueuedEvent
s. - See Also:
-