Package 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, Initializable, Component, Serviceable

Direct Known Subclasses:

PopulationContextHelper, SitePopulationContextHelper

public class PopulationContextHelper
extends AbstractLogEnabled
implements Component, Serviceable, Initializable

Helper for associating UserPopulations to contexts.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	__ADMIN_RIGHT_ACCESS	The id of right for administration access
protected static final String	__USER_POPULATIONS_TABLE	The name of the JDBC table for user populations by context
protected ServiceManager	_manager	The service manager
static final String	ADMIN_CONTEXT	The "admin" context
static final String	POPULATION_CONTEXTS_REQUEST_ATTR	The name of request attribute holding the current population contexts
static final String	ROLE	Avalon Role

Constructor Summary

Constructors

Constructor	Description
PopulationContextHelper()

Method Summary

Modifier and Type	Method	Description
protected Cache<String,Set<Pair<String,Integer>>>	_getCache()	Get the cache
protected Map<String,Set<Pair<String,Integer>>>	_getCacheAsMap()	Get the cache as map
protected CurrentUserProvider	getCurrentUserProvider()	Get the current user provider
protected ObservationManager	getObservationManager()	Get the observation manager
protected RightManager	getRightManager()	Get the right manager
protected Connection	getSQLConnection()	Get the connection to the database
protected UserPopulationDAO	getUserPopulationDAO()	Get the DAO for user populations
Set<String>	getUserPopulationsOnContext(String context, boolean withDisabled)	Gets the populations linked to the given context (need the population to be enabled)
Set<String>	getUserPopulationsOnContexts(Collection<String> contexts, boolean withDisabled)	Gets the populations linked to at least one of the given contexts (need the population to be enabled)
Set<String>	getUserPopulationsOnContexts(Collection<String> contexts, boolean withDisabled, boolean checkRights)	Gets the populations linked to at least one of the given contexts (need the population to be enabled)
void	initialize()
boolean	isLinked(String upId)	Returns true if the user population is linked to a context.
Set<String>	link(String context, Collection<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 Details

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

protected static final String __USER_POPULATIONS_TABLE

The name of the JDBC table for user populations by context

See Also:

• Constant Field Values

__ADMIN_RIGHT_ACCESS

protected static final String __ADMIN_RIGHT_ACCESS

The id of right for administration access

See Also:

• Constant Field Values

_manager

protected ServiceManager _manager

The service manager

Constructor Details

PopulationContextHelper

public PopulationContextHelper()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

getObservationManager

protected ObservationManager getObservationManager()

Get the observation manager

Returns:

the

getUserPopulationDAO

protected UserPopulationDAO getUserPopulationDAO()

Get the DAO for user populations

Returns:

the DAO for user populations

getCurrentUserProvider

protected CurrentUserProvider getCurrentUserProvider()

Get the current user provider

Returns:

the current user provider

getRightManager

protected RightManager getRightManager()

Get the right manager

Returns:

the right manager

getSQLConnection

protected Connection getSQLConnection()

Get the connection to the database

Returns:

the SQL connection

link

public Set<String> link(String context,
 Collection<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 Set<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 Set<String> getUserPopulationsOnContexts(Collection<String> contexts,
 boolean withDisabled,
 boolean checkRights)

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

checkRights - True to check that current user belongs to one of populations or is an administrator user

Returns:

The ids of populations linked to the contexts

getUserPopulationsOnContexts

public Set<String> getUserPopulationsOnContexts(Collection<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

_getCache

protected Cache<String,Set<Pair<String,Integer>>> _getCache()

Get the cache

Returns:

Non null cache

_getCacheAsMap

protected Map<String,Set<Pair<String,Integer>>> _getCacheAsMap()

Get the cache as map

Returns:

Non null cache

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.