Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * $Id: Lifecycle.java,v 1.32 2007/04/27 22:00:09 ofung Exp $
   */
  
  /*
   * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
   * 
   * Copyright 1997-2007 Sun Microsystems, Inc. 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.html
  * or glassfish/bootstrap/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 glassfish/bootstrap/legal/LICENSE.txt.
  * Sun designates this particular file as subject to the "Classpath" exception
  * as provided by Sun in the GPL Version 2 section of the License file that
  * accompanied this code.  If applicable, add the following below the License
  * Header, with the fields enclosed by brackets [] replaced by your own
  * identifying information: "Portions Copyrighted [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.lifecycle;
 

Lifecycle manages the processing of the entire lifecycle of a particular JavaServer Faces request. It is responsible for executing all of the phases that have been defined by the JavaServer Faces Specification, in the specified order, unless otherwise directed by activities that occurred during the execution of each phase.

An instance of Lifecycle is created by calling the getLifecycle() method of LifecycleFactory, for a specified lifecycle identifier. Because this instance is shared across multiple simultaneous requests, it must be implemented in a thread-safe manner.

 
 
 public abstract class Lifecycle {
 
 
     // ---------------------------------------------------------- Public Methods
 

    

Register a new javax.faces.event.PhaseListener instance that is interested in being notified before and after the processing for standard phases of the request processing lifecycle.

Parameters:
listener The javax.faces.event.PhaseListener to be registered
Throws:
java.lang.NullPointerException if listener is null
 
     public abstract void addPhaseListener(PhaseListener listener);


    

Execute all of the phases of the request processing lifecycle, up to but not including the Render Response phase, as described in the JavaServer Faces Specification, in the specified order. The processing flow can be affected (by the application, by components, or by event listeners) by calls to the renderResponse() or responseComplete() methods of the javax.faces.context.FacesContext instance associated with the current request.

Parameters:
context FacesContext for the request to be processed
Throws:
javax.faces.FacesException if thrown during the execution of the request processing lifecycle
java.lang.NullPointerException if context is null
 
     public abstract void execute(FacesContext contextthrows FacesException;


    

Return the set of registered javax.faces.event.PhaseListeners for this Lifecycle instance. If there are no registered listeners, a zero-length array is returned.

    public abstract PhaseListener[] getPhaseListeners();


    

Deregister an existing javax.faces.event.PhaseListener instance that is no longer interested in being notified before and after the processing for standard phases of the request processing lifecycle. If no such listener instance has been registered, no action is taken.

Parameters:
listener The javax.faces.event.PhaseListener to be deregistered
Throws:
java.lang.NullPointerException if listener is null
    public abstract void removePhaseListener(PhaseListener listener);


    

Execute the Render Response phase of the request processing lifecycle, unless the responseComplete() method has been called on the javax.faces.context.FacesContext instance associated with the current request.

Parameters:
context FacesContext for the request being processed
Throws:
javax.faces.FacesException if an exception is thrown during the execution of the request processing lifecycle
java.lang.NullPointerException if context is null
    public abstract void render(FacesContext contextthrows FacesException;
New to GrepCode? Check out our FAQ X