KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > jcorporate > expresso > core > controller > TilesController


1 /* ====================================================================
2  * The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
3  *
4  * Copyright (c) 1995-2002 Jcorporate Ltd. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * 1. Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright
14  * notice, this list of conditions and the following disclaimer in
15  * the documentation and/or other materials provided with the
16  * distribution.
17  *
18  * 3. The end-user documentation included with the redistribution,
19  * if any, must include the following acknowledgment:
20  * "This product includes software developed by Jcorporate Ltd.
21  * (http://www.jcorporate.com/)."
22  * Alternately, this acknowledgment may appear in the software itself,
23  * if and wherever such third-party acknowledgments normally appear.
24  *
25  * 4. "Jcorporate" and product names such as "Expresso" must
26  * not be used to endorse or promote products derived from this
27  * software without prior written permission. For written permission,
28  * please contact info@jcorporate.com.
29  *
30  * 5. Products derived from this software may not be called "Expresso",
31  * or other Jcorporate product names; nor may "Expresso" or other
32  * Jcorporate product names appear in their name, without prior
33  * written permission of Jcorporate Ltd.
34  *
35  * 6. No product derived from this software may compete in the same
36  * market space, i.e. framework, without prior written permission
37  * of Jcorporate Ltd. For written permission, please contact
38  * partners@jcorporate.com.
39  *
40  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
41  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
42  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
43  * DISCLAIMED. IN NO EVENT SHALL JCORPORATE LTD OR ITS CONTRIBUTORS
44  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
45  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
46  * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
47  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
48  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
49  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
50  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  * ====================================================================
53  *
54  * This software consists of voluntary contributions made by many
55  * individuals on behalf of the Jcorporate Ltd. Contributions back
56  * to the project(s) are encouraged when you make modifications.
57  * Please send them to support@jcorporate.com. For more information
58  * on Jcorporate Ltd. and its products, please see
59  * <http://www.jcorporate.com/>.
60  *
61  * Portions of this software are based upon other open source
62  * products and are subject to their respective licenses.
63  */

64
65 package com.jcorporate.expresso.core.controller;
66
67 import com.jcorporate.expresso.core.ExpressoConstants;
68 import org.apache.struts.tiles.ComponentContext;
69 import org.apache.struts.tiles.Controller;
70
71 import javax.servlet.ServletContext JavaDoc;
72 import javax.servlet.ServletException JavaDoc;
73 import javax.servlet.http.HttpServletRequest JavaDoc;
74 import javax.servlet.http.HttpServletResponse JavaDoc;
75 import java.io.IOException JavaDoc;
76
77
78 /**
79  * Implementation of the org.apache.struts.tiles.Controller interface.
80  * This allows for manipulation of the ControllerResponse for a particular
81  * tile before it is displayed, independantly of the State currently being
82  * processed.
83  * Developers should extend this class and code the execute() method.
84  *
85  * @author Malcolm Wise
86  */

87 public abstract class TilesController
88         implements Controller {
89
90     /**
91      * Creates a new instance of TilesController
92      */

93     public TilesController() {
94     }
95
96     /**
97      * Implementation of perform() method. Obtains ControllerRequest and ControllerResponse
98      * from supplied HttpServletRequest and calls execute().
99      */

100     public final void perform(ComponentContext context, HttpServletRequest JavaDoc request,
101                               HttpServletResponse JavaDoc response, ServletContext JavaDoc servletContext)
102             throws ServletException JavaDoc, IOException JavaDoc {
103
104         ControllerResponse res = (ControllerResponse) request.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 JavaDoc(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, ControllerRequest request,
118                         ControllerResponse response, ServletContext JavaDoc servletContext)
119             throws ControllerException {
120
121     }
122
123 }
124
Popular Tags