Package lumis.portal.user
Interface IUserDao
-
- All Known Implementing Classes:
UserDaoJdbc
public interface IUserDao
Interface for user DAO operations.- Since:
- 4.0.0
- Version:
- $Revision: 23034 $ $Date: 2019-08-05 16:52:47 -0300 (Mon, 05 Aug 2019) $
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
add(UserConfig userConfig, ITransaction transaction)
Add the user.void
addAlternativeLogin(String userId, String newLogin, ITransaction transaction)
Adds an alternative login to a user.void
delete(String userId, ITransaction transaction)
Delete the user.void
deleteAlternativeLogin(String loginToDelete, ITransaction transaction)
Deletes an alternative login.List<UserConfig>
findUsers(String query, boolean includeFrameworkUsers, int maxResults)
Find users by user login or user name, given a search query.UserConfig
get(String userId, ITransaction transaction)
get the user.Collection<String>
getAllUserIds(ITransaction transaction)
Returns all user ids.Collection<String>
getAlternativeLogins(String userId, ITransaction transaction)
Returns the alternative logins of an user.Collection<String>
getByChannelId(String channelId, ITransaction transaction)
Return the local users IDs of the specified channelCollection<String>
getByOrigin(String origin, ITransaction transaction)
Return the user ids, searching by the user's origin.String
getUserIdByLogin(String login, ITransaction transaction)
Get the id of the user.Collection<UserConfig>
getUsersByLogins(Set<String> logins)
Get users with the given logins.void
setPassword(String userId, String password, ITransaction transaction)
Sets a new password for the uservoid
update(UserConfig userConfig, ITransaction transaction)
Update the user.void
updateLoginHistory(String userId, boolean loginSuccess)
Updates persistence information about a user login history.
-
-
-
Method Detail
-
add
void add(UserConfig userConfig, ITransaction transaction) throws DaoException, PortalException
Add the user.- Parameters:
userConfig
-transaction
-- Throws:
DaoException
PortalException
-
get
UserConfig get(String userId, ITransaction transaction) throws DaoException, PortalException
get the user.- Parameters:
userId
-transaction
-- Returns:
- Throws:
DaoException
PortalException
-
getUserIdByLogin
String getUserIdByLogin(String login, ITransaction transaction) throws DaoException, PortalException
Get the id of the user.- Parameters:
login
-transaction
-- Returns:
- Throws:
DaoException
PortalException
-
update
void update(UserConfig userConfig, ITransaction transaction) throws DaoException, PortalException
Update the user.- Parameters:
userConfig
-transaction
-- Throws:
DaoException
PortalException
-
setPassword
void setPassword(String userId, String password, ITransaction transaction) throws DaoException, PortalException
Sets a new password for the user- Parameters:
userId
-password
-transaction
-- Throws:
DaoException
PortalException
-
updateLoginHistory
void updateLoginHistory(String userId, boolean loginSuccess) throws PortalException
Updates persistence information about a user login history. This method is to be called after a login attempt.Note: This method uses its own transaction.
- Parameters:
userId
- the user identifier.loginSuccess
-true
if the login attempt was successful,false
otherwise.- Throws:
PortalException
- Since:
- 12.0.0
-
delete
void delete(String userId, ITransaction transaction) throws DaoException, PortalException
Delete the user.- Parameters:
userId
-transaction
-- Throws:
DaoException
PortalException
-
getByChannelId
Collection<String> getByChannelId(String channelId, ITransaction transaction) throws DaoException, PortalException
Return the local users IDs of the specified channel- Parameters:
channelId
-transaction
-- Returns:
- Throws:
DaoException
PortalException
-
addAlternativeLogin
void addAlternativeLogin(String userId, String newLogin, ITransaction transaction) throws PortalException
Adds an alternative login to a user.- Parameters:
userId
- the user id.newLogin
- the alternative login to be added.transaction
- the transaction for persistence access.- Throws:
PortalException
- Since:
- 4.0.8
-
getAlternativeLogins
Collection<String> getAlternativeLogins(String userId, ITransaction transaction) throws PortalException
Returns the alternative logins of an user.- Parameters:
userId
- the user id.transaction
- the transaction for persistence access.- Returns:
- a collection with the alternative logins of the user.
- Throws:
PortalException
- Since:
- 4.0.8
-
deleteAlternativeLogin
void deleteAlternativeLogin(String loginToDelete, ITransaction transaction) throws PortalException
Deletes an alternative login.- Parameters:
loginToDelete
- the alternative login to be deleted.transaction
- the transaction for persistence access.- Throws:
PortalException
- Since:
- 4.0.8
-
getByOrigin
Collection<String> getByOrigin(String origin, ITransaction transaction) throws DaoException, PortalException
Return the user ids, searching by the user's origin.- Parameters:
origin
- the origin.transaction
- the transaction for persistence access.- Returns:
- the user ids, or an empty collection if none was found.
- Throws:
DaoException
PortalException
- Since:
- 4.0.8
-
getAllUserIds
Collection<String> getAllUserIds(ITransaction transaction) throws PortalException
Returns all user ids.- Parameters:
transaction
- the transaction for persistence access.- Returns:
- the user ids, or an empty collection if none was found.
- Throws:
PortalException
- Since:
- 4.0.11
-
findUsers
List<UserConfig> findUsers(String query, boolean includeFrameworkUsers, int maxResults) throws PortalException
Find users by user login or user name, given a search query.- Parameters:
query
- query used to search usersincludeFrameworkUsers
- indicates if framework users must also be returnedmaxResults
- amount of users to return- Returns:
- List of users which matches the search query with the given parameters, ordered by user name.
- Throws:
PortalException
- Since:
- 10.1.0
-
getUsersByLogins
Collection<UserConfig> getUsersByLogins(Set<String> logins) throws PortalException
Get users with the given logins.- Parameters:
logins
- logins for getting users- Returns:
- List of users with the given logins, ordered by user name.
- Throws:
PortalException
- Since:
- 10.1.0
-
-