001: /* ====================================================================
002: * The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
003: *
004: * Copyright (c) 1995-2002 Jcorporate Ltd. All rights reserved.
005: *
006: * Redistribution and use in source and binary forms, with or without
007: * modification, are permitted provided that the following conditions
008: * are met:
009: *
010: * 1. Redistributions of source code must retain the above copyright
011: * notice, this list of conditions and the following disclaimer.
012: *
013: * 2. Redistributions in binary form must reproduce the above copyright
014: * notice, this list of conditions and the following disclaimer in
015: * the documentation and/or other materials provided with the
016: * distribution.
017: *
018: * 3. The end-user documentation included with the redistribution,
019: * if any, must include the following acknowledgment:
020: * "This product includes software developed by Jcorporate Ltd.
021: * (http://www.jcorporate.com/)."
022: * Alternately, this acknowledgment may appear in the software itself,
023: * if and wherever such third-party acknowledgments normally appear.
024: *
025: * 4. "Jcorporate" and product names such as "Expresso" must
026: * not be used to endorse or promote products derived from this
027: * software without prior written permission. For written permission,
028: * please contact info@jcorporate.com.
029: *
030: * 5. Products derived from this software may not be called "Expresso",
031: * or other Jcorporate product names; nor may "Expresso" or other
032: * Jcorporate product names appear in their name, without prior
033: * written permission of Jcorporate Ltd.
034: *
035: * 6. No product derived from this software may compete in the same
036: * market space, i.e. framework, without prior written permission
037: * of Jcorporate Ltd. For written permission, please contact
038: * partners@jcorporate.com.
039: *
040: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
041: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
042: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
043: * DISCLAIMED. IN NO EVENT SHALL JCORPORATE LTD OR ITS CONTRIBUTORS
044: * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
045: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
046: * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
047: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
048: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
049: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
050: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
051: * SUCH DAMAGE.
052: * ====================================================================
053: *
054: * This software consists of voluntary contributions made by many
055: * individuals on behalf of the Jcorporate Ltd. Contributions back
056: * to the project(s) are encouraged when you make modifications.
057: * Please send them to support@jcorporate.com. For more information
058: * on Jcorporate Ltd. and its products, please see
059: * <http://www.jcorporate.com/>.
060: *
061: * Portions of this software are based upon other open source
062: * products and are subject to their respective licenses.
063: */
064:
065: package com.jcorporate.expresso.core.controller;
066:
067: import com.jcorporate.expresso.core.ExpressoConstants;
068: import org.apache.struts.tiles.ComponentContext;
069: import org.apache.struts.tiles.Controller;
070:
071: import javax.servlet.ServletContext;
072: import javax.servlet.ServletException;
073: import javax.servlet.http.HttpServletRequest;
074: import javax.servlet.http.HttpServletResponse;
075: import java.io.IOException;
076:
077: /**
078: * Implementation of the org.apache.struts.tiles.Controller interface.
079: * This allows for manipulation of the ControllerResponse for a particular
080: * tile before it is displayed, independantly of the State currently being
081: * processed.
082: * Developers should extend this class and code the execute() method.
083: *
084: * @author Malcolm Wise
085: */
086: public abstract class TilesController implements Controller {
087:
088: /**
089: * Creates a new instance of TilesController
090: */
091: public TilesController() {
092: }
093:
094: /**
095: * Implementation of perform() method. Obtains ControllerRequest and ControllerResponse
096: * from supplied HttpServletRequest and calls execute().
097: */
098: public final void perform(ComponentContext context,
099: HttpServletRequest request, HttpServletResponse response,
100: ServletContext servletContext) throws ServletException,
101: IOException {
102:
103: ControllerResponse res = (ControllerResponse) request
104: .getAttribute(ExpressoConstants.CONTROLLER_RESPONSE_KEY);
105: ControllerRequest req = (ControllerRequest) res.getRequest();
106: try {
107: execute(context, req, res, servletContext);
108: } catch (ControllerException ce) {
109: throw new ServletException(ce);
110: }
111: }
112:
113: /**
114: * This method will be called by the perform() method. Subclasses should
115: * contain code to set up data to be displayed by the corresponding tile
116: */
117: public void execute(ComponentContext context,
118: ControllerRequest request, ControllerResponse response,
119: ServletContext servletContext) throws ControllerException {
120:
121: }
122:
123: }
|