KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > go > teaservlet > Application


1 /* ====================================================================
2  * TeaServlet - Copyright (c) 1999-2000 Walt Disney Internet Group
3  * ====================================================================
4  * The Tea Software License, Version 1.1
5  *
6  * Copyright (c) 2000 Walt Disney Internet Group. All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in
17  * the documentation and/or other materials provided with the
18  * distribution.
19  *
20  * 3. The end-user documentation included with the redistribution,
21  * if any, must include the following acknowledgment:
22  * "This product includes software developed by the
23  * Walt Disney Internet Group (http://opensource.go.com/)."
24  * Alternately, this acknowledgment may appear in the software itself,
25  * if and wherever such third-party acknowledgments normally appear.
26  *
27  * 4. The names "Tea", "TeaServlet", "Kettle", "Trove" and "BeanDoc" must
28  * not be used to endorse or promote products derived from this
29  * software without prior written permission. For written
30  * permission, please contact opensource@dig.com.
31  *
32  * 5. Products derived from this software may not be called "Tea",
33  * "TeaServlet", "Kettle" or "Trove", nor may "Tea", "TeaServlet",
34  * "Kettle", "Trove" or "BeanDoc" appear in their name, without prior
35  * written permission of the Walt Disney Internet Group.
36  *
37  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40  * DISCLAIMED. IN NO EVENT SHALL THE WALT DISNEY INTERNET GROUP OR ITS
41  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
42  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
43  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
44  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
45  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
46  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
47  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
48  * ====================================================================
49  *
50  * For more information about Tea, please see http://opensource.go.com/.
51  */

52
53 package com.go.teaservlet;
54
55 import javax.servlet.ServletException JavaDoc;
56
57 /******************************************************************************
58  * The main hook into the TeaServlet framework. Implement this interface for
59  * instantiating other required components and for providing functions to
60  * templates.
61  *
62  * @author Reece Wilton
63  * @version
64  * <!--$$Revision:--> 44 <!-- $-->, <!--$$JustDate:--> 9/07/00 <!-- $-->
65  */

66 public interface Application {
67     /**
68      * Initializes resources used by the Application.
69      *
70      * @param config the application's configuration object
71      */

72     public void init(ApplicationConfig config) throws ServletException JavaDoc;
73     
74     /**
75      * Called by the TeaServlet when the application is no longer needed.
76      */

77     public void destroy();
78
79     /**
80      * Creates a context, which defines functions that are callable by
81      * templates. Any public method in the context is a callable function,
82      * except methods defined in Object. A context may receive a request and
83      * response, but it doesn't need to use any of them. They are provided only
84      * in the event that a function needs access to these objects.
85      * <p>
86      * Unless the getContextType method returns null, the createContext method
87      * is called once for every request to the TeaServlet, so context creation
88      * should have a fairly quick initialization. One way of accomplishing this
89      * is to return the same context instance each time. The drawback to this
90      * technique is that functions will not be able to access the current
91      * request and response.
92      * <p>
93      * The recommended technique is to construct a new context that simply
94      * references this Application and any of the passed in parameters. This
95      * way, the Application contains all the resources and "business logic",
96      * and the context just provides templates access to it.
97      *
98      * @param request the client's HTTP request
99      * @param response the client's HTTP response
100      * @return an object context for the templates
101      */

102     public Object JavaDoc createContext(ApplicationRequest request,
103                                 ApplicationResponse response);
104
105     /**
106      * The class of the object that the createContext method will return, which
107      * does not need to implement any special interface or extend any special
108      * class. Returning null indicates that this Application defines no
109      * context, and createContext will never be called.
110      *
111      * @return the class that the createContext method will return
112      */

113     public Class JavaDoc getContextType();
114 }
115
Popular Tags