DbConnectionProvider


1   /**
2    * Copyright (C) 2001 Yasna.com. All rights reserved.
3    *
4    * ===================================================================
5    * The Apache Software License, Version 1.1
6    *
7    * Redistribution and use in source and binary forms, with or without
8    * modification, are permitted provided that the following conditions
9    * are met:
10   *
11   * 1. Redistributions of source code must retain the above copyright
12   *    notice, this list of conditions and the following disclaimer.
13   *
14   * 2. Redistributions in binary form must reproduce the above copyright
15   *    notice, this list of conditions and the following disclaimer in
16   *    the documentation and/or other materials provided with the
17   *    distribution.
18   *
19   * 3. The end-user documentation included with the redistribution,
20   *    if any, must include the following acknowledgment:
21   *       "This product includes software developed by
22   *        Yasna.com (http://www.yasna.com)."
23   *    Alternately, this acknowledgment may appear in the software itself,
24   *    if and wherever such third-party acknowledgments normally appear.
25   *
26   * 4. The names "Yazd" and "Yasna.com" must not be used to
27   *    endorse or promote products derived from this software without
28   *    prior written permission. For written permission, please
29   *    contact yazd@yasna.com.
30   *
31   * 5. Products derived from this software may not be called "Yazd",
32   *    nor may "Yazd" appear in their name, without prior written
33   *    permission of Yasna.com.
34   *
35   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
36   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
37   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
38   * DISCLAIMED.  IN NO EVENT SHALL YASNA.COM OR
39   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
41   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
42   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
43   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
44   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
45   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
46   * SUCH DAMAGE.
47   * ====================================================================
48   *
49   * This software consists of voluntary contributions made by many
50   * individuals on behalf of Yasna.com. For more information
51   * on Yasna.com, please see <http://www.yasna.com>.
52   */
53  
54  /**
55   * Copyright (C) 2000 CoolServlets.com. All rights reserved.
56   *
57   * ===================================================================
58   * The Apache Software License, Version 1.1
59   *
60   * Redistribution and use in source and binary forms, with or without
61   * modification, are permitted provided that the following conditions
62   * are met:
63   *
64   * 1. Redistributions of source code must retain the above copyright
65   *    notice, this list of conditions and the following disclaimer.
66   *
67   * 2. Redistributions in binary form must reproduce the above copyright
68   *    notice, this list of conditions and the following disclaimer in
69   *    the documentation and/or other materials provided with the
70   *    distribution.
71   *
72   * 3. The end-user documentation included with the redistribution,
73   *    if any, must include the following acknowledgment:
74   *       "This product includes software developed by
75   *        CoolServlets.com (http://www.coolservlets.com)."
76   *    Alternately, this acknowledgment may appear in the software itself,
77   *    if and wherever such third-party acknowledgments normally appear.
78   *
79   * 4. The names "Jive" and "CoolServlets.com" must not be used to
80   *    endorse or promote products derived from this software without
81   *    prior written permission. For written permission, please
82   *    contact webmaster@coolservlets.com.
83   *
84   * 5. Products derived from this software may not be called "Jive",
85   *    nor may "Jive" appear in their name, without prior written
86   *    permission of CoolServlets.com.
87   *
88   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
89   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
90   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
91   * DISCLAIMED.  IN NO EVENT SHALL COOLSERVLETS.COM OR
92   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
93   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
94   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
95   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
96   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
97   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
98   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
99   * SUCH DAMAGE.
100  * ====================================================================
101  *
102  * This software consists of voluntary contributions made by many
103  * individuals on behalf of CoolServlets.com. For more information
104  * on CoolServlets.com, please see <http://www.coolservlets.com>.
105  */
106 
107 package com.Yasna.forum.database;
108 
109 import java.sql.Connection  ;
110 import java.util.Enumeration  ;
111 
112 /**
113  * Abstract class that defines the connection provider framework. Other classes
114  * extend this abstract class to make connection to actual data sources.
115  */
116 public abstract class DbConnectionProvider {
117 
118     /** Dummy values. Override in subclasses. **/
119     private static final String   NAME = "";
120     private static final String   DESCRIPTION = "";
121     private static final String   AUTHOR = "";
122     private static final int MAJOR_VERSION = 0;
123     private static final int MINOR_VERSION = 0;
124     private static final boolean POOLED = false;
125 
126     /**
127      * Returns the name of the connection provider.
128      *
129      * @return the name of the connection provider.
130      */
131     public String   getName() {
132         return NAME;
133     }
134 
135     /**
136      * Returns a description of the connection provider.
137      *
138      * @return the description of the connection provider.
139      */
140     public String   getDescription() {
141         return DESCRIPTION;
142     }
143 
144     /**
145      * Returns the author of the connection provider.
146      *
147      * @return the name of the author of this connection provider.
148      */
149     public String   getAuthor() {
150         return AUTHOR;
151     }
152 
153     /**
154      * Returns the major version of the connection provider, i.e. 1.x.
155      *
156      * @return the major version number of the provider.
157      */
158     public int getMajorVersion() {
159         return MAJOR_VERSION;
160     }
161 
162     /**
163      * Returns the minor version of the connection provider, i.e. x.1.
164      *
165      * @return the minor version number of the provider.
166      */
167     public int getMinorVersion() {
168         return MINOR_VERSION;
169     }
170 
171     /**
172      * Returns true if this connection provider provides connections out
173      * of a connection pool. Implementing and using connection providers that
174      * are pooled is strongly recommended, as they greatly increase the speed
175      * of Yazd.
176      *
177      * @return true if the Connection objects returned by this provider are
178      *      pooled.
179      */
180     public boolean isPooled() {
181         return POOLED;
182     }
183 
184     /**
185      * Returns a database connection. When a Yazd component is done with a
186      * connection, it will call the close method of that connection. Therefore,
187      * connection pools with special release methods are not directly
188      * supported by the connection provider infrastructure. Instead, connections
189      * from those pools should be wrapped such that calling the close method
190      * on the wrapper class will release the connection from the pool.
191      *
192      * @return a Connection object.
193      */
194     public abstract Connection   getConnection();
195 
196     /**
197      * Starts the connection provider. For some connection providers, this
198      * will be a no-op. However, connection provider users should always call
199      * this method to make sure the connection provider is started.
200      */
201     protected abstract void start();
202 
203     /**
204      * This method should be called whenever properties have been changed so
205      * that the changes will take effect.
206      */
207     protected abstract void restart();
208 
209     /**
210      * Tells the connection provider to destroy itself. For many connection
211      * providers, this will essentially result in a no-op. However,
212      * connection provider users should always call this method when changing
213      * from one connection provider to another to ensure that there are no
214      * dangling database connections.
215      */
216     protected abstract void destroy();
217 
218     /**
219      * Returns the value of a property of the connection provider.
220      *
221      * @param name the name of the property.
222      * @return the value of the property.
223      */
224     public abstract String   getProperty(String   name);
225 
226     /**
227      * Returns the description of a property of the connection provider.
228      *
229      * @param name the name of the property.
230      * @return the description of the property.
231      */
232     public abstract String   getPropertyDescription(String   name);
233 
234     /**
235      * Returns an enumeration of the property names for the connection provider.
236      *
237      * @return an Enumeration of the property names.
238      */
239     public abstract Enumeration   propertyNames();
240 
241     /**
242      * Sets a property of the connection provider. Each provider has a set number
243      * of properties that are determined by the author. Trying to set a non-
244      * existant property will result in an IllegalArgumentException.
245      *
246      * @param name the name of the property to set.
247      * @param value the new value for the property.
248      */
249     public abstract void setProperty(String   name, String   value);
250 
251 }
252
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags