DataRepositoryPool (Tigase XMPP Server 7.0.0 API)

java.lang.Object
- tigase.db.DataRepositoryPool

All Implemented Interfaces:

DataRepository, Repository
```
public class DataRepositoryPool
extends Object
implements DataRepository
```
Created: Sep 4, 2010 2:13:22 PM

Version:

$Rev$

Author:

Artur Hefczyc

Nested Class Summary
- Nested classes/interfaces inherited from interface tigase.db.DataRepository
  DataRepository.dbTypes
- Nested classes/interfaces inherited from interface tigase.db.Repository
  Repository.Meta

Constructor Summary

Constructors
Constructor and Description

DataRepositoryPool()

Constructors
Constructor and Description
`DataRepositoryPool()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addRepo(DataRepository repo)` Method description
`boolean`	`checkTable(String tableName)` The method checks whether a table for the given name exists in the database.
`boolean`	`checkTable(String tableName, String createTableQuery)` The method checks whether a table for the given name exists in the database and if it does not, it automatically creates it.
`void`	`commit()` Commits current transaction on the DataRepository connection.
`Statement`	`createStatement(tigase.xmpp.BareJID user_id)` Creates a SQL statement on which SQL queries can be executed later by the higher repository layer.
`void`	`endTransaction()` Ends current transaction on the DataRepository connection.
`DataRepository.dbTypes`	`getDatabaseType()` Returns type of DataRepository database
`PreparedStatement`	`getPreparedStatement(tigase.xmpp.BareJID user_id, String stIdKey)` Returns a prepared statement for a given key.
`String`	`getResourceUri()` Returns a DB connection string or DB connection URI.
`void`	`initPreparedStatement(String stIdKey, String query)` Initializes a prepared statement for a given query and stores it internally under the given id key.
`void`	`initPreparedStatement(String stIdKey, String query, int autoGeneratedKeys)` Initializes a prepared statement for a given query and stores it internally under the given id key.
`void`	`initRepository(String resource_uri, Map<String,String> params)` The method is called to initialize the data repository.
`void`	`release(Statement stmt, ResultSet rs)` A helper method to release resources from the statement and result set.
`void`	`releaseRepoHandle(DataRepository repo)` Method description
`void`	`rollback()` Rolls back started transaction on the DataRepository connection.
`void`	`startTransaction()` Starts transaction on the DataRepository connection.
`DataRepository`	`takeRepo(tigase.xmpp.BareJID user_id)` Method description
`DataRepository`	`takeRepoHandle(tigase.xmpp.BareJID user_id)` Returns `DataRepository` instance.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DataRepositoryPool
```
public DataRepositoryPool()
```
- Method Detail
  - addRepo
```
public void addRepo(DataRepository repo)
```
    Method description
    
    Parameters:
    repo -
  - takeRepo
```
public DataRepository takeRepo(tigase.xmpp.BareJID user_id)
```
    Method description
  - takeRepoHandle
```
public DataRepository takeRepoHandle(tigase.xmpp.BareJID user_id)
```
    Description copied from interface: DataRepository
    
    Returns DataRepository instance. If this is a repository pool then it returns particular instance from the pool. It this is a real repository instance it returns itself. This is exclusive take, no other thread may use this handle until it is returned to the pool.
    
    Specified by:
    
    takeRepoHandle in interface DataRepository
    
    Parameters:
    user_id - is user account ID for which we acquire the handle.
    
    Returns:
    DataRepository instance.
  - releaseRepoHandle
```
public void releaseRepoHandle(DataRepository repo)
```
    Description copied from interface: DataRepository
    
    Method description
    
    Specified by:
    
    releaseRepoHandle in interface DataRepository
    
    Parameters:
    repo - is a DataRepository
  - checkTable
```
public boolean checkTable(String tableName)
                   throws SQLException
```
    Description copied from interface: DataRepository
    
    The method checks whether a table for the given name exists in the database.
    
    Specified by:
    
    checkTable in interface DataRepository
    
    Parameters:
    tableName - is a String value of the table name to check
    
    Returns:
    true boolean value if the table exist in the database and false if the table was not found.
    
    Throws:
    
    SQLException - if there was a problem accessing database.
  - checkTable
```
public boolean checkTable(String tableName,
                 String createTableQuery)
                   throws SQLException
```
    Description copied from interface: DataRepository
    
    The method checks whether a table for the given name exists in the database and if it does not, it automatically creates it.
    
    Specified by:
    
    checkTable in interface DataRepository
    
    Parameters:
    tableName - is a String value of the table name to check
    createTableQuery - is a String with the query to create table
    
    Returns:
    true boolean value if the table exist in the database and false if the table was not found.
    
    Throws:
    
    SQLException - if there was a problem accessing database.
  - createStatement
```
public Statement createStatement(tigase.xmpp.BareJID user_id)
                          throws SQLException
```
    Description copied from interface: DataRepository
    
    Creates a SQL statement on which SQL queries can be executed later by the higher repository layer.
    
    Specified by:
    
    createStatement in interface DataRepository
    
    Parameters:
    user_id - user id for which the statement has to be created. This is an optional parameter and null can be provided. It is used mainly to group queries for the same user on the same DB connection.
    
    Returns:
    a newly created Statement
    
    Throws:
    
    SQLException - if a JDBC error occurs.
  - getPreparedStatement
