com.haulmont.cuba.web.testsupport.ui

Class TestUserManagementService

java.lang.Object

com.haulmont.cuba.web.testsupport.ui.TestUserManagementService

All Implemented Interfaces:

UserManagementService

public class TestUserManagementService
extends java.lang.Object
implements UserManagementService

Field Summary

Fields inherited from interface com.haulmont.cuba.security.app.UserManagementService

NAME

Constructor Summary

Constructors

Constructor and Description
TestUserManagementService()

Method Summary

Modifier and Type	Method and Description
void	changeGroupParent(java.util.UUID groupId, java.util.UUID newParentId) Sets new parent group in separate transaction.
java.util.Map<java.util.UUID,java.lang.String>	changePasswordsAtLogon(java.util.List<java.util.UUID> userIds, boolean generatePassword) Make specified users to change passwords at next logon.
java.lang.Integer	changePasswordsAtLogonAndSendEmails(java.util.List<java.util.UUID> userIds) Update passwords for specified users, send them emails with new generated passwords and make them change passwords at next logon.
void	changeUserPassword(java.util.UUID userId, java.lang.String newPasswordHash) Change password for user
boolean	checkPassword(java.util.UUID userId, java.lang.String passwordHash)
Group	copyAccessGroup(java.util.UUID accessGroupId) Copy access group with all its properties and subgroups.
Role	copyRole(java.lang.String predefinedRoleName) Copy predefined user role with all its permissions.
Role	copyRole(java.util.UUID roleId) Copy user role with all its permissions.
java.lang.String	generateRememberMeToken(java.util.UUID userId) Generate and store to DB RememberMeToken
java.util.List<java.lang.String>	getSessionAttributeNames(java.util.UUID groupId) Get names of session attributes defined for the given group and all its parent groups.
java.util.List<UserSubstitution>	getSubstitutedUsers(java.util.UUID userId) Get list of substituted users by user id.
boolean	isAnonymousUser(java.lang.String userLogin) Checks if user is anonymous user.
boolean	isRememberMeTokenValid(java.lang.String login, java.lang.String rememberMeToken) Checks that the given rememberMeToken exists and is not expired.
boolean	isUsersRemovingAllowed(java.util.Collection<java.lang.String> userLogins) Checks whether removing of users with the given logins is allowed
java.lang.String	loadOwnLocale() Load current user's language.
UserTimeZone	loadOwnTimeZone() Load current user's time zone settings.
java.lang.Integer	moveUsersToGroup(java.util.List<java.util.UUID> userIds, java.lang.String targetAccessGroupName) Move specified users to a new predefined access group.
java.lang.Integer	moveUsersToGroup(java.util.List<java.util.UUID> userIds, java.util.UUID targetAccessGroupId) Move specified users to a new database access group.
void	removeRememberMeTokens(java.util.List<java.lang.String> rememberMeTokens) Removes the given rememberMeTokens.
void	resetRememberMeTokens() Remove remember me tokens for all users.
void	resetRememberMeTokens(java.util.List<java.util.UUID> userIds) Remove remember me tokens for users.
void	saveOwnLocale(java.lang.String locale) Save current user's language settings.
void	saveOwnTimeZone(UserTimeZone timeZone) Save current user's time zone settings.

Methods inherited from class java.lang.Object

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

Constructor Detail

TestUserManagementService

public TestUserManagementService()

Method Detail

copyAccessGroup

public Group copyAccessGroup(java.util.UUID accessGroupId)

Description copied from interface: UserManagementService

Copy access group with all its properties and subgroups.

Specified by:

copyAccessGroup in interface UserManagementService

Parameters:

accessGroupId - Source access group Id

Returns:

Cloned group

copyRole

public Role copyRole(java.util.UUID roleId)

Description copied from interface: UserManagementService

Copy user role with all its permissions.

Specified by:

copyRole in interface UserManagementService

Parameters:

roleId - Source access role Id

Returns:

Cloned role

copyRole

public Role copyRole(java.lang.String predefinedRoleName)

Description copied from interface: UserManagementService

Copy predefined user role with all its permissions.

Specified by:

copyRole in interface UserManagementService

Parameters:

predefinedRoleName - Source access role name

Returns:

Cloned role

moveUsersToGroup

public java.lang.Integer moveUsersToGroup(java.util.List<java.util.UUID> userIds,
                                          @Nullable
                                          java.util.UUID targetAccessGroupId)

Description copied from interface: UserManagementService

Move specified users to a new database access group.

Specified by:

moveUsersToGroup in interface UserManagementService

Parameters:

userIds - Ids for moved users

targetAccessGroupId - Id of target access group, may be null

Returns:

Number of users moved to target group

moveUsersToGroup

public java.lang.Integer moveUsersToGroup(java.util.List<java.util.UUID> userIds,
                                          @Nullable
                                          java.lang.String targetAccessGroupName)

Description copied from interface: UserManagementService

Move specified users to a new predefined access group.

Specified by:

moveUsersToGroup in interface UserManagementService

Parameters:

userIds - Ids for moved users

targetAccessGroupName - target access group name

Returns:

Number of users moved to target group

changePasswordsAtLogonAndSendEmails

public java.lang.Integer changePasswordsAtLogonAndSendEmails(java.util.List<java.util.UUID> userIds)

