org.castor.jdo.util
Class JDOConfFactory

java.lang.Object
  org.castor.jdo.util.JDOConfFactory

public final class JDOConfFactory
extends Object

Factory to create JDO configurations without the need of a database configuration XML file.

This is an example for setting up a JDO configuration using JDOConfFactory:

// create driver configuration org.castor.jdo.conf.Driver driverConf = JDOConfFactory.createDriver(DRIVER, CONNECT, USERNAME, PASSWORD); // create mapping configuration String mappingConf = getClass().getResource(MAPPING).toString(); // create database configuration org.castor.jdo.conf.Database dbConf = JDOConfFactory.createDatabase(DATABASE, ENGINE, driverConf, mappingConf); // create and load jdo configuration JDOManager.loadConfiguration(JDOConfFactory.createJdoConf(dbConf), null);

Since:

0.9.9.1

Version:

$Revision: 8994 $ $Date: 2011-08-02 01:40:59 +0200 (Di, 02 Aug 2011) $

Author:

Martin Fuchs, Ralf Joachim

Method Summary

static ClassMapping	createClassMapping(String classname) Create an class mapping configurations for JDO from given class name.
static Database	createDatabase(String name, String engine, DataSource ds) Create a database configuration with given name, engine and datasource configuration.
static Database	createDatabase(String name, String engine, DataSource ds, String mapping) Deprecated. create database w/o mapping.
static Database	createDatabase(String name, String engine, DataSource ds, String[] mappings) Deprecated. create database w/o mappings.
static Database	createDatabase(String name, String engine, Driver driver) Create a database configuration with given name, engine and driver configuration.
static Database	createDatabase(String name, String engine, Driver driver, String mapping) Deprecated. create database w/o mapping.
static Database	createDatabase(String name, String engine, Driver driver, String[] mappings) Deprecated. create database w/o mappings.
static Database	createDatabase(String name, String engine, Jndi jndi) Create a database configuration with given name, engine and JNDI configuration.
static Database	createDatabase(String name, String engine, Jndi jndi, String mapping) Deprecated. create database w/o mapping.
static Database	createDatabase(String name, String engine, Jndi jndi, String[] mappings) Deprecated. create database w/o mappings.
static DataSource	createDataSource(String datasource, Properties props) Create a JDO datasource configuration from a JDBC DataSource instance and apply the supplied property entries.
static Driver	createDriver(String driver, String connect, String user, String password) Create a JDO driver configuration from JDBC connection parameters.
static TransactionDemarcation	createGlobalTransactionDemarcation(String name, Properties props) Create a transaction demarcation configuration with global transaction handling for transaction manager with given name using given properties.
static JdoConf	createJdoConf(Database database) Create a JDO configuration with local transaction demarcation and given database.
static JdoConf	createJdoConf(Database[] databases) Create a JDO configuration with local transaction demarcation and given databases.
static JdoConf	createJdoConf(Database[] databases, TransactionDemarcation tx) Create a JDO configuration with given databases and transaction demarcation.
static JdoConf	createJdoConf(Database database, TransactionDemarcation tx) Create a JDO configuration with given database and transaction demarcation.
static JdoConf	createJdoConf(InputSource source, EntityResolver resolver, ClassLoader loader) Creates a JdoConf instance from a SAX InputSource, using a Castor XML Unmarshaller.
static Jndi	createJNDI(String name) Create a JDO jndi configuration with the given name.
static TransactionDemarcation	createLocalTransactionDemarcation() Create a transaction demarcation configuration with local transaction handling.
static PackageMapping	createPackageMapping(String packagename) Create an package mapping configurations for JDO from given package name.
static Mapping	createXmlMapping(String mapping) Create an XML mapping configurations for JDO from given URL.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createJdoConf

public static JdoConf createJdoConf(InputSource source,
                                    EntityResolver resolver,
                                    ClassLoader loader)
                             throws MappingException

Creates a JdoConf instance from a SAX InputSource, using a Castor XML Unmarshaller.

Parameters:

source - SAX input source representing the JDO configuration.

resolver - SAX entity resolver.

loader - Class loader.

Returns:

The unmarshalled JdoConf instance.

Throws:

MappingException - If failed to load the mconfiguration from source.

createJdoConf

public static JdoConf createJdoConf(Database database)

Create a JDO configuration with local transaction demarcation and given database.

Parameters:

database - Database configuration.

Returns:

JDO configuration.

createJdoConf

public static JdoConf createJdoConf(Database[] databases)

Create a JDO configuration with local transaction demarcation and given databases.

Parameters:

databases - Array of database configurations.

Returns:

JDO configuration.

createJdoConf

public static JdoConf createJdoConf(Database database,
                                    TransactionDemarcation tx)

Create a JDO configuration with given database and transaction demarcation.

Parameters:

database - Database configuration.

tx - TransactionDemarcation configuration.

Returns:

JDO configuration.

createJdoConf

public static JdoConf createJdoConf(Database[] databases,
                                    TransactionDemarcation tx)

Create a JDO configuration with given databases and transaction demarcation.

Parameters:

databases - Array of database configurations.

tx - TransactionDemarcation configuration.

Returns:

JDO configuration.

createDatabase

public static Database createDatabase(String name,
                                      String engine,
                                      DataSource ds,
                                      String mapping)

