net.as_development.asdk.api.db

Interface IDBPool

All Known Implementing Classes:

DBPool

public interface IDBPool

Obtaining an instance of type IDB can be tricky ... e.g. in case performance aspects like multiplexing data bases or tables should be used for performance reasons. Creating such IDB instances normally by calling new() wont work then. Only a specialized instance can know (if it's configured to know such things) how and if a new instance must be created.

Method Summary

Modifier and Type	Method and Description
IDB	getDbForPersistenceUnit(String sPersistenceUnit) return a new created/reseted or reused IDB instance from the pool which is bound to a persistence unit matching the given name.
void	registerPersistenceUnit(IPersistenceUnit aUnit) register new persistence unit inside this pool.
void	registerPersistenceUnit(String sName) load the specified persistence unit from the persistence.xml file and register those unit inside this pool.

Method Detail

getDbForPersistenceUnit

IDB getDbForPersistenceUnit(String sPersistenceUnit)
                     throws Exception

return a new created/reseted or reused IDB instance from the pool which is bound to a persistence unit matching the given name.

Parameters:

sPersistenceUnit - [IN] name of the persistence unit (configuration) where the searched DB instance is bound to.

Returns:

the right DB instance.

Throws:

Exception

registerPersistenceUnit

void registerPersistenceUnit(String sName)
                      throws Exception

load the specified persistence unit from the persistence.xml file and register those unit inside this pool.

Parameters:

sName - [IN] the name of the persistence unit.

Throws:

Exception - if such persistence unit couldn't be registered successfully.

registerPersistenceUnit

void registerPersistenceUnit(IPersistenceUnit aUnit)
                      throws Exception

register new persistence unit inside this pool.

Parameters:

aUnit - [IN] the new persistence unit for this pool.

Throws:

Exception - if such persistence unit couldn't be registered successfully.