Package org.ametys.core.datasource

Class SQLDataSourceManager

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.datasource.AbstractDataSourceManager

org.ametys.core.datasource.SQLDataSourceManager

All Implemented Interfaces:

LogEnabled, Disposable, Initializable, Component, Serviceable

public class SQLDataSourceManager
extends AbstractDataSourceManager

This component handles SQL data sources. It is associated with the configuration file $AMETYS_HOME/config/datasources-sql.xml

Nested Class Summary

Nested classes/interfaces inherited from class org.ametys.core.datasource.AbstractDataSourceManager

AbstractDataSourceManager.DataSourceDefinition

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AMETYS_INTERNAL_DATASOURCE_ID	The id of the internal DataSource
static final String	PARAM_DATABASE_PASSWORD	Name of parameter for user's password
static final String	PARAM_DATABASE_TYPE	Name of parameter for database type
static final String	PARAM_DATABASE_URL	Name of parameter for database url
static final String	PARAM_DATABASE_USER	Name of parameter for user's login
static final String	ROLE	Avalon Role
static final String	SQL_DATASOURCE_PREFIX	The id of the internal DataSource

Fields inherited from class org.ametys.core.datasource.AbstractDataSourceManager

_currentUserProvider, _dataSourcesDef, _observationManager, DEFAULT_DATASOURCE_SUFFIX

Constructor Summary

Constructors

Constructor	Description
SQLDataSourceManager()

Method Summary

Modifier and Type	Method	Description
void	checkParameters(Map<String,Object> parameters)	Checks the parameters of a data source
protected void	createDataSource(AbstractDataSourceManager.DataSourceDefinition dataSourceDef)	Creates a data source from its configuration
protected void	deleteDataSource(AbstractDataSourceManager.DataSourceDefinition dataSource)	Deletes a data source
void	dispose()
void	dispose(boolean preserveInternalDB)	Disposes connections.
protected Map<String,AbstractDataSourceManager.DataSourceDefinition>	doReadConfiguration(File file)	Actually read configuration.
protected void	editDataSource(AbstractDataSourceManager.DataSourceDefinition dataSource)	Edit a data source from its configuration
AbstractDataSourceManager.DataSourceDefinition	getDataSourceDefinition(String id)	Get the data source definition or null if not found
Map<String,AbstractDataSourceManager.DataSourceDefinition>	getDataSourceDefinitions(boolean includePrivate, boolean includeInternal, boolean includeDefault)	Get the data source definitions
protected String	getDataSourcePrefixId()	Get the prefix for data source identifier
AbstractDataSourceManager.DataSourceDefinition	getDefaultDataSourceDefinition()	Get the default data source for this type
File	getFileConfiguration()	Get the file configuration of data sources
static AbstractDataSourceManager.DataSourceDefinition	getInternalDataSourceDefinition()	Get the datasource definition for internal database
Connection	getInternalSQLDataSourceConnection()	Get a connection object the internal data source
DataSource	getSQLDataSource(String id)	Get the SQL data source by its identifier
Map<String,DataSource>	getSQLDataSources()	Get the existing SQL data sources
static File	getStaticFileConfiguration()	Get the configuration file for SQL data sources
void	initialize()
void	initialize(boolean preserveInternalDB)	Initializes connections.
protected void	internalSetDefaultDataSource()	Set a default data source internally
static Map<String,AbstractDataSourceManager.DataSourceDefinition>	readDataSourceDefinition(File file)	Read the read source definitions
void	service(ServiceManager serviceManager)
AbstractDataSourceManager.DataSourceDefinition	setDefaultDataSource(String id)	Set the data source with the given id as the default data source
static void	setFilename(String filename)	Set the config filename.

Methods inherited from class org.ametys.core.datasource.AbstractDataSourceManager

add, checkDataSources, delete, edit, getDefaultDataSourceId, readConfiguration, saveConfiguration, saxDataSource

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Details

ROLE

public static final String ROLE

Avalon Role

PARAM_DATABASE_TYPE

public static final String PARAM_DATABASE_TYPE

Name of parameter for database type

See Also:

• Constant Field Values

PARAM_DATABASE_URL

public static final String PARAM_DATABASE_URL

Name of parameter for database url

See Also:

• Constant Field Values

PARAM_DATABASE_USER

public static final String PARAM_DATABASE_USER

Name of parameter for user's login

See Also:

• Constant Field Values

PARAM_DATABASE_PASSWORD

public static final String PARAM_DATABASE_PASSWORD

Name of parameter for user's password

See Also:

• Constant Field Values

SQL_DATASOURCE_PREFIX

public static final String SQL_DATASOURCE_PREFIX

The id of the internal DataSource

See Also:

• Constant Field Values

AMETYS_INTERNAL_DATASOURCE_ID

public static final String AMETYS_INTERNAL_DATASOURCE_ID

The id of the internal DataSource

See Also:

• Constant Field Values

Constructor Details

SQLDataSourceManager

public SQLDataSourceManager()

Method Details

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractDataSourceManager

Throws:

ServiceException

readDataSourceDefinition

public static Map<String,AbstractDataSourceManager.DataSourceDefinition> readDataSourceDefinition(File file)

Read the read source definitions

Parameters:

file - The configuration file

Returns:

the data source definitions

doReadConfiguration

protected Map<String,AbstractDataSourceManager.DataSourceDefinition> doReadConfiguration(File file)

