1   /*
    2    * $Id: PhaseListener.java,v 1.6 2007/04/27 22:00:09 ofung Exp $
    3    */
    4   
    5   /*
    6    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
    7    * 
    8    * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
    9    * 
   10    * The contents of this file are subject to the terms of either the GNU
   11    * General Public License Version 2 only ("GPL") or the Common Development
   12    * and Distribution License("CDDL") (collectively, the "License").  You
   13    * may not use this file except in compliance with the License. You can obtain
   14    * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
   15    * or glassfish/bootstrap/legal/LICENSE.txt.  See the License for the specific
   16    * language governing permissions and limitations under the License.
   17    * 
   18    * When distributing the software, include this License Header Notice in each
   19    * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
   20    * Sun designates this particular file as subject to the "Classpath" exception
   21    * as provided by Sun in the GPL Version 2 section of the License file that
   22    * accompanied this code.  If applicable, add the following below the License
   23    * Header, with the fields enclosed by brackets [] replaced by your own
   24    * identifying information: "Portions Copyrighted [year]
   25    * [name of copyright owner]"
   26    * 
   27    * Contributor(s):
   28    * 
   29    * If you wish your version of this file to be governed by only the CDDL or
   30    * only the GPL Version 2, indicate your decision by adding "[Contributor]
   31    * elects to include this software in this distribution under the [CDDL or GPL
   32    * Version 2] license."  If you don't indicate a single choice of license, a
   33    * recipient has the option to distribute your version of this file under
   34    * either the CDDL, the GPL Version 2 or to extend the choice of license to
   35    * its licensees as provided above.  However, if you add GPL Version 2 code
   36    * and therefore, elected the GPL Version 2 license, then the option applies
   37    * only if the new code is made subject to such option by the copyright
   38    * holder.
   39    */
   40   
   41   package javax.faces.event;
   42   
   43   
   44   import java.io.Serializable;
   45   import java.util.EventListener;
   46   
   47   
   48   /**
   49    * <p>An interface implemented by objects that wish to be notified at
   50    * the beginning and ending of processing for each standard phase of the
   51    * request processing lifecycle.</p>
   52    */
   53   
   54   public interface PhaseListener extends EventListener, Serializable {
   55   
   56   
   57       /**
   58        * <p>Handle a notification that the processing for a particular
   59        * phase has just been completed.</p>
   60        */
   61       public void afterPhase(PhaseEvent event);
   62   
   63   
   64       /**
   65        * <p>Handle a notification that the processing for a particular
   66        * phase of the request processing lifecycle is about to begin.</p>
   67        */
   68       public void beforePhase(PhaseEvent event);
   69   
   70   
   71       /**
   72        * <p>Return the identifier of the request processing phase during
   73        * which this listener is interested in processing {@link PhaseEvent}
   74        * events.  Legal values are the singleton instances defined by the
   75        * {@link PhaseId} class, including <code>PhaseId.ANY_PHASE</code>
   76        * to indicate an interest in being notified for all standard phases.</p>
   77        */
   78       public PhaseId getPhaseId();
   79   
   80   
   81   }