|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.torque.TorqueInstance
public class TorqueInstance
The core of Torque's implementation. Both the classic Torque
static wrapper and the TorqueComponent
Avalon implementation leverage
this class.
Constructor Summary | |
---|---|
TorqueInstance()
Creates a new instance with default configuration. |
Method Summary | |
---|---|
void |
closeConnection(java.sql.Connection con)
Closes a connection. |
org.apache.commons.configuration.Configuration |
getConfiguration()
Get the configuration for this component. |
java.sql.Connection |
getConnection()
This method returns a Connection from the default pool. |
java.sql.Connection |
getConnection(java.lang.String name)
Returns a database connection to the database with the key name . |
java.sql.Connection |
getConnection(java.lang.String name,
java.lang.String username,
java.lang.String password)
This method returns a Connection using the given parameters. |
Database |
getDatabase(java.lang.String databaseName)
Returns the database for the key databaseName . |
DatabaseMap |
getDatabaseMap()
Returns the default database map information. |
DatabaseMap |
getDatabaseMap(java.lang.String name)
Returns the database map information. |
java.util.Map |
getDatabases()
Returns a Map containing all Databases registered to Torque. |
DataSourceFactory |
getDataSourceFactory(java.lang.String name)
Returns the DataSourceFactory for the database with the name name . |
DB |
getDB(java.lang.String name)
Returns the database adapter for a specific database. |
java.lang.String |
getDefaultDB()
Returns the name of the default database. |
AbstractBaseManager |
getManager(java.lang.String name)
This method returns a Manager for the given name. |
AbstractBaseManager |
getManager(java.lang.String name,
java.lang.String defaultClassName)
This methods returns either the Manager from the configuration file, or the default one provided by the generated code. |
MapBuilder |
getMapBuilder(java.lang.String className)
Get a MapBuilder |
java.util.Map |
getMapBuilders()
Get the registered MapBuilders |
Database |
getOrCreateDatabase(java.lang.String databaseName)
Returns the database for the key databaseName . |
java.lang.String |
getSchema(java.lang.String name)
This method returns the current schema for a database connection |
void |
init(org.apache.commons.configuration.Configuration conf)
Initialization of Torque with a Configuration object. |
void |
init(java.lang.String configFile)
Initialization of Torque with a properties file. |
protected void |
initManagerMappings(org.apache.commons.configuration.Configuration conf)
Creates a mapping between classes and their manager classes. |
boolean |
isInit()
Determine whether Torque has already been initialized. |
void |
registerMapBuilder(MapBuilder builder)
Register a MapBuilder |
void |
registerMapBuilder(java.lang.String className)
Register a MapBuilder |
void |
setConfiguration(org.apache.commons.configuration.Configuration conf)
Sets the configuration for Torque and all dependencies. |
void |
setSchema(java.lang.String name,
java.lang.String schema)
Sets the current schema for a database connection |
void |
shutdown()
Shuts down the service. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public TorqueInstance()
resetConfiguration()
Method Detail |
---|
public void init(java.lang.String configFile) throws TorqueException
configFile
- The absolute path to the configuration file.
TorqueException
- Any exceptions caught during processing will be
rethrown wrapped into a TorqueException.public void init(org.apache.commons.configuration.Configuration conf) throws TorqueException
conf
- The Torque configuration.
TorqueException
- Any exceptions caught during processing will be
rethrown wrapped into a TorqueException.protected void initManagerMappings(org.apache.commons.configuration.Configuration conf) throws TorqueException
torque.managed_class.com.mycompany.Myclass.manager= \ com.mycompany.MyManagerImpl services.managed_class.com.mycompany.Myotherclass.manager= \ com.mycompany.MyOtherManagerImpl
conf
- the Configuration representing the properties file
TorqueException
- Any exceptions caught during processing will be
rethrown wrapped into a TorqueException.public boolean isInit()
public void setConfiguration(org.apache.commons.configuration.Configuration conf)
TORQUE_KEY
needs to be removed from the
configuration keys for the provided configuration.
conf
- the Configuration.public org.apache.commons.configuration.Configuration getConfiguration()
public AbstractBaseManager getManager(java.lang.String name)
name
- name of the manager
public AbstractBaseManager getManager(java.lang.String name, java.lang.String defaultClassName)
name
- name of the managerdefaultClassName
- the class to use if name has not been configured
public void shutdown() throws TorqueException
TorqueException
- if a DataSourceFactory could not be closed
cleanly. Only the first exception is rethrown, any following
exceptions are logged but ignored.public DatabaseMap getDatabaseMap() throws TorqueException
TorqueException
- Any exceptions caught during processing will be
rethrown wrapped into a TorqueException.public DatabaseMap getDatabaseMap(java.lang.String name) throws TorqueException
name
- The name of the database corresponding to the
DatabaseMap
to retrieve.
DatabaseMap
.
TorqueException
- Any exceptions caught during processing will be
rethrown wrapped into a TorqueException.public java.util.Map getMapBuilders()
public void registerMapBuilder(java.lang.String className)
className
- the MapBuilderpublic void registerMapBuilder(MapBuilder builder)
builder
- the instance of the MapBuilderpublic MapBuilder getMapBuilder(java.lang.String className) throws TorqueException
className
- of the MapBuilder
TorqueException
- if the Map Builder cannot be instantiatedpublic java.sql.Connection getConnection() throws TorqueException
TorqueException
- Any exceptions caught during processing will be
rethrown wrapped into a TorqueException.public java.sql.Connection getConnection(java.lang.String name) throws TorqueException
name
.
name
- The database name.
TorqueException
- If no DataSourceFactory is configured for the
named database, the connection information is wrong, or the
connection cannot be returned for any other reason.public DataSourceFactory getDataSourceFactory(java.lang.String name) throws TorqueException
name
.
name
- The name of the database to get the DSF for.
TorqueException
- if Torque is not initiliaized, or
no DatasourceFactory is configured for the given name.public java.sql.Connection getConnection(java.lang.String name, java.lang.String username, java.lang.String password) throws TorqueException
name
- The database name.username
- The name of the database user.password
- The password of the database user.
TorqueException
- Any exceptions caught during processing will be
rethrown wrapped into a TorqueException.public DB getDB(java.lang.String name) throws TorqueException
name
- the name of the database to get the adapter for.
TorqueException
- Any exceptions caught during processing will be
rethrown wrapped into a TorqueException.public java.lang.String getDefaultDB()
public void closeConnection(java.sql.Connection con)
con
- A Connection to close.public void setSchema(java.lang.String name, java.lang.String schema) throws TorqueException
name
- The database name.schema
- The current schema name.
TorqueException
- Any exceptions caught during processing will be
rethrown wrapped into a TorqueException.public java.lang.String getSchema(java.lang.String name) throws TorqueException
name
- The database name.
TorqueException
- Any exceptions caught during processing will be
rethrown wrapped into a TorqueException.public Database getDatabase(java.lang.String databaseName) throws TorqueException
databaseName
.
databaseName
- the key to get the database for.
TorqueException
- if Torque is not yet initialized.public java.util.Map getDatabases() throws TorqueException
TorqueException
- if Torque is not yet initialized.public Database getOrCreateDatabase(java.lang.String databaseName)
databaseName
.
If no database is associated to the specified key,
a new database is created, mapped to the specified key, and returned.
databaseName
- the key to get the database for.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |