org.ifeth.sehr.lib
Class SEHRDataSource

java.lang.Object
  |
  +--org.ifeth.sehr.lib.SEHRDataSource

public class SEHRDataSource

extends java.lang.Object

Simple object for accessing a firebird database within SEHR projects.

To access a SEHR database there are three basic, but different ways
1) using the SQL layer iBATIS
2) accessing the database by using 'java.sql' methods
3) using pooled connections

In any case the database must be connected first. This object can be used either in SEHR server environments where the connection parameters are available by the SEHRCfg.SEHRCfg()configuration object or in a client environment by setting the parameters during object initialization or by using the parameterless construcor together with some setter methods.
Tip: If using 2) to access the database you should use DAOJdbc.DAOJdbc(SEHRDataSource) as a layer between this datasource connector and your application. The DAO provides some commonly used methods for prepared statements in dependence to singleton or pooled connections, executing prepared queries etc.;
In brief the DAO object will save some code to implement java.sql methods.

To use pooled connection do

• initPooledFBDS()
• Then use connectToPool()to establish a connection and get its index
• Finally use getPooledConnection(int)to get the connection handle for usage with standard java.sql procedures

Author:

hansjhaase

See Also:

iBatis Homepage

Constructor Summary

SEHRDataSource()
Initiates a parameterless object instance for database connection To initialize later use init(SEHRCfg object) or initialize manually by setter methods (e.g. on external client applications).

SEHRDataSource(SEHRCfg cfg)
Initiates an object instance with connection parameters using the SEHR configuratio object.

SEHRDataSource(java.lang.String host, int port, java.lang.String database, java.lang.String dblogin, java.lang.String dbpw, java.lang.String XMLpath)
Initiates an object instance with individual connection parameters This constructor is for clients, where a local SEHR configuration access by SEHRCfg is not available.

SEHRDataSource(java.lang.String host, java.lang.String port, java.lang.String database, java.lang.String dblogin, java.lang.String dbpw)
Deprecated. If we're using the db layer 'iBatis' we need XML resources :)

SEHRDataSource(java.lang.String host, java.lang.String sport, java.lang.String database, java.lang.String dblogin, java.lang.String dbpw, java.lang.String XMLpath)
Initiates an object instance with individual connection parameters

Method Summary

void	close() Close the firebird datasource handle of current object.
static void	close(SEHRDataSource fbds) Close the firebird datasource handle of the given object.
void	closeAll() Close all pooled connections
void	closeFBDataSource() Deprecated. use 'close(...)'
static void	closeFBDataSource(SEHRDataSource fbds) Deprecated. use 'close(...)'
java.sql.Connection	connect() Make a connection for the current firebird database source object assuming the parameters are already invoked by this object instance.
static java.sql.Connection	connect(SEHRDataSource fbds) Make a connection for the given firebird database source object assuming the parameters are already invoked by the given 'fbds' object instance.
java.sql.Connection	connectFBDataSource() Deprecated. use 'connect()'
static java.sql.Connection	connectFBDataSource(SEHRDataSource fbds) Deprecated. use 'connect()'
java.sql.Connection	connectFBDataSource(SEHRDataSource fbds, java.lang.String host, java.lang.String port, java.lang.String database, java.lang.String dblogin, java.lang.String dbpw) Deprecated. use 'connect()'
java.sql.Connection	connectFBDataSource(java.lang.String host, java.lang.String port, java.lang.String database, java.lang.String dblogin, java.lang.String dbpw) Deprecated. use 'connect()'
int	connectToPool() Create a new pooled connection for current firebird database source object. * Note: Use closePooledConnection(int conidx)!
int	countExpectedPooledConnections() Get number of currently pooled connections handled by object
int	countPooledConnections() Get number of currently pooled connections by FB engine
java.lang.String	getDBHost() For general usage: get host of db access
java.util.List	getGenerator()
java.util.List	getGenerator(java.lang.String genid)
java.sql.Connection	getHFBConnection() Return the connection handle for the current datasource object.
java.sql.Connection	getHFBConnection(SEHRDataSource fbds) Return the connection handle for given firebird datasource object
java.sql.Connection	getPooledConnection(int idx) Get an already established connection from pool given by index.
com.ibatis.sqlmap.client.SqlMapClient	getSqlmap() Get the initialized SQL mapping object of connected datasource This is the recommended object for accessng the database by its SQL objects; see example in main(String[])
void	init() Initialize SEHR environment for db connections by setting the configuration object The configuration holds some more informations like the XML mappings.
void	init(java.lang.String sehrcfgfile) Initialize SEHR environment
org.firebirdsql.jdbc.FBWrappingDataSource	initPooledFBDS() Init a pooled data connection
boolean	isPooledConnection() Get status if a pooled datasource already in use
static void	main(java.lang.String[] args) For testing purposes only...
void	setCfg(SEHRCfg cfg) Set cfg object to use for datasource initialization
void	setDataBase(java.lang.String dataBase) For client usage: set database including path_to_db_file
void	setDBHost(java.lang.String host) For client usage: set port of firebird engine
void	setDBLogin(java.lang.String login) For client usage: set database login name
void	setDBPort(int port) For client usage: set port of firebird engine
void	setDBPw(java.lang.String pw) For client usage: set database login password
void	setSqlMap(com.ibatis.sqlmap.client.SqlMapClient sqlmap) Set SQL mapping object.
java.lang.String	showProcedures()
static java.lang.String	showProcedures(SEHRDataSource fbds)
java.lang.String	showTables()
java.lang.String	showTables(boolean showfields)
static java.lang.String	showTables(SEHRDataSource fbds)
static java.lang.String	showTables(SEHRDataSource fbds, boolean showfields)

