Package org.apache.torque
Klasse Torque
java.lang.Object
org.apache.torque.Torque
A static facade wrapper around the Torque implementation (which is in
TorqueInstance
).
- Version:
- $Id: Torque.java 1917245 2024-04-21 14:06:23Z tv $
- Autor:
- Daniel Rall, Magn�s ��r Torfason, Jason van Zyl, Rafal Krzewski, Martin Poeschl, Henning P. Schmiedehausen, Kurt Schrader
-
Feldübersicht
FelderModifizierer und TypFeldBeschreibungstatic final String
Name of config property to determine whether caching is used.static final String
The prefix for configuring the database adapters and the default database.static final String
The key used to configure the name of the default database.static final String
default schema name for the configurationstatic final String
"defaults" Key for the configurationstatic final String
A prefix forManager
properties in the configuration.static final String
AService
property determining its implementing class name .static final String
"schema" Key for the configurationstatic final String
The prefix for all configuration keys used by Torque.static final String
The prefix for configuring the transaction manger. -
Methodenübersicht
Modifizierer und TypMethodeBeschreibungstatic void
Closes a connection.static Adapter
getAdapter
(String name) Returns the database adapter for a specific database name.static org.apache.commons.configuration2.Configuration
Get the configuration for this component.static Connection
This method returns a Connection from the default pool.static Connection
getConnection
(String name) This method returns a Connecton using the given database name.static Connection
getConnection
(String name, String username, String password) This method returns a Connecton using the given parameters.static Database
getDatabase
(String name) Returns the database for the given key.static DatabaseMap
Returns the default database map information.static DatabaseMap
getDatabaseMap
(String name) Returns the database map information for a given database.Returns a Map containing all Databases registered to Torque.static String
Returns the name of the default database.static TorqueInstance
Retrieves the singleTorqueInstance
used by this class.static <T extends AbstractBaseManager<? extends Persistent>>
TgetManager
(String name) This method returns a Manager for the given name.static <T extends AbstractBaseManager<? extends Persistent>>
TgetManager
(String name, String defaultClassName) This methods returns either the Manager from the configuration file, or the default one provided by the generated code.static Database
getOrCreateDatabase
(String name) Returns the database for the keydatabaseName
.static <T,
P extends BasePeerImpl<T>>
PgetPeerInstance
(Class<T> omClass) This method returns a PeerImpl for the given class.static String
This method returns the current schema for a database connectionstatic void
Initialization of Torque with a path to a properties file.static void
init
(org.apache.commons.configuration2.Configuration conf) Initialization of Torque with a configuration.static boolean
isInit()
Determine whether Torque has already been initialized.static void
registerIDBroker
(IDBroker idBroker) Registers an id broker.static <T> void
registerPeerInstance
(Class<T> omClass, BasePeerImpl<T> peerInstance) This method registers a PeerImpl for a given class.static void
setConfiguration
(org.apache.commons.configuration2.Configuration conf) Sets the configuration for Torque and all dependencies.static void
setInstance
(TorqueInstance instance) Sets the singleTorqueInstance
used by this class.static void
Sets the current schema for a database connectionstatic void
shutdown()
Shuts down the service.
-
Felddetails
-
TORQUE_KEY
The prefix for all configuration keys used by Torque.- Siehe auch:
-
DATABASE_KEY
The prefix for configuring the database adapters and the default database.- Siehe auch:
-
DEFAULT_KEY
The key used to configure the name of the default database.- Siehe auch:
-
SCHEMA_KEY
"schema" Key for the configuration- Siehe auch:
-
DEFAULTS_KEY
"defaults" Key for the configuration- Siehe auch:
-
DEFAULT_SCHEMA_KEY
default schema name for the configuration- Siehe auch:
-
MANAGER_PREFIX
A prefix forManager
properties in the configuration.- Siehe auch:
-
MANAGER_SUFFIX
AService
property determining its implementing class name .- Siehe auch:
-
CACHE_KEY
Name of config property to determine whether caching is used.- Siehe auch:
-
TRANSACTION_MANAGER_KEY
The prefix for configuring the transaction manger.- Siehe auch:
-
-
Methodendetails
-
getInstance
Retrieves the singleTorqueInstance
used by this class.- Gibt zurück:
- Our singleton.
-
setInstance
Sets the singleTorqueInstance
used by this class. This is used by the Avalon component to make sure that only one instance of Torque exists.- Parameter:
instance
- Our singleton.
-
init
Initialization of Torque with a path to a properties file.- Parameter:
configFile
- The absolute path to the configuration file.- Löst aus:
TorqueException
- Any exceptions caught during processing will be rethrown wrapped into a TorqueException.
-
init
public static void init(org.apache.commons.configuration2.Configuration conf) throws TorqueException Initialization of Torque with a configuration.- Parameter:
conf
- The Torque configuration.- Löst aus:
TorqueException
- Any exceptions caught during processing will be rethrown wrapped into a TorqueException.
-
isInit
public static boolean isInit()Determine whether Torque has already been initialized.- Gibt zurück:
- true if Torque is already initialized
-
setConfiguration
public static void setConfiguration(org.apache.commons.configuration2.Configuration conf) throws TorqueException Sets the configuration for Torque and all dependencies.- Parameter:
conf
- the Configuration- Löst aus:
TorqueException
- if the configuration does not contain any keys starting withTorque.TORQUE_KEY
.
-
getConfiguration
public static org.apache.commons.configuration2.Configuration getConfiguration()Get the configuration for this component.- Gibt zurück:
- the Configuration
-
getManager
This method returns a Manager for the given name.- Typparameter:
T
- the type of the manager class- Parameter:
name
- name of the manager.- Gibt zurück:
- The requested Manager.
-
getManager
public static <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.- Typparameter:
T
- the type of the manager class- Parameter:
name
- name of the manager.defaultClassName
- the class to use if name has not been configured.- Gibt zurück:
- a Manager
-
registerPeerInstance
This method registers a PeerImpl for a given class.- Typparameter:
T
- the type of the OM class- Parameter:
omClass
- the class of the associated OM objectpeerInstance
- PeerImpl instance
-
getPeerInstance
This method returns a PeerImpl for the given class.- Typparameter:
T
- the type of the OM classP
- the type of the peer instance class- Parameter:
omClass
- the class of the associated OM object- Gibt zurück:
- a PeerImpl instance
-
shutdown
Shuts down the service. This method halts the IDBroker's daemon thread in all of the DatabaseMap's. It also closes all SharedPoolDataSourceFactories and PerUserPoolDataSourceFactories initialized by Torque.- Löst aus:
TorqueException
- if a DataSourceFactory could not be closed cleanly. Only the first exception is rethrown, any following exceptions are logged but ignored.
-
getDatabaseMap
Returns the default database map information.- Gibt zurück:
- A DatabaseMap.
- Löst aus:
TorqueException
- if Torque is not initialized.
-
getDatabaseMap
Returns the database map information for a given database.- Parameter:
name
- The name of the database corresponding to theDatabaseMap
to retrieve, or null for the default database.- Gibt zurück:
- The named
DatabaseMap
, not null. - Löst aus:
TorqueException
- if Torque is not initialized and name is null.
-
registerIDBroker
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.- Parameter:
idBroker
- the id broker to register, not null.- Löst aus:
NullPointerException
- if idBroker is null.
-
getConnection
This method returns a Connection from the default pool.- Gibt zurück:
- The requested connection.
- Löst aus:
TorqueException
- Any exceptions caught during processing will be rethrown wrapped into a TorqueException.
-
getConnection
This method returns a Connecton using the given database name.- Parameter:
name
- The database name.- Gibt zurück:
- a database connection to the database with the given name.
- Löst aus:
TorqueException
- Any exceptions caught during processing will be rethrown wrapped into a TorqueException.
-
getConnection
public static Connection getConnection(String name, String username, String password) throws TorqueException This method returns a Connecton using the given parameters. You should only use this method if you need user based access to the database!- Parameter:
name
- The database name.username
- The name of the database user.password
- The password of the database user.- Gibt zurück:
- A Connection to the database with the given name.
- Löst aus:
TorqueException
- Any exceptions caught during processing will be rethrown wrapped into a TorqueException.
-
getAdapter
Returns the database adapter for a specific database name.- Parameter:
name
- the database name, or null for the default db.- Gibt zurück:
- The corresponding database adapter, or null if no database adapter is defined for the given database.
- Löst aus:
TorqueException
- Any exceptions caught during processing will be rethrown wrapped into a TorqueException.
-
getDefaultDB
Returns the name of the default database.- Gibt zurück:
- name of the default DB, or null if Torque is not initialized yet
-
closeConnection
Closes a connection.- Parameter:
con
- A Connection to close.
-
setSchema
Sets the current schema for a database connection- Parameter:
name
- The database name.schema
- The current schema name.- Löst aus:
NullPointerException
- if databaseName is null.
-
getSchema
This method returns the current schema for a database connection- Parameter:
name
- The database name.- Gibt zurück:
- The current schema name. Null means, no schema has been set.
- Löst aus:
TorqueException
- if Torque is not yet initialized.
-
getDatabase
Returns the database for the given key.- Parameter:
name
- the key to get the database for, or null for the default database.- Gibt zurück:
- the Database for the given name, or null if no database exists for the given name.
- Löst aus:
TorqueException
- if Torque is not yet initialized.
-
getOrCreateDatabase
Returns the database for the keydatabaseName
. If no database is associated to the specified key, a new database is created, mapped to the specified key, and returned.- Parameter:
name
- the key to get the database for, not null.- Gibt zurück:
- the database associated with specified key, or the newly created database, never null.
- Löst aus:
IllegalArgumentException
- if databaseName is null.
-
getDatabases
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. However, Databases should be initialized in the init() method, so this will not happen if Torque is used properly.
- Gibt zurück:
- a Map containing all Databases known to Torque, never null.
- Löst aus:
TorqueException
- if Torque is not yet initialized.
-