ProxoolConstants


1   /*
2    * This software is released under a licence similar to the Apache Software Licence.
3    * See org.logicalcobwebs.proxool.package.html for details.
4    * The latest version is available at http://proxool.sourceforge.net
5    */
6   package org.logicalcobwebs.proxool;
7   
8   /**
9    * All constants here please.
10   *
11   * @version $Revision: 1.21 $, $Date: 2004/06/02 20:39:17 $
12   * @author billhorsman
13   * @author $Author: billhorsman $ (current maintainer)
14   */
15  public interface ProxoolConstants {
16  
17      public final String   PROXOOL = "proxool";
18  
19      /**
20       * The namespace uri associated with namepace aware Proxool xml configurations.<br>
21       * Value: The latest version is available at http://proxool.sourceforge.net/xml-namespace
22       */
23      public final String   PROXOOL_XML_NAMESPACE_URI = "The latest version is available at http://proxool.sourceforge.net/xml-namespace";
24  
25      public final String   ALIAS_DELIMITER = ".";
26  
27      public final String   PROPERTY_PREFIX = PROXOOL + ".";
28  
29      public final String   URL_DELIMITER = ":";
30  
31      /** Standard JDBC property */
32      public final String   USER_PROPERTY = "user";
33  
34      /** Standard JDBC property */
35      public final String   PASSWORD_PROPERTY = "password";
36  
37      /** Used to build up URL */
38      public final String   ALIAS_PROPERTY = PROPERTY_PREFIX + "alias";
39  
40      /** Instead of defining the driver in the url you can also use this property */
41      public final String   DELEGATE_DRIVER = "driver";
42  
43      /** @see ProxoolDriver#getPropertyInfo */
44       public final String   DELEGATE_DRIVER_PROPERTY = PROPERTY_PREFIX + DELEGATE_DRIVER;
45  
46      /** @see #HOUSE_KEEPING_SLEEP_TIME_PROPERTY */
47      public final String   DELEGATE_URL = "url";
48  
49      /** @see ProxoolDriver#getPropertyInfo */
50       public final String   DELEGATE_URL_PROPERTY = PROPERTY_PREFIX + DELEGATE_URL;
51  
52      /** @see #HOUSE_KEEPING_SLEEP_TIME_PROPERTY */
53      public final String   HOUSE_KEEPING_SLEEP_TIME = "house-keeping-sleep-time";
54  
55      /** @see ProxoolDriver#getPropertyInfo */
56       public final String   HOUSE_KEEPING_SLEEP_TIME_PROPERTY = PROPERTY_PREFIX + HOUSE_KEEPING_SLEEP_TIME;
57  
58      /** @see #HOUSE_KEEPING_TEST_SQL_PROPERTY */
59      public final String   HOUSE_KEEPING_TEST_SQL = "house-keeping-test-sql";
60  
61      /** @see ProxoolDriver#getPropertyInfo */
62      public final String   HOUSE_KEEPING_TEST_SQL_PROPERTY = PROPERTY_PREFIX + HOUSE_KEEPING_TEST_SQL;
63  
64      /** @see #TEST_BEFORE_USE_PROPERTY */
65      public final String   TEST_BEFORE_USE = "test-before-use";
66  
67      /** @see ProxoolDriver#getPropertyInfo */
68      public final String   TEST_BEFORE_USE_PROPERTY = PROPERTY_PREFIX + TEST_BEFORE_USE;
69  
70      /** @see #TEST_AFTER_USE_PROPERTY */
71      public final String   TEST_AFTER_USE = "test-after-use";
72  
73      /** @see ProxoolDriver#getPropertyInfo */
74      public final String   TEST_AFTER_USE_PROPERTY = PROPERTY_PREFIX + TEST_AFTER_USE;
75  
76      /** @see #MAXIMUM_CONNECTION_COUNT_PROPERTY */
77      public final String   MAXIMUM_CONNECTION_COUNT = "maximum-connection-count";
78  
79      /** @see ProxoolDriver#getPropertyInfo */
80      public final String   MAXIMUM_CONNECTION_COUNT_PROPERTY = PROPERTY_PREFIX + MAXIMUM_CONNECTION_COUNT;
81  
82      /** @see #MAXIMUM_CONNECTION_LIFETIME_PROPERTY */
83      public final String   MAXIMUM_CONNECTION_LIFETIME = "maximum-connection-lifetime";
84  
85      /** @see ProxoolDriver#getPropertyInfo */
86      public final String   MAXIMUM_CONNECTION_LIFETIME_PROPERTY = PROPERTY_PREFIX + MAXIMUM_CONNECTION_LIFETIME;
87  
88      /**
89       * @deprecated use {@link #SIMULTANEOUS_BUILD_THROTTLE} instead
90       */
91      public final String   MAXIMUM_NEW_CONNECTIONS = "maximum-new-connections";
92  
93      /**
94       * @deprecated use {@link #SIMULTANEOUS_BUILD_THROTTLE_PROPERTY} instead
95       */
96      public final String   MAXIMUM_NEW_CONNECTIONS_PROPERTY = PROPERTY_PREFIX + MAXIMUM_NEW_CONNECTIONS;
97  
98      /** @see #SIMULTANEOUS_BUILD_THROTTLE_PROPERTY*/
99      public final String   SIMULTANEOUS_BUILD_THROTTLE = "simultaneous-build-throttle";
100 
101     /** @see ProxoolDriver#getPropertyInfo */
102     public final String   SIMULTANEOUS_BUILD_THROTTLE_PROPERTY = PROPERTY_PREFIX + SIMULTANEOUS_BUILD_THROTTLE;
103 
104     /** @see #MINIMUM_CONNECTION_COUNT_PROPERTY */
105     public final String   MINIMUM_CONNECTION_COUNT = "minimum-connection-count";
106 
107     /** @see ProxoolDriver#getPropertyInfo */
108     public final String   MINIMUM_CONNECTION_COUNT_PROPERTY = PROPERTY_PREFIX + MINIMUM_CONNECTION_COUNT;
109 
110     /** @see #PROTOTYPE_COUNT_PROPERTY */
111     public final String   PROTOTYPE_COUNT = "prototype-count";
112 
113     /** @see ProxoolDriver#getPropertyInfo */
114     public final String   PROTOTYPE_COUNT_PROPERTY = PROPERTY_PREFIX + PROTOTYPE_COUNT;
115 
116     /** @see #RECENTLY_STARTED_THRESHOLD_PROPERTY */
117     public final String   RECENTLY_STARTED_THRESHOLD = "recently-started-threshold";
118 
119     /** @see ProxoolDriver#getPropertyInfo */
120     public final String   RECENTLY_STARTED_THRESHOLD_PROPERTY = PROPERTY_PREFIX + RECENTLY_STARTED_THRESHOLD;
121 
122     /** @see #OVERLOAD_WITHOUT_REFUSAL_LIFETIME_PROPERTY */
123     public final String   OVERLOAD_WITHOUT_REFUSAL_LIFETIME = "overload-without-refusal-lifetime";
124 
125     /** @see ProxoolDriver#getPropertyInfo */
126     public final String   OVERLOAD_WITHOUT_REFUSAL_LIFETIME_PROPERTY = PROPERTY_PREFIX + OVERLOAD_WITHOUT_REFUSAL_LIFETIME;
127 
128     /** @see #MAXIMUM_ACTIVE_TIME_PROPERTY */
129     public final String   MAXIMUM_ACTIVE_TIME = "maximum-active-time";
130 
131     /** @see ProxoolDriver#getPropertyInfo */
132     public final String   MAXIMUM_ACTIVE_TIME_PROPERTY = PROPERTY_PREFIX + MAXIMUM_ACTIVE_TIME;
133 
134     /** @see #INJECTABLE_CONNECTION_INTERFACE_NAME_PROPERTY */
135     public final String   INJECTABLE_CONNECTION_INTERFACE_NAME = "injectable-connection-interface";
136 
137     /** @see ProxoolDriver#getPropertyInfo */
138     public final String   INJECTABLE_CONNECTION_INTERFACE_NAME_PROPERTY = PROPERTY_PREFIX + INJECTABLE_CONNECTION_INTERFACE_NAME;
139 
140     /** @see #INJECTABLE_STATEMENT_INTERFACE_NAME_PROPERTY */
141     public final String   INJECTABLE_STATEMENT_INTERFACE_NAME = "injectable-statement-interface";
142 
143     /** @see ProxoolDriver#getPropertyInfo */
144     public final String   INJECTABLE_STATEMENT_INTERFACE_NAME_PROPERTY = PROPERTY_PREFIX + INJECTABLE_STATEMENT_INTERFACE_NAME;
145 
146     /** @see #INJECTABLE_PREPARED_STATEMENT_INTERFACE_NAME_PROPERTY */
147     public final String   INJECTABLE_PREPARED_STATEMENT_INTERFACE_NAME = "injectable-prepared-statement-interface";
148 
149     /** @see ProxoolDriver#getPropertyInfo */
150     public final String   INJECTABLE_PREPARED_STATEMENT_INTERFACE_NAME_PROPERTY = PROPERTY_PREFIX + INJECTABLE_PREPARED_STATEMENT_INTERFACE_NAME;
151 
152     /** @see #INJECTABLE_CALLABLE_STATEMENT_INTERFACE_NAME_PROPERTY */
153     public final String   INJECTABLE_CALLABLE_STATEMENT_INTERFACE_NAME = "injectable-callable-statement-interface";
154 
155     /** @see ProxoolDriver#getPropertyInfo */
156     public final String   INJECTABLE_CALLABLE_STATEMENT_INTERFACE_NAME_PROPERTY = PROPERTY_PREFIX + INJECTABLE_CALLABLE_STATEMENT_INTERFACE_NAME;
157 
158     /**
159      * @deprecated use {@link #VERBOSE_PROPERTY verbose} instead.
160      */
161     public final String   DEBUG_LEVEL_PROPERTY = PROPERTY_PREFIX + "debug-level";
162 
163     /** @see #VERBOSE_PROPERTY */
164     public final String   VERBOSE = "verbose";
165 
166     /** @see ProxoolDriver#getPropertyInfo */
167     public final String   VERBOSE_PROPERTY = PROPERTY_PREFIX + VERBOSE;
168 
169     /** @see #TRACE_PROPERTY */
170     public final String   TRACE = "trace";
171 
172     /** @see ProxoolDriver#getPropertyInfo */
173     public final String   TRACE_PROPERTY = PROPERTY_PREFIX + TRACE;
174 
175     /** @see #FATAL_SQL_EXCEPTION_PROPERTY **/
176     public final String   FATAL_SQL_EXCEPTION = "fatal-sql-exception";
177 
178     /** @see ProxoolDriver#getPropertyInfo */
179     public final String   FATAL_SQL_EXCEPTION_PROPERTY = PROPERTY_PREFIX + FATAL_SQL_EXCEPTION;
180 
181     /** @see #FATAL_SQL_EXCEPTION_WRAPPER_CLASS_PROPERTY**/
182     public final String   FATAL_SQL_EXCEPTION_WRAPPER_CLASS = "fatal-sql-exception-wrapper-class";
183 
184     /** @see ProxoolDriver#getPropertyInfo */
185     public final String   FATAL_SQL_EXCEPTION_WRAPPER_CLASS_PROPERTY = PROPERTY_PREFIX + FATAL_SQL_EXCEPTION_WRAPPER_CLASS;
186 
187     public static final String   STATISTICS = "statistics";
188 
189     /** @see ProxoolDriver#getPropertyInfo */
190     public final String   STATISTICS_PROPERTY = PROPERTY_PREFIX + STATISTICS;
191 
192     public static final String   STATISTICS_LOG_LEVEL = "statistics-log-level";
193 
194     /** @see ProxoolDriver#getPropertyInfo */
195     public final String   STATISTICS_LOG_LEVEL_PROPERTY = PROPERTY_PREFIX + STATISTICS_LOG_LEVEL;
196 
197     public static final String   JNDI_NAME = "jndi-name";
198     
199     /** Prefix for generic JNDI properties. */
200     public static final String   JNDI_PROPERTY_PREFIX = "jndi-";
201 
202     /** @see ProxoolDriver#getPropertyInfo */
203     public final String   JNDI_NAME_PROPERTY = PROPERTY_PREFIX + JNDI_NAME;
204 
205 // End JNDI
206 
207     public static final String   STATISTICS_LOG_LEVEL_TRACE = "TRACE";
208 
209     public static final String   STATISTICS_LOG_LEVEL_DEBUG = "DEBUG";
210 
211     public static final String   STATISTICS_LOG_LEVEL_INFO = "INFO";
212 
213     /**
214      * Element name for the container of properties passed directlry to the delegate driver.
215      */
216     public static final String   DRIVER_PROPERTIES = "driver-properties";
217 
218 
219     /**
220      * Configuration attribute used to indicate that a pool should be registered with JMX.
221      */
222     public static final String   JMX = "jmx";
223 
224     /**
225      * "proxool." prefixed version of {@link #JMX}.
226      */
227     public final String   JMX_PROPERTY = PROPERTY_PREFIX + JMX;
228 
229     /**
230      * Configuration attribute for a list of jmx agent ids to register a
231      * {@link org.logicalcobwebs.proxool.admin.jmx.ConnectionPoolMBean} to.
232      * The list is comma separated.
233      */
234     public static final String   JMX_AGENT_ID = "jmx-agent-id";
235 
236     /**
237      * "proxool." prefixed version of {@link #JMX_AGENT_ID}.
238      */
239     public final String   JMX_AGENT_PROPERTY = PROPERTY_PREFIX + JMX_AGENT_ID;
240 
241     /**
242      *  Un-prefixed propety name for the Proxool alias configuration property. Value: alias
243      */
244     public final String   ALIAS = "alias";
245 
246     /**
247      *  Un-prefixed propety name for the Proxool driver class  configuration property. Value: driver-class
248      */
249     public final String   DRIVER_CLASS = "driver-class";
250     /**
251      *  Prefixed propety name for the Proxool driver class  configuration property. Value: proxool.driver-class
252      */
253     public final String   DRIVER_CLASS_PROPERTY = PROPERTY_PREFIX + DRIVER_CLASS;;
254     /**
255      *  Un-prefixed propety name for the Proxool driver url configuration property. Value: driver-url
256      */
257     public final String   DRIVER_URL = "driver-url";
258     /**
259      *  Prefixed propety name for the Proxool driver url configuration property. Value: proxool.driver-url
260      */
261     public final String   DRIVER_URL_PROPERTY = PROPERTY_PREFIX + DRIVER_URL;
262 }
263 
264 /*
265  Revision history:
266  $Log: ProxoolConstants.java,v $
267  Revision 1.21  2004/06/02 20:39:17  billhorsman
268  New injectable interface constants
269 
270  Revision 1.20  2004/03/15 02:43:47  chr32
271  Removed explicit JNDI properties. Going for a generic approach instead.
272  Added constant for JNDI properties prefix.
273 
274  Revision 1.19  2003/09/30 18:39:08  billhorsman
275  New test-before-use, test-after-use and fatal-sql-exception-wrapper-class properties.
276 
277  Revision 1.18  2003/09/29 17:48:21  billhorsman
278  New fatal-sql-exception-wrapper-class allows you to define what exception is used as a wrapper. This means that you
279  can make it a RuntimeException if you need to.
280 
281  Revision 1.17  2003/09/05 17:00:42  billhorsman
282  New wrap-fatal-sql-exceptions property.
283 
284  Revision 1.16  2003/07/23 06:54:48  billhorsman
285  draft JNDI changes (shouldn't effect normal operation)
286 
287  Revision 1.15  2003/03/05 23:28:56  billhorsman
288  deprecated maximum-new-connections property in favour of
289  more descriptive simultaneous-build-throttle
290 
291  Revision 1.14  2003/03/03 11:11:58  billhorsman
292  fixed licence
293 
294  Revision 1.13  2003/02/26 16:05:52  billhorsman
295  widespread changes caused by refactoring the way we
296  update and redefine pool definitions.
297 
298  Revision 1.12  2003/02/24 18:02:24  chr32
299  Added JMX related constants.
300 
301  Revision 1.11  2003/02/24 01:16:15  chr32
302  Added constant for "driver-properties" property.
303 
304  Revision 1.10  2003/02/06 15:41:17  billhorsman
305  add statistics-log-level
306 
307  Revision 1.9  2003/01/30 17:22:03  billhorsman
308  new statistics property
309 
310  Revision 1.8  2003/01/23 10:41:05  billhorsman
311  changed use of pool-name to alias for consistency
312 
313  Revision 1.7  2002/12/26 11:32:22  billhorsman
314  Moved ALIAS, DRIVER_URL and DRIVER_CLASS constants
315  from XMLConfgiurator to ProxoolConstants.
316 
317  Revision 1.6  2002/12/15 19:22:51  chr32
318  Added constant for proxool xml namespace.
319 
320  Revision 1.5  2002/12/11 01:47:12  billhorsman
321  extracted property names without proxool. prefix for use
322  by XMLConfigurators.
323 
324  Revision 1.4  2002/11/09 15:50:49  billhorsman
325  new trace constant
326 
327  Revision 1.3  2002/10/27 13:29:38  billhorsman
328  deprecated debug-level in favour of verbose
329 
330  Revision 1.2  2002/10/25 15:59:32  billhorsman
331  made non-public where possible
332 
333  Revision 1.1.1.1  2002/09/13 08:13:06  billhorsman
334  new
335 
336  Revision 1.3  2002/08/24 19:57:15  billhorsman
337  checkstyle changes
338 
339  Revision 1.2  2002/07/12 23:03:22  billhorsman
340  added doc headers
341 
342  Revision 1.7  2002/07/10 16:14:47  billhorsman
343  widespread layout changes and move constants into ProxoolConstants
344 
345  Revision 1.6  2002/07/02 11:19:08  billhorsman
346  layout code and imports
347 
348  Revision 1.5  2002/07/02 08:27:47  billhorsman
349  bug fix when settiong definition, displayStatistics now available to ProxoolFacade, prototyper no longer attempts to make connections when maximum is reached
350 
351  Revision 1.4  2002/06/28 11:19:47  billhorsman
352  improved doc
353 
354 */
355
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags