org.apache.torque
Class TorqueInstance

java.lang.Object
  extended by org.apache.torque.TorqueInstance
Direct Known Subclasses:
TorqueComponent

public class TorqueInstance
extends Object

The core of Torque's implementation. Both the classic Torque static wrapper and the TorqueComponent Avalon implementation leverage this class.

Version:
$Id: TorqueInstance.java 1402640 2012-10-26 19:58:19Z tfischer $
Author:
Daniel Rall, Magn�s ��r Torfason, Jason van Zyl, Rafal Krzewski, Martin Poeschl, Henning P. Schmiedehausen, Kurt Schrader, Thomas Vandahl

Constructor Summary
TorqueInstance()
          Creates a new instance with default configuration.
 
Method Summary
 void closeConnection(Connection con)
          Closes a connection.
 Adapter getAdapter(String name)
          Returns the database adapter for a specific database.
 org.apache.commons.configuration.Configuration getConfiguration()
          Get the configuration for this component.
 Connection getConnection()
          This method returns a Connection from the default pool.
 Connection getConnection(String name)
          Returns a database connection to the database with the key name.
 Connection getConnection(String name, String username, String password)
          This method returns a Connection using the given parameters.
 Database getDatabase(String databaseName)
          Returns the database for the key databaseName.
 DatabaseMap getDatabaseMap()
          Returns the database map information for the default db.
 DatabaseMap getDatabaseMap(String name)
          Returns the database map information for the given database name.
 Map<String,Database> getDatabases()
          Returns a Map containing all Databases registered to Torque.
 DataSourceFactory getDataSourceFactory(String name)
          Returns the DataSourceFactory for the database with the name name.
 Adapter getDB(String name)
          Deprecated. use getAdapter(String) instead. This method will be removed in a future version of Torque.
 String getDefaultDB()
          Returns the name of the default database.
<T extends AbstractBaseManager<? extends Persistent>>
T
getManager(String name)
          This method returns a Manager for the given name.