Description copied from class: AbstractDataSourceManager

Actually read configuration.

Specified by:

doReadConfiguration in class AbstractDataSourceManager

Parameters:

file - the definitions file.

Returns:

all definitions.

setFilename

public static void setFilename(String filename)

Set the config filename. Only use for tests.

Parameters:

filename - Name with path of the config file

getStaticFileConfiguration

public static File getStaticFileConfiguration()

Get the configuration file for SQL data sources

Returns:

the configuration file

getFileConfiguration

public File getFileConfiguration()

Description copied from class: AbstractDataSourceManager

Get the file configuration of data sources

Specified by:

getFileConfiguration in class AbstractDataSourceManager

Returns:

the file

initialize

public void initialize(boolean preserveInternalDB)
                throws Exception

Initializes connections.

Parameters:

preserveInternalDB - also initialize internal db connection, or not.

Throws:

Exception - if an error occurs

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Overrides:

initialize in class AbstractDataSourceManager

Throws:

Exception

getDataSourceDefinition

public AbstractDataSourceManager.DataSourceDefinition getDataSourceDefinition(String id)

Description copied from class: AbstractDataSourceManager

Get the data source definition or null if not found

Overrides:

getDataSourceDefinition in class AbstractDataSourceManager

Parameters:

id - the id of data source

Returns:

the data source definition or null if not found

getDataSourceDefinitions

public Map<String,AbstractDataSourceManager.DataSourceDefinition> getDataSourceDefinitions(boolean includePrivate,
 boolean includeInternal,
 boolean includeDefault)

Description copied from class: AbstractDataSourceManager

Get the data source definitions

Overrides:

getDataSourceDefinitions in class AbstractDataSourceManager

Parameters:

includePrivate - true to include private data sources

includeInternal - true to include internal data sources. Not used by default.

includeDefault - true to include an additional data source definition for each default data source

Returns:

the data source definitions

getDataSourcePrefixId

protected String getDataSourcePrefixId()

Description copied from class: AbstractDataSourceManager

Get the prefix for data source identifier

Specified by:

getDataSourcePrefixId in class AbstractDataSourceManager

Returns:

the id prefix

getInternalDataSourceDefinition

public static AbstractDataSourceManager.DataSourceDefinition getInternalDataSourceDefinition()

Get the datasource definition for internal database

Returns:

The datasource definition

getInternalSQLDataSourceConnection

public Connection getInternalSQLDataSourceConnection()

Get a connection object the internal data source

Returns:

the connection object to Ametys' internal SQL data source

getSQLDataSources

public Map<String,DataSource> getSQLDataSources()

Get the existing SQL data sources

Returns:

the SQL data sources

getSQLDataSource

public DataSource getSQLDataSource(String id)

Get the SQL data source by its identifier

Parameters:

id - The id of data source

Returns:

the SQL data source

setDefaultDataSource

public AbstractDataSourceManager.DataSourceDefinition setDefaultDataSource(String id)

Description copied from class: AbstractDataSourceManager

Set the data source with the given id as the default data source

Overrides:

setDefaultDataSource in class AbstractDataSourceManager

Parameters:

id - the id of the data source

Returns:

the AbstractDataSourceManager.DataSourceDefinition of the data source set as default

getDefaultDataSourceDefinition

public AbstractDataSourceManager.DataSourceDefinition getDefaultDataSourceDefinition()

Description copied from class: AbstractDataSourceManager

Get the default data source for this type

Overrides:

getDefaultDataSourceDefinition in class AbstractDataSourceManager

Returns:

the definition object of the default data source. Can return null if no datasource is defined.

internalSetDefaultDataSource

protected void internalSetDefaultDataSource()

Description copied from class: AbstractDataSourceManager

Set a default data source internally

Specified by:

internalSetDefaultDataSource in class AbstractDataSourceManager

checkParameters

public void checkParameters(Map<String,Object> parameters)
                     throws ItemCheckerTestFailureException

Description copied from class: AbstractDataSourceManager

Checks the parameters of a data source

Specified by:

checkParameters in class AbstractDataSourceManager

Parameters:

parameters - the parameters of the data source

Throws:

ItemCheckerTestFailureException - if the test failed

editDataSource

protected void editDataSource(AbstractDataSourceManager.DataSourceDefinition dataSource)

Description copied from class: AbstractDataSourceManager

Edit a data source from its configuration

Specified by:

editDataSource in class AbstractDataSourceManager

Parameters:

dataSource - the data source configuration

createDataSource

protected void createDataSource(AbstractDataSourceManager.DataSourceDefinition dataSourceDef)

Description copied from class: AbstractDataSourceManager

Creates a data source from its configuration

Specified by:

createDataSource in class AbstractDataSourceManager

Parameters:

dataSourceDef - the data source configuration

deleteDataSource

protected void deleteDataSource(AbstractDataSourceManager.DataSourceDefinition dataSource)

Description copied from class: AbstractDataSourceManager

Deletes a data source

Specified by:

deleteDataSource in class AbstractDataSourceManager

Parameters:

dataSource - the data source configuration

dispose

public void dispose(boolean preserveInternalDB)

Disposes connections.

Parameters:

preserveInternalDB - also remove internal db connection, or not.

dispose

public void dispose()

Specified by:

dispose in interface Disposable

Overrides:

dispose in class AbstractDataSourceManager