001: /*
002: * This software is released under a licence similar to the Apache Software Licence.
003: * See org.logicalcobwebs.proxool.package.html for details.
004: * The latest version is available at http://proxool.sourceforge.net
005: */
006: package org.logicalcobwebs.proxool;
007:
008: /**
009: * All constants here please.
010: *
011: * @version $Revision: 1.21 $, $Date: 2004/06/02 20:39:17 $
012: * @author billhorsman
013: * @author $Author: billhorsman $ (current maintainer)
014: */
015: public interface ProxoolConstants {
016:
017: public final String PROXOOL = "proxool";
018:
019: /**
020: * The namespace uri associated with namepace aware Proxool xml configurations.<br>
021: * Value: The latest version is available at http://proxool.sourceforge.net/xml-namespace
022: */
023: public final String PROXOOL_XML_NAMESPACE_URI = "The latest version is available at http://proxool.sourceforge.net/xml-namespace";
024:
025: public final String ALIAS_DELIMITER = ".";
026:
027: public final String PROPERTY_PREFIX = PROXOOL + ".";
028:
029: public final String URL_DELIMITER = ":";
030:
031: /** Standard JDBC property */
032: public final String USER_PROPERTY = "user";
033:
034: /** Standard JDBC property */
035: public final String PASSWORD_PROPERTY = "password";
036:
037: /** Used to build up URL */
038: public final String ALIAS_PROPERTY = PROPERTY_PREFIX + "alias";
039:
040: /** Instead of defining the driver in the url you can also use this property */
041: public final String DELEGATE_DRIVER = "driver";
042:
043: /** @see ProxoolDriver#getPropertyInfo */
044: public final String DELEGATE_DRIVER_PROPERTY = PROPERTY_PREFIX
045: + DELEGATE_DRIVER;
046:
047: /** @see #HOUSE_KEEPING_SLEEP_TIME_PROPERTY */
048: public final String DELEGATE_URL = "url";
049:
050: /** @see ProxoolDriver#getPropertyInfo */
051: public final String DELEGATE_URL_PROPERTY = PROPERTY_PREFIX
052: + DELEGATE_URL;
053:
054: /** @see #HOUSE_KEEPING_SLEEP_TIME_PROPERTY */
055: public final String HOUSE_KEEPING_SLEEP_TIME = "house-keeping-sleep-time";
056:
057: /** @see ProxoolDriver#getPropertyInfo */
058: public final String HOUSE_KEEPING_SLEEP_TIME_PROPERTY = PROPERTY_PREFIX
059: + HOUSE_KEEPING_SLEEP_TIME;
060:
061: /** @see #HOUSE_KEEPING_TEST_SQL_PROPERTY */
062: public final String HOUSE_KEEPING_TEST_SQL = "house-keeping-test-sql";
063:
064: /** @see ProxoolDriver#getPropertyInfo */
065: public final String HOUSE_KEEPING_TEST_SQL_PROPERTY = PROPERTY_PREFIX
066: + HOUSE_KEEPING_TEST_SQL;
067:
068: /** @see #TEST_BEFORE_USE_PROPERTY */
069: public final String TEST_BEFORE_USE = "test-before-use";
070:
071: /** @see ProxoolDriver#getPropertyInfo */
072: public final String TEST_BEFORE_USE_PROPERTY = PROPERTY_PREFIX
073: + TEST_BEFORE_USE;
074:
075: /** @see #TEST_AFTER_USE_PROPERTY */
076: public final String TEST_AFTER_USE = "test-after-use";
077:
078: /** @see ProxoolDriver#getPropertyInfo */
079: public final String TEST_AFTER_USE_PROPERTY = PROPERTY_PREFIX
080: + TEST_AFTER_USE;
081:
082: /** @see #MAXIMUM_CONNECTION_COUNT_PROPERTY */
083: public final String MAXIMUM_CONNECTION_COUNT = "maximum-connection-count";
084:
085: /** @see ProxoolDriver#getPropertyInfo */
086: public final String MAXIMUM_CONNECTION_COUNT_PROPERTY = PROPERTY_PREFIX
087: + MAXIMUM_CONNECTION_COUNT;
088:
089: /** @see #MAXIMUM_CONNECTION_LIFETIME_PROPERTY */
090: public final String MAXIMUM_CONNECTION_LIFETIME = "maximum-connection-lifetime";
091:
092: /** @see ProxoolDriver#getPropertyInfo */
093: public final String MAXIMUM_CONNECTION_LIFETIME_PROPERTY = PROPERTY_PREFIX
094: + MAXIMUM_CONNECTION_LIFETIME;
095:
096: /**
097: * @deprecated use {@link #SIMULTANEOUS_BUILD_THROTTLE} instead
098: */
099: public final String MAXIMUM_NEW_CONNECTIONS = "maximum-new-connections";
100:
101: /**
102: * @deprecated use {@link #SIMULTANEOUS_BUILD_THROTTLE_PROPERTY} instead
103: */
104: public final String MAXIMUM_NEW_CONNECTIONS_PROPERTY = PROPERTY_PREFIX
105: + MAXIMUM_NEW_CONNECTIONS;
106:
107: /** @see #SIMULTANEOUS_BUILD_THROTTLE_PROPERTY*/
108: public final String SIMULTANEOUS_BUILD_THROTTLE = "simultaneous-build-throttle";
109:
110: /** @see ProxoolDriver#getPropertyInfo */
111: public final String SIMULTANEOUS_BUILD_THROTTLE_PROPERTY = PROPERTY_PREFIX
112: + SIMULTANEOUS_BUILD_THROTTLE;
113:
114: /** @see #MINIMUM_CONNECTION_COUNT_PROPERTY */
115: public final String MINIMUM_CONNECTION_COUNT = "minimum-connection-count";
116:
117: /** @see ProxoolDriver#getPropertyInfo */
118: public final String MINIMUM_CONNECTION_COUNT_PROPERTY = PROPERTY_PREFIX
119: + MINIMUM_CONNECTION_COUNT;
120:
121: /** @see #PROTOTYPE_COUNT_PROPERTY */
122: public final String PROTOTYPE_COUNT = "prototype-count";
123:
124: /** @see ProxoolDriver#getPropertyInfo */
125: public final String PROTOTYPE_COUNT_PROPERTY = PROPERTY_PREFIX
126: + PROTOTYPE_COUNT;
127:
128: /** @see #RECENTLY_STARTED_THRESHOLD_PROPERTY */
129: public final String RECENTLY_STARTED_THRESHOLD = "recently-started-threshold";
130:
131: /** @see ProxoolDriver#getPropertyInfo */
132: public final String RECENTLY_STARTED_THRESHOLD_PROPERTY = PROPERTY_PREFIX
133: + RECENTLY_STARTED_THRESHOLD;
134:
135: /** @see #OVERLOAD_WITHOUT_REFUSAL_LIFETIME_PROPERTY */
136: public final String OVERLOAD_WITHOUT_REFUSAL_LIFETIME = "overload-without-refusal-lifetime";
137:
138: /** @see ProxoolDriver#getPropertyInfo */
139: public final String OVERLOAD_WITHOUT_REFUSAL_LIFETIME_PROPERTY = PROPERTY_PREFIX
140: + OVERLOAD_WITHOUT_REFUSAL_LIFETIME;
141:
142: /** @see #MAXIMUM_ACTIVE_TIME_PROPERTY */
143: public final String MAXIMUM_ACTIVE_TIME = "maximum-active-time";
144:
145: /** @see ProxoolDriver#getPropertyInfo */
146: public final String MAXIMUM_ACTIVE_TIME_PROPERTY = PROPERTY_PREFIX
147: + MAXIMUM_ACTIVE_TIME;
148:
149: /** @see #INJECTABLE_CONNECTION_INTERFACE_NAME_PROPERTY */
150: public final String INJECTABLE_CONNECTION_INTERFACE_NAME = "injectable-connection-interface";
151:
152: /** @see ProxoolDriver#getPropertyInfo */
153: public final String INJECTABLE_CONNECTION_INTERFACE_NAME_PROPERTY = PROPERTY_PREFIX
154: + INJECTABLE_CONNECTION_INTERFACE_NAME;
155:
156: /** @see #INJECTABLE_STATEMENT_INTERFACE_NAME_PROPERTY */
157: public final String INJECTABLE_STATEMENT_INTERFACE_NAME = "injectable-statement-interface";
158:
159: /** @see ProxoolDriver#getPropertyInfo */
160: public final String INJECTABLE_STATEMENT_INTERFACE_NAME_PROPERTY = PROPERTY_PREFIX
161: + INJECTABLE_STATEMENT_INTERFACE_NAME;
162:
163: /** @see #INJECTABLE_PREPARED_STATEMENT_INTERFACE_NAME_PROPERTY */
164: public final String INJECTABLE_PREPARED_STATEMENT_INTERFACE_NAME = "injectable-prepared-statement-interface";
165:
166: /** @see ProxoolDriver#getPropertyInfo */
167: public final String INJECTABLE_PREPARED_STATEMENT_INTERFACE_NAME_PROPERTY = PROPERTY_PREFIX
168: + INJECTABLE_PREPARED_STATEMENT_INTERFACE_NAME;
169:
170: /** @see #INJECTABLE_CALLABLE_STATEMENT_INTERFACE_NAME_PROPERTY */
171: public final String INJECTABLE_CALLABLE_STATEMENT_INTERFACE_NAME = "injectable-callable-statement-interface";
172:
173: /** @see ProxoolDriver#getPropertyInfo */
174: public final String INJECTABLE_CALLABLE_STATEMENT_INTERFACE_NAME_PROPERTY = PROPERTY_PREFIX
175: + INJECTABLE_CALLABLE_STATEMENT_INTERFACE_NAME;
176:
177: /**
178: * @deprecated use {@link #VERBOSE_PROPERTY verbose} instead.
179: */
180: public final String DEBUG_LEVEL_PROPERTY = PROPERTY_PREFIX
181: + "debug-level";
182:
183: /** @see #VERBOSE_PROPERTY */
184: public final String VERBOSE = "verbose";
185:
186: /** @see ProxoolDriver#getPropertyInfo */
187: public final String VERBOSE_PROPERTY = PROPERTY_PREFIX + VERBOSE;
188:
189: /** @see #TRACE_PROPERTY */
190: public final String TRACE = "trace";
191:
192: /** @see ProxoolDriver#getPropertyInfo */
193: public final String TRACE_PROPERTY = PROPERTY_PREFIX + TRACE;
194:
195: /** @see #FATAL_SQL_EXCEPTION_PROPERTY **/
196: public final String FATAL_SQL_EXCEPTION = "fatal-sql-exception";
197:
198: /** @see ProxoolDriver#getPropertyInfo */
199: public final String FATAL_SQL_EXCEPTION_PROPERTY = PROPERTY_PREFIX
200: + FATAL_SQL_EXCEPTION;
201:
202: /** @see #FATAL_SQL_EXCEPTION_WRAPPER_CLASS_PROPERTY**/
203: public final String FATAL_SQL_EXCEPTION_WRAPPER_CLASS = "fatal-sql-exception-wrapper-class";
204:
205: /** @see ProxoolDriver#getPropertyInfo */
206: public final String FATAL_SQL_EXCEPTION_WRAPPER_CLASS_PROPERTY = PROPERTY_PREFIX
207: + FATAL_SQL_EXCEPTION_WRAPPER_CLASS;
208:
209: public static final String STATISTICS = "statistics";
210:
211: /** @see ProxoolDriver#getPropertyInfo */
212: public final String STATISTICS_PROPERTY = PROPERTY_PREFIX
213: + STATISTICS;
214:
215: public static final String STATISTICS_LOG_LEVEL = "statistics-log-level";
216:
217: /** @see ProxoolDriver#getPropertyInfo */
218: public final String STATISTICS_LOG_LEVEL_PROPERTY = PROPERTY_PREFIX
219: + STATISTICS_LOG_LEVEL;
220:
221: public static final String JNDI_NAME = "jndi-name";
222:
223: /** Prefix for generic JNDI properties. */
224: public static final String JNDI_PROPERTY_PREFIX = "jndi-";
225:
226: /** @see ProxoolDriver#getPropertyInfo */
227: public final String JNDI_NAME_PROPERTY = PROPERTY_PREFIX
228: + JNDI_NAME;
229:
230: // End JNDI
231:
232: public static final String STATISTICS_LOG_LEVEL_TRACE = "TRACE";
233:
234: public static final String STATISTICS_LOG_LEVEL_DEBUG = "DEBUG";
235:
236: public static final String STATISTICS_LOG_LEVEL_INFO = "INFO";
237:
238: /**
239: * Element name for the container of properties passed directlry to the delegate driver.
240: */
241: public static final String DRIVER_PROPERTIES = "driver-properties";
242:
243: /**
244: * Configuration attribute used to indicate that a pool should be registered with JMX.
245: */
246: public static final String JMX = "jmx";
247:
248: /**
249: * "proxool." prefixed version of {@link #JMX}.
250: */
251: public final String JMX_PROPERTY = PROPERTY_PREFIX + JMX;
252:
253: /**
254: * Configuration attribute for a list of jmx agent ids to register a
255: * {@link org.logicalcobwebs.proxool.admin.jmx.ConnectionPoolMBean} to.
256: * The list is comma separated.
257: */
258: public static final String JMX_AGENT_ID = "jmx-agent-id";
259:
260: /**
261: * "proxool." prefixed version of {@link #JMX_AGENT_ID}.
262: */
263: public final String JMX_AGENT_PROPERTY = PROPERTY_PREFIX
264: + JMX_AGENT_ID;
265:
266: /**
267: * Un-prefixed propety name for the Proxool alias configuration property. Value: alias
268: */
269: public final String ALIAS = "alias";
270:
271: /**
272: * Un-prefixed propety name for the Proxool driver class configuration property. Value: driver-class
273: */
274: public final String DRIVER_CLASS = "driver-class";
275: /**
276: * Prefixed propety name for the Proxool driver class configuration property. Value: proxool.driver-class
277: */
278: public final String DRIVER_CLASS_PROPERTY = PROPERTY_PREFIX
279: + DRIVER_CLASS;;
280: /**
281: * Un-prefixed propety name for the Proxool driver url configuration property. Value: driver-url
282: */
283: public final String DRIVER_URL = "driver-url";
284: /**
285: * Prefixed propety name for the Proxool driver url configuration property. Value: proxool.driver-url
286: */
287: public final String DRIVER_URL_PROPERTY = PROPERTY_PREFIX
288: + DRIVER_URL;
289: }
290:
291: /*
292: Revision history:
293: $Log: ProxoolConstants.java,v $
294: Revision 1.21 2004/06/02 20:39:17 billhorsman
295: New injectable interface constants
296:
297: Revision 1.20 2004/03/15 02:43:47 chr32
298: Removed explicit JNDI properties. Going for a generic approach instead.
299: Added constant for JNDI properties prefix.
300:
301: Revision 1.19 2003/09/30 18:39:08 billhorsman
302: New test-before-use, test-after-use and fatal-sql-exception-wrapper-class properties.
303:
304: Revision 1.18 2003/09/29 17:48:21 billhorsman
305: New fatal-sql-exception-wrapper-class allows you to define what exception is used as a wrapper. This means that you
306: can make it a RuntimeException if you need to.
307:
308: Revision 1.17 2003/09/05 17:00:42 billhorsman
309: New wrap-fatal-sql-exceptions property.
310:
311: Revision 1.16 2003/07/23 06:54:48 billhorsman
312: draft JNDI changes (shouldn't effect normal operation)
313:
314: Revision 1.15 2003/03/05 23:28:56 billhorsman
315: deprecated maximum-new-connections property in favour of
316: more descriptive simultaneous-build-throttle
317:
318: Revision 1.14 2003/03/03 11:11:58 billhorsman
319: fixed licence
320:
321: Revision 1.13 2003/02/26 16:05:52 billhorsman
322: widespread changes caused by refactoring the way we
323: update and redefine pool definitions.
324:
325: Revision 1.12 2003/02/24 18:02:24 chr32
326: Added JMX related constants.
327:
328: Revision 1.11 2003/02/24 01:16:15 chr32
329: Added constant for "driver-properties" property.
330:
331: Revision 1.10 2003/02/06 15:41:17 billhorsman
332: add statistics-log-level
333:
334: Revision 1.9 2003/01/30 17:22:03 billhorsman
335: new statistics property
336:
337: Revision 1.8 2003/01/23 10:41:05 billhorsman
338: changed use of pool-name to alias for consistency
339:
340: Revision 1.7 2002/12/26 11:32:22 billhorsman
341: Moved ALIAS, DRIVER_URL and DRIVER_CLASS constants
342: from XMLConfgiurator to ProxoolConstants.
343:
344: Revision 1.6 2002/12/15 19:22:51 chr32
345: Added constant for proxool xml namespace.
346:
347: Revision 1.5 2002/12/11 01:47:12 billhorsman
348: extracted property names without proxool. prefix for use
349: by XMLConfigurators.
350:
351: Revision 1.4 2002/11/09 15:50:49 billhorsman
352: new trace constant
353:
354: Revision 1.3 2002/10/27 13:29:38 billhorsman
355: deprecated debug-level in favour of verbose
356:
357: Revision 1.2 2002/10/25 15:59:32 billhorsman
358: made non-public where possible
359:
360: Revision 1.1.1.1 2002/09/13 08:13:06 billhorsman
361: new
362:
363: Revision 1.3 2002/08/24 19:57:15 billhorsman
364: checkstyle changes
365:
366: Revision 1.2 2002/07/12 23:03:22 billhorsman
367: added doc headers
368:
369: Revision 1.7 2002/07/10 16:14:47 billhorsman
370: widespread layout changes and move constants into ProxoolConstants
371:
372: Revision 1.6 2002/07/02 11:19:08 billhorsman
373: layout code and imports
374:
375: Revision 1.5 2002/07/02 08:27:47 billhorsman
376: bug fix when settiong definition, displayStatistics now available to ProxoolFacade, prototyper no longer attempts to make connections when maximum is reached
377:
378: Revision 1.4 2002/06/28 11:19:47 billhorsman
379: improved doc
380:
381: */
|