com.screenscraper.datamanager.sql

Class DataManagerDataSource

java.lang.Object

com.screenscraper.datamanager.sql.DataManagerDataSource

All Implemented Interfaces:

java.sql.Wrapper, javax.sql.CommonDataSource, javax.sql.DataSource

public class DataManagerDataSource
extends java.lang.Object
implements javax.sql.DataSource

Wrapper for the data source given to the data manager. This has a close method that will attempt to run the close method on the data source given. It allows for more types of data sources to be passed in and still work. It also wraps all statements and result sets so that calling close on the connection will close all it's statements. Closing a statement from a wrapped connection will close all it's ResultSets. While most data sources SHOULD do this themselves, not all do. This will help prevent memory leaks if another type of data source is given that doesn't handle this on it's own. This DataSource also ensures that anytime the data source is closed, all connections it had given out are also closed.

Version:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DataManagerDataSource.ManagedConnection Wrapper for connections
static class	DataManagerDataSource.QueryLogger A class used for logging query events (debugging purposes)

Constructor Summary

Constructors

Constructor and Description
DataManagerDataSource(javax.sql.DataSource dataSource, ScrapingSession session, SqlDataManager.SqlDataManagerLogger logger) Creates a data manager data source
DataManagerDataSource(javax.sql.DataSource dataSource, ScrapingSession session, SqlDataManager.SqlDataManagerLogger logger, DataManagerDataSource.QueryLogger queryLogger) Creates a data manager data source

Method Summary

Modifier and Type	Method and Description
void	close() Closes the underlying DataSource (if it has a close method).
java.sql.Connection	getConnection()
java.sql.Connection	getConnection(java.lang.String connectionName) Gets a connection and gives it a name for debugging purposes
java.sql.Connection	getConnection(java.lang.String username, java.lang.String password)
java.sql.Connection	getConnection(java.lang.String connectionName, java.lang.String username, java.lang.String password) Gets a connection and gives it a name for debugging purposes
SqlDataManager.SqlDataManagerLogger	getLogger() Returns the logger in use by the data source
int	getLoginTimeout()
java.io.PrintWriter	getLogWriter()
java.util.logging.Logger	getParentLogger()
DataManagerDataSource.QueryLogger	getQueryLogger() Returns the QueryLogger for the object
boolean	isWrapperFor(java.lang.Class<?> iface)
void	setLoginTimeout(int seconds)
void	setLogWriter(java.io.PrintWriter out)
void	setQueryLogger(DataManagerDataSource.QueryLogger queryLogger) Sets the QueryLogger for the object, which is used for gathering information about all queries run on the data source
void	startConnectionMonitorThread() Starts the thread that logs out information about old connections
java.lang.String	toString()
<T> T	unwrap(java.lang.Class<T> iface)

Methods inherited from class java.lang.Object

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

Constructor Detail

DataManagerDataSource

public DataManagerDataSource(@NotNull
                             javax.sql.DataSource dataSource,
                             @Nullable
                             ScrapingSession session,
                             @NotNull
                             SqlDataManager.SqlDataManagerLogger logger)

Creates a data manager data source

Parameters:

dataSource - The source to wrap

session - The session

logger - The logger for writing to the session (or elsewhere if desired)

DataManagerDataSource

public DataManagerDataSource(@NotNull
                             javax.sql.DataSource dataSource,
                             @Nullable
                             ScrapingSession session,
                             @NotNull
                             SqlDataManager.SqlDataManagerLogger logger,
                             @NotNull
                             DataManagerDataSource.QueryLogger queryLogger)

Creates a data manager data source

Parameters:

dataSource - The source to wrap

session - The session

logger - The logger for writing to the session (or elsewhere if desired)

queryLogger - A QueryLogger object used for debugging. It is called at various times to allow logging queries run through the source

Method Detail

getLogger

@InternalOnly
public SqlDataManager.SqlDataManagerLogger getLogger()

Returns the logger in use by the data source

Returns:

The logger in use by the data source

getQueryLogger

@NotNull
 @InternalOnly
public DataManagerDataSource.QueryLogger getQueryLogger()

Returns the QueryLogger for the object

Returns:

The QueryLogger for the object

setQueryLogger

public void setQueryLogger(@NotNull
                           DataManagerDataSource.QueryLogger queryLogger)

Sets the QueryLogger for the object, which is used for gathering information about all queries run on the data source

Parameters:

queryLogger - The new value for QueryLogger

startConnectionMonitorThread

public void startConnectionMonitorThread()

Starts the thread that logs out information about old connections

close

public void close()

Closes the underlying DataSource (if it has a close method). This also stops the connection monitor thread if it is running

getConnection

public java.sql.Connection getConnection()
                                  throws java.sql.SQLException

Specified by:

getConnection in interface javax.sql.DataSource

Throws:

java.sql.SQLException

getConnection

public java.sql.Connection getConnection(java.lang.String connectionName)
                                  throws java.sql.SQLException

Gets a connection and gives it a name for debugging purposes

Parameters:

connectionName - The name for the connection

Returns:

The connection

Throws:

java.sql.SQLException - On error connecting to the database

getConnection

public java.sql.Connection getConnection(java.lang.String username,
                                         java.lang.String password)
                                  throws java.sql.SQLException

Specified by:

getConnection in interface javax.sql.DataSource

Throws:

java.sql.SQLException

getConnection

public java.sql.Connection getConnection(java.lang.String connectionName,
                                         java.lang.String username,
                                         java.lang.String password)
                                  throws java.sql.SQLException

Gets a connection and gives it a name for debugging purposes

Parameters:

connectionName - The name for the connection

username - The username for this connection

password - The password for this connection

Returns:

The connection

Throws:

java.sql.SQLException - On error connecting to the database

getLogWriter

public java.io.PrintWriter getLogWriter()
                                 throws java.sql.SQLException

Specified by:

getLogWriter in interface javax.sql.CommonDataSource

Throws:

java.sql.SQLException

setLogWriter

public void setLogWriter(java.io.PrintWriter out)
                  throws java.sql.SQLException

Specified by:

setLogWriter in interface javax.sql.CommonDataSource

Throws:

java.sql.SQLException

setLoginTimeout

public void setLoginTimeout(int seconds)
                     throws java.sql.SQLException

Specified by:

setLoginTimeout in interface javax.sql.CommonDataSource

Throws:

java.sql.SQLException

getLoginTimeout

public int getLoginTimeout()
                    throws java.sql.SQLException

Specified by:

getLoginTimeout in interface javax.sql.CommonDataSource

Throws:

java.sql.SQLException

unwrap

public <T> T unwrap(java.lang.Class<T> iface)
             throws java.sql.SQLException

Specified by:

unwrap in interface java.sql.Wrapper

Throws:

java.sql.SQLException

isWrapperFor

public boolean isWrapperFor(java.lang.Class<?> iface)
                     throws java.sql.SQLException

Specified by:

isWrapperFor in interface java.sql.Wrapper

Throws:

java.sql.SQLException

getParentLogger

@NotNull
public java.util.logging.Logger getParentLogger()
                                                   throws java.sql.SQLFeatureNotSupportedException

Specified by:

getParentLogger in interface javax.sql.CommonDataSource

Throws:

java.sql.SQLFeatureNotSupportedException

toString

@NotNull
public java.lang.String toString()

Overrides:

toString in class java.lang.Object