Java Doc for ConnectionPoolDefinitionIF.java in  » Database-JDBC-Connection-Pool » proxool » org » logicalcobwebs » proxool » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Database JDBC Connection Pool » proxool » org.logicalcobwebs.proxool 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.logicalcobwebs.proxool.ConnectionPoolDefinitionIF

All known Subclasses:   org.logicalcobwebs.proxool.ConnectionPoolDefinition,
ConnectionPoolDefinitionIF
public interface ConnectionPoolDefinitionIF (Code)
A full definition of everything to do with a connection. You can get one of these from ProxoolFacade.getConnectionPoolDefinition ProxoolFacade .
 String alias = "myPool";
 ConnectionPoolDefinitionIF cpd = ProxoolFacade.getConnectionPoolDefinition(alias);
 
If you want to update the definition you should either update the properties definition next time you java.sql.Driver.connect ask for a connection or call ProxoolFacade.updateConnectionPool Proxool directly.
version:
   $Revision: 1.22 $, $Date: 2004/06/02 20:19:14 $
author:
   billhorsman
author:
   $Author: billhorsman $ (current maintainer)


Field Summary
final public static  intDEBUG_LEVEL_LOUD
    
final public static  intDEBUG_LEVEL_QUIET
    
final public static  intDEFAULT_HOUSE_KEEPING_SLEEP_TIME
    
final public static  intDEFAULT_MAXIMUM_ACTIVE_TIME
    
final public static  intDEFAULT_MAXIMUM_CONNECTION_COUNT
    
final public static  intDEFAULT_MAXIMUM_CONNECTION_LIFETIME
    
final public static  intDEFAULT_MAXIMUM_NEW_CONNECTIONS
    
final public static  intDEFAULT_MINIMUM_CONNECTION_COUNT
    
final public static  intDEFAULT_OVERLOAD_WITHOUT_REFUSAL_THRESHOLD
    
final public static  intDEFAULT_PROTOTYPE_COUNT
    
final public static  intDEFAULT_RECENTLY_STARTED_THRESHOLD
    
final public static  intDEFAULT_SIMULTANEOUS_BUILD_THROTTLE
    
final public static  StringFATAL_SQL_EXCEPTIONS_DELIMITER
    
final public static  StringPASSWORD_PROPERTY
    
final public static  StringUSER_PROPERTY
    