<T extends AbstractBaseManager<? extends Persistent>>
T
getManager(String name, String defaultClassName)
          This methods returns either the Manager from the configuration file, or the default one provided by the generated code.
 Database getOrCreateDatabase(String databaseName)
          Returns the database for the key databaseName.
 String getSchema(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(String configFile)
          Initialization of Torque with a path to 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 registerIDBroker(IDBroker idBroker)
          Registers an id broker.
 void setConfiguration(org.apache.commons.configuration.Configuration conf)
          Sets the configuration for Torque and all dependencies.
 void setSchema(String name, String schema)
          Sets the current schema for a database connection
 void shutdown()
          Shuts down Torque.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TorqueInstance

public TorqueInstance()
Creates a new instance with default configuration.

See Also:
resetConfiguration()
Method Detail

init

public void init(String configFile)
          throws TorqueException
Initialization of Torque with a path to a properties file.

Parameters:
configFile - The absolute path to the configuration file.
Throws:
TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

init

public void init(org.apache.commons.configuration.Configuration conf)
          throws TorqueException
Initialization of Torque with a Configuration object.

Parameters:
conf - The Torque configuration.
Throws:
TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

initManagerMappings

protected void initManagerMappings(org.apache.commons.configuration.Configuration conf)
                            throws TorqueException
Creates a mapping between classes and their manager classes. The mapping is built according to settings present in properties file. The entries should have the following form:
 torque.managed_class.com.mycompany.Myclass.manager= \
          com.mycompany.MyManagerImpl
 services.managed_class.com.mycompany.Myotherclass.manager= \
          com.mycompany.MyOtherManagerImpl
 

Generic ServiceBroker provides no Services.

Parameters:
conf - the Configuration representing the properties file
Throws:
TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

isInit

public boolean isInit()
Determine whether Torque has already been initialized.

Returns:
true if Torque is already initialized

setConfiguration

public void setConfiguration(org.apache.commons.configuration.Configuration conf)
                      throws TorqueException
Sets the configuration for Torque and all dependencies. The prefix TORQUE_KEY will be removed from the configuration keys for the provided configuration.

Parameters:
conf - the Configuration.
Throws:
TorqueException - if the configuration does not contain any keys starting with Torque.TORQUE_KEY.

getConfiguration

public org.apache.commons.configuration.Configuration getConfiguration()
Get the configuration for this component.

Returns:
the Configuration

getManager

public <T extends AbstractBaseManager<? extends Persistent>> T getManager(String name)
This method returns a Manager for the given name.

Parameters:
name - name of the manager
Returns:
a Manager

getManager

public <T extends AbstractBaseManager<? extends Persistent>> T getManager(String name,
                                                                          String defaultClassName)
This methods returns either the Manager from the configuration file, or the default one provided by the generated code.

Parameters:
name - name of the manager.
defaultClassName - the class to use if name has not been configured.
Returns:
a Manager

shutdown

public void shutdown()
              throws TorqueException
Shuts down Torque. This method halts the IDBroker's daemon thread in all of the DatabaseMap's. It also closes all SharedPoolDataSourceFactories and PerUserPoolDataSourceFactories initialized by Torque.

Throws:
TorqueException - if a DataSourceFactory could not be closed cleanly. Only the first exception is rethrown, any following exceptions are logged but ignored.

getDatabaseMap

public DatabaseMap getDatabaseMap()
                           throws TorqueException
Returns the database map information for the default db.

Returns:
the requested DatabaseMap, not null.
Throws:
TorqueException - if Torque is not initialized.

getDatabaseMap

public DatabaseMap getDatabaseMap(String name)
                           throws TorqueException
Returns the database map information for the given database name.

Parameters:
name - The name of the database corresponding to the DatabaseMap to retrieve, or null for the default database.
Returns:
The named DatabaseMap, not null.
Throws:
TorqueException - if Torque is not initialized and name is null.

registerIDBroker

public void registerIDBroker(IDBroker idBroker)
Registers an id broker. If Torque is already initialized, the id broker is started. If Torque is not initialized, the id broker will be started on initialization.

Parameters:
idBroker - the id broker to register, not null.
Throws:
NullPointerException - if idBroker is null.

getConnection

public Connection getConnection()
                         throws TorqueException
This method returns a Connection from the default pool.

Returns:
The requested connection, never null.
Throws:
TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

getConnection

public Connection getConnection(String name)
                         throws TorqueException
Returns a database connection to the database with the key name.

Parameters:
name - The database name.
Returns:
a database connection to the named database, never null.
Throws:
TorqueException - if Torque is not initialized, if no DataSourceFactory is configured for the named database, the connection information is wrong, or the connection cannot be returned for any other reason.

getDataSourceFactory

public DataSourceFactory getDataSourceFactory(String name)
                                       throws TorqueException
Returns the DataSourceFactory for the database with the name name.

Parameters:
name - The name of the database to get the DSF for.
Returns:
A DataSourceFactory object, never null.
Throws:
TorqueException - if Torque is not initialized, or no DatasourceFactory is configured for the given name.

getConnection

public Connection getConnection(String name,
                                String username,
                                String password)
                         throws TorqueException
This method returns a Connection using the given parameters. You should only use this method if you need user based access to the database!

Parameters:
name - The database name.
username - The name of the database user.
password - The password of the database user.
Returns:
A Connection to the named database.
Throws:
TorqueException - Any exceptions caught during processing will be rethrown wrapped into a TorqueException.

getDB

@Deprecated
public Adapter getDB(String name)
              throws TorqueException
Deprecated. use getAdapter(String) instead. This method will be removed in a future version of Torque.

Returns the database adapter for a specific database.

Parameters:
name - the database name, or null for the default db.
Returns:
The corresponding database adapter, or null if no database adapter is defined for the given database.
Throws:
TorqueException - if Torque is not initialized.

getAdapter

public Adapter getAdapter(String name)
                   throws TorqueException
Returns the database adapter for a specific database.

Parameters:
name - the database name, or null for the default db.
Returns:
The corresponding database adapter, or null if no database adapter is defined for the given database.
Throws:
TorqueException - if Torque is not initialized.

getDefaultDB

public String getDefaultDB()
Returns the name of the default database.

Returns:
name of the default DB, or null if Torque is not initialized yet

closeConnection

public void closeConnection(Connection con)
Closes a connection.

Parameters:
con - A Connection to close.

setSchema

public void setSchema(String name,
                      String schema)
Sets the current schema for a database connection

Parameters:
name - The database name, not null.
schema - The current schema name.
Throws:
NullPointerException - if databaseName is null.

getSchema

public String getSchema(String name)
                 throws TorqueException
This method returns the current schema for a database connection

Parameters:
name - The database name.
Returns:
The current schema name. Null means, no schema has been set or no database with the given name exists.
Throws:
TorqueException - if Torque is not yet initialized.

getDatabase

public Database getDatabase(String databaseName)
                     throws TorqueException
Returns the database for the key databaseName.

Parameters:
databaseName - the key to get the database for, or null for the default database.
Returns:
the database for the specified key, or null if the database does not exist.
Throws:
TorqueException - if Torque is not yet initialized.

getDatabases

public Map<String,Database> getDatabases()
                                  throws TorqueException
Returns a Map containing all Databases registered to Torque. The key of the Map is the name of the database, and the value is the database instance.
Note that in the very special case where a new database which is not configured in Torque's configuration gets known to Torque at a later time, the returned map may change, and there is no way to protect you against this.

Returns:
a Map containing all Databases known to Torque, never null.
Throws:
TorqueException - if Torque is not yet initialized.

getOrCreateDatabase

public Database getOrCreateDatabase(String databaseName)
Returns the database for the key databaseName. If no database is associated to the specified key, a new database is created, mapped to the specified key, and returned.

Parameters:
databaseName - the key to get the database for, not null.
Returns:
the database associated with specified key, or the newly created database, never null.
Throws:
NullPointerException - if databaseName is null.


Copyright © 2000-2013 The Apache Software Foundation. All Rights Reserved.