javax.faces.context

Class ExceptionHandler

Table des matières
  • All Implemented Interfaces:
    EventListener, FacesListener, SystemEventListener
    Direct Known Subclasses:
    ExceptionHandlerWrapper

    public abstract class ExceptionHandler
extends Object
implements SystemEventListener

    ExceptionHandler is the central point for handling unexpected Exceptions that are thrown during the Faces lifecycle. The ExceptionHandler must not be notified of any Exceptions that occur during application startup or shutdown.

    See the specification prose document for the requirements for the default implementation. Exceptions may be passed to the ExceptionHandler in one of two ways:

    • by ensuring that Exceptions are not caught, or are caught and re-thrown.

      This approach allows the ExceptionHandler facility specified in section JSF.6.2 to operate on the Exception.

    • By using the system event facility to publish an ExceptionQueuedEvent that wraps the Exception.

      This approach requires manually publishing the ExceptionQueuedEvent, but allows more information about the Exceptionto be stored in the event. The following code is an example of how to do this.

      

 //...
 } catch (Exception e) {
   FacesContext ctx = FacesContext.getCurrentInstance();
   ExceptionQueuedEventContext eventContext = new ExceptionQueuedEventContext(ctx, e);
   eventContext.getAttributes().put("key", "value");
   ctx.getApplication().publishEvent(ExceptionQueuedEvent.class, eventContext);
 }

      Because the Exception must not be re-thrown when using this approach, lifecycle processing may continue as normal, allowing more Exceptions to be published if necessary.

    With either approach, any ExceptionQueuedEvent instances that are published in this way are accessible to the handle() method, which is called at the end of each lifecycle phase, as specified in section JSF.6.2.

    Instances of this class are request scoped and are created by virtue of FacesContextFactory.getFacesContext(java.lang.Object, java.lang.Object, java.lang.Object, javax.faces.lifecycle.Lifecycle) calling ExceptionHandlerFactory.getExceptionHandler().

    Since:
    2.0

    • Constructor Detail

      • ExceptionHandler

        public ExceptionHandler()

    • Method Detail

      • handle

        public abstract void handle()
                     throws FacesException

        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 JSF.6.2.1.

        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.
        Since:
        2.0

      • getHandledExceptionQueuedEvent

        public abstract ExceptionQueuedEvent getHandledExceptionQueuedEvent()

        Return the first ExceptionQueuedEvent handled by this handler.

      • getUnhandledExceptionQueuedEvents

        public abstract Iterable<ExceptionQueuedEvent> getUnhandledExceptionQueuedEvents()

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

      • getHandledExceptionQueuedEvents

        public abstract Iterable<ExceptionQueuedEvent> getHandledExceptionQueuedEvents()

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

      • isListenerForSource

        public abstract 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.

        Specified by:
        isListenerForSource in interface SystemEventListener
        Parameters:
        source - the source that is inquiring about the appropriateness of sending an event to this listener instance.

      • getRootCause

        public abstract Throwable getRootCause(Throwable t)

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

        Throws:
        NullPointerException - if argument t is null.
        Since:
        2.0

Traduction non disponible

Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.

Version en cache

21/08/2025 17:18:12 Cette version de la page est en cache (à la date du 21/08/2025 17:18:12) afin d'accélérer le traitement.
Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la version plus récente de la page.

Document créé le 11/06/2005, dernière modification le 18/08/2025
Source du document imprimé : https://www.gaudry.be/java-api-javaee-rf-javax/faces/context/exceptionhandler.html

L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.

Références

  1. Consulter le document html Langue du document :fr Manuel PHP : https://docs.oracle.com

Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.