Method Summary
 StringgetAlias()
     The name associated with this connection pool.
 StringgetCompleteUrl()
     The URL that was used to define this pool.
 intgetDebugLevel()
    
 PropertiesgetDelegateProperties()
     Get all of the properties that are defined on the delegated driver.
 StringgetDelegateProperty(String name)
    
 StringgetDriver()
    
 StringgetFatalSqlExceptionWrapper()
     If this is not-null then any fatal SQLException is wrapped up inside an instance of this class.
 SetgetFatalSqlExceptions()
     Get the list of fatal SQL exception (Strings) fragments that will trigger the death of a Connection. All SQLExceptions are caught and tested for containing this text fragment.
 intgetHouseKeepingSleepTime()
     This is the time the house keeping thread sleeps for between checks.
 StringgetHouseKeepingTestSql()
     The test SQL that we perform to see if a connection is alright.
 StringgetInitialContextFactory()
    
 ClassgetInjectableCallableStatementInterface()
     The class name of an interface that should be injected everytime we make a CallableStatement. Use this when you want to access methods on a concrete class in the vendor's CallableStatement object that aren't declared in a public interface.
 ClassgetInjectableConnectionInterface()
     The class name of an interface that should be injected everytime we make a Connection. Use this when you want to access methods on a concrete class in the vendor's Connection object that aren't declared in a public interface.
 ClassgetInjectablePreparedStatementInterface()
     The class name of an interface that should be injected everytime we make a PreparedStatement. Use this when you want to access methods on a concrete class in the vendor's PreparedStatement object that aren't declared in a public interface.
 ClassgetInjectableStatementInterface()
     The class name of an interface that should be injected everytime we make a Statement. Use this when you want to access methods on a concrete class in the vendor's Statement object that aren't declared in a public interface.
 StringgetJdbcDriverVersion()
    
 StringgetJmxAgentId()
     Get a comma separated list of JMX agent ids (as used by MBeanServerFactory.findMBeanServer(String agentId)) to register the pool to.
 StringgetJndiName()
    
 intgetMaximumActiveTime()
     If the housekeeper comes across a thread that has been active for longer than this then it will kill it.
 intgetMaximumConnectionCount()
    
 intgetMaximumConnectionLifetime()
     The maximum amount of time that a connection exists for before it is killed (recycled).
 intgetMaximumNewConnections()
     In order to prevent overloading, this is the maximum number of connections that you can have that are in the progress of being made.
 intgetMinimumConnectionCount()
     The minimum number of connections we will keep open, regardless of whether anyone needs them or not.
 StringgetName()
    
 intgetOverloadWithoutRefusalLifetime()
     This is the time in milliseconds after the last time that we refused a connection that we still consider ourselves to be overloaded.
 StringgetPassword()
    
 PropertiesgetProperties()
     Get all of the properties that are defined on the delegated driver.
 intgetPrototypeCount()
     This is the number of spare connections we will strive to have.
 StringgetProviderUrl()
    
 intgetRecentlyStartedThreshold()
     As long as we have one connection that was started within this threshold then we consider the pool to be up.
 StringgetSecurityAuthentication()
    
 StringgetSecurityCredentials()
    
 StringgetSecurityPrincipal()
    
 intgetSimultaneousBuildThrottle()
     In order to prevent overloading, this is the maximum number of connections that you can have that are in the progress of being made.
 StringgetStatistics()
     The sample length (in seconds) when taking statistical information, or null to disable statistics.
 StringgetStatisticsLogLevel()
     Whether statistics are logged as they are produced.
 StringgetUrl()
     This is the URL used to connect to the database.
 StringgetUser()
    
 booleanisJmx()
     Indicate wether this pool should be registered with JMX or not.
 booleanisTestAfterUse()
    
 booleanisTestBeforeUse()
    
 booleanisTrace()
     if this is true then we will log each execution.
 booleanisVerbose()
     If this is true then we start logging a lot of stuff everytime we serve a connection and everytime the house keeper and prototyper run.

Field Detail
DEBUG_LEVEL_LOUD
final public static int DEBUG_LEVEL_LOUD(Code)



DEBUG_LEVEL_QUIET
final public static int DEBUG_LEVEL_QUIET(Code)



DEFAULT_HOUSE_KEEPING_SLEEP_TIME
final public static int DEFAULT_HOUSE_KEEPING_SLEEP_TIME(Code)
30000 (30 Seconds)



DEFAULT_MAXIMUM_ACTIVE_TIME
final public static int DEFAULT_MAXIMUM_ACTIVE_TIME(Code)
300000 (5 minutes)



DEFAULT_MAXIMUM_CONNECTION_COUNT
final public static int DEFAULT_MAXIMUM_CONNECTION_COUNT(Code)
15



DEFAULT_MAXIMUM_CONNECTION_LIFETIME
final public static int DEFAULT_MAXIMUM_CONNECTION_LIFETIME(Code)
4 * 60 * 60 * 1000 (4 hours)



DEFAULT_MAXIMUM_NEW_CONNECTIONS
final public static int DEFAULT_MAXIMUM_NEW_CONNECTIONS(Code)
10 ConnectionPoolDefinitionIF.DEFAULT_SIMULTANEOUS_BUILD_THROTTLE



DEFAULT_MINIMUM_CONNECTION_COUNT
final public static int DEFAULT_MINIMUM_CONNECTION_COUNT(Code)
0



DEFAULT_OVERLOAD_WITHOUT_REFUSAL_THRESHOLD
final public static int DEFAULT_OVERLOAD_WITHOUT_REFUSAL_THRESHOLD(Code)
60000



DEFAULT_PROTOTYPE_COUNT
final public static int DEFAULT_PROTOTYPE_COUNT(Code)
0



DEFAULT_RECENTLY_STARTED_THRESHOLD
final public static int DEFAULT_RECENTLY_STARTED_THRESHOLD(Code)
60000



DEFAULT_SIMULTANEOUS_BUILD_THROTTLE
final public static int DEFAULT_SIMULTANEOUS_BUILD_THROTTLE(Code)
10



FATAL_SQL_EXCEPTIONS_DELIMITER
final public static String FATAL_SQL_EXCEPTIONS_DELIMITER(Code)

