com.stc.connector.db
Interface DbConnector

public interface DbConnector

Connector interface for database e*Way.

Version:

$Revision: 1.2 $

Author:

$Author: cmbuild $

Method Summary

void	close() Requests the DbConnector to close a connection and release all the necessary resources.
void	commit() Commits a transaction for the connection.
java.lang.Object	connInvoke(java.lang.String methodName, java.lang.Class[] argsCls, java.lang.Object[] args) Invokes a method of the database Connection object of this ETD.
boolean	getAutoCommit() Gets the AutoCommit mode of the connection.
java.lang.String	getCatalog() Gets the catalog name of the connection.
java.sql.Connection	getConnection() Get the database Connection object of this ETD.
com.stc.connector.appconn.db.StatementAgent	getInstance(java.lang.Class clsAgent) /** Gets an instance of the named StaementAgent.
com.stc.connector.appconn.db.StatementAgent	getInstance(java.lang.Class clsAgent, int iScroll, int iConcur) Gets an instance of the named StaementAgent with the specified resultset and concurrency types.
int	getTransactionIsolation() Gets the transaction isolation level for the connection.
void	init(javax.sql.DataSource ds, java.util.Properties props) Initialize DbConnector
boolean	isConnected() Returns the connection status.
boolean	isOpen() Checks if the DbConnector has a open connection.
void	open(javax.sql.DataSource ds, java.util.Properties props) Requests the DbConnector object to open a connection and allocate necessary resources.
void	release() Releases all the DbConnector resources.
void	requestReset() Receives a request to reset the data content of the DB ETD.
void	rollback() Rollbacks a transaction for the connection.
void	setAutoCommit(boolean bAuto) Sets the AutoCommit mode of the connection.
void	setCatalog(java.lang.String sCatalog) Sets the catalog name of the connection.
void	setConcurrencyToReadOnly() Set concurrency type of the session to read only.
void	setConcurrencyToUpdatable() Set concurrency type of the session to updatable.
void	setScrollTypeToForwardOnly() Set result set type of the session to be forward only.
void	setScrollTypeToScrollInsensitive() Set result set type of the session to be insensitive.
void	setScrollTypeToScrollSensitive() Set result set type of the session to be sensitive.
void	setTransactionIsolation(int iLevel) Sets the transaction isolation level for the connection.

Method Detail

init

void init(javax.sql.DataSource ds,
          java.util.Properties props)
          throws java.sql.SQLException

Initialize DbConnector

Parameters:

ds - a DataSource object used to establish connection.

props - a property object which consists of connecton information.

Throws:

java.sql.SQLException - owing to session creation.

open

void open(javax.sql.DataSource ds,
          java.util.Properties props)
          throws java.sql.SQLException

Requests the DbConnector object to open a connection and allocate necessary resources.

Parameters:

ds - a DataSource object used to establish connection.

props - a property object which consists of connecton information.

Throws:

java.sql.SQLException - owing to opening a connection.

close

void close()
           throws java.sql.SQLException

Requests the DbConnector to close a connection and release all the necessary resources.

Throws:

java.sql.SQLException - when encountering any error in closing a connection.

release

void release()

Releases all the DbConnector resources.

isOpen

boolean isOpen()
               throws java.sql.SQLException

Checks if the DbConnector has a open connection.

Returns:

true if the connection is still oper; false otherwise.

Throws:

java.sql.SQLException - if errors are encountered during connection checking.

isConnected

boolean isConnected()

Returns the connection status.

Returns:

true if connection is broken or not established; false otherwise.

getInstance

com.stc.connector.appconn.db.StatementAgent getInstance(java.lang.Class clsAgent)
                                                        throws java.sql.SQLException

/** Gets an instance of the named StaementAgent. Only one instance of this class will be created. The same instance will be retrieved if it has been created.

Parameters:

clsAgent - the class of the StatementAgent.

Returns:

the named StatementAgent instance.

Throws:

java.sql.SQLException - if it encounters errors in instantiating the named class.

getInstance

com.stc.connector.appconn.db.StatementAgent getInstance(java.lang.Class clsAgent,
                                                        int iScroll,
                                                        int iConcur)
                                                        throws java.sql.SQLException

Gets an instance of the named StaementAgent with the specified resultset and concurrency types. Only one instance of this class will be created. The same instance will be retrieved if it has been created.

Parameters:

clsAgent - the class of the StatementAgent.

iScroll - resultset type; TYPE_FORWARD_ONLY, TYPE_SCROLL_INSENSITIVE, TYPE_SCROLL_SENSITIVE

iConcur - concurrency type; CONCUR_READ_ONLY, CONCUR_UPDATABLE

Returns:

the named StatementAgent instance.

Throws:

java.sql.SQLException - if it encounters errors in instantiating the named class.

getAutoCommit

boolean getAutoCommit()
                      throws java.sql.SQLException

Gets the AutoCommit mode of the connection.

Returns:

true if the Autocommit mode is true; false otherwise.

Throws:

java.sql.SQLException - if there is any error in getting the AutoCommit mode from the database.

setAutoCommit

void setAutoCommit(boolean bAuto)
                   throws java.sql.SQLException

Sets the AutoCommit mode of the connection.

Parameters:

bAuto - a true value will set the connection to be in AutoCommit mode; false otherwise.

Throws:

java.sql.SQLException - if there is any problem in setting the AutoCommit mode.

getCatalog

java.lang.String getCatalog()
                            throws java.sql.SQLException

Gets the catalog name of the connection.

Returns:

the catalog name.

Throws:

java.sql.SQLException - if there is any problem in getting the catalog name.

setCatalog

void setCatalog(java.lang.String sCatalog)
                throws java.sql.SQLException

Sets the catalog name of the connection.

Parameters:

sCatalog - the desired catalog name.

Throws:

java.sql.SQLException - if there is any problem in setting the catalog name.

getTransactionIsolation

int getTransactionIsolation()
                            throws java.sql.SQLException

Gets the transaction isolation level for the connection.

Returns:

the transaction isolation level: TRANSACTION_NONE, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE.

Throws:

java.sql.SQLException - if there is any error in getting the transaction isolation level.

setTransactionIsolation

void setTransactionIsolation(int iLevel)
                             throws java.sql.SQLException

Sets the transaction isolation level for the connection.

Parameters:

iLevel - a transaction isolation value: TRANSACTION_NONE, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE.

Throws:

java.sql.SQLException - if there is any problem in setting the transaction isolation level.

commit

void commit()
            throws java.sql.SQLException

Commits a transaction for the connection. All data changes will be permanent.

Throws:

java.sql.SQLException - if there is any problem in commiting a transaction.

rollback

void rollback()
              throws java.sql.SQLException

Rollbacks a transaction for the connection. All data changes will be cleared.

Throws:

java.sql.SQLException - if there is any problem in rolling back a transaction.

requestReset

void requestReset()

Receives a request to reset the data content of the DB ETD.

connInvoke

java.lang.Object connInvoke(java.lang.String methodName,
                            java.lang.Class[] argsCls,
                            java.lang.Object[] args)
                            throws java.sql.SQLException

Invokes a method of the database Connection object of this ETD.

Parameters:

methodName - the name of the method

argsCls - Class array for types of formal arguments for method, in the declared order. Can be null if there are no formal arguments. However, cannot invoke constructor here.

args - Object array of formal arguments for method in the declared order. Can be null if there are no formal arguments. However, cannot invoke constructor here.

Returns:

the Object instance resulting from the method invocation. Can be null if nothing is returned (void return declaration).

Throws:

java.sql.SQLException - whatever exception the invoked method throws.

getConnection

java.sql.Connection getConnection()
                                  throws java.sql.SQLException

Get the database Connection object of this ETD.

Returns:

the database Connection object of this ETD.

Throws:

java.sql.SQLException - owing to connection retrieval.

setScrollTypeToForwardOnly

void setScrollTypeToForwardOnly()
                                throws java.sql.SQLException

Set result set type of the session to be forward only.

Throws:

java.sql.SQLException - if there is any problem in setting scroll type.

setScrollTypeToScrollInsensitive

void setScrollTypeToScrollInsensitive()
                                      throws java.sql.SQLException

Set result set type of the session to be insensitive.

Throws:

java.sql.SQLException - if there is any problem in setting scroll type.

setScrollTypeToScrollSensitive

void setScrollTypeToScrollSensitive()
                                    throws java.sql.SQLException

Set result set type of the session to be sensitive.

Throws:

java.sql.SQLException - if there is any problem in setting scroll type.

setConcurrencyToReadOnly

void setConcurrencyToReadOnly()
                              throws java.sql.SQLException

Set concurrency type of the session to read only.

Throws:

java.sql.SQLException - if there is any problem in setting concurrency type.

setConcurrencyToUpdatable

void setConcurrencyToUpdatable()
                               throws java.sql.SQLException

Set concurrency type of the session to updatable.

Throws:

java.sql.SQLException - if there is any problem in setting concurrency type.