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

Method Summary

Methods

Modifier and Type	Method and Description
long	countCloudAwareUsers() Count the number of cloud-enabled users, regardless of signup state
long	countUsers()
long	countUsers(boolean created)
long	countUsers(String domain, boolean created)
void	createNewUser(UserData data)
UserData	findUserByEmail(String email) Find a user by email address
UserData	findUserByUsername(String username) Find a user by username
UserData	findUserByUserName(String userName) Find a user by it's username.
List<UserData>	getCreatedUsers(int startIndex, int count) Get a list of usernames that are created in alfresco with paging
List<UserData>	getUsersInDomain(String domain, int startIndex, int count) Return a maximum of "max" users in the network with id "networkId".
List<UserData>	getUsersInDomain(String domain, int startIndex, int count, boolean created) Return a maximum of "max" users in the network with id "networkId" and given created flag.
List<UserData>	getUsersPendingCreation(int startIndex, int count) Get a list of usernames that are NOT created in alfresco with paging
List<UserData>	getUsersWithoutCloudSignUp(int startIndex, int count) Retrieves a selection of users that have no cloud signup details.
Iterator<String>	networksIterator() An iterator over networks in the users collection.
UserData	randomUser() Select a random, pre-created user.
UserData	randomUser(List<String> domains) Select a random, pre-created user that is a member of one of the given domains.
UserData	randomUser(String domain) Select a random, pre-created user.
void	setUserCloudSignUp(String username, CloudSignUpData cloudSignUp) Set the registration data for a user
void	setUserCreated(String username, boolean created) Change the 'created' state of the user i.e.
void	setUserNodeId(String username, String nodeId) Store a node ID associated with the username
void	setUserPassword(String username, String password) Update a user's password
void	setUserTicket(String username, String ticket) Store an authentication token (ticket) against a username
Iterator<UserData>	usersIterator(String domain) Iterate over users in the given network.

Method Detail

createNewUser

void createNewUser(UserData data)

setUserTicket

void setUserTicket(String username,
                 String ticket)

Store an authentication token (ticket) against a username

setUserPassword

void setUserPassword(String username,
                   String password)

Update a user's password

setUserNodeId

void setUserNodeId(String username,
                 String nodeId)

Store a node ID associated with the username

setUserCreated

void setUserCreated(String username,
                  boolean created)

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

countUsers

long countUsers(boolean created)

Parameters:

created - true to only count users present in Alfresco

countUsers

long countUsers(String domain,
              boolean created)

Parameters:

domain - the domain to search

created - true to only count users present in Alfresco

countUsers

long countUsers()

Returns:

a count of all users in any state

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.

getUsersPendingCreation

List<UserData> getUsersPendingCreation(int startIndex,
                                     int count)

Get a list of usernames that are NOT created in alfresco with paging

Parameters:

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

getCreatedUsers

List<UserData> getCreatedUsers(int startIndex,
                             int count)

Get a list of usernames that are created in alfresco with paging

Parameters:

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

setUserCloudSignUp

void setUserCloudSignUp(String username,
                      CloudSignUpData cloudSignUp)

Set the registration data for a user

Parameters:

username - the username

cloudSignUp - the new registration data to set

countCloudAwareUsers

long countCloudAwareUsers()

Count the number of cloud-enabled users, regardless of signup state

Returns:

the number of users that have cloud registration details, regardless of state

getUsersWithoutCloudSignUp

List<UserData> getUsersWithoutCloudSignUp(int startIndex,
                                        int count)

Retrieves a selection of users that have no cloud signup details. Note they must also not be created in any instance of Alfresco.

getUsersInDomain

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

Return a maximum of "max" users in the network with id "networkId".

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 domain

getUsersInDomain

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

Return a maximum of "max" users in the network with id "networkId" and given created flag.

Parameters:

domain - the user domain

startIndex - the start index for paging

count - the number of users to retrieve

created - is the user created or not?

Returns:

a list of users in the domain

networksIterator

Iterator<String> networksIterator()

An iterator over networks in the users collection.

Returns:

an iterator over networks

findUserByUserName

UserData findUserByUserName(String userName)

Find a user by it's username.

Returns:

the UserData found. Null, if user doesn't exist.

randomUser

UserData randomUser()

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

randomUser

UserData randomUser(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

randomUser

UserData randomUser(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

usersIterator

Iterator<UserData> usersIterator(String domain)

Iterate over users in the given network.

Parameters:

domain - the user domain

Returns:

an iterator over users.