org.resthub.jpa.pool

Class AbstractDataSourceFactory<T extends DataSource>

java.lang.Object

org.resthub.jpa.pool.AbstractDataSourceFactory<T>

Direct Known Subclasses:

BoneCPDataSourceFactory, HikariCPDataSourceFactory

public abstract class AbstractDataSourceFactory<T extends DataSource>
extends Object

Common abstract factory for dataSource creation

This factory allows to create directly a DataSource instance from a set of configuration properties.

It provides complementary operations on properties to check if property has been resolved and ignore it if it was not. This behaviour allows, for instance, to expose entire dataSource options to end user through spring placeholder without necessity to override all defaults from dataSource.

Constructor Summary

Constructors

Constructor and Description
AbstractDataSourceFactory()

Method Summary

Methods

Modifier and Type	Method and Description
protected DataSource	callConstructor(Class<? extends T> clazz, Properties configProperties) Perform call to the DataSource constructor.
DataSource	create(Class<? extends T> clazz, Properties dsProperties)
DataSource	create(Properties dsProperties) Create new instance of DataSource fully configured with properties.
Class<? extends T>	getDsClass()
protected DataSource	instantiateDataSource(Properties configProperties) Instantiate a concrete dataSource instance depending on the property value
protected boolean	isResolvedProperty(Properties dsProperties, String key) Check if a property has been resolved. i.e. the property does not contain the special spring placeholder resolver character '$').
void	setDsClass(Class<? extends T> dsClass)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractDataSourceFactory

public AbstractDataSourceFactory()

Method Detail

create

public DataSource create(Class<? extends T> clazz,
                Properties dsProperties)
                  throws Exception

Throws:

Exception

create

public DataSource create(Properties dsProperties)
                  throws Exception

Create new instance of DataSource fully configured with properties.

All given properties will be set configured but the process ignore unresolved properties that will the be set to DataSource default values.

Parameters:

dsProperties - configuration properties

Returns:

the new DataSource instance.

Throws:

Exception

isResolvedProperty

protected boolean isResolvedProperty(Properties dsProperties,
                         String key)

Check if a property has been resolved. i.e. the property does not contain the special spring placeholder resolver character '$').

Parameters:

dsProperties - properties map containing property to check

key - key identifier of the property to check

Returns:

true if the property has been resolved, false otherwise

callConstructor

protected DataSource callConstructor(Class<? extends T> clazz,
                         Properties configProperties)
                              throws Exception

Perform call to the DataSource constructor.

This method calls by default no-args constructor but can be overridden to use a constructor with args instead.

Parameters:

clazz - class to instantiate. Cannot be null

configProperties - properties list to configure new DataSource. by default, these properties are not used because default no-arg constructor is called but are available in case of specific override. Cannot be null

Returns:

the new created DataSource instance

Throws:

NoSuchMethodException - if the specified constructor was not found

IllegalAccessException - if the specified constructor cannot be called due to access restrictions

InvocationTargetException - if the underlying constructor throws an exception.

InstantiationException - if the class that declares the underlying constructor represents an abstract class

Exception

instantiateDataSource

protected DataSource instantiateDataSource(Properties configProperties)
                                    throws Exception

Instantiate a concrete dataSource instance depending on the property value

Parameters:

configProperties - configuration properties. Cannot be null

Returns:

the new created and configured DataSource instance

Throws:

Exception

getDsClass

public Class<? extends T> getDsClass()

setDsClass

public void setDsClass(Class<? extends T> dsClass)