|
Oracle® On Track Communication SDK Documentation Release 1(1.0) E20955-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public static interface XUserModule.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 |
---|
XUserInfo getMe()
XUserInfo getUser(XObjectID userID)
userID
- The User.XUserInfo getUserByName(String emailAddress)
emailAddress
- The User's email address.XUserDetailsInfo getUserDetails(XObjectID userID)
userID
- The User.List<XUserInfo> getUsers(List<XObjectID> userIDs)
userIDs
- The list of Users.List<XUserPhoneNumberInfo> getUserPhoneNumbers(XObjectID userID)
userID
- The User.List<XUserInfo> findUsers(String searchString)
Only enabled, registered, Users are returned for all Realms.
Requires Admin privilege.
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.List<XUserInfo> findDisabledUsers(String searchString)
Only disabled, registered, Users are returned for all Realms.
Requires Admin privilege.
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.List<XUserSearchInfo> findUsersWithLimit(String searchString, int maxUsers, boolean searchRealms)
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.void updateUser(XObjectID userID, XUpdater updater)
userID
- The User.updater
- The Attributes.XUserUpdater
XUserTestCreateInfo testCreateUser(String emailAddress)
emailAddress
- The User's email address.XUserInfo createUser(String emailAddress, boolean sendInvitation)
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.XUserInfo createSystemUser(String userName, String password, String fullName, String emailAddress, boolean isActOnBehalfOf)
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.
userName
- the user namepassword
- the user's passwordfullName
- the user's full display nameemailAddress
- optional email address for the userisActOnBehalfOf
- set to true if the user should have act-on-behalf-of privileges; false otherwisevoid deleteUnverifiedUser(XObjectID userID)
userID
- The ID of the User to delete.void synchronizeUserProfile(XObjectID userID)
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.userID
- The ID of the User whose profile data will be synchronized with the external realm.void createTestUsers(String prefix, int start, int count)
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.prefix
- test user name prefixstart
- index of first test user namecount
- number of test users to createvoid unlockUser(XObjectID userID)
userID
- The User.
|
Oracle® On Track Communication SDK Documentation Release 1(1.0) E20955-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |