com.sun.faces.context

Class ExceptionHandlerImpl

java.lang.Object

jakarta.faces.context.ExceptionHandler

com.sun.faces.context.ExceptionHandlerImpl

All Implemented Interfaces:

FacesListener, SystemEventListener, EventListener

public class ExceptionHandlerImpl
extends ExceptionHandler

The default implementation of ExceptionHandler for Faces.

As an implementation note, if changes going forward are required here, review the ExceptionHandler implementation within jakarta.faces.webapp.PreJsf2ExceptionHandlerFactory. The code is, in most cases, quite similar.

Field Summary

Fields

Modifier and Type	Field and Description
static Level	INCIDENT_ERROR

Constructor Summary

Constructors

Constructor and Description
ExceptionHandlerImpl()
ExceptionHandlerImpl(boolean errorPagePresent)

Method Summary

Modifier and Type	Method and Description
ExceptionQueuedEvent	getHandledExceptionQueuedEvent() Return the first ExceptionQueuedEvent handled by this handler.
Iterable<ExceptionQueuedEvent>	getHandledExceptionQueuedEvents() The default implementation must return an Iterable over all ExceptionQueuedEvents that have been handled by the ExceptionHandler.handle() method.
Throwable	getRootCause(Throwable t) Unwrap the argument t until the unwrapping encounters an Object whose getClass() is not equal to FacesException.class or jakarta.el.ELException.class.
Iterable<ExceptionQueuedEvent>	getUnhandledExceptionQueuedEvents() Return an Iterable over all ExceptionQueuedEvents that have not yet been handled by the ExceptionHandler.handle() method.
void	handle() Take action to handle the Exception instances residing inside the ExceptionQueuedEvent instances that have been queued by calls to Application().publishEvent(ExceptionQueuedEvent.class, eventContext).
boolean	isListenerForSource(Object source) This method must return true if and only if this listener instance is interested in receiving events from the instance referenced by the source parameter.
void	processEvent(SystemEvent event) When called, the listener can assume that any guarantees given in the javadoc for the specific SystemEvent subclass are true.

Methods inherited from class java.lang.Object

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

Field Detail

INCIDENT_ERROR

public static final Level INCIDENT_ERROR

Constructor Detail

ExceptionHandlerImpl

public ExceptionHandlerImpl()

ExceptionHandlerImpl

public ExceptionHandlerImpl(boolean errorPagePresent)

Method Detail

getHandledExceptionQueuedEvent

public ExceptionQueuedEvent getHandledExceptionQueuedEvent()

Description copied from class: ExceptionHandler

Return the first ExceptionQueuedEvent handled by this handler.

Specified by:

getHandledExceptionQueuedEvent in class ExceptionHandler

Returns:

instance of ExceptionQueuedEvent.

handle

public void handle()
            throws FacesException

Description copied from class: ExceptionHandler

Take action to handle the Exception instances residing inside the ExceptionQueuedEvent instances that have been queued by calls to Application().publishEvent(ExceptionQueuedEvent.class, eventContext). The requirements of the default implementation are detailed in section 6.2.1 of the spec prose document.

Specified by:

handle in class ExceptionHandler

Throws:

FacesException - if and only if a problem occurs while performing the algorithm to handle the Exception, not as a means of conveying a handled Exception itself.

See Also:

ExceptionHandler.handle()

isListenerForSource

public boolean isListenerForSource(Object source)

Description copied from class: ExceptionHandler

This method must return true if and only if this listener instance is interested in receiving events from the instance referenced by the source parameter.

Specified by:

isListenerForSource in interface SystemEventListener

Specified by:

isListenerForSource in class ExceptionHandler

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:

ExceptionHandler.isListenerForSource(Object)

processEvent

public void processEvent(SystemEvent event)
                  throws AbortProcessingException

Description copied from class: ExceptionHandler

When called, the listener can assume that any guarantees given in the javadoc for the specific SystemEvent subclass are true.

Specified by:

processEvent in interface SystemEventListener

Specified by:

processEvent in class ExceptionHandler

Parameters:

event - the SystemEvent 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)

Description copied from class: ExceptionHandler

Unwrap the argument t until the unwrapping encounters an Object whose getClass() is not equal to FacesException.class or jakarta.el.ELException.class. If there is no root cause, null is returned.

Specified by:

getRootCause in class ExceptionHandler

Parameters:

t - passed-in wrapped Throwable.

Returns:

unwrapped object.

See Also:

ExceptionHandler.getRootCause(Throwable)

getUnhandledExceptionQueuedEvents

public Iterable<ExceptionQueuedEvent> getUnhandledExceptionQueuedEvents()

Description copied from class: ExceptionHandler

Return an Iterable over all ExceptionQueuedEvents that have not yet been handled by the ExceptionHandler.handle() method.

Specified by:

getUnhandledExceptionQueuedEvents in class ExceptionHandler

Returns:

the unhandled set of ExceptionQueuedEvents.

See Also:

ExceptionHandler.getUnhandledExceptionQueuedEvents()

getHandledExceptionQueuedEvents

public Iterable<ExceptionQueuedEvent> getHandledExceptionQueuedEvents()

Description copied from class: ExceptionHandler

The default implementation must return an Iterable over all ExceptionQueuedEvents that have been handled by the ExceptionHandler.handle() method.

Specified by:

getHandledExceptionQueuedEvents in class ExceptionHandler

Returns:

an Iterable over all ExceptionQueuedEvents.

See Also:

ExceptionHandler.getHandledExceptionQueuedEvents()