Package tigase.db
Class DataRepositoryPool
java.lang.Object
tigase.db.DataRepositoryPool
- All Implemented Interfaces:
DataRepository,DataSource,DataSourcePool<DataRepository>,Repository,RepositoryPool<DataRepository>,StatisticsProviderIfc
public class DataRepositoryPool
extends Object
implements DataRepository, DataSourcePool<DataRepository>, StatisticsProviderIfc
Created: Sep 4, 2010 2:13:22 PM
- Author:
- Artur Hefczyc
-
Nested Class Summary
Nested classes/interfaces inherited from interface tigase.db.DataRepository
DataRepository.dbTypesNested classes/interfaces inherited from interface tigase.db.Repository
Repository.Meta, Repository.SchemaId -
Field Summary
Fields inherited from interface tigase.db.DataRepository
UTC_CALENDAR -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddRepo(DataRepository repo) Method called to add instance of a repository to the repository pool.booleanvoidcheckConnectivity(Duration watchdogTime) This method is called by data source bean watchdog mechanism to ensure that there is proper connectivity to underlying data storage.booleancheckSchemaVersion(DataSourceAware<? extends DataSource> datasource, boolean shutdownServer) Method checks version of the particular DataSource stored in the defined source.booleancheckTable(String tableName) The method checks whether a table for the given name exists in the database.booleancheckTable(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.voidcommit()Commits current transaction on the DataRepository connection.createStatement(BareJID user_id) Creates a SQL statement on which SQL queries can be executed later by the higher repository layer.voidEnds current transaction on the DataRepository connection.Returns type of DataRepository databaseintgetPreparedStatement(int hashCode, String stIdKey) Returns a prepared statement for a given key.getPreparedStatement(BareJID user_id, String stIdKey) Returns a prepared statement for a given key.Returns a DB connection string or DB connection URI.getSchemaVersion(String component) Method obtains version of the schema for particular component stored in the database.voidgetStatistics(String compName, StatisticsList list) voidinitialize(String resource_uri) The method is called to initialize the data repository.voidinitPreparedStatement(String stIdKey, String query) Initializes a prepared statement for a given query and stores it internally under the given id key.voidinitPreparedStatement(String stIdKey, String query, int autoGeneratedKeys) Initializes a prepared statement for a given query and stores it internally under the given id key.voidinitRepository(String resource_uri, Map<String, String> params) Deprecated.voidA helper method to release resources from the statement and result set.voidvoidrollback()Rolls back started transaction on the DataRepository connection.voidStarts transaction on the DataRepository connection.takeRepo(int hashCode) takeRepoHandle(BareJID user_id) ReturnsDataRepositoryinstance.toString()Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface tigase.db.DataRepository
getTimestamp, getTimestamp, setTimestamp
-
Constructor Details
-
DataRepositoryPool
public DataRepositoryPool()
-
-
Method Details
-
addRepo
Description copied from interface:RepositoryPoolMethod called to add instance of a repository to the repository pool.- Specified by:
addRepoin interfaceRepositoryPool<DataRepository>- Parameters:
repo- instance of a repository
-
automaticSchemaManagement
public boolean automaticSchemaManagement()- Specified by:
automaticSchemaManagementin interfaceDataSource
-
checkConnectivity
Description copied from interface:DataSourceThis method is called by data source bean watchdog mechanism to ensure that there is proper connectivity to underlying data storage.- Specified by:
checkConnectivityin interfaceDataSource- Parameters:
watchdogTime- time which should pass between checks
-
takeRepo
-
takeRepo
-
takeRepoHandle
Description copied from interface:DataRepositoryReturnsDataRepositoryinstance. 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:
takeRepoHandlein interfaceDataRepository- Parameters:
user_id- is user account ID for which we acquire the handle.- Returns:
- DataRepository instance.
-
releaseRepoHandle
- Specified by:
releaseRepoHandlein interfaceDataRepository
-
checkSchemaVersion
public boolean checkSchemaVersion(DataSourceAware<? extends DataSource> datasource, boolean shutdownServer) Description copied from interface:DataSourceMethod checks version of the particular DataSource stored in the defined source.- Specified by:
checkSchemaVersionin interfaceDataSource- Parameters:
datasource- implementation ofDataSourceAwareinterfaceshutdownServer- specifies whether server should be shutdown automatically if the version in the database doesn't match required version.- Returns:
- a
falsewhen the version doesn't match or there is no version information in the repository. ifshutdownServeris set totrueand the component version is final it would force shutting down of the server, otherwise (for non-final version) only a warning would be printed.
-
getSchemaVersion
Description copied from interface:DataSourceMethod obtains version of the schema for particular component stored in the database.- Specified by:
getSchemaVersionin interfaceDataSource- Parameters:
component- name of the component for which we want to get the schema version- Returns:
- an optional value of the version.
-
checkTable
Description copied from interface:DataRepositoryThe method checks whether a table for the given name exists in the database.- Specified by:
checkTablein interfaceDataRepository- Parameters:
tableName- is aStringvalue of the table name to check- Returns:
truebooleanvalue if the table exist in the database andfalseif the table was not found.- Throws:
SQLException- if there was a problem accessing database.
-
checkTable
Description copied from interface:DataRepositoryThe method checks whether a table for the given name exists in the database and if it does not, it automatically creates it.- Specified by:
checkTablein interfaceDataRepository- Parameters:
tableName- is aStringvalue of the table name to checkcreateTableQuery- is aStringwith the query to create table- Returns:
truebooleanvalue if the table exist in the database andfalseif the table was not found.- Throws:
SQLException- if there was a problem accessing database.
-
createStatement
Description copied from interface:DataRepositoryCreates a SQL statement on which SQL queries can be executed later by the higher repository layer.- Specified by:
createStatementin interfaceDataRepository- 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
Description copied from interface:DataRepositoryReturns a prepared statement for a given key.- Specified by:
getPreparedStatementin interfaceDataRepository- 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
PreparedStatementfor the given id key or null if such a statement does not exist. - Throws:
SQLException
-
getPreparedStatement
Description copied from interface:DataRepositoryReturns a prepared statement for a given key.- Specified by:
getPreparedStatementin interfaceDataRepository- Parameters:
hashCode- user for selection of connection to use. It is used mainly to group queries for the same user on the same DB connection.stIdKey- is a statement identification key.- Returns:
- a
PreparedStatementfor the given id key or null if such a statement does not exist. - Throws:
SQLException
-
getResourceUri
Description copied from interface:DataRepositoryReturns a DB connection string or DB connection URI.- Specified by:
getResourceUriin interfaceDataRepository- Specified by:
getResourceUriin interfaceDataSource- Returns:
- a
Stringvalue representing database connection string.
-
getDatabaseType
Description copied from interface:DataRepositoryReturns type of DataRepository database- Specified by:
getDatabaseTypein interfaceDataRepository- Returns:
- a value of
dbTypes
-
getStatistics
- Specified by:
getStatisticsin interfaceStatisticsProviderIfc
-
initPreparedStatement
Description copied from interface:DataRepositoryInitializes a prepared statement for a given query and stores it internally under the given id key. It can be retrieved later usinggetPreparedStatement(stIdKey)method.- Specified by:
initPreparedStatementin interfaceDataRepository- 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:DataRepositoryInitializes a prepared statement for a given query and stores it internally under the given id key. It can be retrieved later usinggetPreparedStatement(stIdKey)method.- Specified by:
initPreparedStatementin interfaceDataRepository- 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
-
initialize
Description copied from interface:DataSourceThe method is called to initialize the data repository.- Specified by:
initializein interfaceDataSource- Parameters:
resource_uri- value in most cases representing the database connection string.- Throws:
DBInitException
-
initRepository
@Deprecated public void initRepository(String resource_uri, Map<String, String> params) throws DBInitExceptionDeprecated.Description copied from interface:RepositoryMethod is deprecated and should not be user any more.
The method is called to initialize the data repository. Depending on the implementation all the initialization parameters can be passed either viaresource_uriparameter as the database connection string or viaparamsmap if the required repository parameters are more complex or both.- Specified by:
initRepositoryin interfaceRepository- Parameters:
resource_uri- value in most cases representing the database connection string.params- is aMapwith 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
Description copied from interface:DataRepositoryA 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:
releasein interfaceDataRepository- Parameters:
stmt- aStatementvariable to release resources for. Might be null.rs- aResultSetvariable to release resources for. Might be null.
-
startTransaction
Description copied from interface:DataRepositoryStarts 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:
startTransactionin interfaceDataRepository- Throws:
SQLException
-
commit
Description copied from interface:DataRepositoryCommits 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:
commitin interfaceDataRepository- Throws:
SQLException
-
rollback
Description copied from interface:DataRepositoryRolls 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:
rollbackin interfaceDataRepository- Throws:
SQLException
-
endTransaction
Description copied from interface:DataRepositoryEnds 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:
endTransactionin interfaceDataRepository- Throws:
SQLException
-
getPoolSize
public int getPoolSize()- Specified by:
getPoolSizein interfaceDataRepository
-
toString
-