at.chrl.database

Class DatabaseFactory

java.lang.Object

at.chrl.database.DatabaseFactory

public class DatabaseFactory
extends Object

Database Factory

This file is used for creating a pool of connections for the server.
It utilizes database.properties and creates a pool of connections and automatically recycles them when closed.

DB.java utilizes the class.

Author:

Disturbing, SoulKeeper

Method Summary

Modifier and Type	Method and Description
static void	close(Connection con) Closes connection and returns it to the pool.
static void	close(PreparedStatement st) Helper method for silently close PreparedStament object.
static void	close(PreparedStatement st, Connection con) Closes both prepared statement and result set
int	getActiveConnections() Returns number of active connections in the pool.
static Connection	getConnection() Returns an active connection from pool.
static int	getDatabaseMajorVersion() Returns database version.
static int	getDatabaseMinorVersion() Returns database minor version.
static String	getDatabaseName() Returns database name.
int	getIdleConnections() Returns number of Idle connections.
static void	init() Initializes DatabaseFactory.
static void	shutdown() Shuts down pool and closes connections

Methods inherited from class java.lang.Object

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

Method Detail

init

public static void init()

Initializes DatabaseFactory.

getConnection

public static Connection getConnection()
                                throws SQLException

Returns an active connection from pool. This function utilizes the dataSource which grabs an object from the ObjectPool within its limits. The GenericObjectPool.borrowObject()' function utilized in 'DataSource.getConnection()' does not allow any connections to be returned as null, thus a null check is not needed. Throws SQLException in case of a Failed Connection

Returns:

Connection pooled connection

Throws:

SQLException - if can't get connection

getActiveConnections

public int getActiveConnections()

Returns number of active connections in the pool.

Returns:

int Active DB Connections

getIdleConnections

public int getIdleConnections()

Returns number of Idle connections. Idle connections represent the number of instances in Database Connections that have once been connected and now are closed and ready for re-use. The 'getConnection' function will grab idle connections before creating new ones.

Returns:

int Idle DB Connections

shutdown

public static void shutdown()

Shuts down pool and closes connections

close

public static void close(PreparedStatement st,
                         Connection con)

Closes both prepared statement and result set

Parameters:

st - prepared statement to close

con - connection to close

close

public static void close(PreparedStatement st)

Helper method for silently close PreparedStament object.
Associated connection object will not be closed.

Parameters:

st - prepared statement to close

close

public static void close(Connection con)

Closes connection and returns it to the pool.
It's ok to pass null variable here.
When closing connection - this method will make sure that connection returned to the pool in in autocommit mode.
. If it's not - autocommit mode will be forced to 'true'

Parameters:

con - Connection object to close, can be null

getDatabaseName

public static String getDatabaseName()

Returns database name. For instance MySQL 5.0.51 community edition returns MySQL

Returns:

database name that is used.

getDatabaseMajorVersion

public static int getDatabaseMajorVersion()

Returns database version. For instance MySQL 5.0.51 community edition returns 5

Returns:

database major version

getDatabaseMinorVersion

public static int getDatabaseMinorVersion()

Returns database minor version. For instance MySQL 5.0.51 community edition reutnrs 0

Returns:

database minor version