```
public PreparedStatement getPreparedStatement(tigase.xmpp.BareJID user_id,
                                     String stIdKey)
                                       throws SQLException
```
    Description copied from interface: DataRepository
    
    Returns a prepared statement for a given key.
    
    Specified by:
    
    getPreparedStatement in interface DataRepository
    
    Parameters:
    user_id - user id for which the statement has to be created. This is an optional parameter and null can be provided. It is used mainly to group queries for the same user on the same DB connection.
    stIdKey - is a statement identification key.
    
    Returns:
    a PreparedStatement for the given id key or null if such a statement does not exist.
    
    Throws:
    
    SQLException
  - getResourceUri
```
public String getResourceUri()
```
    Description copied from interface: DataRepository
    
    Returns a DB connection string or DB connection URI.
    
    Specified by:
    
    getResourceUri in interface DataRepository
    
    Returns:
    a String value representing database connection string.
  - getDatabaseType
```
public DataRepository.dbTypes getDatabaseType()
```
    Description copied from interface: DataRepository
    
    Returns type of DataRepository database
    
    Specified by:
    
    getDatabaseType in interface DataRepository
    
    Returns:
    a value of dbTypes
  - initPreparedStatement
```
public void initPreparedStatement(String stIdKey,
                         String query)
                           throws SQLException
```
    Description copied from interface: DataRepository
    
    Initializes a prepared statement for a given query and stores it internally under the given id key. It can be retrieved later using getPreparedStatement(stIdKey) method.
    
    Specified by:
    
    initPreparedStatement in interface DataRepository
    
    Parameters:
    stIdKey - is a statement identification key.
    query - is a query for the prepared statement.
    
    Throws:
    
    SQLException
  - initPreparedStatement
```
public void initPreparedStatement(String stIdKey,
                         String query,
                         int autoGeneratedKeys)
                           throws SQLException
```
    Description copied from interface: DataRepository
    
    Initializes a prepared statement for a given query and stores it internally under the given id key. It can be retrieved later using getPreparedStatement(stIdKey) method.
    
    Specified by:
    
    initPreparedStatement in interface DataRepository
    
    Parameters:
    stIdKey - is a statement identification key.
    query - is a query for the prepared statement.
    autoGeneratedKeys - defines if statement should return auto generated keys
    
    Throws:
    
    SQLException
  - initRepository
```
public void initRepository(String resource_uri,
                  Map<String,String> params)
                    throws DBInitException
```
    Description copied from interface: Repository
    
    The method is called to initialize the data repository. Depending on the implementation all the initialization parameters can be passed either via resource_uri parameter as the database connection string or via params map if the required repository parameters are more complex or both.
    
    Specified by:
    
    initRepository in interface Repository
    
    Parameters:
    resource_uri - value in most cases representing the database connection string.
    params - is a Map with repository properties necessary to initialize and perform all the functions. The initialization parameters are implementation dependent.
    
    Throws:
    
    DBInitException - if there was an error during repository initialization. Some implementations, though, perform so called lazy initialization so even though there is a problem with the underlying repository it may not be signaled through this method call.
  - release
```
public void release(Statement stmt,
           ResultSet rs)
```
    Description copied from interface: DataRepository
    
    A helper method to release resources from the statement and result set. This is most common operation for all database calls, therefore it does make sense to add such a utility method to the API.
    
    Specified by:
    
    release in interface DataRepository
    
    Parameters:
    stmt - a Statement variable to release resources for. Might be null.
    rs - a ResultSet variable to release resources for. Might be null.
  - startTransaction
```
public void startTransaction()
                      throws SQLException
```
    Description copied from interface: DataRepository
    
    Starts transaction on the DataRepository connection. Please note that calling this method on the repository pool has no effect. You have to obtain particular repository handle first, before you can start transaction.
    
    Specified by:
    
    startTransaction in interface DataRepository
    
    Throws:
    
    SQLException
  - commit
```
public void commit()
            throws SQLException
```
    Description copied from interface: DataRepository
    
    Commits current transaction on the DataRepository connection. Please note that calling this method on the repository pool has no effect. You have to obtain particular repository handle first, before you can start transaction.
    
    Specified by:
    
    commit in interface DataRepository
    
    Throws:
    
    SQLException
  - rollback
```
public void rollback()
              throws SQLException
```
    Description copied from interface: DataRepository
    
    Rolls back started transaction on the DataRepository connection. Please note that calling this method on the repository pool has no effect. You have to obtain particular repository handle first, before you can start transaction.
    
    Specified by:
    
    rollback in interface DataRepository
    
    Throws:
    
    SQLException
  - endTransaction
```
public void endTransaction()
                    throws SQLException
```
    Description copied from interface: DataRepository
    
    Ends current transaction on the DataRepository connection. Please note that calling this method on the repository pool has no effect. You have to obtain particular repository handle first, before you can start transaction.
    
    Specified by:
    
    endTransaction in interface DataRepository
    
    Throws:
    
    SQLException

Class DataRepositoryPool

Nested Class Summary

Nested classes/interfaces inherited from interface tigase.db.DataRepository

Nested classes/interfaces inherited from interface tigase.db.Repository

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DataRepositoryPool

Method Detail

addRepo

takeRepo

takeRepoHandle

releaseRepoHandle

checkTable

checkTable

createStatement

getPreparedStatement

getResourceUri

getDatabaseType

initPreparedStatement

initPreparedStatement

initRepository

release

startTransaction

commit

rollback

endTransaction