com.agiletec.aps.system.services.user.IUserDAO Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of entando-engine Show documentation
Entando Engine: an agile, modern and user-centric open source Portal platform.
There is a newer version: 6.2.27
/*
 * Copyright 2015-Present Entando Inc. (http://www.entando.com) All rights reserved.
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 * details.
 */
package com.agiletec.aps.system.services.user;

import com.agiletec.aps.util.IApsEncrypter;
import java.util.List;

/**
 * Interfaccia base per Data Access Object degli oggetti User (User).
 *
 * @author M.Diana - E.Santoboni
 */
public interface IUserDAO {

    public List loadUsernames();

    public List searchUsernames(String text);

    /**
     * Carica e restituisce la lista completa di utenti.
     *
     * @return La lista completa di utenti.
     */
    public List loadUsers();

    /**
     * Restituisce la lista di utenti ricavata dalla ricerca sulla username (o
     * porzione di essa).
     *
     * @param text Il testo tramite il quale effettuare la ricerca sulla
     * username.
     * @return La lista di utenti ricavati.
     */
    public List searchUsers(String text);

    /**
     * Carica un'utente corrispondente alla userName e password immessa. null se
     * non vi è nessun utente corrispondente.
     *
     * @param username Nome utente dell'utente cercato
     * @param password password dell'utente cercato
     * @return L'oggetto utente corrispondente ai parametri richiesti, oppure
     * null se non vi è nessun utente corrispondente.
     */
    public UserDetails loadUser(String username, String password);

    /**
     * Carica un'utente corrispondente alla userName immessa. null se non vi è
     * nessun utente corrispondente.
     *
     * @param username Nome utente dell'utente cercato.
     * @return L'oggetto utente corrispondente ai parametri richiesti, oppure
     * null se non vi è nessun utente corrispondente.
     */
    public UserDetails loadUser(String username);

    /**
     * Cancella l'utente.
     *
     * @param user L'oggetto di tipo User relativo all'utente da cancellare.
     */
    public void deleteUser(UserDetails user);

    /**
     * Cancella l'utente corrispondente alla userName immessa.
     *
     * @param username Il nome identificatore dell'utente.
     */
    public void deleteUser(String username);

    /**
     * Aggiunge un nuovo utente.
     *
     * @param user Oggetto di tipo User relativo all'utente da aggiungere.
     */
    public void addUser(UserDetails user);

    /**
     * Aggiorna un utente già presente con nuovi valori (tranne la username che
     * è fissa).
     *
     * @param user Oggetto di tipo User relativo all'utente da aggiornare.
     */
    public void updateUser(UserDetails user);

    /*
	 * Carica gli utenti membri di un gruppo.
	 * @param groupName Il nome del grupo tramite il quale cercare gli utenti.
	 * @return La lista degli utenti (oggetti User) membri del gruppo specificato.
	 * @deprecated USE loadUsernamesForGroup and load single users from current UserManager.
     */
    //public List loadUsersForGroup(String groupName);
    /*
	 * Carica la lista di usernames correlati con il gruppo specificato.
	 * @param groupName Il nome del gruppo tramite il quale cercare i nomi utenti.
	 * @return La lista di usernames correlati con il gruppo specificato.
     */
    //public List loadUsernamesForGroup(String groupName);
    /**
     * Effettua l'aggiornamento della password di un'utente.
     *
     * @param username La username dell'utente a cui aggiornare la password.
     * @param password La nuova password.
     */
    public void changePassword(String username, String password);

    public void updateLastAccess(String username);

    public IApsEncrypter getEncrypter();

}