Methods inherited from class java.lang.Object

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

Constructor Detail

SEHRDataSource

public SEHRDataSource()

Initiates a parameterless object instance for database connection

To initialize later use init(SEHRCfg object) or initialize manually by setter methods (e.g. on external client applications).

SEHRDataSource

public SEHRDataSource(SEHRCfg cfg)

Initiates an object instance with connection parameters using the SEHR configuratio object.

This is the recommended way on SEHR servers. To connect/open use connectFBDataSource((Object) this)

SEHRDataSource

public SEHRDataSource(java.lang.String host,
                      int port,
                      java.lang.String database,
                      java.lang.String dblogin,
                      java.lang.String dbpw,
                      java.lang.String XMLpath)

Initiates an object instance with individual connection parameters

This constructor is for clients, where a local SEHR configuration access by SEHRCfg is not available. There are two ways for the client to get the parameters
1) by written papers and a local configuration :)
2) by using a SOAP or socket request to the server by IP and port

To connect/open use connectFBDataSource((Object) this)

Parameters:

host -

port -

database -

dblogin -

dbpw -

XMLpath - if using 'iBatis' this is the path to the SQL-XML files

SEHRDataSource

public SEHRDataSource(java.lang.String host,
                      java.lang.String sport,
                      java.lang.String database,
                      java.lang.String dblogin,
                      java.lang.String dbpw,
                      java.lang.String XMLpath)

Initiates an object instance with individual connection parameters

See Also:

SEHRDataSource(String, int, String, String, String, String)

SEHRDataSource

public SEHRDataSource(java.lang.String host,
                      java.lang.String port,
                      java.lang.String database,
                      java.lang.String dblogin,
                      java.lang.String dbpw)

Deprecated. If we're using the db layer 'iBatis' we need XML resources :)

Initiates an object instance with individual connection parameters

To connect/open use connect()

Parameters:

host -

port -

database -

dblogin -

dbpw -

Method Detail

init

public void init()

Initialize SEHR environment for db connections by setting the configuration object

The configuration holds some more informations like the XML mappings.

init

public void init(java.lang.String sehrcfgfile)

Initialize SEHR environment

See Also:

setCfg(SEHRCfg)

initPooledFBDS

public org.firebirdsql.jdbc.FBWrappingDataSource initPooledFBDS()

Init a pooled data connection

connectFBDataSource

public java.sql.Connection connectFBDataSource()

Deprecated. use 'connect()'

Make a connection for current firebird database source object

connectFBDataSource

public java.sql.Connection connectFBDataSource(java.lang.String host,
                                               java.lang.String port,
                                               java.lang.String database,
                                               java.lang.String dblogin,
                                               java.lang.String dbpw)

Deprecated. use 'connect()'

Make a connection for current firebird database source object w/ submitting connection paramters. If connected the method "getHFBConnection()' returns the handle (is not null.)

connectFBDataSource

public java.sql.Connection connectFBDataSource(SEHRDataSource fbds,
                                               java.lang.String host,
                                               java.lang.String port,
                                               java.lang.String database,
                                               java.lang.String dblogin,
                                               java.lang.String dbpw)

Deprecated. use 'connect()'

Make a connection for given firebird database source object w/ submitting connection paramters. If connected the method "[object].getHFBConnection()' is not null.

