org.alfresco.bm.user

Class UserDataServiceImpl

java.lang.Object

org.alfresco.bm.user.AbstractUserDataService

org.alfresco.bm.user.UserDataServiceImpl

All Implemented Interfaces:

UserDataService, org.springframework.beans.factory.InitializingBean

public class UserDataServiceImpl
extends AbstractUserDataService
implements org.springframework.beans.factory.InitializingBean

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	Class and Description
static class	UserDataServiceImpl.Range
class	UserDataServiceImpl.XObject

Nested classes/interfaces inherited from interface org.alfresco.bm.user.UserDataService

UserDataService.UserCallback

Constructor Summary

Constructors

Constructor and Description
UserDataServiceImpl(org.springframework.data.mongodb.core.MongoTemplate mongo, String collectionName)

Method Summary

Methods

Modifier and Type	Method and Description
void	afterPropertiesSet()
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.
protected List<UserData>	getUsers(boolean created, int startIndex, int count)
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>	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.

Methods inherited from class org.alfresco.bm.user.AbstractUserDataService

getCreatedUsers, getUsersPendingCreation

Methods inherited from class java.lang.Object

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

Constructor Detail

UserDataServiceImpl

public UserDataServiceImpl(org.springframework.data.mongodb.core.MongoTemplate mongo,
                   String collectionName)

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

createNewUser

public void createNewUser(UserData data)

Specified by:

createNewUser in interface UserDataService

setUserTicket

public void setUserTicket(String username,
                 String ticket)

Store an authentication token (ticket) against a username

Specified by:

setUserTicket in interface UserDataService

setUserPassword

public void setUserPassword(String username,
                   String password)

Update a user's password

Specified by:

setUserPassword in interface UserDataService

setUserNodeId

public void setUserNodeId(String username,
                 String nodeId)

Store a node ID associated with the username

Specified by:

setUserNodeId in interface UserDataService

setUserCreated

public void setUserCreated(String username,
                  boolean created)

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

Specified by:

setUserCreated in interface UserDataService

countUsers

public long countUsers(boolean created)

Specified by:

countUsers in interface UserDataService

Parameters:

created - true to only count users present in Alfresco

countUsers

public long countUsers(String domain,
              boolean created)

Specified by:

countUsers in interface UserDataService

Parameters:

domain - the domain to search

created - true to only count users present in Alfresco

countUsers

public long countUsers()

Specified by:

countUsers in interface UserDataService

Returns:

a count of all users in any state

findUserByUsername

public UserData findUserByUsername(String username)

Find a user by username

Specified by:

findUserByUsername in interface UserDataService

Returns:

the UserData found otherwise null

findUserByEmail

public UserData findUserByEmail(String email)

Find a user by email address

Specified by:

findUserByEmail in interface UserDataService

Returns:

the UserData found otherwise null

getUsers

protected List<UserData> getUsers(boolean created,
                      int startIndex,
                      int count)

Specified by:

getUsers in class AbstractUserDataService

Parameters:

created - true to only count users present in Alfresco

setUserCloudSignUp

public void setUserCloudSignUp(String username,
                      CloudSignUpData cloudSignUp)

Set the registration data for a user

Specified by:

setUserCloudSignUp in interface UserDataService

Parameters:

username - the username

cloudSignUp - the new registration data to set

countCloudAwareUsers

public long countCloudAwareUsers()

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

Specified by:

countCloudAwareUsers in interface UserDataService

Returns:

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

getUsersWithoutCloudSignUp

public 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.

Specified by:

getUsersWithoutCloudSignUp in interface UserDataService

getUsersInDomain

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

Description copied from interface: UserDataService

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

Specified by:

getUsersInDomain in interface UserDataService

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

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

Description copied from interface: UserDataService

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

Specified by:

getUsersInDomain in interface UserDataService

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

public Iterator<String> networksIterator()

Description copied from interface: UserDataService

An iterator over networks in the users collection.

Specified by:

networksIterator in interface UserDataService

Returns:

an iterator over networks

findUserByUserName

public UserData findUserByUserName(String userName)

Find a user by it's username.

Specified by:

findUserByUserName in interface UserDataService

Returns:

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

randomUser

public UserData randomUser()

Description copied from interface: UserDataService

Select a random, pre-created user.

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

Specified by:

randomUser in interface UserDataService

Returns:

a random user or null if none are available

randomUser

public UserData randomUser(String domain)

Description copied from interface: UserDataService

Select a random, pre-created user.

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

Specified by:

randomUser in interface UserDataService

Parameters:

domain - the user domain

Returns:

a random user or null if none are available

randomUser

public UserData randomUser(List<String> domains)

Description copied from interface: UserDataService

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.

Specified by:

randomUser in interface UserDataService

Returns:

a random user or null if none are available

usersIterator

public Iterator<UserData> usersIterator(String domain)

Description copied from interface: UserDataService

Iterate over users in the given network.

Specified by:

usersIterator in interface UserDataService

Parameters:

domain - the user domain

Returns:

an iterator over users.