com.atlassian.crucible.spi.services

Interface UserService

public interface UserService

Provides an API for working with Users.

Method Summary

Modifier and Type	Method and Description
int	getActiveUserCount() Deprecated. use getLicensedUserCount()
java.util.List<UserData>	getAllUsers() Returns the list of FishEye/Crucible users.
int	getLicensedUserCount()
UserData	getMappedUser(java.lang.String repository, java.lang.String committer) Get a the UserData of the user that is mapped to a committer in a repository.
UserData	getUser(java.lang.String userName) Get a UserData object for a named user.
UserProfileData	getUserProfile(java.lang.String userName) Get a UserProfileData object for a named user.
java.util.List<UserData>	getUsers(java.util.Set<java.lang.String> usernames) Get a List object for users.

Method Detail

getAllUsers

java.util.List<UserData> getAllUsers()
                              throws ServerException

Returns the list of FishEye/Crucible users.

Returns:

a list of FishEye/Crucible users or an empty list if there are none

Throws:

NotPermittedException - if the effective principal is anonymous and anonymous access is not allowed (either via disabling global anonymous access, or by restricting user list visibility)

ServerException

getLicensedUserCount

int getLicensedUserCount()
                  throws ServerException

Returns:

licensed user count, enabled user with proper global permission set is considered as licensed.

Throws:

NotPermittedException - if the effective principal is anonymous and anonymous access is not allowed

ServerException

getActiveUserCount

@Deprecated
int getActiveUserCount()
                            throws ServerException

Deprecated. use getLicensedUserCount()

Returns:

licensed user count, enabled user with proper global permission set is considered as licensed.

Throws:

NotPermittedException - if the effective principal is anonymous and anonymous access is not allowed

ServerException

getUser

UserData getUser(java.lang.String userName)
          throws ServerException

Get a UserData object for a named user.

Throws:

NotPermittedException - if the effective principal is anonymous and anonymous access is not allowed

NotFoundException - if there is no user with username userName

ServerException

getUsers

java.util.List<UserData> getUsers(java.util.Set<java.lang.String> usernames)

Get a List object for users.

Throws:

NotPermittedException - if the effective principal is anonymous and anonymous access is not allowed

getUserProfile

UserProfileData getUserProfile(java.lang.String userName)
                        throws ServerException

Get a UserProfileData object for a named user. In case non-admin is asking for a different user than himself limited profile will be returned.

Throws:

NotPermittedException - if you are not logged in

NotFoundException - if there is no user with username userName

ServerException

getMappedUser

UserData getMappedUser(java.lang.String repository,
                       java.lang.String committer)
                throws ServerException

Get a the UserData of the user that is mapped to a committer in a repository.

Parameters:

repository - the key of the repository for the committer

committer - name of the committer

Returns:

the user data for the mapped committer

Throws:

NotPermittedException - if the effective principle does not have permission to access the repository or if the effective principal is anonymous and anonymous access is not allowed

NotFoundException - if the committer cannot be found or the mapping cannot be found.

ServerException