com.atlassian.sal.api.user
Interface UserManager

public interface UserManager

Interface providing user based operations across various apps.

Since:

2.0

Method Summary

boolean	authenticate(java.lang.String username, java.lang.String password) Given a usernamen & password, this method checks, whether or not the provided user can be authenticated
java.lang.String	getRemoteUsername() Returns the username of the currently logged in user or null if no user can be found.
java.lang.String	getRemoteUsername(javax.servlet.http.HttpServletRequest request) Returns the username of the currently logged in user or null if no user can be found.
boolean	isSystemAdmin(java.lang.String username) Returns true or false depending on if a user has been granted the system admin permission.
boolean	isUserInGroup(java.lang.String username, java.lang.String group) Returns whether the user is in the specify group
java.security.Principal	resolve(java.lang.String username) Returns the user that made this request or null if this application does not have such a user.

Method Detail

getRemoteUsername

java.lang.String getRemoteUsername()

Returns the username of the currently logged in user or null if no user can be found. If possible, please use getRemoteUsername(HttpServletRequest).

Returns:

The user name of the logged in user or null

getRemoteUsername

java.lang.String getRemoteUsername(javax.servlet.http.HttpServletRequest request)

Returns the username of the currently logged in user or null if no user can be found.

Parameters:

request - The request to retrieve the username from

Returns:

The user name of the logged in user or null

isUserInGroup

boolean isUserInGroup(java.lang.String username,
                      java.lang.String group)

Returns whether the user is in the specify group

Parameters:

username - The username to check

group - The group to check

Returns:

True if the user is in the specified group

isSystemAdmin

boolean isSystemAdmin(java.lang.String username)

Returns true or false depending on if a user has been granted the system admin permission.

Parameters:

username - The username of the user to check

Returns:

true or false depending on if a user has been granted the system admin permission.

authenticate

boolean authenticate(java.lang.String username,
                     java.lang.String password)

Given a usernamen & password, this method checks, whether or not the provided user can be authenticated

Parameters:

username - Username of the user

password - Password of the user

Returns:

True if the user can be authenticated, false otherwise

resolve

java.security.Principal resolve(java.lang.String username)
                                throws UserResolutionException

Returns the user that made this request or null if this application does not have such a user.

Parameters:

username - Username of the user a consumer is making a request on behalf of

Returns:

Principal corresponding to the username, null if the user does not exist

Throws:

UserResolutionException - thrown if there is a problem resolving the user, such as a failure when accessing an external user store