See Also:   ConnectionPoolDefinitionIF.getFatalSqlExceptions



PASSWORD_PROPERTY
final public static String PASSWORD_PROPERTY(Code)



USER_PROPERTY
final public static String USER_PROPERTY(Code)





Method Detail
getAlias
String getAlias()(Code)
The name associated with this connection pool. This is how you identify this pool when you need to use it.



getCompleteUrl
String getCompleteUrl()(Code)
The URL that was used to define this pool. For example: proxool:org.hsqldb.jdbcDriver:jdbc:hsqldb:test the complete url



getDebugLevel
int getDebugLevel()(Code)
ConnectionPoolDefinitionIF.isVerbose



getDelegateProperties
Properties getDelegateProperties()(Code)
Get all of the properties that are defined on the delegated driver. the delegate properties



getDelegateProperty
String getDelegateProperty(String name)(Code)



getDriver
String getDriver()(Code)



getFatalSqlExceptionWrapper
String getFatalSqlExceptionWrapper()(Code)
If this is not-null then any fatal SQLException is wrapped up inside an instance of this class. If null, then the original exception is thrown. Range: any valid class name that is a subclass of SQLException or RuntimeException Default: null (original exception is thrown) the class name to use for fatal SQL exceptions



getFatalSqlExceptions
Set getFatalSqlExceptions()(Code)
Get the list of fatal SQL exception (Strings) fragments that will trigger the death of a Connection. All SQLExceptions are caught and tested for containing this text fragment. If it matches than this connection is considered useless and it is discarded. Regardless of what happens the exception is always thrown back to the user. the list of exception fragments (String)
See Also:   ConnectionPoolDefinitionIF.FATAL_SQL_EXCEPTIONS_DELIMITER



getHouseKeepingSleepTime
int getHouseKeepingSleepTime()(Code)
This is the time the house keeping thread sleeps for between checks. (milliseconds)



getHouseKeepingTestSql
String getHouseKeepingTestSql()(Code)
The test SQL that we perform to see if a connection is alright. Should be fast and robust. house keeping test SQL



getInitialContextFactory
String getInitialContextFactory()(Code)
JNDI property the initial context factory



getInjectableCallableStatementInterface
Class getInjectableCallableStatementInterface()(Code)
The class name of an interface that should be injected everytime we make a CallableStatement. Use this when you want to access methods on a concrete class in the vendor's CallableStatement object that aren't declared in a public interface. Without this, the CallableStatement that is provided will only give you access to public interfaces (like CallableStatement and any other vendor provided ones) the interface



getInjectableConnectionInterface
Class getInjectableConnectionInterface()(Code)
The class name of an interface that should be injected everytime we make a Connection. Use this when you want to access methods on a concrete class in the vendor's Connection object that aren't declared in a public interface. Without this, the connection that gets served will only give you access to public interfaces (like Connection and any other vendor provided ones) the interface



getInjectablePreparedStatementInterface
Class getInjectablePreparedStatementInterface()(Code)
The class name of an interface that should be injected everytime we make a PreparedStatement. Use this when you want to access methods on a concrete class in the vendor's PreparedStatement object that aren't declared in a public interface. Without this, the PreparedStatement that is provided will only give you access to public interfaces (like PreparedStatement and any other vendor provided ones) the interface



getInjectableStatementInterface
Class getInjectableStatementInterface()(Code)
The class name of an interface that should be injected everytime we make a Statement. Use this when you want to access methods on a concrete class in the vendor's Statement object that aren't declared in a public interface. Without this, the statement that is provided will only give you access to public interfaces (like Statement and any other vendor provided ones) the interface



getJdbcDriverVersion
String getJdbcDriverVersion()(Code)



getJmxAgentId
String getJmxAgentId()(Code)
Get a comma separated list of JMX agent ids (as used by MBeanServerFactory.findMBeanServer(String agentId)) to register the pool to. a comma separated list of JMX agent ids (as used byMBeanServerFactory.findMBeanServer(String agentId)) to register the pool to.



getJndiName
String getJndiName()(Code)
JNDI property JNDI name



getMaximumActiveTime
int getMaximumActiveTime()(Code)
If the housekeeper comes across a thread that has been active for longer than this then it will kill it. So make sure you set this to a number bigger than your slowest expected response!



