KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > jcorporate > expresso > core > servlet > InitServlet


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.servlet;
66
67 /**
68  * InitServlet.java
69  *
70  * Copyright 2000, 2001 Jcorporate Ltd.
71  */
72
73 import com.jcorporate.expresso.core.db.DBException;
74 import com.jcorporate.expresso.core.misc.ConfigManager;
75
76 import javax.servlet.ServletConfig JavaDoc;
77 import javax.servlet.ServletException JavaDoc;
78
79
80 /**
81  * InitServlet is a "faceless" servlet that is automatically started when
82  * the servlet container starts.
83  * <p/>
84  * NOTE: All the properties files in this directory will be read in. For that reason
85  * do NOT park old versions of renamed properties files in this directory, they might
86  * conflict with other properties. Keep only current properties files in this directory.
87  * <p/>
88  * The InitServlet first populates configuration beans in the ConfigManager. Then, it
89  * initializes the DBPool with the dbvalues. Finally, the loadLists method is called.
90  * The loadLists method is used to populate the ConfigManager with "lookup list"
91  * vectors. A lookup list is a vector of ValidValue objects that does not change very
92  * often. You can use this method to read in lookup lists one time and cache them in
93  * the ConfigManager, making the code in your DBObjects getValidValues() methods much
94  * cleaner and faster.
95  *
96  * @author Adam Rossi
97  * @since Expresso 2.0
98  */
99 public abstract class InitServlet
100         extends DBServlet {
101     /**
102      * InitServlet constructor.
103      */
104     public InitServlet() {
105         super();
106     } /* InitServlet() */
107
108     /**
109      * This method is used to load "lists" and cache them in ConfigManager list cache.
110      * These lists are used to populate valid values for DBObjects.
111      * <p/>
112      * Load a valid list (a vector containing ValidValue objects), and put it into the
113      * list cache in ConfigManager by calling:
114      * ConfigManager.setList("list_name", list_vector);
115      * <p/>
116      * Example:
117      */
118     public abstract void loadLists()
119             throws DBException;
120
121     /* loadLists() */
122     /**
123      * This method is called when the server initializes.
124      * This method simply calls the ConfigManager.config method which
125      * actually does the job of initializing Expresso.
126      *
127      * @param conf The servlet Configuration paramter
128      */
129     public void init(ServletConfig JavaDoc conf)
130             throws ServletException JavaDoc {
131         super.init(conf);
132     } /* init(ServletConfig) */
133
134
135     /**
136      * Called when the context is destroyed for either reload or application
137      * close
138      */
139     public void destroy() {
140         super.destroy();
141         ConfigManager.destroy();
142     }
143 } /* InitServlet */
144
145 /* InitServlet */
Popular Tags