KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > openejb > alt > assembler > classic > OpenEjbConfigurationFactory


1 /**
2  * Redistribution and use of this software and associated documentation
3  * ("Software"), with or without modification, are permitted provided
4  * that the following conditions are met:
5  *
6  * 1. Redistributions of source code must retain copyright
7  * statements and notices. Redistributions must also contain a
8  * copy of this document.
9  *
10  * 2. Redistributions in binary form must reproduce the
11  * above copyright notice, this list of conditions and the
12  * following disclaimer in the documentation and/or other
13  * materials provided with the distribution.
14  *
15  * 3. The name "Exolab" must not be used to endorse or promote
16  * products derived from this Software without prior written
17  * permission of Exoffice Technologies. For written permission,
18  * please contact info@exolab.org.
19  *
20  * 4. Products derived from this Software may not be called "Exolab"
21  * nor may "Exolab" appear in their names without prior written
22  * permission of Exoffice Technologies. Exolab is a registered
23  * trademark of Exoffice Technologies.
24  *
25  * 5. Due credit should be given to the Exolab Project
26  * (http://www.exolab.org/).
27  *
28  * THIS SOFTWARE IS PROVIDED BY EXOFFICE TECHNOLOGIES AND CONTRIBUTORS
29  * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
30  * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
31  * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
32  * EXOFFICE TECHNOLOGIES OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
33  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
34  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
35  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
37  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
38  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
39  * OF THE POSSIBILITY OF SUCH DAMAGE.
40  *
41  * Copyright 1999 (C) Exoffice Technologies Inc. All Rights Reserved.
42  *
43  * $Id: OpenEjbConfigurationFactory.java 1921 2005-06-19 22:40:34Z jlaskowski $
44  */
45
46 package org.openejb.alt.assembler.classic;
47
48 import java.util.Properties JavaDoc;
49
50 import org.openejb.OpenEJBException;
51
52 /**
53  * Factory for creating an instance of the OpenEjbConfiguration
54  *
55  * <p>
56  * The OpenEjbConfiguration object structure provides the information about the
57  * configuration of OpenEJB and the container system and is used by the
58  * org.openejb.alt.assembler.classic.Assembler to build a running unstance of OpenEJB.</p>
59  *
60  * <p>
61  * The default OpenEjbConfigurationFactory is DomOpenEjbConfigurationFactory, which
62  * creates an OpenEjbConfiguration object based on XML config files located on the
63  * local system.</p>
64  *
65  * <p>
66  * Other OpenEjbConfigurationFactory implementations can be created that might populate
67  * this object using a different approach. Other usefull implementations might be:<br>
68  * <UL>
69  * <LI>Populating the OpenEjbConfiguration from values in a RDBMS.
70  * <LI>Populating the OpenEjbConfiguration from values in a Properties file.
71  * <LI>Retrieving the OpenEjbConfiguration from a ODBMS.
72  * <LI>Creating the OpenEjbConfiguration using a JavaBeans enabled editing tool or wizard.
73  * </UL>
74  *
75  * <p>
76  * If you are interested in creating alternate an OpenEjbConfigurationFactory to do
77  * any of the above techniques or a new approach, email the
78  * <a HREF="mailto:openejb-dev@exolab.org">OpenEJB Developer list</a> with a description
79  * of the new OpenEjbConfigurationFactory implementation.
80  * </p>
81  *
82  * @author <a HREF="mailto:david.blevins@visi.com">David Blevins</a>
83  * @author <a HREF="mailto:Richard@Monson-Haefel.com">Richard Monson-Haefel</a>
84  * @see org.openejb.spi.Assembler
85  * @see org.openejb.alt.assembler.classic.Assembler
86  * @see org.openejb.alt.assembler.classic.OpenEjbConfiguration
87  * @see org.openejb.alt.assembler.classic.OpenEjbConfigurationFactory
88  */
89 public interface OpenEjbConfigurationFactory {
90     
91
92     public void init(Properties JavaDoc props)throws OpenEJBException;
93     
94     public OpenEjbConfiguration getOpenEjbConfiguration()throws OpenEJBException;
95
96     /*
97      * Not used yet.
98      * Will be used in the future to give the ability to load and reload container systems
99      * after OpenEJB has been started.
100     public ContainerSystemInfo getContainerSystemInformation()throws OpenEJBException;
101
102     */
103
104 }
105
Popular Tags