org.ametys.core.user.population

Class PopulationContextHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.user.population.PopulationContextHelper

All Implemented Interfaces:

LogEnabled, Component, Serviceable

Direct Known Subclasses:

SitePopulationContextHelper

public class PopulationContextHelper
extends AbstractLogEnabled
implements Component, Serviceable

Helper for associating UserPopulations to contexts.

Field Summary

Fields

Modifier and Type	Field and Description
private static String	__USER_POPULATIONS_TABLE The name of the JDBC table for user populations by context
private CurrentUserProvider	_currentUserProvider
protected ServiceManager	_manager The service manager
private ObservationManager	_observationManager
private UserPopulationDAO	_userPopulationDAO The DAO for UserPopulations
static String	ADMIN_CONTEXT The "admin" context
static String	POPULATION_CONTEXTS_REQUEST_ATTR The name of request attribute holding the current population contexts
static String	ROLE Avalon Role

Constructor Summary

Constructors

Constructor and Description
PopulationContextHelper()

Method Summary

Modifier and Type	Method and Description
private List<String>	_getPopulationsOnContextFromDatabase(String context, boolean withDisabled)
private CurrentUserProvider	getCurrentUserProvider()
private ObservationManager	getObservationManager()
protected Connection	getSQLConnection() Get the connection to the database
private UserPopulationDAO	getUserPopulationDAO()
List<String>	getUserPopulationsOnContext(String context, boolean withDisabled) Gets the populations linked to the given context (need the population to be enabled)
List<String>	getUserPopulationsOnContexts(Set<String> contexts, boolean withDisabled) Gets the populations linked to at least one of the given contexts (need the population to be enabled)
boolean	isLinked(String upId) Returns true if the user population is linked to a context.
List<String>	link(String context, List<String> ids) Links given populations to a context.
void	service(ServiceManager manager)

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 Detail

ROLE

public static final String ROLE

Avalon Role

POPULATION_CONTEXTS_REQUEST_ATTR

public static final String POPULATION_CONTEXTS_REQUEST_ATTR

The name of request attribute holding the current population contexts

See Also:

Constant Field Values

ADMIN_CONTEXT

public static final String ADMIN_CONTEXT

The "admin" context

See Also:

Constant Field Values

__USER_POPULATIONS_TABLE

private static final String __USER_POPULATIONS_TABLE

The name of the JDBC table for user populations by context

See Also:

Constant Field Values

_manager

protected ServiceManager _manager

The service manager

_userPopulationDAO

private UserPopulationDAO _userPopulationDAO

The DAO for UserPopulations

_observationManager

private ObservationManager _observationManager

_currentUserProvider

private CurrentUserProvider _currentUserProvider

Constructor Detail

PopulationContextHelper

public PopulationContextHelper()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getObservationManager

private ObservationManager getObservationManager()

getUserPopulationDAO

private UserPopulationDAO getUserPopulationDAO()

getCurrentUserProvider

private CurrentUserProvider getCurrentUserProvider()

getSQLConnection

protected Connection getSQLConnection()

Get the connection to the database

Returns:

the SQL connection

link

public List<String> link(String context,
                         List<String> ids)

Links given populations to a context.

Parameters:

context - The context

ids - The ids of the populations to link

Returns:

The ids of the changed user populations (the ones unlinked and the ones linked)

getUserPopulationsOnContext

public List<String> getUserPopulationsOnContext(String context,
                                                boolean withDisabled)

Gets the populations linked to the given context (need the population to be enabled)

Parameters:

context - The context

withDisabled - True to also return disabled populations

Returns:

The ids of populations linked to the context

getUserPopulationsOnContexts

public List<String> getUserPopulationsOnContexts(Set<String> contexts,
                                                 boolean withDisabled)

Gets the populations linked to at least one of the given contexts (need the population to be enabled)

Parameters:

contexts - The contexts

withDisabled - True to also return disabled populations

Returns:

The ids of populations linked to the contexts

_getPopulationsOnContextFromDatabase

private List<String> _getPopulationsOnContextFromDatabase(String context,
                                                          boolean withDisabled)

isLinked

public boolean isLinked(String upId)

Returns true if the user population is linked to a context.

Parameters:

upId - The id of the user population

Returns:

True if the user population is currently linked to a context.