Skip navigation links

waggle.common.modules.user
Interface XUserModule.Server

All Superinterfaces:

XAPIInterface, XAPIInterface.Server

Enclosing interface:

XUserModule

public static interface XUserModule.Server

extends XAPIInterface.Server

Server interface for the User Module API.

Nested Class Summary

Nested classes/interfaces inherited from interface waggle.core.api.XAPIInterface

XAPIInterface.Client, XAPIInterface.Server

Method Summary

XUserInfo	createSystemUser(String userName, String password, String fullName, String emailAddress, boolean isActOnBehalfOf) Create a new system user.
void	createTestUsers(String prefix, int start, int count) Create count test users.
XUserInfo	createUser(String emailAddress, boolean sendInvitation) Create a new user.
void	deleteUnverifiedUser(XObjectID userID) Delete an unverified user.
List<XUserInfo>	findDisabledUsers(String searchString) Get info for the specified disabled Users.
List<XUserInfo>	findUsers(String searchString) Get info for the specified Users.
List<XUserSearchInfo>	findUsersWithLimit(String searchString, int maxUsers, boolean searchRealms) Search for a set of Users including those registered in the database realm and those who are available through one of the other defined realms.
XUserInfo	getMe() Get info for the current User.
XUserInfo	getUser(XObjectID userID) Get info for the specified User.
XUserInfo	getUserByName(String emailAddress) Get info for the specified User.
XUserDetailsInfo	getUserDetails(XObjectID userID) Get extended info for the specified User.
List<XUserPhoneNumberInfo>	getUserPhoneNumbers(XObjectID userID) Get phone numbers for the specified User.
List<XUserInfo>	getUsers(List<XObjectID> userIDs) Get info for the specified Users.
void	synchronizeUserProfile(XObjectID userID) Synchronize a user's profile from an external directory store, if available.
XUserTestCreateInfo	testCreateUser(String emailAddress) Test creating a user, validating the input data and generating inferred values.
void	unlockUser(XObjectID userID) Unlock the specified User if they are locked.
void	updateUser(XObjectID userID, XUpdater updater) Update a User.

Method Detail

getMe

XUserInfo getMe()

Get info for the current User.

Returns:

The info for the current User.

getUser

XUserInfo getUser(XObjectID userID)

Get info for the specified User.

Parameters:

userID - The User.

Returns:

The info for that User.

getUserByName

XUserInfo getUserByName(String emailAddress)

Get info for the specified User.

Parameters:

emailAddress - The User's email address.

Returns:

The info for that User or null if not found.

getUserDetails

XUserDetailsInfo getUserDetails(XObjectID userID)

Get extended info for the specified User.

Parameters:

userID - The User.

Returns:

The info for that User.

getUsers

List<XUserInfo> getUsers(List<XObjectID> userIDs)

Get info for the specified Users.

Parameters:

userIDs - The list of Users.

Returns:

The List of User infos.

getUserPhoneNumbers

List<XUserPhoneNumberInfo> getUserPhoneNumbers(XObjectID userID)

Get phone numbers for the specified User.

Parameters:

userID - The User.

Returns:

The User' phone numbers.

findUsers

List<XUserInfo> findUsers(String searchString)

Get info for the specified Users.

Only enabled, registered, Users are returned for all Realms.

Requires Admin privilege.

Parameters:

searchString - The User search String. The percent character (%) matches any number of character(s), including the absence of characters, the underscore character (_) matches a single character. A backslash character can be used to escape these wildcard characters. Note that you must use two backslashes to insert a single backslash into the string.

Returns:

The infos for the found Users.

findDisabledUsers

List<XUserInfo> findDisabledUsers(String searchString)

Get info for the specified disabled Users.

Only disabled, registered, Users are returned for all Realms.

Requires Admin privilege.

Parameters:

searchString - The User search String. The percent character (%) matches any number of character(s), including the absence of characters, the underscore character (_) matches a single character. A backslash character can be used to escape these wildcard characters. Note that you must use two backslashes to insert a single backslash into the string.

Returns:

The infos for the found Users.

findUsersWithLimit

List<XUserSearchInfo> findUsersWithLimit(String searchString,
                                         int maxUsers,
                                         boolean searchRealms)

Search for a set of Users including those registered in the database realm and those who are available through one of the other defined realms.

Parameters:

searchString - A search string used to find Users. No need to include wildcards, as the underlying implementation will return the largest set of users it reasonably can (given implementation-dependent constraints, such as which fields are indexed for efficient searching).

maxUsers - The maximum number of users to return.

searchRealms - True to search Realms. False to just search database. If false only registered, enabled, Users are returned for all Realms. If true any matching external Realm (LDAP) Users are also returned.

Returns:

The located set of User infos.

updateUser

void updateUser(XObjectID userID,
                XUpdater updater)

Update a User.

Parameters:

userID - The User.

updater - The Attributes.

See Also:

XUserUpdater

testCreateUser

XUserTestCreateInfo testCreateUser(String emailAddress)

Test creating a user, validating the input data and generating inferred values.

Parameters:

emailAddress - The User's email address.

Returns:

Info about the new User.

createUser

XUserInfo createUser(String emailAddress,
                     boolean sendInvitation)

Create a new user.

Parameters:

emailAddress - The User's email address.

sendInvitation - Send an invitation. If true is specified an invitation will be sent now. If false is specified an invitation will not be sent until the User is added to a Conversation's membership.

Returns:

XUserInfo Info about the new User.

createSystemUser

XUserInfo createSystemUser(String userName,
                           String password,
                           String fullName,
                           String emailAddress,
                           boolean isActOnBehalfOf)

Create a new system user. The user will be created in the internal realm and will not require validation. No invitation/signup email will be sent.

Unlike regular non-system-users, the userName should not be an email address. Instead, it should be a short login name (such as "Admin" or "MyApp System").

The emailAddress is optional and can be set so that the system user will receive its notifications.

Parameters:

userName - the user name

password - the user's password

fullName - the user's full display name

emailAddress - optional email address for the user

isActOnBehalfOf - set to true if the user should have act-on-behalf-of privileges; false otherwise

Returns:

XUserInfo Info about the new user

deleteUnverifiedUser

void deleteUnverifiedUser(XObjectID userID)

Delete an unverified user. The caller must be an admin, cannot be a self-edit, not yet Enabled, and has an outstanding (non-null) Verify ID.

Parameters:

userID - The ID of the User to delete.

synchronizeUserProfile

void synchronizeUserProfile(XObjectID userID)

Synchronize a user's profile from an external directory store, if available. The caller must either be an admin or the user corresponding to userID. If the user corresponding to userID is in the internal realm, or in a realm that does not support retrieval of attributes, then no work is performed.

Parameters:

userID - The ID of the User whose profile data will be synchronized with the external realm.

createTestUsers

void createTestUsers(String prefix,
                     int start,
                     int count)

Create count test users. The user names will consist of prefix concatenated with a numeric index starting with start. If a user already exists, no action will be taken. Newly created users will have their password set to their user name.

Parameters:

prefix - test user name prefix

start - index of first test user name

count - number of test users to create

unlockUser

void unlockUser(XObjectID userID)

Unlock the specified User if they are locked. The caller must be an admin.

Parameters:

userID - The User.

Skip navigation links