abstractfacescontroller.java

Please read your package and describe it at least 40 bytes in English. System will automatically de

/*
 * Copyright 2002-2004 the original author or authors.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package de.mindmatters.faces.spring.context.servlet.controller;

import javax.faces.context.FacesContext;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.springframework.util.Assert;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.mvc.AbstractController;

/**
 * <strong>AbstractController</strong> that exposes the current
 * {@link FacesContext} to the template method
 * {@link #handleRequestInternal(FacesContext, HttpServletRequest, HttpServletResponse)}.
 * 
 * @author Andreas Kuhrwahl
 * 
 */
public abstract class AbstractFacesController extends AbstractController {

    /**
     * Template method. Subclasses must implement this. The contract is the same
     * as for <code>handleRequest</code>.
     * 
     * @param context
     *            {@link FacesContext} for the current request
     * @param request
     *            current HTTP request
     * @param response
     *            current HTTP response
     * @return a ModelAndView to render, or <code>null</code> if handled
     *         directly
     * @throws Exception
     *             in case of errors
     * @see AbstractController#handleRequest(HttpServletRequest,
     *      HttpServletResponse)
     */
    protected abstract ModelAndView handleRequestInternal(
            final FacesContext context, final HttpServletRequest request,
            final HttpServletResponse response) throws Exception;

    /**
     * {@inheritDoc}
     */
    protected final ModelAndView handleRequestInternal(
            final HttpServletRequest request, final HttpServletResponse response)
            throws Exception {
        FacesContext context = FacesContext.getCurrentInstance();
        Assert.notNull(context);
        return handleRequestInternal(context, request, response);
    }

}