org.jppf.persistence

Class JPPFDatasourceFactory

java.lang.Object

org.jppf.persistence.JPPFDatasourceFactory

public final class JPPFDatasourceFactory
extends Object

This class represents a registry and factory for data sources defined via JPPF configuration properties.

Method Summary

Modifier and Type	Method and Description
void	clear() Close and remove all the data sources in this registry.
DataSource	createDataSource(String name, Properties props) Create a data source from the specified configuration properties.
Map<String,DataSource>	createDataSources(Properties props) Create one or more data sources from the specified configuration properties.
DataSource	getDataSource(String name) Get the data source with the specified name.
List<String>	getDataSourceNames() Get the names of all currently defined data sources.
static JPPFDatasourceFactory	getInstance() Get a data source factory.
boolean	removeDataSource(String name) Remove the data source with the specified name.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static JPPFDatasourceFactory getInstance()

Get a data source factory. This method always returns the same instance.

Returns:

a JPPFDatasourceFactory instance.

getDataSource

public DataSource getDataSource(String name)

Get the data source with the specified name.

Parameters:

name - the name assigned to the data source.

Returns:

a DataSource instance, or null if no such data source could be retrieved.

getDataSourceNames

public List<String> getDataSourceNames()

Get the names of all currently defined data sources.

Returns:

a List of datasource names.

createDataSource

public DataSource createDataSource(String name,
                                   Properties props)

Create a data source from the specified configuration properties. This method assumes the property names have no prefix.

Parameters:

name - the name of the data source to create.

props - the data source configuration properties.

Returns:

a DataSource instance.

createDataSources

public Map<String,DataSource> createDataSources(Properties props)

Create one or more data sources from the specified configuration properties. This method assumes the property names have the same format as for static datasources configurations, that is:
jppf.datasource.<configId>.<property_name> = <property_value>.

Parameters:

props - the data sources configuration properties.

Returns:

a Map whose keys are the names of the created data sources and whose values are the corresponding DataSource objects.

removeDataSource

public boolean removeDataSource(String name)

Remove the data source with the specified name. This method also closes the data source and releases the resources it is using.

Parameters:

name - the name assigned to the datasource.

Returns:

true if the removal was succcessful, false if it fails for any reason, including if no data source with the specified name exists.

clear

public void clear()

Close and remove all the data sources in this registry.