SitePopulationContextHelper (Ametys 4.3.x - API)

java.lang.Object
- org.ametys.runtime.plugin.component.AbstractLogEnabled
- - org.ametys.core.user.population.PopulationContextHelper
  - - org.ametys.plugins.site.population.SitePopulationContextHelper

All Implemented Interfaces:

LogEnabled, Initializable, Component, Serviceable
```
public class SitePopulationContextHelper
extends PopulationContextHelper
```
Helper for associating UserPopulations to contexts for FO application. Overrides PopulationContextHelper.getUserPopulationsOnContext(String, boolean) in order to authenticate through Front-Office URLs

Field Summary

Fields
Modifier and Type	Field	Description
`private static String`	`__SITES_FO_PREFIX_CONTEXT`
`private static String`	`__SITES_PREFIX_CONTEXT`
`private SiteInformationCache`	`_siteInformationCache`

Fields inherited from class org.ametys.core.user.population.PopulationContextHelper
__ADMIN_RIGHT_ACCESS, __USER_POPULATIONS_TABLE, _manager, ADMIN_CONTEXT, POPULATION_CONTEXTS_REQUEST_ATTR, ROLE

Constructor Summary

Constructors
Constructor Description

SitePopulationContextHelper()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`private void`	`_delayedService()`
`private Site`	`_findSite(String siteName)`
`Set<String>`	`getUserPopulationsOnContext(String context, boolean withDisabled)`	Gets the populations linked to the given context (need the population to be enabled)

Methods inherited from class org.ametys.core.user.population.PopulationContextHelper
_getCache, _getCacheAsMap, getCurrentUserProvider, getObservationManager, getRightManager, getSQLConnection, getUserPopulationDAO, getUserPopulationsOnContexts, getUserPopulationsOnContexts, initialize, isLinked, link, service

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
  - __SITES_PREFIX_CONTEXT
```
private static final String __SITES_PREFIX_CONTEXT
```
    See Also:
    
    Constant Field Values
  - __SITES_FO_PREFIX_CONTEXT
```
private static final String __SITES_FO_PREFIX_CONTEXT
```
    See Also:
    
    Constant Field Values
  - _siteInformationCache
```
private SiteInformationCache _siteInformationCache
```
- Constructor Detail
  - SitePopulationContextHelper
```
public SitePopulationContextHelper()
```
- Method Detail
  - _delayedService
```
private void _delayedService()
```
  - getUserPopulationsOnContext
```
public Set<String> getUserPopulationsOnContext(String context,
                                               boolean withDisabled)
```
    Description copied from class: PopulationContextHelper
    
    Gets the populations linked to the given context (need the population to be enabled)
    
    Overrides:
    
    getUserPopulationsOnContext in class PopulationContextHelper
    
    Parameters:
    
    context - The context
    
    withDisabled - True to also return disabled populations
    
    Returns:
    
    The ids of populations linked to the context
  - _findSite
```
private Site _findSite(String siteName)
```