org.rhq.plugins.database

Class BasePooledConnectionProvider

java.lang.Object

org.rhq.plugins.database.BasePooledConnectionProvider

All Implemented Interfaces:

PooledConnectionProvider

public abstract class BasePooledConnectionProvider
extends Object
implements PooledConnectionProvider

Base implementation of a PooledConnectionProvider. Plugin authors should:

1. create a concrete implementation which overrides the getDriverClass() method
2. adopt the configuration properties described here or override the corresponding #get method

The first point is important if a concrete database plugin embeds the JDBC driver: the database-specific driver class must be loaded by the child plugin classloader.

Author:

Elias Ross

Field Summary

Fields

Modifier and Type	Field and Description
static String	DRIVER_CLASS Driver class key.
static String	PASSWORD JDBC password config key.
protected org.rhq.core.domain.configuration.Configuration	pluginConfig
static String	TIMEOUT Connection timeout setting.
static String	TRACK If true, track connections and statements.
static String	URL JDBC URL config key.
static String	USERNAME JDBC username config key.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BasePooledConnectionProvider(org.rhq.core.domain.configuration.Configuration pluginConfig)

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Shutdown the connection pool.
protected Properties	getConnectionProperties() Return additional database connection pool properties.
protected long	getConnectionTimeout() Return the connection timeout setting, in milliseconds.
protected Class<Driver>	getDriverClass() Returns the driver class, by default the name from getDriverClassName().
protected String	getDriverClassName() Returns the driver class, by default configuration item DRIVER_CLASS.
protected String	getJdbcUrl() Implemented by subclasses to return the JDBC connection URL.
protected String	getPassword() Return the JDBC password.
Connection	getPooledConnection() Get a pooled connection.
protected String	getUsername() Return the JDBC username.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DRIVER_CLASS

public static final String DRIVER_CLASS

Driver class key.

See Also:

Constant Field Values

URL

public static final String URL

JDBC URL config key.

See Also:

Constant Field Values

USERNAME

public static final String USERNAME

JDBC username config key.

See Also:

Constant Field Values

PASSWORD

public static final String PASSWORD

JDBC password config key.

See Also:

Constant Field Values

TRACK

public static final String TRACK

If true, track connections and statements.

See Also:

Constant Field Values

TIMEOUT

public static final String TIMEOUT

Connection timeout setting.

See Also:

Constant Field Values

pluginConfig

protected final org.rhq.core.domain.configuration.Configuration pluginConfig

Constructor Detail

BasePooledConnectionProvider

protected BasePooledConnectionProvider(org.rhq.core.domain.configuration.Configuration pluginConfig)
                                throws Exception

Throws:

Exception

Method Detail

getPooledConnection

public Connection getPooledConnection()
                               throws SQLException

Description copied from interface: PooledConnectionProvider

Get a pooled connection. It's the responsibility of the caller to return the connection to the pool by calling Connection.close() on the returned Connection object.

Specified by:

getPooledConnection in interface PooledConnectionProvider

Returns:

a pooled Connection

Throws:

SQLException - if a pooled connection could not be retrieved

getConnectionProperties

protected Properties getConnectionProperties()

Return additional database connection pool properties. By default, returns an empty properties object.

getDriverClass

protected Class<Driver> getDriverClass()
                                throws ClassNotFoundException

Returns the driver class, by default the name from getDriverClassName(). If not configured, this assumes the plugin will load the appropriate driver.

Throws:

ClassNotFoundException - if the classloader could not load this class

getDriverClassName

protected String getDriverClassName()
                             throws ClassNotFoundException

Returns the driver class, by default configuration item DRIVER_CLASS.

Throws:

ClassNotFoundException

getJdbcUrl

protected String getJdbcUrl()

Implemented by subclasses to return the JDBC connection URL. By default, returns the configuration item URL.

getUsername

protected String getUsername()

Return the JDBC username. By default, returns the configuration item USERNAME.

getPassword

protected String getPassword()

Return the JDBC password. By default, returns the configuration item PASSWORD.

getConnectionTimeout

protected long getConnectionTimeout()

Return the connection timeout setting, in milliseconds. By default, returns the configuration item TIMEOUT.

close

public void close()

Shutdown the connection pool.