org.alfresco.bm.user

Interface UserDataService

All Known Implementing Classes:

AbstractUserDataService, UserDataServiceImpl

public interface UserDataService

Service providing access to UserData storage. All UserData returned from and persisted with this service will be testrun-specific. The testrun-identifier is set in the constructor.

Since:

1.1

Author:

Frederik Heremans, Derek Hulley, steveglover

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	UserDataService.UserCallback

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_DOMAIN The domain given to users who belong to the default domain

Method Summary

Modifier and Type	Method and Description
void	addUserGroups(String username, List<String> groups) Record additional groups that the user belongs to.
long	countUsers(String domain, DataCreationState creationState)
void	createNewUser(UserData data)
long	deleteUsers(DataCreationState creationState) Delete users by create state
UserData	findUserByEmail(String email) Find a user by email address
UserData	findUserByUsername(String username) Find a user by username
Iterator<String>	getDomainsIterator() An iterator over domains in the users collection.
UserData	getRandomUser() Select a random, pre-created user.
UserData	getRandomUserFromDomain(String domain) Select a random, pre-created user.
UserData	getRandomUserFromDomains(List<String> domains) Select a random, pre-created user that is a member of one of the given domains.
List<UserData>	getUsersByCreationState(DataCreationState creationState, int startIndex, int count) Get the users based on user creation state
List<UserData>	getUsersInDomain(String domain, int startIndex, int count) Access created users by their user domain using paging
void	removeUserGroups(String username, List<String> groups) Remove some groups from the user's groups list
void	setUserCreationState(String username, DataCreationState creationState) Change the 'created' state of the user i.e.
void	setUserPassword(String username, String password) Update a user's password

Field Detail

DEFAULT_DOMAIN

static final String DEFAULT_DOMAIN

The domain given to users who belong to the default domain

See Also:

Constant Field Values

Method Detail

createNewUser

void createNewUser(UserData data)

Throws:

com.mongodb.DuplicateKeyException - if the username is already used

setUserPassword

void setUserPassword(String username,
                     String password)

Update a user's password

setUserCreationState

void setUserCreationState(String username,
                          DataCreationState creationState)

Change the 'created' state of the user i.e. whether the user exists on the server or not

countUsers

long countUsers(String domain,
                DataCreationState creationState)

Parameters:

domain - the domain to search or null for all domains

creationState - optional creation state to filter the count or null for all

deleteUsers

long deleteUsers(DataCreationState creationState)

Delete users by create state

Parameters:

creationState - the user creation state to target or null to delete all users

findUserByUsername

UserData findUserByUsername(String username)

Find a user by username

Returns:

the UserData found otherwise null.

findUserByEmail

UserData findUserByEmail(String email)

Find a user by email address

Returns:

the UserData found otherwise null.

getUsersByCreationState

List<UserData> getUsersByCreationState(DataCreationState creationState,
                                       int startIndex,
                                       int count)

Get the users based on user creation state

Parameters:

creationState - the current creation state

startIndex - index to start getting users from

count - number of users to fetch

Returns:

List of user data, which may be empty or less than the required count

getRandomUser

UserData getRandomUser()

Select a random, pre-created user.

Note that this is useful only for large numbers of users.

Returns:

a random user or null if none are available

getUsersInDomain

List<UserData> getUsersInDomain(String domain,
                                int startIndex,
                                int count)

Access created users by their user domain using paging

Parameters:

domain - the user domain

startIndex - the start index for paging

count - the number of users to retrieve

Returns:

a list of users in the user domain

See Also:

DEFAULT_DOMAIN

getDomainsIterator

Iterator<String> getDomainsIterator()

An iterator over domains in the users collection.

Returns:

an iterator over domains

See Also:

DEFAULT_DOMAIN

getRandomUserFromDomain

UserData getRandomUserFromDomain(String domain)

Select a random, pre-created user.

Note that this is useful only for large numbers of users.

Parameters:

domain - the user domain

Returns:

a random user or null if none are available

See Also:

DEFAULT_DOMAIN

getRandomUserFromDomains

UserData getRandomUserFromDomains(List<String> domains)

Select a random, pre-created user that is a member of one of the given domains.

Note that this is useful only for large numbers of users.

Parameters:

domain - the user domain

Returns:

a random user or null if none are available

See Also:

DEFAULT_DOMAIN

addUserGroups

void addUserGroups(String username,
                   List<String> groups)

Record additional groups that the user belongs to. The list of groups does not have to be complete i.e. the groups are added to the set of existing user groups.

Parameters:

username - the username

groups - new groups for the user

removeUserGroups

void removeUserGroups(String username,
                      List<String> groups)

Remove some groups from the user's groups list

Parameters:

username - the username

groups - groups to which the user no longer belongs