com.atlassian.crowd.integration.service
Interface UserManager

All Known Implementing Classes:

CachingUserManager

public interface UserManager

Methods related to operations on users, but not on their group or role memberships.

Method Summary

SOAPPrincipal	addUser(SOAPPrincipal user, PasswordCredential credential) Adds a user to Crowd.
java.util.List	getAllUserNames() Deprecated. Since 1.4.
SOAPPrincipal	getUser(java.lang.String userName) Given a userName, fetches the user's details, either from cache or from the Crowd server.
SOAPPrincipal	getUserFromToken(java.lang.String token) Given an authentication token, retrieves the user associated with it.
boolean	isUser(java.lang.String userName) Returns true if userName represents a valid user.
void	removeUser(java.lang.String userName) Removes a user from Crowd.
java.util.List	searchUsers(SearchRestriction[] restrictions) Searches the list of all available users based on the passed-in restrictions and returns a list of users that match.
void	updatePassword(java.lang.String userName, PasswordCredential credential) Changes the password for the user specified by userName.
void	updateUser(SOAPPrincipal user) Updates a user's details in Crowd.

Method Detail

isUser

boolean isUser(java.lang.String userName)
               throws java.rmi.RemoteException,
                      InvalidAuthorizationTokenException

Returns true if userName represents a valid user. Will return true if the user is valid but inactive.

Parameters:

userName -

Returns:

true if the user is valid, false otherwise.

Throws:

java.rmi.RemoteException - A communication error occurred - the Crowd server may not be available.

InvalidAuthorizationTokenException - The application (not the user) was not authenticated correctly.

getUser

SOAPPrincipal getUser(java.lang.String userName)
                      throws java.rmi.RemoteException,
                             InvalidAuthorizationTokenException,
                             ObjectNotFoundException

Given a userName, fetches the user's details, either from cache or from the Crowd server.

Parameters:

userName - The user's identifer

Returns:

An object representing the user

Throws:

java.rmi.RemoteException - A communication error occurred - the Crowd server may not be available.

InvalidAuthorizationTokenException - The application (not the user) was not authenticated correctly.

ObjectNotFoundException - Could not find the user.

getUserFromToken

SOAPPrincipal getUserFromToken(java.lang.String token)
                               throws java.rmi.RemoteException,
                                      InvalidAuthorizationTokenException,
                                      InvalidTokenException,
                                      ObjectNotFoundException

Given an authentication token, retrieves the user associated with it.

Parameters:

token - The token presented by the client browser to the webserver.

Returns:

An object representing the user

Throws:

java.rmi.RemoteException - A communication error occurred - the Crowd server may not be available.

InvalidAuthorizationTokenException - The application (not the user) was not authenticated correctly.

InvalidTokenException - The token presented was not a valid Crowd token.

ObjectNotFoundException - Could not find the user.

searchUsers

java.util.List searchUsers(SearchRestriction[] restrictions)
                           throws java.rmi.RemoteException,
                                  InvalidAuthorizationTokenException

Searches the list of all available users based on the passed-in restrictions and returns a list of users that match.

Parameters:

restrictions -

Returns:

A List of SOAPPrincipals that match the criteria.

Throws:

java.rmi.RemoteException - A communication error occurred - the Crowd server may not be available.

InvalidAuthorizationTokenException - The application (not the user) was not authenticated correctly.

addUser

SOAPPrincipal addUser(SOAPPrincipal user,
                      PasswordCredential credential)
                      throws java.rmi.RemoteException,
                             ApplicationPermissionException,
                             InvalidCredentialException,
                             InvalidUserException,
                             InvalidAuthorizationTokenException

Adds a user to Crowd.

Parameters:

user - The user to add to Crowd

credential - The credential (eg. password) for the user. May be null.

Returns:

The SOAPPrincipal, as returned by the Crowd server.

Throws:

java.rmi.RemoteException - A communication error occurred - the Crowd server may not be available.

InvalidAuthorizationTokenException - The application (not the user) was not authenticated correctly.

ApplicationPermissionException - The application, not the user, does not have rights to add users.

InvalidUserException - The user was malformed or already exists.

InvalidCredentialException - The credentials were malformed or did not meet directory complexity requirements.

updateUser

void updateUser(SOAPPrincipal user)
                throws java.rmi.RemoteException,
                       ObjectNotFoundException,
                       ApplicationPermissionException,
                       InvalidAuthorizationTokenException

Updates a user's details in Crowd.

Parameters:

user - The user to update

Throws:

java.rmi.RemoteException - A communication error occurred - the Crowd server may not be available.

InvalidAuthorizationTokenException - The application (not the user) was not authenticated correctly.

ObjectNotFoundException - The user to update could not be found.

ApplicationPermissionException - This application does not have the rights to update the user. Sorry.

updatePassword

void updatePassword(java.lang.String userName,
                    PasswordCredential credential)
                    throws java.rmi.RemoteException,
                           InvalidAuthorizationTokenException,
                           InvalidCredentialException,
                           ObjectNotFoundException,
                           ApplicationPermissionException

Changes the password for the user specified by userName.

Parameters:

userName - The identifier of the user

credential - The new credentials for the user.

Throws:

java.rmi.RemoteException - A communication error occurred - the Crowd server may not be available.

InvalidAuthorizationTokenException - The application (not the user) was not authenticated correctly.

InvalidCredentialException - The credentials were malformed or did not meet directory complexity requirements.

ObjectNotFoundException - The user could not be found in any directory mapped to this application.

ApplicationPermissionException - This application does not have the rights to update the user's password. Sorry.

removeUser

void removeUser(java.lang.String userName)
                throws java.rmi.RemoteException,
                       InvalidAuthorizationTokenException,
                       ObjectNotFoundException,
                       ApplicationPermissionException

Removes a user from Crowd.

Parameters:

userName - The name of the user to remove.

Throws:

java.rmi.RemoteException - A communication error occurred - the Crowd server may not be available.

InvalidAuthorizationTokenException - The application (not the user) was not authenticated correctly.

ObjectNotFoundException - The user to remove could not be found.

ApplicationPermissionException - This application is not allowed to remove this user.

getAllUserNames

java.util.List getAllUserNames()
                               throws java.rmi.RemoteException,
                                      InvalidAuthorizationTokenException

Deprecated. Since 1.4.

Returns a list of all available users. We strongly recommend against use of this API; it will prevent your application from scaling. If you're implementing a user-picker or similar, use searchUsers() instead. Presenting a drop-down list of 10m users simply won't work.

Returns:

A List of Strings that list all the users visible to this application.

Throws:

java.rmi.RemoteException - A communication error occurred - the Crowd server may not be available.

InvalidAuthorizationTokenException - The application (not the user) was not authenticated correctly.