org.rhq.core.db

Class DbUtil

java.lang.Object

org.rhq.core.db.DbUtil

public class DbUtil
extends Object

Provides database utilities. See also DatabaseTypeFactory for additional database functionality.

Author:

John Mazzitelli

See Also:

DatabaseTypeFactory

Method Summary

Methods

Modifier and Type	Method and Description
static Connection	getConnection(String jdbc_url, String username, String password) Given a JDBC URL, this will attempt to create a connection to the database.
static String	getSQLExceptionString(SQLException e) Given an SQL exception, this will return a string that contains the error code and message for it and its causes.
static boolean	ping(String jdbc_url, String username, String password) Pings a database by simply connecting to it.

Methods inherited from class java.lang.Object

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

Method Detail

getConnection

public static Connection getConnection(String jdbc_url,
                       String username,
                       String password)
                                throws SQLException

Given a JDBC URL, this will attempt to create a connection to the database. The connection can then be used to get the DatabaseType object via DatabaseTypeFactory.getDatabaseType(Connection).

Parameters:

jdbc_url - a connection URL to the database

username - may be null in which case an anonymous login will be attempted

password -

Returns:

a live database connection

Throws:

SQLException - if failed to connect to the database

ping

public static boolean ping(String jdbc_url,
           String username,
           String password)

Pings a database by simply connecting to it. If the user credentials allow for a successful connection to the given JDBC URL, this returns true. If the connection attempt fails, this returns false.

Parameters:

jdbc_url -

username -

password -

Returns:

true if a connection to the database can be made

getSQLExceptionString

public static String getSQLExceptionString(SQLException e)

Given an SQL exception, this will return a string that contains the error code and message for it and its causes.

Parameters:

e - the SQL exception

Returns:

error message containing all the SQL error codes and messages