com.atlassian.crowd.service

Class AbstractUserService

java.lang.Object

com.atlassian.crowd.service.AbstractUserService

All Implemented Interfaces:

UserService

Direct Known Subclasses:

UserServiceImpl

public abstract class AbstractUserService
extends Object
implements UserService

Field Summary

Fields

Modifier and Type	Field and Description
protected ApplicationService	applicationService
protected AuthenticatedUserProvider	authenticatedUserProvider
protected InternalApplicationHelper	internalApplicationHelper
protected TokenAuthenticationManager	tokenAuthenticationManager
protected UserPermissionService	userPermissionService

Constructor Summary

Constructors

Constructor and Description
AbstractUserService(InternalApplicationHelper internalApplicationHelper, ApplicationService applicationService, TokenAuthenticationManager tokenAuthenticationManager, UserPermissionService userPermissionService, AuthenticatedUserProvider authenticatedUserProvider)

Method Summary

Modifier and Type	Method and Description
boolean	authenticate(String username, String password) Given a username and password, this method checks, whether or not the provided user can be authenticated
String	getAuthenticatedUsername(javax.servlet.http.HttpServletRequest request) Returns the username of the currently logged in user or null if no user can be found.
boolean	isAdmin(String username) Returns true or false depending on if a user has been granted the admin or sysAdmin permission within Crowd.
boolean	isSystemAdmin(String username) Returns true or false depending on if a user has been granted the sysAdmin permission within Crowd.
boolean	isUserInGroup(String username, String group) Returns whether the user is in the specify group
abstract Principal	resolve(String username) Returns the user that made this request or null if this application does not have such a user.
abstract boolean	setAuthenticatedUser(String username) Authenticate the current user by setting an appropriate authentication token in Spring Security's SecurityContext.

Methods inherited from class java.lang.Object

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

Field Detail

internalApplicationHelper

protected final InternalApplicationHelper internalApplicationHelper

applicationService

protected final ApplicationService applicationService

tokenAuthenticationManager

protected final TokenAuthenticationManager tokenAuthenticationManager

userPermissionService

protected final UserPermissionService userPermissionService

authenticatedUserProvider

protected final AuthenticatedUserProvider authenticatedUserProvider

Constructor Detail

AbstractUserService

public AbstractUserService(InternalApplicationHelper internalApplicationHelper,
                           ApplicationService applicationService,
                           TokenAuthenticationManager tokenAuthenticationManager,
                           UserPermissionService userPermissionService,
                           AuthenticatedUserProvider authenticatedUserProvider)

Method Detail

getAuthenticatedUsername

@Nullable
public String getAuthenticatedUsername(javax.servlet.http.HttpServletRequest request)

Description copied from interface: UserService

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

Specified by:

getAuthenticatedUsername in interface UserService

Parameters:

request - The request to retrieve the username from

Returns:

The user name of the logged in user or null

isUserInGroup

public boolean isUserInGroup(String username,
                             String group)

Description copied from interface: UserService

Returns whether the user is in the specify group

Specified by:

isUserInGroup in interface UserService

Parameters:

username - The username to check

group - The group to check

Returns:

True if the user is in the specified group

isSystemAdmin

public boolean isSystemAdmin(String username)

Description copied from interface: UserService

Returns true or false depending on if a user has been granted the sysAdmin permission within Crowd.

Specified by:

isSystemAdmin in interface UserService

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.

isAdmin

public boolean isAdmin(String username)

Description copied from interface: UserService

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

Specified by:

isAdmin in interface UserService

Parameters:

username - The username of the user to check

Returns:

true if the user has been granted either the admin or sysAdmin permission, false otherwise.

authenticate

public boolean authenticate(String username,
                            String password)

Description copied from interface: UserService

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

Specified by:

authenticate in interface UserService

Parameters:

username - Username of the user

password - Password of the user

Returns:

True if the user can be authenticated, false otherwise

resolve

public abstract Principal resolve(String username)

Description copied from interface: UserService

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

Specified by:

resolve in interface UserService

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

setAuthenticatedUser

public abstract boolean setAuthenticatedUser(String username)

Description copied from interface: UserService

Authenticate the current user by setting an appropriate authentication token in Spring Security's SecurityContext. This method should only be called if the user has been authenticated via some other mean (e.g OAuth or Trusted Apps).

Specified by:

setAuthenticatedUser in interface UserService

Parameters:

username - the username of the user to authenticate

Returns:

true if the username was correctly resolved and authenticated, false otherwise