Package org.ametys.core.datasource

Interface DataSourceConsumer

All Known Implementing Classes:

CollectionDataSourceConsumer, ConfigurationDataSourceConsumer, GroupDirectoriesDataSourceConsumer, PopulationDataSourceConsumer

public interface DataSourceConsumer

Interface for entities that use data sources

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	DataSourceConsumer.TypeOfUse	The type of use of a data source

Method Summary

Modifier and Type	Method	Description
Map<String,DataSourceConsumer.TypeOfUse>	getUsedDataSourceIds()	Retrieve the ids of the used data sources
DataSourceConsumer.TypeOfUse	isInUse(String id)	Determines if a data source is used

Method Details

isInUse

DataSourceConsumer.TypeOfUse isInUse(String id)

Determines if a data source is used

Parameters:

id - The id of data source to check

Returns:

true if the data source is currently in use

getUsedDataSourceIds

Map<String,DataSourceConsumer.TypeOfUse> getUsedDataSourceIds()

Retrieve the ids of the used data sources

Returns:

the set of ids of the data source(s) used by this data source customer