org.ametys.plugins.datainclusion.data
Interface DataSource

All Known Implementing Classes:

AbstractDataSource, LdapDataSource, SqlDataSource

public interface DataSource

Class representing a data source.

Method Summary

Map<String,String>	getAdditionalValues(boolean exceptPassword) Get the additional datasource configuration information.
String	getDescription() Get the datasource description.
String	getId() Get the datasource ID.
String	getName() Get the datasource name.
<T extends Query> Map<String,T>	getQueries() Get the queries on this datasource.
String	getType() Get the datasource type.

Method Detail

getId

String getId()

Get the datasource ID.

Returns:

the datasource ID.

getName

String getName()

Get the datasource name.

Returns:

the datasource name.

getDescription

String getDescription()

Get the datasource description.

Returns:

the datasource description.

getType

String getType()

Get the datasource type.

Returns:

the datasource type.

getAdditionalValues

Map<String,String> getAdditionalValues(boolean exceptPassword)

Get the additional datasource configuration information.

Parameters:

exceptPassword - true to do not return password values

Returns:

the additional datasource information as a Map of Id -> Value.

getQueries

<T extends Query> Map<String,T> getQueries()

Get the queries on this datasource.

Type Parameters:

T - the Query subclass managed by this DataSource.

Returns:

the the queries on this datasource as a Map.