com.sun.faces.config.processor.ConfigProcessor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of javax.faces Show documentation
This is the master POM file for Oracle's Implementation of the JSF 2.2 Specification.
There is a newer version: 2.4.0
/*
 * 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 com.sun.faces.config.processor;

import com.sun.faces.config.DocumentInfo;

import javax.servlet.ServletContext;

/**
 * 
 *  This interface provides a CoR structure for processing JSF configuration
 *  resources.
 * 
 */
public interface ConfigProcessor {

    /**
     * 
     *   Set the next ConfigProcessor to be invoked once
     *   {@link ConfigProcessor#process(javax.servlet.ServletContext,com.sun.faces.config.DocumentInfo[])}
     *   has completed.
     * 
     *
     * @param nextProcessor the next processor in the chain to be invoked
     */
    public void setNext(ConfigProcessor nextProcessor);

    /**
     * Return the next config processor in the chain, or null.
     * 
     */
    public ConfigProcessor getNext();
    
    /*
     * Called to initialize the per-application metadata used by the ConfigProcessor
     */
    
    public void initializeClassMetadataMap(ServletContext sc);

    /**
     * 
     *  Process the array of Documents.
     * 
     *
     * @param sc the ServletContext for the application being configured
     * @param documentInfos  @throws Exception if an error occurs during processing
     */
    public void process(ServletContext sc, DocumentInfo[] documentInfos)
    throws Exception;

    public void destroy(ServletContext sc);
    
    /**
     * 
     *  Invoke the ConfigProcess specified by
     *  a call to {@link ConfigProcessor#setNext(ConfigProcessor)}, if any.
     * 
     * @param sc the ServletContext for the application being configured
     * @param documentInfos  @throws Exception if an error occurs invoking the next processor
     */
    public void invokeNext(ServletContext sc, DocumentInfo[] documentInfos)
    throws Exception;
    
    public void destroyNext(ServletContext sc);

}