com.haulmont.cuba.security.app

Interface UserManagementService

All Known Implementing Classes:

TestUserManagementService, UserManagementServiceBean

public interface UserManagementService

Service providing maintenance operations on security entities.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

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.

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

copyAccessGroup

Group copyAccessGroup(java.util.UUID accessGroupId)

Copy access group with all its properties and subgroups.

Parameters:

accessGroupId - Source access group Id

Returns:

Cloned group

copyRole

Role copyRole(java.util.UUID roleId)

Copy user role with all its permissions.

Parameters:

roleId - Source access role Id

Returns:

Cloned role

copyRole

Role copyRole(java.lang.String predefinedRoleName)

Copy predefined user role with all its permissions.

Parameters:

predefinedRoleName - Source access role name

Returns:

Cloned role

moveUsersToGroup

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

Move specified users to a new database access group.

Parameters:

userIds - Ids for moved users

targetAccessGroupId - Id of target access group, may be null

Returns:

Number of users moved to target group

moveUsersToGroup

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

Move specified users to a new predefined access group.

Parameters:

userIds - Ids for moved users

targetAccessGroupName - target access group name

Returns:

Number of users moved to target group

changePasswordsAtLogonAndSendEmails

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.

Parameters:

userIds - User ids

Returns:

Count of users

changePasswordsAtLogon

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.

Parameters:

userIds - User ids

generatePassword - Generate new passwords

Returns:

Map with userId and new password

checkPassword

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

Parameters:

userId - User id

passwordHash - Plain hash of new password

Returns:

True if the new and old passwords are equal

resetRememberMeTokens

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

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.

Parameters:

userIds - User ids

resetRememberMeTokens

void resetRememberMeTokens()

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

removeRememberMeTokens

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

Removes the given rememberMeTokens.

Parameters:

rememberMeTokens - remember be tokens to remove

isRememberMeTokenValid

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

Checks that the given rememberMeToken exists and is not expired.

Returns:

true if token is valid or false otherwise

generateRememberMeToken

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

Generate and store to DB RememberMeToken

Returns:

token string

getSessionAttributeNames

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.

Parameters:

groupId - Group identifier

Returns:

list of session attribute names

loadOwnTimeZone

UserTimeZone loadOwnTimeZone()

Load current user's time zone settings.

saveOwnTimeZone

void saveOwnTimeZone(UserTimeZone timeZone)

Save current user's time zone settings.

loadOwnLocale

java.lang.String loadOwnLocale()

Load current user's language.

saveOwnLocale

void saveOwnLocale(java.lang.String locale)

Save current user's language settings.

changeUserPassword

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

Change password for user

Parameters:

userId - user id

newPasswordHash - password hash

isUsersRemovingAllowed

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

Checks whether removing of users with the given logins is allowed

Parameters:

userLogins - user logins

Returns:

true if removing is allowed or false otherwise

changeGroupParent

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

Sets new parent group in separate transaction.

Parameters:

groupId - id of group

newParentId - id of new parent group

isAnonymousUser

boolean isAnonymousUser(java.lang.String userLogin)

Checks if user is anonymous user.

Parameters:

userLogin - user login

getSubstitutedUsers

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

Get list of substituted users by user id.

Parameters:

userId - user id

Returns:

list of substituted users