KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > openejb > spi > ConnectionManagerFactory


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: ConnectionManagerFactory.java 1921 2005-06-19 22:40:34Z jlaskowski $
44  */

45 package org.openejb.spi;
46
47 import java.io.PrintWriter JavaDoc;
48 import java.util.Properties JavaDoc;
49
50 import javax.resource.spi.ManagedConnectionFactory JavaDoc;
51
52 import org.openejb.OpenEJBException;
53
54 /**
55  * Interface for a service that creates ConnectionManager implementations on
56  * demand. This is used to interface custom ConnectionManagers with
57  * OpenEJB. The exact method of identifying and loading
58  * ConnectionManagerFactory instances depends on the Assembler implementation
59  * you're using.
60  *
61  * @author Aaron Mulder (ammulder@alumni.princeton.edu)
62  * @version $Revision: 1921 $
63  */

64 public interface ConnectionManagerFactory {
65     /**
66      * Provides logging capabilities, which should be passed on to
67      * ConnectionManager instances created by this factory.
68      *
69      * <p><font color="red">Note:</font> This method will go away once
70      * Logging is made a primary service of OpenEJB.</p>
71      */

72     public void setLogWriter(PrintWriter JavaDoc logger);
73
74     /**
75      * Configures the factory itself. If the factory does not require
76      * additional configuration it may provide an empty implementation.
77      */

78     public void setProperties(Properties JavaDoc props);
79
80     /**
81      * Create a ConnectionManager to use for the specified
82      * ManagedConnectionFactory. This method may return the same
83      * ConnectionManager from different calls, if a single
84      * ConnectionManager instance can handle multiple
85      * ManagedConnectionFactories, but that is not required.
86      * @param name The deployment ID of the connector, which may be used
87      * for logging, etc.
88      * @param config configuration
89      * @param factory The ManagedConnectionFactory to configure a
90      * ConnectionManager for.
91      */

92     public OpenEJBConnectionManager createConnectionManager(
93                String JavaDoc name, ConnectionManagerConfig config,
94                ManagedConnectionFactory JavaDoc factory) throws OpenEJBException;
95 }
Popular Tags