Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
   *
   * Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
   *
   * The contents of this file are subject to the terms of either the GNU
   * General Public License Version 2 only ("GPL") or the Common Development
   * and Distribution License("CDDL") (collectively, the "License").  You
   * may not use this file except in compliance with the License.  You can
  * obtain a copy of the License at
  * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
  * or packager/legal/LICENSE.txt.  See the License for the specific
  * language governing permissions and limitations under the License.
  *
  * When distributing the software, include this License Header Notice in each
  * file and include the License file at packager/legal/LICENSE.txt.
  *
  * GPL Classpath Exception:
  * Oracle designates this particular file as subject to the "Classpath"
  * exception as provided by Oracle in the GPL Version 2 section of the License
  * file that accompanied this code.
  *
  * Modifications:
  * If applicable, add the following below the License Header, with the fields
  * enclosed by brackets [] replaced by your own identifying information:
  * "Portions Copyright [year] [name of copyright owner]"
  *
  * Contributor(s):
  * If you wish your version of this file to be governed by only the CDDL or
  * only the GPL Version 2, indicate your decision by adding "[Contributor]
  * elects to include this software in this distribution under the [CDDL or GPL
  * Version 2] license."  If you don't indicate a single choice of license, a
  * recipient has the option to distribute your version of this file under
  * either the CDDL, the GPL Version 2 or to extend the choice of license to
  * its licensees as provided above.  However, if you add GPL Version 2 code
  * and therefore, elected the GPL Version 2 license, then the option applies
  * only if the new code is made subject to such option by the copyright
  * holder.
  */
 
 package javax.faces.context;
 

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 javax.faces.event.ExceptionQueuedEvent that wraps the Exception.

    This approach requires manually publishing the javax.faces.event.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
public abstract class ExceptionHandler implements SystemEventListener {

   

Take action to handle the Exception instances residing inside the javax.faces.event.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:
javax.faces.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
    public abstract void handle() throws FacesException;


    

Return the first ExceptionQueuedEvent handled by this handler.

    public abstract ExceptionQueuedEvent getHandledExceptionQueuedEvent();


    

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

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

    public abstract void processEvent(SystemEvent exceptionQueuedEventthrows AbortProcessingException;


    
    public abstract boolean isListenerForSource(Object source);

    
    

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:
java.lang.NullPointerException if argument t is null.
Since:
2.0
    public abstract Throwable getRootCause(Throwable t);
New to GrepCode? Check out our FAQ X