KickJava   Java API By Example, From Geeks To Geeks.

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


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 /**
68  * Title: Expresso Framework
69  * Description: The Expresso Web Application Framework
70  * Copyright: Copyright (c) 2001-2002
71  * Company: JCorporate
72  * @author Michael Rimov
73  */
74
75 /**
76  * Abstract interface for creating a controller. Some situations need to
77  * cache the resulting controller. Some situations just need to create it
78  * and run. Some need to merge with Struts. This is the interface that
79  * ties it all in.
80  */
81 public interface ControllerFactory {
82     /**
83      * Dumb construction method.... just tries to create the controller. This
84      * may have the limitation if there's more that one ActionServlet running
85      * around that the object cache gets sent to the wrong ActionServlet resulting
86      * in extra object contructions.
87      * <p><font color="red">Additional notes by Peter Pilgrim Sun Feb 16 13:53:07 GMT 2003</font></p>
88      * <p/>
89      * <p/>
90      * Struts 1.1 introduces the concept of <em>Modules</em> to
91      * further complicate the idea of instantiating an action
92      * controller. It is assume that this method retrieve a controller
93      * from the default root module.
94      * </p>
95      *
96      * @param className The className to instantiate
97      * @return a constructed controller
98      * @throws ControllerException if there's an error instantiating the
99      * controller
100      */
101     public Controller getController(String JavaDoc className)
102             throws ControllerException;
103
104     /**
105      * Dumb construction method.... just tries to create the controller. This
106      * may have the limitation if there's more that one ActionServlet running
107      * around that the object cache gets sent to the wrong ActionServlet resulting
108      * in extra object contructions.
109      * <p/>
110      * <p/>
111      * <p><font color="red">Additional notes by Peter Pilgrim Sun Feb 16 13:53:07 GMT 2003</font></p>
112      * <p/>
113      * <p/>
114      * Struts 1.1 introduces the concept of <em>Modules</em> to
115      * further complicate the idea of instantiating an action
116      * controller. It is assume that this method retrieve a controller
117      * specifically from the named module. If such an implementation
118      * aims to support modules. If not it can legally ignore the
119      * <code>module</mode> parameter
120      * </p>
121      *
122      * @param className The className to instantiate
123      * @param module The module to instantiate
124      * @return a constructed controller
125      * @throws ControllerException if there's an error instantiating the
126      * controller
127      */
128     public Controller getController(String JavaDoc module, String JavaDoc className)
129             throws ControllerException;
130
131     /**
132      * This method is similar to getController(className) except that it may try
133      * to route the construction call to the appropriate servlet constructor
134      * IF the request is a HttpServletControllerRequest AND the implementation
135      * chooses to accept this mission.
136      *
137      * @param request The ControllerRequest that has all the parameters we
138      * need to construct the appropriate controller.
139      * <p/>
140      * <p><font color="red">Additional notes by Peter Pilgrim Sun Feb 16 13:53:07 GMT 2003</font></p>
141      * <p/>
142      * <p/>
143      * Struts 1.1 introduces the concept of <em>Modules</em> to
144      * further complicate the idea of instantiating an action
145      * controller. It is assume that this method retrieve a controller
146      * specifically from the named module. If such an implementation
147      * aims to support modules. Since the controller factory could retrieve
148      * an <code>HttpServletRequest</code> from the
149      * <code>ControllerRequest</code> and then find the appropriate
150      * module name, therefore no extra parameter was required for this method.
151      * </p>
152      * @return instantiated controller
153      * @throws ControllerException if there's an error instantiating the
154      * controller
155      */
156     public Controller getController(ControllerRequest request)
157             throws ControllerException;
158
159 }
Popular Tags