getMaximumConnectionCount
int getMaximumConnectionCount()(Code)
The maximum number of connections to the database



getMaximumConnectionLifetime
int getMaximumConnectionLifetime()(Code)
The maximum amount of time that a connection exists for before it is killed (recycled). (milliseconds)



getMaximumNewConnections
int getMaximumNewConnections()(Code)
In order to prevent overloading, this is the maximum number of connections that you can have that are in the progress of being made. That is, ones we have started to make but haven't finished yet. ConnectionPoolDefinitionIF.getSimultaneousBuildThrottle



getMinimumConnectionCount
int getMinimumConnectionCount()(Code)
The minimum number of connections we will keep open, regardless of whether anyone needs them or not.



getName
String getName()(Code)
ConnectionPoolDefinitionIF.getAlias



getOverloadWithoutRefusalLifetime
int getOverloadWithoutRefusalLifetime()(Code)
This is the time in milliseconds after the last time that we refused a connection that we still consider ourselves to be overloaded. We have to do this because, even when overloaded, it's not impossible for the available connection count to be high and it's possible to be serving a lot of connections. Recognising an overload is easy (we refuse a connection) - it's recognising when we stop being overloaded that is hard. Hence this fudge :)



getPassword
String getPassword()(Code)
The password to use to login to the database



getProperties
Properties getProperties()(Code)
Get all of the properties that are defined on the delegated driver. the delegate propertiesConnectionPoolDefinitionIF.getDelegateProperties



getPrototypeCount
int getPrototypeCount()(Code)
This is the number of spare connections we will strive to have. So, if we have a prototypeCount of 5 but only 3 spare connections the prototyper will make an additional 2. This is important because it can take around a seconds to establish a connection, and if we are being very strict about killing connections when they get too old it happens a fair bit.



getProviderUrl
String getProviderUrl()(Code)
JNDI property provider URL



getRecentlyStartedThreshold
int getRecentlyStartedThreshold()(Code)
As long as we have one connection that was started within this threshold then we consider the pool to be up. (That is, not down). This allows us to differentiate between having all the connections frozen and just being really busy.



getSecurityAuthentication
String getSecurityAuthentication()(Code)
JNDI property security authentication



getSecurityCredentials
String getSecurityCredentials()(Code)
JNDI property security credentials



getSecurityPrincipal
String getSecurityPrincipal()(Code)
JNDI property security principal



getSimultaneousBuildThrottle
int getSimultaneousBuildThrottle()(Code)
In order to prevent overloading, this is the maximum number of connections that you can have that are in the progress of being made. That is, ones we have started to make but haven't finished yet.



getStatistics
String getStatistics()(Code)
The sample length (in seconds) when taking statistical information, or null to disable statistics. Default is null. You can comma delimit a series of periods. The suffix for the period is either "s" (seconds), "m" (minutes), "h" (hours) or "d" (days). For example: "15s,1h" would give two separate sample rates: every 15 seconds and every hour. statistics definition



getStatisticsLogLevel
String getStatisticsLogLevel()(Code)
Whether statistics are logged as they are produced. Range: DEBUG, INFO, WARN, ERROR, FATAL. Default is null (no logging) statisticsLogLevel



getUrl
String getUrl()(Code)
This is the URL used to connect to the database. e.g. driver:@host:port:database.



getUser
String getUser()(Code)



isJmx
boolean isJmx()(Code)
Indicate wether this pool should be registered with JMX or not. wether this pool should be registered with JMX or not.



isTestAfterUse
boolean isTestAfterUse()(Code)
Whether we test each connection after it is closed (that is, returned to the pool) true if we do the test
See Also:   ConnectionPoolDefinitionIF.getHouseKeepingTestSql



isTestBeforeUse
boolean isTestBeforeUse()(Code)
Whether we test each connection before it is served true if we do the test
See Also:   ConnectionPoolDefinitionIF.getHouseKeepingTestSql



isTrace
boolean isTrace()(Code)
if this is true then we will log each execution. The SQL used and the execution time. true if we should log each execution



isVerbose
boolean isVerbose()(Code)
If this is true then we start logging a lot of stuff everytime we serve a connection and everytime the house keeper and prototyper run. Be prepared for a lot of debug! true if in verbose mode



www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.