KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > turbine > TurbineXmlConfig


1 package org.apache.turbine;
2
3 /* ====================================================================
4  * The Apache Software License, Version 1.1
5  *
6  * Copyright (c) 2001 The Apache Software Foundation. All rights
7  * reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  * notice, this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright
17  * notice, this list of conditions and the following disclaimer in
18  * the documentation and/or other materials provided with the
19  * distribution.
20  *
21  * 3. The end-user documentation included with the redistribution,
22  * if any, must include the following acknowledgment:
23  * "This product includes software developed by the
24  * Apache Software Foundation (http://www.apache.org/)."
25  * Alternately, this acknowledgment may appear in the software itself,
26  * if and wherever such third-party acknowledgments normally appear.
27  *
28  * 4. The names "Apache" and "Apache Software Foundation" and
29  * "Apache Turbine" must not be used to endorse or promote products
30  * derived from this software without prior written permission. For
31  * written permission, please contact apache@apache.org.
32  *
33  * 5. Products derived from this software may not be called "Apache",
34  * "Apache Turbine", nor may "Apache" appear in their name, without
35  * prior written permission of the Apache Software Foundation.
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 APACHE SOFTWARE FOUNDATION OR
41  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48  * SUCH DAMAGE.
49  * ====================================================================
50  *
51  * This software consists of voluntary contributions made by many
52  * individuals on behalf of the Apache Software Foundation. For more
53  * information on the Apache Software Foundation, please see
54  * <http://www.apache.org/>.
55  */
56
57 import java.util.HashMap JavaDoc;
58 import java.util.Hashtable JavaDoc;
59 import java.util.Map JavaDoc;
60
61 import org.apache.commons.logging.Log;
62 import org.apache.commons.logging.LogFactory;
63
64 /**
65  * A class used for initalization of Turbine without a servlet container.
66  *
67  * If you need to use Turbine outside of a servlet container, you can
68  * use this class for initalization of the Turbine servlet.<br>
69  *
70  * <blockquote><code><pre>
71  * TurbineConfig config = new TurbineXmlConfig(".", "/conf/TurbineConfiguration.xml");
72  * </pre></code></blockquote>
73  *
74  * @author <a HREF="mailto:epugh@opensourceconnections.com">Eric Pugh</a>
75  * @version $Id: TurbineXmlConfig.java,v 1.1 2004/02/02 11:20:13 epugh Exp $
76  */
77 public class TurbineXmlConfig extends TurbineConfig
78 {
79     private static final Log log = LogFactory.getLog(TurbineXmlConfig.class);
80
81     /**
82      * Servlet initialization parameter name for the path to
83      * TurbineConfiguration.xml file used by Turbine
84      */
85     public static final String JavaDoc CONFIGURATION_PATH_KEY = "configuration";
86
87    
88     /**
89      * This is the general form of the constructor. You can provide
90      * a path to search for files, and a name-value map of init
91      * parameters.
92      *
93      * <p> For the list of recognized init parameters, see
94      * {@link org.apache.turbine.Turbine} class.
95      *
96      * @param path The web application root (i.e. the path for file lookup).
97      * @param attributes Servlet container (or emulator) attributes.
98      * @param initParams Global (i.e. psuedo-context wide)
99      * initialization parameters.
100      */
101     public TurbineXmlConfig(String JavaDoc path, Map JavaDoc attributes, Map JavaDoc initParams)
102     {
103         super(path, attributes, initParams);
104     }
105
106     /**
107      * @see #TurbineConfig(String path, Map attributes, Map initParams)
108      */
109     public TurbineXmlConfig(String JavaDoc path, Map JavaDoc initParams)
110     {
111         this(path, new Hashtable JavaDoc(0), initParams);
112     }
113
114     /**
115      * This is a specialized constructor that allows to configure
116      * Turbine easiliy in the common setups.
117      *
118      * @param path The web application root (i.e. the path for file lookup).
119      * @param properties the relative path to TurbineResources.properties file
120      */
121     public TurbineXmlConfig(String JavaDoc path, String JavaDoc properties)
122     {
123         this(path, new HashMap JavaDoc(1));
124         initParams.put(CONFIGURATION_PATH_KEY, properties);
125     }
126
127 }
128
Popular Tags