Package org.opennms.core.db

Class BaseConnectionFactory

java.lang.Object

org.opennms.core.db.BaseConnectionFactory

All Implemented Interfaces:

Closeable, AutoCloseable, Wrapper, CommonDataSource, DataSource, ClosableDataSource

Direct Known Subclasses:

C3P0ConnectionFactory, HikariCPConnectionFactory

public abstract class BaseConnectionFactory
extends Object
implements ClosableDataSource

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseConnectionFactory(JdbcDataSource ds)

Method Summary

Modifier and Type	Method	Description
void	close()	close
abstract DataSource	getDataSource()	getDataSource
abstract int	getLoginTimeout()	getLoginTimeout
abstract String	getUrl()	getUrl
abstract String	getUser()	getUser
protected abstract void	initializePool(JdbcDataSource ds)
boolean	isWrapperFor(Class<?> iface)	isWrapperFor
abstract void	setUrl(String url)	setUrl
abstract void	setUser(String user)	setUser
<T> T	unwrap(Class<T> iface)	unwrap
protected static void	validateJdbcUrl(String url)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opennms.core.db.ClosableDataSource

setIdleTimeout, setLoginTimeout, setMaxPool, setMaxSize, setMinPool

Methods inherited from interface javax.sql.CommonDataSource

createShardingKeyBuilder, getParentLogger

Methods inherited from interface javax.sql.DataSource

createConnectionBuilder, getConnection, getConnection, getLogWriter, setLogWriter

Constructor Detail

BaseConnectionFactory

protected BaseConnectionFactory(JdbcDataSource ds)
                         throws SQLException

Parameters:

stream - A configuration file as an InputStream.

dsName - The data source's name.

Throws:

PropertyVetoException - if any.

SQLException - if any.

Method Detail

initializePool

protected abstract void initializePool(JdbcDataSource ds)
                                throws SQLException

Throws:

SQLException

getUrl

public abstract String getUrl()

getUrl

Returns:

a String object.

setUrl

public abstract void setUrl(String url)

setUrl

Parameters:

url - a String object.

getUser

public abstract String getUser()

getUser

Returns:

a String object.

setUser

public abstract void setUser(String user)

setUser

Parameters:

user - a String object.

getDataSource

public abstract DataSource getDataSource()

getDataSource

Returns:

a DataSource object.

getLoginTimeout

public abstract int getLoginTimeout()
                             throws SQLException

getLoginTimeout

Specified by:

getLoginTimeout in interface CommonDataSource

Specified by:

getLoginTimeout in interface DataSource

Returns:

a int.

Throws:

SQLException - if any.

close

public void close()

close

Specified by:

close in interface AutoCloseable

Specified by:

close in interface ClosableDataSource

Specified by:

close in interface Closeable

unwrap

public <T> T unwrap(Class<T> iface)

unwrap

Specified by:

unwrap in interface Wrapper

Type Parameters:

T - a T object.

Parameters:

iface - a Class object.

Returns:

a T object.

isWrapperFor

public boolean isWrapperFor(Class<?> iface)

isWrapperFor

Specified by:

isWrapperFor in interface Wrapper

Parameters:

iface - a Class object.

Returns:

a boolean.

validateJdbcUrl

protected static void validateJdbcUrl(String url)