KickJava   Java API By Example, From Geeks To Geeks.

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


1 /* ====================================================================
2  * The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
3  *
4  * Copyright (c) 1995-2003 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 package com.jcorporate.expresso.core.servlet;
65
66 import com.jcorporate.expresso.core.misc.ConfigManager;
67 import com.jcorporate.expresso.core.misc.StringUtil;
68 import com.jcorporate.expresso.core.misc.SystemMacros;
69 import com.jcorporate.expresso.kernel.RootContainerInterface;
70 import com.jcorporate.expresso.kernel.SystemFactory;
71 import com.jcorporate.expresso.kernel.exception.ConfigurationException;
72 import org.apache.log4j.Logger;
73
74 import javax.servlet.ServletConfig JavaDoc;
75 import javax.servlet.ServletContext JavaDoc;
76 import javax.servlet.ServletException JavaDoc;
77 import javax.servlet.http.HttpServlet JavaDoc;
78
79 /**
80  * This is an initialization servlet that provides a running example on how
81  * to load an Expresso runtime system
82  *
83  * @author Michael Rimov
84  * @since Expresso 5.1
85  */
86 public class RuntimeInitServlet extends HttpServlet JavaDoc {
87
88     /**
89      * Logging directory parameter
90      */
91     private String JavaDoc loggingDirectory;
92
93     /**
94      * Expresso Services Config location
95      */
96     private String JavaDoc expressoServicesConfig;
97
98     /**
99      * Logging configuration
100      */
101     private String JavaDoc loggingConfig;
102
103     /**
104      * Log4j Log
105      */
106     private Logger log;
107
108     /**
109      * Expresso runtime root container
110      */
111     private RootContainerInterface root;
112
113     public RuntimeInitServlet() {
114     }
115
116     /**
117      * Initialize the Expresso runtime system.
118      *
119      * @param sc The ServletConfig. The Servlet config in web.xml needs to
120      * have 3 parameters set: loggingDirectory, expressoConfig, and loggingConfig.
121      * @throws javax.servlet.ServletException upon instantiation error
122      */
123     public void init(ServletConfig JavaDoc sc) throws javax.servlet.ServletException JavaDoc {
124         super.init(sc);
125
126         try {
127             initializeSystemMacros(sc);
128             long startTime = System.currentTimeMillis();
129             loggingDirectory = sc.getInitParameter(ConfigManager.LOG_DIR_PARAM_NAME);
130             expressoServicesConfig = sc.getInitParameter("expressoConfig");
131             loggingConfig = sc.getInitParameter("loggingConfig");
132             root = SystemFactory.buildExpressoComponentSystem(expressoServicesConfig,
133                     loggingConfig, loggingDirectory);
134
135             log = Logger.getLogger(RuntimeInitServlet.class);
136             long endTime = System.currentTimeMillis();
137             log.info("Completed initialization in " + (endTime - startTime) / 1000 + " seconds");
138         } catch (ConfigurationException ex) {
139             this.log("Error loading Expresso Configuration", ex);
140             throw new ServletException JavaDoc("Error loading Expresso Configuration", ex);
141         }
142     }
143
144     /**
145      * Initialize System Macros Object with things like webapp, and Context.
146      * <p/>
147      * We can't set ServerPrefix until an actual server request is initiated.
148      *
149      * @param c The ServletConfiguration system.
150      */
151     public void initializeSystemMacros(ServletConfig JavaDoc c) {
152         ServletContext JavaDoc sc = c.getServletContext();
153         String JavaDoc rootDir = StringUtil.notNull(sc.getRealPath("/"));
154
155         this.log("ConfigManager: Context root (webAppDir) is '" +
156                 rootDir + "'");
157
158         SystemMacros sm = SystemMacros.getInstance();
159         if (rootDir.equals("")) {
160             this.log("Deploying inside a packed war file. Relative File URLs will throw Exceptions");
161             rootDir = System.getProperty("expresso.home", "");
162             if (rootDir.length() == 0) {
163                 log.warn("Deployed inside WAR file and no expresso.home " +
164                         "directory set. %WEB-APP% will expand to null");
165             } else {
166                 sm.setWebAppDir(rootDir);
167             }
168         } else {
169             sm.setWebAppDir(rootDir);
170         }
171
172         sm.setContextPath(this.getServletContext().getServletContextName());
173     }
174
175     /**
176      * Destroys the servlet and the Global Expresso runtime container.
177      */
178     public void destroy() {
179         if (log != null) {
180             log.info("Destroying Global Runtime Container");
181         }
182
183         if (root != null) {
184             root.destroy();
185         }
186     }
187
188
189 }
Popular Tags