org.ametys.plugins.core.user

Class ImportUsers

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.core.user.ImportUsers

All Implemented Interfaces:

LogEnabled, Component, Serviceable

public class ImportUsers
extends AbstractLogEnabled
implements Component, Serviceable

Import users from a CSV or text file.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	ImportUsers.ImportUserActionException Internal exception to throw with a i18n message

Field Summary

Fields

Modifier and Type	Field and Description
private static String[]	_ALLOWED_EXTENSIONS
private static String	_COLUMN_EMAIL
private static String	_COLUMN_FIRSTNAME
private static String	_COLUMN_LASTNAME
private static String	_COLUMN_LOGIN
private static String	_COLUMN_PASSWORD
private static String	_COLUMN_SALT
private static String[]	_COLUMNS
protected I18nUtils	_i18nUtils I18n utils
protected UserManager	_userManager User Manager.
protected UserDAO	_usersDao The subscribers DAO.
static String	ROLE Avalon Role

Constructor Summary

Constructors

Constructor and Description
ImportUsers()

Method Summary

Modifier and Type	Method and Description
private void	_checkCsvHeader(String[] columns, boolean hashedPassword) Check a line (the header) and throw an exception if not correct
private String	_parseErrors(Map<String,Errors> errors)
protected List<Map<String,String>>	clearUserDirectory(String populationId, String userDirectoryId, List<UserIdentity> usersToSave) Remove all users in a userDirectory, avoiding those in usersToSave list
Map<String,Object>	importUsers(Part filePart, String populationId, String userDirectoryId, boolean cleanDirectory, boolean hashedPasswords) Read a file from disk and add users inside in the requested population/directory
protected Map<String,List<UserIdentity>>	parseFile(org.apache.commons.io.input.BOMInputStream bomIS, String populationId, String userDirectoryId, boolean hashedPassword) Parse the file to add new users in the directory
void	service(ServiceManager smanager)

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

_ALLOWED_EXTENSIONS

private static final String[] _ALLOWED_EXTENSIONS

_COLUMNS

private static final String[] _COLUMNS

_COLUMN_LOGIN

private static final String _COLUMN_LOGIN

See Also:

Constant Field Values

_COLUMN_PASSWORD

private static final String _COLUMN_PASSWORD

See Also:

Constant Field Values

_COLUMN_FIRSTNAME

private static final String _COLUMN_FIRSTNAME

See Also:

Constant Field Values

_COLUMN_LASTNAME

private static final String _COLUMN_LASTNAME

See Also:

Constant Field Values

_COLUMN_EMAIL

private static final String _COLUMN_EMAIL

See Also:

Constant Field Values

_COLUMN_SALT

private static final String _COLUMN_SALT

See Also:

Constant Field Values

_usersDao

protected UserDAO _usersDao

The subscribers DAO.

_userManager

protected UserManager _userManager

User Manager.

_i18nUtils

protected I18nUtils _i18nUtils

I18n utils

Constructor Detail

ImportUsers

public ImportUsers()

Method Detail

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

importUsers

public Map<String,Object> importUsers(Part filePart,
                                      String populationId,
                                      String userDirectoryId,
                                      boolean cleanDirectory,
                                      boolean hashedPasswords)
                               throws FileNotFoundException,
                                      InvalidModificationException

Read a file from disk and add users inside in the requested population/directory

Parameters:

filePart - file

populationId - population Id

userDirectoryId - user directory

cleanDirectory - true to clear every user that was not in the import file

hashedPasswords - true if the passwords are already hashed in the file (salt must be in the file too, and password hashed with "saltPassword" with nothing in-between)

Returns:

a map containing success, addedCount, existingCount, errorCount, deletedCount, message success : true if success addedCount, existingCount, errorCount : number of imported user added, modified, an error occured (see server log) message : error message if something wrong happened (usually malformed file)

Throws:

FileNotFoundException - error reading the file

InvalidModificationException - error modifying the directory

clearUserDirectory

protected List<Map<String,String>> clearUserDirectory(String populationId,
                                                      String userDirectoryId,
                                                      List<UserIdentity> usersToSave)
                                               throws InvalidModificationException

Remove all users in a userDirectory, avoiding those in usersToSave list

Parameters:

populationId - population Id

userDirectoryId - directory Id

usersToSave - list of users that need to be saved

Returns:

list of deleted users (containing login and populationId)

Throws:

InvalidModificationException - If modification is not possible

parseFile

protected Map<String,List<UserIdentity>> parseFile(org.apache.commons.io.input.BOMInputStream bomIS,
                                                   String populationId,
                                                   String userDirectoryId,
                                                   boolean hashedPassword)
                                            throws IOException,
                                                   ImportUsers.ImportUserActionException

Parse the file to add new users in the directory

Parameters:

bomIS - input stream

populationId - population Id

userDirectoryId - directory Id

hashedPassword - true if the password is hashed

Returns:

a map, containing added/edited/error, each containing the logins in each list

Throws:

IOException - if an error occurs

ImportUsers.ImportUserActionException - file parsing failed

_parseErrors

private String _parseErrors(Map<String,Errors> errors)

_checkCsvHeader

private void _checkCsvHeader(String[] columns,
                             boolean hashedPassword)
                      throws ImportUsers.ImportUserActionException

Check a line (the header) and throw an exception if not correct

Parameters:

columns - list of fields

hashedPassword - is the password in clear text ? (special case for 'salt' column)

Throws:

ImportUsers.ImportUserActionException - thrown if error