edu.internet2.middleware.subject.provider
Interface JdbcConnectionProvider

All Known Implementing Classes:
C3p0JdbcConnectionProvider, DbcpJdbcConnectionProvider, GrouperJdbcConnectionProvider

public interface JdbcConnectionProvider

gives connections and allows returns. e.b. dbcp pooling, c3p0 pooling, grouper built in db


Method Summary
 JdbcConnectionBean connectionBean()
          get a connection (dont close this when done, just call "doneWithConnection()"
 void init(String sourceId, String driver, Integer maxActive, int defaultMaxActive, Integer maxIdle, int defaultMaxIdle, Integer maxWaitSeconds, int defaultMaxWaitSeconds, String dbUrl, String dbUser, String dbPassword, Boolean readOnly, boolean readOnlyDefault)
          init the pool
 boolean requiresJdbcConfigInSourcesXml()
          if the provider requires jdbc data in the sources.xml
 

Method Detail

requiresJdbcConfigInSourcesXml

boolean requiresJdbcConfigInSourcesXml()
if the provider requires jdbc data in the sources.xml

Returns:
true if provider requires data in sources.xml

init

void init(String sourceId,
          String driver,
          Integer maxActive,
          int defaultMaxActive,
          Integer maxIdle,
          int defaultMaxIdle,
          Integer maxWaitSeconds,
          int defaultMaxWaitSeconds,
          String dbUrl,
          String dbUser,
          String dbPassword,
          Boolean readOnly,
          boolean readOnlyDefault)
          throws SourceUnavailableException
init the pool

Parameters:
sourceId - mainly for logging
driver - driver
maxActive - max active connection if pool
defaultMaxActive - if max active is needed, and blank, then use this
maxIdle - max idle connections if pool
defaultMaxIdle - if max is needed, and blank, then use this
maxWaitSeconds - max wait if pool empty in seconds. -1 means long time
defaultMaxWaitSeconds - if max wait is needed, and blank, then use this, -1 mean long time
dbUrl - jdbc url of the database
dbUser - user to login to the database
dbPassword - password for the database (unencrypted)
readOnly - if conn should be readonly
readOnlyDefault - default if not specified and needed
Throws:
SourceUnavailableException - if something is not right or not available

connectionBean

JdbcConnectionBean connectionBean()
                                  throws SQLException
get a connection (dont close this when done, just call "doneWithConnection()"

Returns:
the connection
Throws:
SQLException - if there is a problem