Package org.ametys.plugins.core.impl.user.population

Class PopulationDataSourceConsumer

java.lang.Object

org.ametys.plugins.core.impl.user.population.PopulationDataSourceConsumer

All Implemented Interfaces:

DataSourceConsumer, Component, Serviceable

public class PopulationDataSourceConsumer
extends Object
implements DataSourceConsumer, Component, Serviceable

Implementation of DataSourceConsumer allowing to know whether a data source is used by the populations or not. It also allows to retrieve the data source ids that are currently in use.

Nested Class Summary

Nested classes/interfaces inherited from interface org.ametys.core.datasource.DataSourceConsumer

DataSourceConsumer.TypeOfUse

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ROLE	Avalon Role

Constructor Summary

Constructors

Constructor	Description
PopulationDataSourceConsumer()

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
void	service(ServiceManager manager)

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

Constructor Details

PopulationDataSourceConsumer

public PopulationDataSourceConsumer()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

isInUse

public DataSourceConsumer.TypeOfUse isInUse(String id)

Description copied from interface: DataSourceConsumer

Determines if a data source is used

Specified by:

isInUse in interface DataSourceConsumer

Parameters:

id - The id of data source to check

Returns:

true if the data source is currently in use

getUsedDataSourceIds

public Map<String,DataSourceConsumer.TypeOfUse> getUsedDataSourceIds()

Description copied from interface: DataSourceConsumer

Retrieve the ids of the used data sources

Specified by:

getUsedDataSourceIds in interface DataSourceConsumer

Returns:

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