Package org.opennms.core.db

Class DataSourceFactory

java.lang.Object

org.opennms.core.db.DataSourceFactory

public abstract class DataSourceFactory
extends Object

This is the singleton class used to load the OpenNMS database configuration from the opennms-datasources.xml. This provides convenience methods to create database connections to the database configured in this default XML.

Author:

Brian Weaver

Constructor Summary

Constructors

Constructor	Description
DataSourceFactory()

Method Summary

Modifier and Type	Method	Description
static void	close()	close
static DataSource	getInstance()	Return the singleton instance of this factory.
static DataSource	getInstance(String name)	getInstance
static void	init()	Deprecated. This function is no longer necessary for DataSourceFactory initialization
static void	init(String dsName)	init
static void	setDataSourceConfigurationFactory(DataSourceConfigurationFactory factory)
static void	setInstance(String dsName, DataSource ds)	setInstance
static void	setInstance(DataSource ds)	setInstance

Methods inherited from class java.lang.Object

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

Constructor Detail

DataSourceFactory

public DataSourceFactory()

Method Detail

init

public static void init()
                 throws IOException,
                        ClassNotFoundException,
                        PropertyVetoException,
                        SQLException

Deprecated.

This function is no longer necessary for DataSourceFactory initialization

Throws:

IOException

ClassNotFoundException

PropertyVetoException

SQLException

init

public static void init(String dsName)

init

Parameters:

dsName - a String object.

getInstance

public static DataSource getInstance()

Return the singleton instance of this factory. This is the instance of the factory that was last created when the init or reload method was invoked. The instance will not change unless a reload method is invoked.

Returns:

The current factory instance.

Throws:

IllegalStateException - Thrown if the factory has not yet been initialized.

getInstance

public static DataSource getInstance(String name)

getInstance

Parameters:

name - a String object.

Returns:

a DataSource object.

setInstance

public static void setInstance(DataSource ds)

setInstance

Parameters:

ds - a DataSource object.

setInstance

public static void setInstance(String dsName,
                               DataSource ds)

setInstance

Parameters:

dsName - a String object.

ds - a DataSource object.

setDataSourceConfigurationFactory

public static void setDataSourceConfigurationFactory(DataSourceConfigurationFactory factory)

close

public static void close()

close

Throws:

SQLException - if any.