com.atlassian.crowd.plugin.rest.admin.controller
Class UsersController

java.lang.Object
  com.atlassian.crowd.plugin.rest.admin.controller.UsersController

public class UsersController
extends Object

Field Summary

protected org.apache.log4j.Logger

logger

Constructor Summary

UsersController()

Method Summary

void	addUser(Directory directory, RestUser user) Adds a user to the directory in question, if the directory permissions allow.
void	deleteUser(Directory directory, String userName) Removes a user from the directory, if the directory permissions allow.
RestUser	getUser(Directory directory, String userName) Returns the user with the specified username
RestUsers	getUsers(Directory directory, String searchTerm) Returns a list of users in the directory that match the search term.
void	setDirectoryManager(DirectoryManager directoryManager)
void	updateUser(Directory directory, RestUser user) Updates a user, based on their identifier, if directory permissions allow.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.apache.log4j.Logger logger

Constructor Detail

UsersController

public UsersController()

Method Detail

getUsers

public RestUsers getUsers(Directory directory,
                          String searchTerm)

Returns a list of users in the directory that match the search term. Searches across username, first name, last name, and email address and returns a list of users that match any of these terms. This search can be quite slow if the underlying directory is particularly large or slow; not recommended for extremely performance-sensitive applications.

Parameters:

directory -

Returns:

getUser

public RestUser getUser(Directory directory,
                        String userName)

Returns the user with the specified username

Parameters:

userName -

Returns:

addUser

public void addUser(Directory directory,
                    RestUser user)

Adds a user to the directory in question, if the directory permissions allow.

Parameters:

directory -

user -

deleteUser

public void deleteUser(Directory directory,
                       String userName)

Removes a user from the directory, if the directory permissions allow.

Parameters:

directory -

user -

updateUser

public void updateUser(Directory directory,
                       RestUser user)

Updates a user, based on their identifier, if directory permissions allow.

Parameters:

directory -

user -

setDirectoryManager

public void setDirectoryManager(DirectoryManager directoryManager)