Package org.ametys.core.user.status

Class UserStatusManager

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.datasource.AbstractMyBatisDAO

org.ametys.core.user.status.UserStatusManager

All Implemented Interfaces:

DeferredServiceable, LogEnabled, PluginAware, Component, Configurable, Contextualizable, Serviceable

public class UserStatusManager
extends AbstractMyBatisDAO
implements DeferredServiceable

Component responsible of managing the status of a user (last connection date, missing date, ...)

Field Summary

Fields

Modifier and Type	Field	Description
protected UserManager	_userManager	The user manager
protected UserPopulationDAO	_userPopulationDAO	The user population DAO
static final String	ROLE	the avalon role

Fields inherited from class org.ametys.core.datasource.AbstractMyBatisDAO

_manager

Constructor Summary

Constructors

Constructor	Description
UserStatusManager()

Method Summary

Modifier and Type	Method	Description
protected Configuration	_getMyBatisConfiguration(Environment env)	Get the mybatis configuration
void	activatePersonalDataRemoval(List<UserIdentity> identities)	Activate the personal data removal processes for these identities
void	deactivatePersonalDataRemoval(List<UserIdentity> identities)	Deactivate the personal data removal processes for these identities
void	deferredService(ServiceManager manager)	Pass the ServiceManager used to access other components.
Optional<ZonedDateTime>	getLastConnectionDate(UserIdentity user)	Get the last connection date of the user
List<UserStatusInfo>	getUnknownUsersWithDataRemovalActive()	Get the list of the unknown users with personal data removal active
void	remove(UserIdentity userIdentity)	Remove the identity from the list of know user status
Map<String,Object>	searchUnknownUsers(String pattern, int offset, int limit, List<Map<String,String>> sorts)	Get a list of the unknown users.
void	service(ServiceManager manager)
void	updateConnectionDate(UserIdentity userIdentity)	Update the last connection date for the given user
void	updateStatusOfInactiveUsers(int monthDelay, ContainerProgressionTracker progressionTracker)	Check and update the unknown status for every users that didn't log in since 2 months (inactive users)

Methods inherited from class org.ametys.core.datasource.AbstractMyBatisDAO

_configureDatasource, _getDataSourceId, configure, contextualize, getSession, getSession, reload, setPluginInfo

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

the avalon role

_userManager

protected UserManager _userManager

The user manager

_userPopulationDAO

protected UserPopulationDAO _userPopulationDAO

The user population DAO

Constructor Details

UserStatusManager

public UserStatusManager()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractMyBatisDAO

Throws:

ServiceException

deferredService

public void deferredService(ServiceManager manager)
                     throws ServiceException

Description copied from interface: DeferredServiceable

Pass the ServiceManager used to access other components.

Specified by:

deferredService in interface DeferredServiceable

Parameters:

manager - The ServiceManager which this DeferredServiceable uses. Must not be null.

Throws:

ServiceException - if an error occurs

_getMyBatisConfiguration

protected Configuration _getMyBatisConfiguration(Environment env)

Description copied from class: AbstractMyBatisDAO

Get the mybatis configuration

Overrides:

_getMyBatisConfiguration in class AbstractMyBatisDAO

Parameters:

env - the mybatis environnement

Returns:

the mybatis configuration

getLastConnectionDate

public Optional<ZonedDateTime> getLastConnectionDate(UserIdentity user)

Get the last connection date of the user

Parameters:

user - the user identity

Returns:

the last connection date or empty if the user never logged in

updateConnectionDate

public void updateConnectionDate(UserIdentity userIdentity)

Update the last connection date for the given user

Parameters:

userIdentity - the user that just logged in

searchUnknownUsers

public Map<String,Object> searchUnknownUsers(String pattern,
 int offset,
 int limit,
 List<Map<String,String>> sorts)

Get a list of the unknown users. A user is considered unknown if its last connection is older than 2 months and the user is not present in its user directory anymore.

Parameters:

pattern - the pattern to search

offset - the position of the first result

limit - the number of result

sorts - the sorters to apply

Returns:

the unknown users

getUnknownUsersWithDataRemovalActive

public List<UserStatusInfo> getUnknownUsersWithDataRemovalActive()

Get the list of the unknown users with personal data removal active

Returns:

the unknown users

activatePersonalDataRemoval

public void activatePersonalDataRemoval(List<UserIdentity> identities)

Activate the personal data removal processes for these identities

Parameters:

identities - the identities

deactivatePersonalDataRemoval

public void deactivatePersonalDataRemoval(List<UserIdentity> identities)

Deactivate the personal data removal processes for these identities

Parameters:

identities - the identities

updateStatusOfInactiveUsers

public void updateStatusOfInactiveUsers(int monthDelay,
 ContainerProgressionTracker progressionTracker)

Check and update the unknown status for every users that didn't log in since 2 months (inactive users)

Parameters:

monthDelay - number of month since last connection to be considered inactive. The configured value will be used for value lower than 0.

progressionTracker - a tracker for the operation

remove

public void remove(UserIdentity userIdentity)

Remove the identity from the list of know user status

Parameters:

userIdentity - the identity to remove