jakarta.faces.context.ExceptionHandlerFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jakarta.faces Show documentation
EE4J Compatible Implementation for Jakarta Faces API
The newest version!
/*
 * Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package jakarta.faces.context;

import jakarta.faces.FacesWrapper;

/**
 * 
 * ExceptionHandlerFactory is a factory object that creates (if needed)
 * and returns a new {@link ExceptionHandler} instance.
 * 
 *
 * 
 *
 * 
 * There must be one ExceptionHandlerFactory instance per web application that is utilizing Jakarta Server
 * Faces. This instance can be acquired, in a portable manner, by calling:
 * 
 *
 *  * 
 *   ExceptionHandlerFactory factory = (ExceptionHandlerFactory)
 *    FactoryFinder.getFactory(FactoryFinder.EXCEPTION_HANDLER_FACTORY);
 * 
 * 
 *
 *
 * 
 *
 * 
 * Usage: extend this class and push the implementation being wrapped to the constructor and use {@link #getWrapped} to
 * access the instance being wrapped.
 * 
 *
 * @since 2.0
 */

public abstract class ExceptionHandlerFactory implements FacesWrapper {

    private ExceptionHandlerFactory wrapped;

    /**
     * @deprecated Use the other constructor taking the implementation being wrapped.
     */
    @Deprecated
    public ExceptionHandlerFactory() {

    }

    /**
     * 
     * If this factory has been decorated, the implementation doing the decorating should push the implementation being
     * wrapped to this constructor. The {@link #getWrapped()} will then return the implementation being wrapped.
     * 
     *
     * @param wrapped The implementation being wrapped.
     */
    public ExceptionHandlerFactory(ExceptionHandlerFactory wrapped) {
        this.wrapped = wrapped;
    }

    /**
     * 
     * If this factory has been decorated, the implementation doing the decorating may override this method to provide
     * access to the implementation being wrapped.
     * 
     */
    @Override
    public ExceptionHandlerFactory getWrapped() {
        return wrapped;
    }

    /**
     * 
     * Create and return a A new ExceptionHandler instance. The implementation must return an
     * ExceptionHandler instance suitable for the environment. For example, in some cases it may be desirable
     * for an ExceptionHandler to write error information to the response instead of throwing exceptions as in
     * the case of Ajax applications.
     * 
     *
     * @return newly created ExceptionHandler.
     *
     */
    public abstract ExceptionHandler getExceptionHandler();

}