net.solarnetwork.central.user.dao.UserDao Maven / Gradle / Ivy

Go to download
/* ==================================================================
 * UserDao.java - Dec 11, 2009 8:38:07 PM
 * 
 * Copyright 2007-2009 SolarNetwork.net Dev Team
 * 
 * This program is free software; you can redistribute it and/or 
 * modify it under the terms of the GNU General Public License as 
 * published by the Free Software Foundation; either version 2 of 
 * the License, or (at your option) any later version.
 * 
 * This program 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 
 * General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License 
 * along with this program; if not, write to the Free Software 
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 
 * 02111-1307 USA
 * ==================================================================
 */

package net.solarnetwork.central.user.dao;

import java.util.Map;
import java.util.Set;
import net.solarnetwork.central.dao.FilterableDao;
import net.solarnetwork.central.dao.GenericDao;
import net.solarnetwork.central.domain.UserFilter;
import net.solarnetwork.central.user.domain.User;
import net.solarnetwork.central.user.domain.UserFilterMatch;

/**
 * DAO API for User objects.
 * 
 * @author matt
 * @version 1.1
 */
public interface UserDao
		extends GenericDao, FilterableDao {

	/**
	 * Get a user by their email.
	 * 
	 * @param email
	 *        the email address to lookup
	 * @return the found User, or {@literal null} if not found
	 */
	User getUserByEmail(String email);

	/**
	 * Get the set of roles a user belongs to.
	 * 
	 * 
	 * Roles represent granted user authorizations.
	 * 
	 * 
	 * @param user
	 *        the user to get the roles for
	 * @return the user roles
	 */
	Set getUserRoles(User user);

	/**
	 * Store the set of roles a user belongs to.
	 * 
	 * 
	 * This will completely replace any existing roles the user may already
	 * belong to.
	 * 
	 * 
	 * @param user
	 *        the user to store the roles for
	 * @param roles
	 *        the set of roles
	 */
	void storeUserRoles(User user, Set roles);

	/**
	 * Get internal data for a user.
	 * 
	 * @param userId
	 *        the ID of the user to get
	 * @return the internal data, or {@literal null} if none available
	 */
	Map getInternalData(Long userId);

	/**
	 * Add, update, or remove properties from the internal data of a user.
	 * 
	 * 
	 * To remove properties, pass in {@literal null} values.
	 * 
	 * 
	 * @param userId
	 *        the ID if the user to update
	 * @param data
	 *        the properties to add, update, or remove
	 * @since 1.1
	 */
	void storeInternalData(Long userId, Map data);

}