KickJava   Java API By Example, From Geeks To Geeks.

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


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 java.beans.*;
56 import javax.servlet.*;
57 import javax.servlet.http.*;
58
59 /******************************************************************************
60  *
61  * @author Brian S O'Neill
62  * @version
63  * <!--$$Revision:--> 32 <!-- $-->, <!--$$JustDate:--> 6/11/01 <!-- $-->
64  */
65 public interface AdminContext extends TeaToolsContext {
66
67     /**
68      * Gets the admin information for the TeaServlet. The user also can
69      * reload the application or reload templates.
70      * <p>
71      * This function processes the following HTTP request parameters:
72      * <ul>
73      * <li>reloadTemplates - reloads the changed templates
74      * <li>reloadTemplates=all - reloads all templates
75      * <li>log - the id of the log
76      * <li>enabled - turns on/off the log (boolean)
77      * <li>debug - turns on/off log debug messages (boolean)
78      * <li>info - turns on/off log info messages (boolean)
79      * <li>warn - turns on/off log warning messages (boolean)
80      * <li>error - turns on/off log error messages (boolean)
81      * </ul>
82      * @return the admin information
83      */
84     public TeaServletAdmin getTeaServletAdmin() throws ServletException;
85
86     /**
87      * Returns a String that uniquely identifies the given Object.
88      */
89     public String JavaDoc getObjectIdentifier(Object JavaDoc obj);
90     
91     /**
92      * Returns a Class object for a given name.
93      * it basically lets templates perform Class.forName(classname);
94      */
95     public Class JavaDoc getClassForName(String JavaDoc classname);
96   
97     /**
98      * Streams the structural bytes of the named class via the HttpResponse.
99      */
100     public void streamClassBytes(String JavaDoc className) throws ServletException;
101
102
103     /**
104      * allows a template to dynamically call another template
105      */
106     public void dynamicTemplateCall(String JavaDoc templateName) throws Exception JavaDoc;
107      
108     /**
109      * allows a template to dynamically call another template
110      * this time with parameters.
111      */
112     public void dynamicTemplateCall(String JavaDoc templateName, Object JavaDoc[] params)
113         throws Exception JavaDoc;
114
115     /**
116      * returns a context for the specified application instance by name.
117      * this is useful when dynamically calling a function in that context.
118      */
119     public Object JavaDoc obtainContextByName(String JavaDoc appName) throws ServletException;
120 }
121
Popular Tags