KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > jcorporate > expresso > kernel > RootContainerInterface


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 package com.jcorporate.expresso.kernel;
65
66 import com.jcorporate.expresso.kernel.digester.ExpressoServicesConfig;
67
68 import java.util.Map JavaDoc;
69
70 /**
71  * This interface represents the special container case of the
72  * Root container where we need to store specific runtime information. It is
73  * not often utilized directly except through configuration information/management
74  * of the Expresso runtime system.
75  *
76  * @author Michael Rimov
77  */
78 public interface RootContainerInterface extends Containable, ComponentLifecycle, ExpressoComponent {
79
80     /**
81      * Retrieve the current ExpressoServicesConfiguration file bean.
82      *
83      * @return the Root ExpressoServicesconfig
84      */
85     public ExpressoServicesConfig getExpressoServicesConfig();
86
87     /**
88      * Set the ExpressoServicesConfig bean. This is usually done by the System
89      * factory, or possibly the management tools.
90      *
91      * @param theConfig the confgiuration to set
92      */
93     public void setExpressoServicesConfig(ExpressoServicesConfig theConfig);
94
95     /**
96      * Destroy the root container and everything it contains.
97      */
98     public void destroy();
99
100     /**
101      * Retrieve the log manager
102      *
103      * @return LogManager
104      */
105     public LogManager getLogManager();
106
107     /**
108      * Sets the LogManager for management access purposes
109      *
110      * @param newManager the new LogManager to use for the root container
111      */
112     void setLogManager(LogManager newManager);
113
114     /**
115      * Retrieve a global setup value (should be rarely used in a good
116      * system design)
117      *
118      * @param valueName the Name of the setup value to retrieve
119      * @return a java.lang.String corresponding value
120      */
121     public String JavaDoc getSetupValue(String JavaDoc valueName);
122
123     /**
124      * Retrieves ALL setup values available for the whole system
125      *
126      * @return java.util.Map that shouldn't be modified directly.
127      */
128     public Map JavaDoc getSetupValues();
129
130
131     /**
132      * Retrieves the URL location of the services file location. May be inside
133      * a jar/war file
134      *
135      * @return java.net.URL
136      */
137     public java.net.URL JavaDoc getServicesFileLocation();
138
139
140     /**
141      * Sets the ULR location of the services file. This is usually called
142      * by the SystemFactory
143      *
144      * @param url the URL of the services file location
145      */
146     public void setServicesFileLocation(java.net.URL JavaDoc url);
147
148 }
Popular Tags