com.logicaldoc.core.security.dao

Class HibernateUserDAO

java.lang.Object

com.logicaldoc.core.HibernatePersistentObjectDAO<User>

com.logicaldoc.core.security.dao.HibernateUserDAO

All Implemented Interfaces:

PersistentObjectDAO<User>, UserDAO

public class HibernateUserDAO
extends HibernatePersistentObjectDAO<User>
implements UserDAO

Hibernate implementation of UserDAO

Since:

3.0

Author:

Marco Meschieri - Logical Objects

Field Summary

Fields inherited from class com.logicaldoc.core.HibernatePersistentObjectDAO

entityClass, log, sessionFactory

Method Summary

Methods

Modifier and Type	Method and Description
int	count() Counts the total number of users
boolean	delete(long userId) This method deletes an entity.
boolean	delete(long userId, UserHistory transaction) This method deletes the user object and insert a new user history entry.
List<User>	findByLikeUserName(String username) This method finds an User by username.
List<User>	findByName(String name) This method finds an User by name.
User	findByUserName(String username) This method finds an User by its username.
List<User>	findByUserNameAndName(String username, String name) This method finds an User by username and name.
Map<String,Generic>	findUserSettings(long userId, String namePrefix) Retrieves the settings for a user.
int	getPasswordTtl()
UserDocDAO	getUserDocDAO()
UserHistoryDAO	getUserHistoryDAO()
UserListenerManager	getUserListenerManager()
void	initialize(User user) Doesn't do anything by default
boolean	isPasswordExpired(String username) Is password expired.
void	setGenericDAO(GenericDAO genericDAO)
void	setPasswordTtl(int passwordTtl)
void	setUserDocDAO(UserDocDAO userDocDAO)
void	setUserHistoryDAO(UserHistoryDAO userHistoryDAO)
void	setUserListenerManager(UserListenerManager userListenerManager)
boolean	store(User user) This method persists the entity object.
boolean	store(User user, UserHistory transaction) This method persists the user object and insert a new user history entry.
boolean	validateUser(String username) Validates an username only (the password content is not inspectged.
boolean	validateUser(String username, String password) Validates an username and a password.

Methods inherited from class com.logicaldoc.core.HibernatePersistentObjectDAO

bulkUpdate, deleteAll, evict, findAll, findAllIds, findById, findByQuery, findByWhere, findByWhere, findIdsByWhere, findIdsByWhere, flush, getConnection, getCurrentSession, getDbms, getSessionFactory, isHsql, isMySQL, isOracle, isSqlServer, jdbcUpdate, jdbcUpdate, merge, prepareQuery, query, queryForInt, queryForList, queryForList, queryForLong, queryForRowSet, refresh, saveOrUpdate, setSessionFactory

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.logicaldoc.core.PersistentObjectDAO

bulkUpdate, deleteAll, findAll, findAllIds, findById, findByQuery, findByWhere, findByWhere, findIdsByWhere, findIdsByWhere, getDbms, jdbcUpdate, jdbcUpdate, query, queryForInt, queryForList, queryForList, queryForLong, queryForRowSet

Method Detail

delete

public boolean delete(long userId)

Description copied from interface: PersistentObjectDAO

This method deletes an entity.

Specified by:

delete in interface PersistentObjectDAO<User>

Overrides:

delete in class HibernatePersistentObjectDAO<User>

Parameters:

userId - ID of the entity which should be deleted.

See Also:

PersistentObjectDAO.delete(long)

findByName

public List<User> findByName(String name)

Description copied from interface: UserDAO

This method finds an User by name.

Specified by:

findByName in interface UserDAO

Parameters:

name - The name of wanted User.

Returns:

Collection of selected users.

See Also:

UserDAO.findByName(java.lang.String)

findByUserName

public User findByUserName(String username)

Description copied from interface: UserDAO

This method finds an User by its username.

Specified by:

findByUserName in interface UserDAO

Parameters:

username - username of wanted User.

Returns:

Wanted User or null if user doesn't exist.

See Also:

UserDAO.findByUserName(java.lang.String)

findByLikeUserName

public List<User> findByLikeUserName(String username)

Description copied from interface: UserDAO

This method finds an User by username.

Specified by:

findByLikeUserName in interface UserDAO

Parameters:

username - The username of wanted User.

Returns:

Collection of selected users.

See Also:

UserDAO.findByUserName(java.lang.String)

findByUserNameAndName

public List<User> findByUserNameAndName(String username,
                               String name)

Description copied from interface: UserDAO

This method finds an User by username and name.

Specified by:

findByUserNameAndName in interface UserDAO

Parameters:

username - The username of wanted user.

name - The name of wanted user.

Returns:

Collection of selected users.

See Also:

UserDAO.findByUserNameAndName(java.lang.String, java.lang.String)

store

public boolean store(User user)

Description copied from interface: PersistentObjectDAO

This method persists the entity object.

Specified by:

store in interface PersistentObjectDAO<User>

Overrides:

store in class HibernatePersistentObjectDAO<User>

Parameters:

user - entity to be stored.

Returns:

True if successfully stored in a database.

See Also:

com.logicaldoc.core.security.dao.UserDAO#store(com.logicaldoc.core.security.User)

store

public boolean store(User user,
            UserHistory transaction)

Description copied from interface: UserDAO

This method persists the user object and insert a new user history entry.

Specified by:

store in interface UserDAO

transaction - entry to log the event

Returns:

True if successfully stored in a database.

validateUser

public boolean validateUser(String username,
                   String password)

Description copied from interface: UserDAO

Validates an username and a password.

Specified by:

validateUser in interface UserDAO

Parameters:

username - Username of the User to be validated.

password - Password of the User to be validated.

Returns:

True if User is valid and authenticated.

See Also:

UserDAO.validateUser(java.lang.String, java.lang.String)

validateUser

public boolean validateUser(String username)

Description copied from interface: UserDAO

Validates an username only (the password content is not inspectged.

Specified by:

validateUser in interface UserDAO

Parameters:

username - Username of the User to be validated.

Returns:

True if User is valid.

getPasswordTtl

public int getPasswordTtl()

Specified by:

getPasswordTtl in interface UserDAO

setPasswordTtl

public void setPasswordTtl(int passwordTtl)

Specified by:

setPasswordTtl in interface UserDAO

isPasswordExpired

public boolean isPasswordExpired(String username)

Description copied from interface: UserDAO

Is password expired.

Specified by:

isPasswordExpired in interface UserDAO

Parameters:

username - Username of the User to be validate.

Returns:

True if the password is expired

count

public int count()

Description copied from interface: UserDAO

Counts the total number of users

Specified by:

count in interface UserDAO

delete

public boolean delete(long userId,
             UserHistory transaction)

Description copied from interface: UserDAO

This method deletes the user object and insert a new user history entry.

Specified by:

delete in interface UserDAO

Parameters:

userId - The id of the user to delete

transaction - entry to log the event

Returns:

True if successfully deleted from the database.

getUserHistoryDAO

public UserHistoryDAO getUserHistoryDAO()

setUserHistoryDAO

public void setUserHistoryDAO(UserHistoryDAO userHistoryDAO)

getUserDocDAO

public UserDocDAO getUserDocDAO()

setUserDocDAO

public void setUserDocDAO(UserDocDAO userDocDAO)

setUserListenerManager

public void setUserListenerManager(UserListenerManager userListenerManager)

getUserListenerManager

public UserListenerManager getUserListenerManager()

initialize

public void initialize(User user)

Description copied from class: HibernatePersistentObjectDAO

Doesn't do anything by default

Specified by:

initialize in interface PersistentObjectDAO<User>

Overrides:

initialize in class HibernatePersistentObjectDAO<User>

Parameters:

user - The entity to be initialised

findUserSettings

public Map<String,Generic> findUserSettings(long userId,
                                   String namePrefix)

Description copied from interface: UserDAO

Retrieves the settings for a user. The settings are stored as Generics of type usersetting.

Specified by:

findUserSettings in interface UserDAO

Parameters:

userId - Identifier of the user

namePrefix - Name prefix of the property (optional)

Returns:

The map setting_name-generic

setGenericDAO

public void setGenericDAO(GenericDAO genericDAO)