Deprecated. create database w/o mapping.

Create a database configuration with given name, engine and datasource configuration.

Parameters:

name - Name of the database configuration.

engine - Name of the database engine.

ds - Datasource configuration.

mapping - Mapping URL.

Returns:

Database configuration.

createDatabase

public static Database createDatabase(String name,
                                      String engine,
                                      DataSource ds,
                                      String[] mappings)

Deprecated. create database w/o mappings.

Create a database configuration with given name, engine and datasource configuration.

Parameters:

name - Name of the database configuration.

engine - Name of the database engine.

ds - Datasource configuration.

mappings - Array of mapping URL's.

Returns:

Database configuration.

createDatabase

public static Database createDatabase(String name,
                                      String engine,
                                      DataSource ds)

Create a database configuration with given name, engine and datasource configuration.

Parameters:

name - Name of the database configuration.

engine - Name of the database engine.

ds - Datasource configuration.

Returns:

Database configuration.

Since:

1.3.2

createDatabase

public static Database createDatabase(String name,
                                      String engine,
                                      Driver driver,
                                      String mapping)

Deprecated. create database w/o mapping.

Create a database configuration with given name, engine and driver configuration.

Parameters:

name - Name of the database configuration.

engine - Name of the database engine.

driver - Driver configuration.

mapping - Mapping URL.

Returns:

Database configuration.

createDatabase

public static Database createDatabase(String name,
                                      String engine,
                                      Driver driver,
                                      String[] mappings)

Deprecated. create database w/o mappings.

Create a database configuration with given name, engine and driver configuration.

Parameters:

name - Name of the database configuration.

engine - Name of the database engine.

driver - Driver configuration.

mappings - Array of mapping URL's.

Returns:

Database configuration.

createDatabase

public static Database createDatabase(String name,
                                      String engine,
                                      Driver driver)

Create a database configuration with given name, engine and driver configuration.

Parameters:

name - Name of the database configuration.

engine - Name of the database engine.

driver - Driver configuration.

Returns:

Database configuration.

Since:

1.3.2

createDatabase

public static Database createDatabase(String name,
                                      String engine,
                                      Jndi jndi,
                                      String mapping)

Deprecated. create database w/o mapping.

Create a database configuration with given name, engine and JNDI configuration.

Parameters:

name - Name of the database configuration.

engine - Name of the database engine.

jndi - JNDI configuration.

mapping - Mapping URL.

Returns:

Database configuration.

createDatabase

public static Database createDatabase(String name,
                                      String engine,
                                      Jndi jndi,
                                      String[] mappings)

Deprecated. create database w/o mappings.

Create a database configuration with given name, engine and JNDI configuration.

Parameters:

name - Name of the database configuration.

engine - Name of the database engine.

jndi - JNDI configuration.

mappings - Array of mapping URL's.

Returns:

Database configuration.

createDatabase

public static Database createDatabase(String name,
                                      String engine,
                                      Jndi jndi)

Create a database configuration with given name, engine and JNDI configuration.

Parameters:

name - Name of the database configuration.

engine - Name of the database engine.

jndi - JNDI configuration.

Returns:

Database configuration.

Since:

1.3.2

createDriver

public static Driver createDriver(String driver,
                                  String connect,
                                  String user,
                                  String password)

Create a JDO driver configuration from JDBC connection parameters.

Parameters:

driver - JDBC driver name.

connect - JDBC connect string.

user - User name for the DB login.

password - Password for the DB login.

Returns:

JDO driver configuration.

createDataSource

public static DataSource createDataSource(String datasource,
                                          Properties props)

Create a JDO datasource configuration from a JDBC DataSource instance and apply the supplied property entries.

Parameters:

datasource - JDBC DataSource class name.

props - Properties to be used for the DataSource.

Returns:

JDO Datasource configuration.

createJNDI

public static Jndi createJNDI(String name)

Create a JDO jndi configuration with the given name.

Parameters:

name - Name to lookup JDBC Datasource through JNDI.

Returns:

JDO JNDI configuration.

createXmlMapping

public static Mapping createXmlMapping(String mapping)

Create an XML mapping configurations for JDO from given URL.

Parameters:

mapping - URL to retrieve mapping configuration file.

Returns:

XML mapping configuration for JDO.

createClassMapping

public static ClassMapping createClassMapping(String classname)

Create an class mapping configurations for JDO from given class name.

Parameters:

classname - Class name to retrieve mapping information.

Returns:

Class mapping configuration for JDO.

createPackageMapping

public static PackageMapping createPackageMapping(String packagename)

Create an package mapping configurations for JDO from given package name.

Parameters:

packagename - Package name to retrieve mapping information.

Returns:

Package mapping configuration for JDO.

createLocalTransactionDemarcation

public static TransactionDemarcation createLocalTransactionDemarcation()

Create a transaction demarcation configuration with local transaction handling.

Returns:

TransactionDemarcation configuration with local transaction handling.

createGlobalTransactionDemarcation

public static TransactionDemarcation createGlobalTransactionDemarcation(String name,
                                                                        Properties props)

Create a transaction demarcation configuration with global transaction handling for transaction manager with given name using given properties.

Parameters:

name - Name of the transaction manager.

props - Properties to be used for the transaction manager.

Returns:

TransactionDemarcation configuration with global transaction handling.