org.jminor.common.db

Interface DatabaseConnection

All Superinterfaces:

java.lang.AutoCloseable

public interface DatabaseConnection
extends java.lang.AutoCloseable

Specifies a database connection, providing basic transaction control and pooling info

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	DatabaseConnection.Function<C> A database function
static interface	DatabaseConnection.Operation A database operation
static interface	DatabaseConnection.Procedure<C> A database procedure

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyValue<java.lang.Integer>	CONNECTION_VALIDITY_CHECK_TIMEOUT Specifies the timeout (in seconds) to use when checking if database connections are valid.

Method Summary

Modifier and Type	Method and Description
void	beginTransaction() Begins a transaction on this connection, to end the transaction use commitTransaction() or rollbackTransaction().
void	commit() Performs a commit
void	commitTransaction() Performs a commit and ends the current transaction
void	disconnect() Performs a rollback and disconnects this connection
java.sql.Connection	getConnection() Returns the underlying connection object, use isConnected() to verify that the connection is not null and valid.
Database	getDatabase()
MethodLogger	getMethodLogger()
long	getPoolTime()
int	getRetryCount()
User	getUser()
boolean	isConnected()
boolean	isTransactionOpen()
int	queryInteger(java.lang.String sql) Performs the given query and returns the result as an integer
long	queryLong(java.lang.String sql) Performs the given query and returns the result as a long
void	rollback() Performs a rollback
void	rollbackTransaction() Performs a rollback and ends the current transaction
void	setConnection(java.sql.Connection connection) Sets the internal connection to use, note that no validation or transaction checking is performed, it is simply used 'as is'
void	setMethodLogger(MethodLogger methodLogger)
void	setPoolTime(long time) Sets the time this connection was checked into a connection pool
void	setRetryCount(int retryCount)

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

CONNECTION_VALIDITY_CHECK_TIMEOUT

static final PropertyValue<java.lang.Integer> CONNECTION_VALIDITY_CHECK_TIMEOUT

Specifies the timeout (in seconds) to use when checking if database connections are valid. Value type: Integer
Default value: 0

Method Detail

isConnected

boolean isConnected()

Returns:

true if the connection has been established and is valid

getConnection

java.sql.Connection getConnection()

Returns the underlying connection object, use isConnected() to verify that the connection is not null and valid.

Returns:

the underlying connection object

setConnection

void setConnection(java.sql.Connection connection)

Sets the internal connection to use, note that no validation or transaction checking is performed, it is simply used 'as is'

Parameters:

connection - the JDBC connection

getPoolTime

long getPoolTime()

Returns:

the time at which this connection was pooled

setPoolTime

void setPoolTime(long time)

Sets the time this connection was checked into a connection pool

Parameters:

time - the time this connection was pooled

setRetryCount

void setRetryCount(int retryCount)

Parameters:

retryCount - the number of retries used to retrieve this connection from the pool

getRetryCount

int getRetryCount()

Returns:

the number of retries required to retrieve this connection from the pool

queryInteger

int queryInteger(java.lang.String sql)
          throws java.sql.SQLException

Performs the given query and returns the result as an integer

Parameters:

sql - the query must select at least a single number column, any other subsequent columns are disregarded

Returns:

the first record in the result as a integer

Throws:

java.sql.SQLException - thrown if anything goes wrong during the execution or if no record is returned

queryLong

long queryLong(java.lang.String sql)
        throws java.sql.SQLException

Performs the given query and returns the result as a long

Parameters:

sql - the query must select at least a single number column, any other subsequent columns are disregarded

Returns:

the first record in the result as a long

Throws:

java.sql.SQLException - thrown if anything goes wrong during the execution or if no record is returned

beginTransaction

void beginTransaction()

Begins a transaction on this connection, to end the transaction use commitTransaction() or rollbackTransaction().

Throws:

java.lang.IllegalStateException - in case a transaction is already open

isTransactionOpen

boolean isTransactionOpen()

Returns:

true if a transaction is open

commitTransaction

void commitTransaction()

Performs a commit and ends the current transaction

Throws:

java.lang.IllegalStateException - in case transaction is not open

rollbackTransaction

void rollbackTransaction()

Performs a rollback and ends the current transaction

Throws:

java.lang.IllegalStateException - in case transaction is not open

commit

void commit()
     throws java.sql.SQLException

Performs a commit

Throws:

java.sql.SQLException - thrown if anything goes wrong during the execution

java.lang.IllegalStateException - in case a transaction is open

rollback

void rollback()
       throws java.sql.SQLException

Performs a rollback

Throws:

java.sql.SQLException - thrown if anything goes wrong during the execution

java.lang.IllegalStateException - in case a transaction is open

disconnect

void disconnect()

Performs a rollback and disconnects this connection

getUser

User getUser()

Returns:

the connection user

getDatabase

Database getDatabase()

Returns:

the database implementation this connection is based on

setMethodLogger

void setMethodLogger(MethodLogger methodLogger)

Parameters:

methodLogger - the MethodLogger to use

getMethodLogger

MethodLogger getMethodLogger()

Returns:

the MethodLogger being used