org.javasimon.jdbcx4

Class AbstractSimonDataSource

java.lang.Object

org.javasimon.jdbcx4.AbstractSimonDataSource

Direct Known Subclasses:

SimonConnectionPoolDataSource, SimonDataSource, SimonXADataSource, WrappingSimonDataSource

public abstract class AbstractSimonDataSource
extends Object

SimonCommonDataSource is parent for all three datasource implementation classes.

It contains getters and setters for basic properties which all three datasource types needs to implement.

Since:

2.4

Author:

Radovan Sninsky, Richard "Virgo" Richter

Field Summary

Fields

Modifier and Type	Field and Description
protected SimonConnectionConfiguration	configuration
protected PrintWriter	logWriter

Constructor Summary

Constructors

Constructor and Description
AbstractSimonDataSource()

Method Summary

Methods

Modifier and Type	Method and Description
protected <T> T	createDataSource(Class<T> dataSourceClass) Instantiates the DataSource.
protected abstract String	doGetRealDataSourceClassName() Reads DataSource class name from configuration.
int	getLoginTimeout() Gets the maximum time in seconds that this data source can wait while attempting to connect to a database.
PrintWriter	getLogWriter() Retrieves the log writer for this DataSource object.
String	getPassword() Returns database password to authenticate connection.
String	getPrefix() Returns Simon prefix for constructing names of Simons.
Properties	getProperties() Get properties specific to the real datasource.
String	getRealDataSourceClassName() Returns real datasource class name.
String	getRealUrl() Returns real JDBC connection URL.
String	getUrl() Returns JDBC connection URL.
String	getUser() Returns database user to authenticate connection.
void	setLoginTimeout(int seconds) Sets the maximum time in seconds that this data source will wait while attempting to connect to a database.
void	setLogWriter(PrintWriter out) Sets the log writer for this DataSource object to the given java.io.PrintWriter object.
void	setPassword(String password) Setter for password property.
void	setPrefix(String prefix) Sets Simon prefix for constructing names of Simons.
void	setProperties(Properties properties) Set properties specific to the real datasource.
void	setRealDataSourceClassName(String className) Setter for realDataSourceClassName property.
void	setUrl(String url) Setter for URL property.
void	setUser(String user) Setter for user property.

Methods inherited from class java.lang.Object

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

Field Detail

logWriter

protected transient PrintWriter logWriter

configuration

protected SimonConnectionConfiguration configuration

Constructor Detail

AbstractSimonDataSource

public AbstractSimonDataSource()

Method Detail

getLogWriter

public final PrintWriter getLogWriter()
                               throws SQLException

Retrieves the log writer for this DataSource object.

Returns:

the log writer for this data source or null if logging is disabled

Throws:

SQLException - if a database access error occurs

See Also:

CommonDataSource.getLogWriter(), setLogWriter(java.io.PrintWriter)

setLogWriter

public final void setLogWriter(PrintWriter out)
                        throws SQLException

Sets the log writer for this DataSource object to the given java.io.PrintWriter object.

Parameters:

out - the new log writer; to disable logging, set to null

Throws:

SQLException - if a database access error occurs

See Also:

CommonDataSource.setLogWriter(java.io.PrintWriter), getLogWriter()

getUrl

public final String getUrl()

Returns JDBC connection URL.

Returns:

JDBC connection URL

setUrl

public final void setUrl(String url)

Setter for URL property.

Parameters:

url - JDBC connection URL

getRealUrl

public final String getRealUrl()

Returns real JDBC connection URL.

Returns:

real JDBC connection URL

getUser

public final String getUser()

Returns database user to authenticate connection.

Returns:

database user

setUser

public final void setUser(String user)

Setter for user property.

Parameters:

user - database user

getPassword

public final String getPassword()

Returns database password to authenticate connection.

Returns:

database password

setPassword

public final void setPassword(String password)

Setter for password property.

Parameters:

password - database password

setLoginTimeout

public final void setLoginTimeout(int seconds)
                           throws SQLException

Sets the maximum time in seconds that this data source will wait while attempting to connect to a database. A value of zero specifies that the timeout is the default system timeout if there is one; otherwise, it specifies that there is no timeout. When a DataSource object is created, the login timeout is initially zero.

Parameters:

seconds - the data source login time limit

Throws:

SQLException - if a database access error occurs.

See Also:

getLoginTimeout()

getLoginTimeout

public final int getLoginTimeout()
                          throws SQLException

Gets the maximum time in seconds that this data source can wait while attempting to connect to a database. A value of zero means that the timeout is the default system timeout if there is one; otherwise, it means that there is no timeout. When a DataSource object is created, the login timeout is initially zero.

Returns:

the data source login time limit

Throws:

SQLException - if a database access error occurs.

See Also:

setLoginTimeout(int)

getRealDataSourceClassName

public final String getRealDataSourceClassName()

Returns real datasource class name.

Returns:

real datasource class name

setRealDataSourceClassName

public final void setRealDataSourceClassName(String className)

Setter for realDataSourceClassName property.

Parameters:

className - class name of real datasource

createDataSource

protected final <T> T createDataSource(Class<T> dataSourceClass)
                            throws SQLException

Instantiates the DataSource.

Type Parameters:

T - DataSource type

Parameters:

dataSourceClass - Expected DataSource class

Returns:

Create DataSource

Throws:

SQLException

doGetRealDataSourceClassName

protected abstract String doGetRealDataSourceClassName()

Reads DataSource class name from configuration.

getPrefix

public final String getPrefix()

Returns Simon prefix for constructing names of Simons.

Returns:

Simon prefix

setPrefix

public final void setPrefix(String prefix)

Sets Simon prefix for constructing names of Simons.

Parameters:

prefix - Simon prefix

getProperties

public Properties getProperties()

Get properties specific to the real datasource.

Returns:

Properties

setProperties

public void setProperties(Properties properties)

Set properties specific to the real datasource.