All Downloads are FREE. Search and download functionalities are using the official Maven repository.

javax.faces.lifecycle.Lifecycle Maven / Gradle / Ivy

Go to download

This is the master POM file for Oracle's Implementation of the JSF 2.3 Specification.

There is a newer version: 2.3-pfd
Show newest version
/*
 * 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.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.lifecycle;

import javax.faces.FacesException;
import javax.faces.context.FacesContext;
import javax.faces.event.PhaseListener;


/**
 * 

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 {@link 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 {@link PhaseListener} instance that is interested in * being notified before and after the processing for standard phases of * the request processing lifecycle.

* * @param listener The {@link PhaseListener} to be registered * * @throws 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 {@link FacesContext} instance associated with * the current request.

* * @param context FacesContext for the request to be processed * * @throws FacesException if thrown during the execution of the * request processing lifecycle * @throws NullPointerException if context * is null */ public abstract void execute(FacesContext context) throws FacesException; /** *

Create or restore the {@link * ClientWindow} to be used to display the {@link * javax.faces.component.UIViewRoot} for this run through the * lifecycle. See the class documentation for {@link ClientWindow} * for an overview of the feature. * * If {@link javax.faces.context.ExternalContext#getClientWindow()} returns * null, create a new instance of ClientWindow using the * {@link ClientWindowFactory}. If the result is non-null, call * {@link ClientWindow#decode(javax.faces.context.FacesContext)} on it. * Store the new ClientWindow by calling * {@link javax.faces.context.ExternalContext#setClientWindow(javax.faces.lifecycle.ClientWindow)}.

* * @param context the {@link FacesContext} for this request. * * @since 2.2 */ public void attachWindow(FacesContext context) { } /** *

Return the set of registered {@link PhaseListener}s for this * {@link Lifecycle} instance. If there are no registered listeners, * a zero-length array is returned.

* * @return the set of registered {@link PhaseListener}s */ public abstract PhaseListener[] getPhaseListeners(); /** *

Deregister an existing {@link 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.

* * @param listener The {@link PhaseListener} to be deregistered * @throws 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 {@link FacesContext} instance * associated with the current request.

* * @param context FacesContext for the request being processed * * @throws FacesException if an exception is thrown during the execution * of the request processing lifecycle * @throws NullPointerException if context * is null */ public abstract void render(FacesContext context) throws FacesException; }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy