Class ExceptionHandlerWrapper
- java.lang.Object
-
- jakarta.faces.context.ExceptionHandler
-
- jakarta.faces.context.ExceptionHandlerWrapper
-
- All Implemented Interfaces:
FacesListener
,SystemEventListener
,FacesWrapper<ExceptionHandler>
,EventListener
public abstract class ExceptionHandlerWrapper extends ExceptionHandler implements FacesWrapper<ExceptionHandler>
Provides a simple implementation of
ExceptionHandler
that can be subclassed by developers wishing to provide specialized behavior to an existingExceptionHandler
instance. The default implementation of all methods is to call through to the wrappedExceptionHandler
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
Constructors Constructor Description ExceptionHandlerWrapper()
Deprecated.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
-
-
-
Constructor Detail
-
ExceptionHandlerWrapper
@Deprecated public ExceptionHandlerWrapper()
Deprecated.Use the other constructor taking the implementation being wrapped.
-
ExceptionHandlerWrapper
public ExceptionHandlerWrapper(ExceptionHandler wrapped)
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 Detail
-
getWrapped
public ExceptionHandler 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
public ExceptionQueuedEvent 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:
ExceptionHandler.getHandledExceptionQueuedEvent()
-
handle
public void handle() throws FacesException
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:
ExceptionHandler.handle()
-
isListenerForSource
public boolean isListenerForSource(Object source)
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
public void processEvent(SystemEvent event) throws AbortProcessingException
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:
ExceptionHandler.processEvent(jakarta.faces.event.SystemEvent)
-
getRootCause
public Throwable getRootCause(Throwable t)
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:
ExceptionHandler.getRootCause(Throwable)
-
getHandledExceptionQueuedEvents
public Iterable<ExceptionQueuedEvent> 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:
ExceptionHandler.getHandledExceptionQueuedEvents()
-
getUnhandledExceptionQueuedEvents
public Iterable<ExceptionQueuedEvent> 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:
ExceptionHandler.getUnhandledExceptionQueuedEvents()
-
-