Description copied from interface: UserManagementService

Update passwords for specified users, send them emails with new generated passwords and make them change passwords at next logon.

Specified by:

changePasswordsAtLogonAndSendEmails in interface UserManagementService

Parameters:

userIds - User ids

Returns:

Count of users

changePasswordsAtLogon

public java.util.Map<java.util.UUID,java.lang.String> changePasswordsAtLogon(java.util.List<java.util.UUID> userIds,
                                                                             boolean generatePassword)

Description copied from interface: UserManagementService

Make specified users to change passwords at next logon.

Specified by:

changePasswordsAtLogon in interface UserManagementService

Parameters:

userIds - User ids

generatePassword - Generate new passwords

Returns:

Map with userId and new password

checkPassword

public boolean checkPassword(java.util.UUID userId,
                             java.lang.String passwordHash)

Specified by:

checkPassword in interface UserManagementService

Parameters:

userId - User id

passwordHash - Plain hash of new password

Returns:

True if the new and old passwords are equal

resetRememberMeTokens

public void resetRememberMeTokens(java.util.List<java.util.UUID> userIds)

Description copied from interface: UserManagementService

Remove remember me tokens for users. The tokens reset is executed in the joined transaction if there is one at the moment, creates a new transaction otherwise.

Specified by:

resetRememberMeTokens in interface UserManagementService

Parameters:

userIds - User ids

resetRememberMeTokens

public void resetRememberMeTokens()

Description copied from interface: UserManagementService

Remove remember me tokens for all users. The tokens reset is always executed in a new transaction.

Specified by:

resetRememberMeTokens in interface UserManagementService

removeRememberMeTokens

public void removeRememberMeTokens(java.util.List<java.lang.String> rememberMeTokens)

Description copied from interface: UserManagementService

Removes the given rememberMeTokens.

Specified by:

removeRememberMeTokens in interface UserManagementService

Parameters:

rememberMeTokens - remember be tokens to remove

isRememberMeTokenValid

public boolean isRememberMeTokenValid(java.lang.String login,
                                      java.lang.String rememberMeToken)

Description copied from interface: UserManagementService

Checks that the given rememberMeToken exists and is not expired.

Specified by:

isRememberMeTokenValid in interface UserManagementService

Returns:

true if token is valid or false otherwise

generateRememberMeToken

public java.lang.String generateRememberMeToken(java.util.UUID userId)

Description copied from interface: UserManagementService

Generate and store to DB RememberMeToken

Specified by:

generateRememberMeToken in interface UserManagementService

Returns:

token string

getSessionAttributeNames

public java.util.List<java.lang.String> getSessionAttributeNames(java.util.UUID groupId)

Description copied from interface: UserManagementService

Get names of session attributes defined for the given group and all its parent groups.

Specified by:

getSessionAttributeNames in interface UserManagementService

Parameters:

groupId - Group identifier

Returns:

list of session attribute names

loadOwnTimeZone

public UserTimeZone loadOwnTimeZone()

Description copied from interface: UserManagementService

Load current user's time zone settings.

Specified by:

loadOwnTimeZone in interface UserManagementService

saveOwnTimeZone

public void saveOwnTimeZone(UserTimeZone timeZone)

Description copied from interface: UserManagementService

Save current user's time zone settings.

Specified by:

saveOwnTimeZone in interface UserManagementService

loadOwnLocale

public java.lang.String loadOwnLocale()

Description copied from interface: UserManagementService

Load current user's language.

Specified by:

loadOwnLocale in interface UserManagementService

saveOwnLocale

public void saveOwnLocale(java.lang.String locale)

Description copied from interface: UserManagementService

Save current user's language settings.

Specified by:

saveOwnLocale in interface UserManagementService

changeUserPassword

public void changeUserPassword(java.util.UUID userId,
                               java.lang.String newPasswordHash)

Description copied from interface: UserManagementService

Change password for user

Specified by:

changeUserPassword in interface UserManagementService

Parameters:

userId - user id

newPasswordHash - password hash

isUsersRemovingAllowed

public boolean isUsersRemovingAllowed(java.util.Collection<java.lang.String> userLogins)

Description copied from interface: UserManagementService

Checks whether removing of users with the given logins is allowed

Specified by:

isUsersRemovingAllowed in interface UserManagementService

Parameters:

userLogins - user logins

Returns:

true if removing is allowed or false otherwise

changeGroupParent

public void changeGroupParent(java.util.UUID groupId,
                              java.util.UUID newParentId)

Description copied from interface: UserManagementService

Sets new parent group in separate transaction.

Specified by:

changeGroupParent in interface UserManagementService

Parameters:

groupId - id of group

newParentId - id of new parent group

isAnonymousUser

public boolean isAnonymousUser(java.lang.String userLogin)

Description copied from interface: UserManagementService

Checks if user is anonymous user.

Specified by:

isAnonymousUser in interface UserManagementService

Parameters:

userLogin - user login

getSubstitutedUsers

public java.util.List<UserSubstitution> getSubstitutedUsers(java.util.UUID userId)

Description copied from interface: UserManagementService

Get list of substituted users by user id.

Specified by:

getSubstitutedUsers in interface UserManagementService

Parameters:

userId - user id

Returns:

list of substituted users