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: package com.jcorporate.expresso.kernel;
065:
066: import com.jcorporate.expresso.kernel.digester.ExpressoServicesConfig;
067:
068: import java.util.Map;
069:
070: /**
071: * This interface represents the special container case of the
072: * Root container where we need to store specific runtime information. It is
073: * not often utilized directly except through configuration information/management
074: * of the Expresso runtime system.
075: *
076: * @author Michael Rimov
077: */
078: public interface RootContainerInterface extends Containable,
079: ComponentLifecycle, ExpressoComponent {
080:
081: /**
082: * Retrieve the current ExpressoServicesConfiguration file bean.
083: *
084: * @return the Root ExpressoServicesconfig
085: */
086: public ExpressoServicesConfig getExpressoServicesConfig();
087:
088: /**
089: * Set the ExpressoServicesConfig bean. This is usually done by the System
090: * factory, or possibly the management tools.
091: *
092: * @param theConfig the confgiuration to set
093: */
094: public void setExpressoServicesConfig(
095: ExpressoServicesConfig theConfig);
096:
097: /**
098: * Destroy the root container and everything it contains.
099: */
100: public void destroy();
101:
102: /**
103: * Retrieve the log manager
104: *
105: * @return LogManager
106: */
107: public LogManager getLogManager();
108:
109: /**
110: * Sets the LogManager for management access purposes
111: *
112: * @param newManager the new LogManager to use for the root container
113: */
114: void setLogManager(LogManager newManager);
115:
116: /**
117: * Retrieve a global setup value (should be rarely used in a good
118: * system design)
119: *
120: * @param valueName the Name of the setup value to retrieve
121: * @return a java.lang.String corresponding value
122: */
123: public String getSetupValue(String valueName);
124:
125: /**
126: * Retrieves ALL setup values available for the whole system
127: *
128: * @return java.util.Map that shouldn't be modified directly.
129: */
130: public Map getSetupValues();
131:
132: /**
133: * Retrieves the URL location of the services file location. May be inside
134: * a jar/war file
135: *
136: * @return java.net.URL
137: */
138: public java.net.URL getServicesFileLocation();
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 url);
147:
148: }
|