001: /* ====================================================================
002: * The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
003: *
004: * Copyright (c) 1995-2002 Jcorporate Ltd. All rights reserved.
005: *
006: * Redistribution and use in source and binary forms, with or without
007: * modification, are permitted provided that the following conditions
008: * are met:
009: *
010: * 1. Redistributions of source code must retain the above copyright
011: * notice, this list of conditions and the following disclaimer.
012: *
013: * 2. Redistributions in binary form must reproduce the above copyright
014: * notice, this list of conditions and the following disclaimer in
015: * the documentation and/or other materials provided with the
016: * distribution.
017: *
018: * 3. The end-user documentation included with the redistribution,
019: * if any, must include the following acknowledgment:
020: * "This product includes software developed by Jcorporate Ltd.
021: * (http://www.jcorporate.com/)."
022: * Alternately, this acknowledgment may appear in the software itself,
023: * if and wherever such third-party acknowledgments normally appear.
024: *
025: * 4. "Jcorporate" and product names such as "Expresso" must
026: * not be used to endorse or promote products derived from this
027: * software without prior written permission. For written permission,
028: * please contact info@jcorporate.com.
029: *
030: * 5. Products derived from this software may not be called "Expresso",
031: * or other Jcorporate product names; nor may "Expresso" or other
032: * Jcorporate product names appear in their name, without prior
033: * written permission of Jcorporate Ltd.
034: *
035: * 6. No product derived from this software may compete in the same
036: * market space, i.e. framework, without prior written permission
037: * of Jcorporate Ltd. For written permission, please contact
038: * partners@jcorporate.com.
039: *
040: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
041: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
042: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
043: * DISCLAIMED. IN NO EVENT SHALL JCORPORATE LTD OR ITS CONTRIBUTORS
044: * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
045: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
046: * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
047: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
048: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
049: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
050: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
051: * SUCH DAMAGE.
052: * ====================================================================
053: *
054: * This software consists of voluntary contributions made by many
055: * individuals on behalf of the Jcorporate Ltd. Contributions back
056: * to the project(s) are encouraged when you make modifications.
057: * Please send them to support@jcorporate.com. For more information
058: * on Jcorporate Ltd. and its products, please see
059: * <http://www.jcorporate.com/>.
060: *
061: * Portions of this software are based upon other open source
062: * products and are subject to their respective licenses.
063: */
064:
065: package com.jcorporate.expresso.core.servlet;
066:
067: /**
068: * InitServlet.java
069: *
070: * Copyright 2000, 2001 Jcorporate Ltd.
071: */
072:
073: import com.jcorporate.expresso.core.db.DBException;
074: import com.jcorporate.expresso.core.misc.ConfigManager;
075:
076: import javax.servlet.ServletConfig;
077: import javax.servlet.ServletException;
078:
079: /**
080: * InitServlet is a "faceless" servlet that is automatically started when
081: * the servlet container starts.
082: * <p/>
083: * NOTE: All the properties files in this directory will be read in. For that reason
084: * do NOT park old versions of renamed properties files in this directory, they might
085: * conflict with other properties. Keep only current properties files in this directory.
086: * <p/>
087: * The InitServlet first populates configuration beans in the ConfigManager. Then, it
088: * initializes the DBPool with the dbvalues. Finally, the loadLists method is called.
089: * The loadLists method is used to populate the ConfigManager with "lookup list"
090: * vectors. A lookup list is a vector of ValidValue objects that does not change very
091: * often. You can use this method to read in lookup lists one time and cache them in
092: * the ConfigManager, making the code in your DBObjects getValidValues() methods much
093: * cleaner and faster.
094: *
095: * @author Adam Rossi
096: * @since Expresso 2.0
097: */
098: public abstract class InitServlet extends DBServlet {
099: /**
100: * InitServlet constructor.
101: */
102: public InitServlet() {
103: super ();
104: } /* InitServlet() */
105:
106: /**
107: * This method is used to load "lists" and cache them in ConfigManager list cache.
108: * These lists are used to populate valid values for DBObjects.
109: * <p/>
110: * Load a valid list (a vector containing ValidValue objects), and put it into the
111: * list cache in ConfigManager by calling:
112: * ConfigManager.setList("list_name", list_vector);
113: * <p/>
114: * Example:
115: */
116: public abstract void loadLists() throws DBException;
117:
118: /* loadLists() */
119: /**
120: * This method is called when the server initializes.
121: * This method simply calls the ConfigManager.config method which
122: * actually does the job of initializing Expresso.
123: *
124: * @param conf The servlet Configuration paramter
125: */
126: public void init(ServletConfig conf) throws ServletException {
127: super .init(conf);
128: } /* init(ServletConfig) */
129:
130: /**
131: * Called when the context is destroyed for either reload or application
132: * close
133: */
134: public void destroy() {
135: super .destroy();
136: ConfigManager.destroy();
137: }
138: } /* InitServlet */
139:
140: /* InitServlet */
|