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

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

UserDataService.UserCallback

Field Summary

Fields

Modifier and Type	Field and Description
protected com.mongodb.DBCollection	collection The collection of users, which can be reused by derived extensions.
static String	FIELD_CREATION_STATE
static String	FIELD_DOMAIN
static String	FIELD_EMAIL
static String	FIELD_FIRST_NAME
static String	FIELD_GROUPS
static String	FIELD_ID
static String	FIELD_KEY
static String	FIELD_LAST_NAME
static String	FIELD_PASSWORD
static String	FIELD_RANDOMIZER
static String	FIELD_USERNAME

Fields inherited from interface org.alfresco.bm.user.UserDataService

DEFAULT_DOMAIN

Constructor Summary

Constructors

Constructor and Description
UserDataServiceImpl(com.mongodb.DB db, String collection)

Method Summary

Modifier and Type	Method and Description
void	addUserGroups(String username, List<String> groups) Record additional groups that the user belongs to.
void	afterPropertiesSet()
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
protected List<UserData>	fromDBCursor(com.mongodb.DBCursor cursor) Turn a cursor into an array of API-friendly objects
protected UserData	fromDBObject(com.mongodb.DBObject userDataObj) Helper to convert a Mongo DBObject into the API consumable object Note that null is handled as a null return.
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

Methods inherited from class java.lang.Object

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

Field Detail

FIELD_RANDOMIZER

public static final String FIELD_RANDOMIZER

See Also:

Constant Field Values

FIELD_USERNAME

public static final String FIELD_USERNAME

See Also:

Constant Field Values

FIELD_PASSWORD

public static final String FIELD_PASSWORD

See Also:

Constant Field Values

FIELD_CREATION_STATE

public static final String FIELD_CREATION_STATE

See Also:

Constant Field Values

FIELD_FIRST_NAME

public static final String FIELD_FIRST_NAME

See Also:

Constant Field Values

FIELD_LAST_NAME

public static final String FIELD_LAST_NAME

See Also:

Constant Field Values

FIELD_EMAIL

public static final String FIELD_EMAIL

See Also:

Constant Field Values

FIELD_DOMAIN

public static final String FIELD_DOMAIN

See Also:

Constant Field Values

FIELD_GROUPS

public static final String FIELD_GROUPS

See Also:

Constant Field Values

FIELD_ID

public static final String FIELD_ID

See Also:

Constant Field Values

FIELD_KEY

public static final String FIELD_KEY

See Also:

Constant Field Values

collection

protected final com.mongodb.DBCollection collection

The collection of users, which can be reused by derived extensions.

Constructor Detail

UserDataServiceImpl

public UserDataServiceImpl(com.mongodb.DB db,
                           String collection)

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

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

Throws:

Exception

fromDBObject

protected UserData fromDBObject(com.mongodb.DBObject userDataObj)

Helper to convert a Mongo DBObject into the API consumable object

Note that null is handled as a null return.

fromDBCursor

protected List<UserData> fromDBCursor(com.mongodb.DBCursor cursor)

Turn a cursor into an array of API-friendly objects

createNewUser

public void createNewUser(UserData data)

Specified by:

createNewUser in interface UserDataService

setUserPassword

public void setUserPassword(String username,
                            String password)

Update a user's password

Specified by:

setUserPassword in interface UserDataService

setUserCreationState

public void setUserCreationState(String username,
                                 DataCreationState creationState)

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

Specified by:

setUserCreationState in interface UserDataService

countUsers

public long countUsers(String domain,
                       DataCreationState creationState)

Specified by:

countUsers in interface UserDataService

Parameters:

domain - the domain to search or null for all domains

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

deleteUsers

public long deleteUsers(DataCreationState creationState)

Description copied from interface: UserDataService

Delete users by create state

Specified by:

deleteUsers in interface UserDataService

Parameters:

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

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)

Description copied from interface: UserDataService

Find a user by email address

Specified by:

findUserByEmail in interface UserDataService

Returns:

the UserData found otherwise null.

getUsersByCreationState

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

Description copied from interface: UserDataService

Get the users based on user creation state

Specified by:

getUsersByCreationState in interface UserDataService

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

public UserData getRandomUser()

Description copied from interface: UserDataService

Select a random, pre-created user.

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

Specified by:

getRandomUser in interface UserDataService

Returns:

a random user or null if none are available

getUsersInDomain

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

Description copied from interface: UserDataService

Access created users by their user domain using paging

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 user domain

See Also:

UserDataService.DEFAULT_DOMAIN

getDomainsIterator

public Iterator<String> getDomainsIterator()

Description copied from interface: UserDataService

An iterator over domains in the users collection.

Specified by:

getDomainsIterator in interface UserDataService

Returns:

an iterator over domains

See Also:

UserDataService.DEFAULT_DOMAIN

getRandomUserFromDomain

public UserData getRandomUserFromDomain(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:

getRandomUserFromDomain in interface UserDataService

Parameters:

domain - the user domain

Returns:

a random user or null if none are available

See Also:

UserDataService.DEFAULT_DOMAIN

getRandomUserFromDomains

public UserData getRandomUserFromDomains(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:

getRandomUserFromDomains in interface UserDataService

Returns:

a random user or null if none are available

See Also:

UserDataService.DEFAULT_DOMAIN

addUserGroups

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

Description copied from interface: UserDataService

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.

Specified by:

addUserGroups in interface UserDataService

Parameters:

username - the username

groups - new groups for the user

removeUserGroups

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

Description copied from interface: UserDataService

Remove some groups from the user's groups list

Specified by:

removeUserGroups in interface UserDataService

Parameters:

username - the username

groups - groups to which the user no longer belongs