[cvs] expresso/expresso-web/WEB-INF/src/com/jcorporate/expresso/core/controller TilesController.java

[JCorporate Ltd]

Update of /home/javacorp/.cvs/expresso/expresso/expresso-web/WEB-INF/src/com/jcorporate/expresso/core/controller
In directory jcorp2.servlets.net:/tmp/cvs-serv23876

Added Files:
	TilesController.java 
Log Message:
Expresso aware implementation of the org.apache.struts.tiles.Controller interface


--- NEW FILE: TilesController.java ---
/* ====================================================================
 * The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
 *
 * Copyright (c) 1995-2002 Jcorporate Ltd. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:
 *       "This product includes software developed by Jcorporate Ltd.
 *        (http://www.jcorporate.com/)."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. "Jcorporate" and product names such as "Expresso" must
 *    not be used to endorse or promote products derived from this
 *    software without prior written permission. For written permission,
 *    please contact info at jcorporate.com.
 *
 * 5. Products derived from this software may not be called "Expresso",
 *    or other Jcorporate product names; nor may "Expresso" or other
 *    Jcorporate product names appear in their name, without prior
 *    written permission of Jcorporate Ltd.
 *
 * 6. No product derived from this software may compete in the same
 *    market space, i.e. framework, without prior written permission
 *    of Jcorporate Ltd. For written permission, please contact
 *    partners at jcorporate.com.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL JCORPORATE LTD OR ITS CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Jcorporate Ltd. Contributions back
 * to the project(s) are encouraged when you make modifications.
 * Please send them to support at jcorporate.com. For more information
 * on Jcorporate Ltd. and its products, please see
 * <http://www.jcorporate.com/>.
 *
 * Portions of this software are based upon other open source
 * products and are subject to their respective licenses.
 */

package com.jcorporate.expresso.core.controller;

import java.io.IOException;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.ServletContext;
import javax.servlet.ServletException;

import org.apache.struts.tiles.Controller;
import org.apache.struts.tiles.ComponentContext;

import com.jcorporate.expresso.core.ExpressoConstants;
import com.jcorporate.expresso.core.controller.*;


/**
 * Implementation of the org.apache.struts.tiles.Controller interface.
 * This allows for manipulation of the ControllerResponse for a particular
 * tile before it is displayed, independantly of the State currently being
 * processed.
 * Developers should extend this class and code the execute() method.
 * @author  Malcolm Wise
 */
public abstract class TilesController
    implements Controller {

    /** Creates a new instance of TilesController */
    public TilesController() {
    }

    /**
     * Implementation of perform() method.  Obtains ControllerRequest and ControllerResponse
     * from supplied HttpServletRequest and calls execute().
     *
     */
    public final void perform(ComponentContext context, HttpServletRequest request,
        HttpServletResponse response, ServletContext servletContext)
        throws ServletException, IOException {

        ControllerResponse res = (ControllerResponse)request.getAttribute(
                ExpressoConstants.CONTROLLER_RESPONSE_KEY);
        ControllerRequest req = (ControllerRequest)res.getRequest();
        try {
            execute(context, req, res, servletContext);
        }
        catch (ControllerException ce) {
            throw new ServletException(ce);
        }
    }
    /**
     *  This method will be called by the perform() method.  Subclasses should
     *  contain code to set up data to be displayed by the corresponding tile
     *
     */
    public void execute(ComponentContext context, ControllerRequest request,
        ControllerResponse response, ServletContext servletContext)
        throws ControllerException {

    }

}