org.identityconnectors.dbcommon

Class DatabaseConnection

java.lang.Object

org.identityconnectors.dbcommon.DatabaseConnection

Direct Known Subclasses:

DatabaseTableConnection

public class DatabaseConnection
extends Object

The DatabaseConnection wraps the JDBC connection. Define the test method meaning the wrapped connection is still valid Defines come useful method to work with prepared statements.

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
DatabaseConnection(Connection conn) Use the Configuration passed in to immediately connect to a database.

Method Summary

Modifier and Type	Method and Description
void	commit() commit transaction.
void	dispose() Closes the internal Connection.
Connection	getConnection() Get the internal JDBC connection.
CallableStatement	prepareCall(String sql, List<SQLParam> params) Indirect call of prepareCall statement with mapped callable statement parameters.
PreparedStatement	prepareStatement(DatabaseQueryBuilder query) Indirect call of prepare statement using the query builder object.
PreparedStatement	prepareStatement(String sql, List<SQLParam> params) Indirect call of prepare statement with mapped prepare statement parameters.
void	setConnection(Connection connection) Get the internal JDBC connection.
void	test() Determines if the underlying JDBC Connection is valid.

Methods inherited from class java.lang.Object

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

Constructor Detail

DatabaseConnection

public DatabaseConnection(Connection conn)

Use the Configuration passed in to immediately connect to a database. If the Connection fails a RuntimeException will be thrown.

Parameters:

conn - a connection

Throws:

RuntimeException - if there is a problem creating a Connection.

Method Detail

dispose

public void dispose()

Closes the internal Connection.

test

public void test()

Determines if the underlying JDBC Connection is valid.

Throws:

RuntimeException - if the underlying JDBC Connection is not valid otherwise do nothing.

getConnection

public Connection getConnection()

Get the internal JDBC connection.

Returns:

the connection

setConnection

public void setConnection(Connection connection)

Get the internal JDBC connection.

Parameters:

connection - new connection

prepareStatement

public PreparedStatement prepareStatement(String sql,
                                          List<SQLParam> params)
                                   throws SQLException

Indirect call of prepare statement with mapped prepare statement parameters.

Parameters:

sql - a String sql statement definition

params - the bind parameter values

Returns:

return a prepared statement

Throws:

SQLException - an exception in statement

prepareStatement

public PreparedStatement prepareStatement(DatabaseQueryBuilder query)
                                   throws SQLException

Indirect call of prepare statement using the query builder object.

Parameters:

query - DatabaseQueryBuilder query

Returns:

return a prepared statement

Throws:

SQLException - an exception in statement

prepareCall

public CallableStatement prepareCall(String sql,
                                     List<SQLParam> params)
                              throws SQLException

Indirect call of prepareCall statement with mapped callable statement parameters.

Parameters:

sql - a String sql statement definition

params - the bind parameter values

Returns:

return a callable statement

Throws:

SQLException - an exception in statement

commit

public void commit()

commit transaction.