connectFBDataSource

public static java.sql.Connection connectFBDataSource(SEHRDataSource fbds)

Deprecated. use 'connect()'

connect

public java.sql.Connection connect()

Make a connection for the current firebird database source object assuming the parameters are already invoked by this object instance.

connect

public static java.sql.Connection connect(SEHRDataSource fbds)

Make a connection for the given firebird database source object assuming the parameters are already invoked by the given 'fbds' object instance.

This is the method finally called to connect

Parameters:

fbds -

Returns:

Connection Handle of connection or 'null'

closeFBDataSource

public void closeFBDataSource()
                       throws java.sql.SQLException

Deprecated. use 'close(...)'

Close the firebird datasource handle of the current object.

java.sql.SQLException

closeFBDataSource

public static void closeFBDataSource(SEHRDataSource fbds)
                              throws java.sql.SQLException

Deprecated. use 'close(...)'

java.sql.SQLException

close

public void close()
           throws java.sql.SQLException

Close the firebird datasource handle of current object.

java.sql.SQLException

close

public static void close(SEHRDataSource fbds)
                  throws java.sql.SQLException

Close the firebird datasource handle of the given object.

Parameters:

fbds - FBDataSource object

java.sql.SQLException

connectToPool

public int connectToPool()
                  throws java.sql.SQLException

Create a new pooled connection for current firebird database source object. *

Note: Use closePooledConnection(int conidx)! Pooled connections do have large benefits in c/s connections but there are also some traps. One of these traps is the number and the maximum of pooled concurrent connections. To get an overview of the number of real connections use countPooledConnections(). To get the number of managed connections use countExpectedPooledConnections().
To close all connections at once use closeAll()
To get established connection use getPooledConnection(int idx)

Throws:

java.sql.SQLException

See Also:

Firebird on Sourceforge

getPooledConnection

public java.sql.Connection getPooledConnection(int idx)

Get an already established connection from pool given by index.

To keep the integrity of prepared statements the pool is indexed. So you may init a connection, assign statements to it and use exactly the indexed connection to get your statementents back.

closeAll

public void closeAll()

Close all pooled connections

countPooledConnections

public int countPooledConnections()

Get number of currently pooled connections by FB engine

countExpectedPooledConnections

public int countExpectedPooledConnections()

Get number of currently pooled connections handled by object

isPooledConnection

public boolean isPooledConnection()

Get status if a pooled datasource already in use

getSqlmap

public com.ibatis.sqlmap.client.SqlMapClient getSqlmap()

Get the initialized SQL mapping object of connected datasource

This is the recommended object for accessng the database by its SQL objects; see example in main(String[])

Returns:

sqlmap SQL mapping object of iBatis layer

setSqlMap

public void setSqlMap(com.ibatis.sqlmap.client.SqlMapClient sqlmap)

Set SQL mapping object.

setCfg

public void setCfg(SEHRCfg cfg)

Set cfg object to use for datasource initialization

setDBPort

public void setDBPort(int port)

For client usage: set port of firebird engine

getDBHost

public java.lang.String getDBHost()

For general usage: get host of db access

Returns:

ip_as_String

setDBHost

public void setDBHost(java.lang.String host)

For client usage: set port of firebird engine

setDataBase

public void setDataBase(java.lang.String dataBase)

For client usage: set database including path_to_db_file

setDBLogin

public void setDBLogin(java.lang.String login)

For client usage: set database login name

setDBPw

public void setDBPw(java.lang.String pw)

For client usage: set database login password

getHFBConnection

public java.sql.Connection getHFBConnection()

Return the connection handle for the current datasource object.

Returns:

Connection hFBConnection

getHFBConnection

public java.sql.Connection getHFBConnection(SEHRDataSource fbds)

Return the connection handle for given firebird datasource object

Parameters:

fbds - FBDataSource object

Returns:

hFBConnection Connection object

showTables

public java.lang.String showTables()

showTables

public java.lang.String showTables(boolean showfields)

showTables

public static java.lang.String showTables(SEHRDataSource fbds)

showTables

public static java.lang.String showTables(SEHRDataSource fbds,
                                          boolean showfields)

showProcedures

public java.lang.String showProcedures()

showProcedures

public static java.lang.String showProcedures(SEHRDataSource fbds)

getGenerator

public java.util.List getGenerator()

getGenerator

public java.util.List getGenerator(java.lang.String genid)

main

public static void main(java.lang.String[] args)

For testing purposes only...