org.assistments.service.manager.core.impl

Class UserManagerImpl

java.lang.Object

org.assistments.service.manager.content.impl.ManagerHelperImpl<User>

org.assistments.service.manager.core.impl.UserManagerImpl

All Implemented Interfaces:

ManagerHelper<User>, UserManager

@Component
public class UserManagerImpl
extends ManagerHelperImpl<User>
implements UserManager

Nested Class Summary

Nested classes/interfaces inherited from interface org.assistments.service.manager.core.UserManager

UserManager.AuthType, UserManager.UpdateField, UserManager.UserJoinStatus

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	classType

Fields inherited from interface org.assistments.service.manager.core.UserManager

HIDE_PASSWORD, INVALID_CREDENTIALS_MSG

Constructor Summary

Constructors

Constructor and Description
UserManagerImpl()

Method Summary

Modifier and Type	Method and Description
AuthenticationData	authenticate(java.lang.String loginName, java.lang.String password, boolean rememberMe) Authenticates the provided credentials in the context of the current partner reference
void	changePassword(XInfo xinfo, java.lang.String newPassword)
User	findByLogin(java.lang.String loginName) Returns the User with the provided login name in the context of the current partner reference.
User	findByLogin(java.lang.String partnerRef, java.lang.String loginName) Returns the User with the provided login name in the context of a partner reference.
java.util.List<java.lang.String>	findJoinedApplications(java.lang.String loginName) Returns the list of partner references a user has joined.
Pair<UserManager.UserJoinStatus,User>	getJoinedStatus(java.lang.String loginName) Returns whether a user exists and if so whether the user belongs to the current partner reference
Pair<UserManager.UserJoinStatus,User>	getJoinedStatus(java.lang.String partnerRef, java.lang.String loginName)
User	getUser(java.lang.String accessToken) Returns the User associated with an access token.
User	getUser(XInfo xinfo) Returns the User represented by the specified external reference information in the context of the current partner reference.
User	joinApplication() Connects the currently authenticated user with the running partner application or service.
User	joinApplication(java.lang.String loginName, java.lang.String password) Connects a user with the running partner application or service.
User	joinApplication(java.lang.String partnerRef, java.lang.String loginName, java.lang.String password) Connects a user with the specified partner application or service.
User	leaveApplication() Disconnects the currently authenticated user with the running partner application or service.
User	leaveApplication(java.lang.String loginName, java.lang.String password)
User	leaveApplication(java.lang.String partnerRef, java.lang.String loginName, java.lang.String password)
void	logout()
User	persist(UserBuilder ub) Persists a User object, creating an external reference linking the user to the current partner reference.
User	persist(UserBuilder ub, java.util.UUID reservation) Persists a User object, creating an external reference linking the user to the current partner reference.
java.util.UUID	reserveLoginName(java.lang.String loginName) Returns whether a login name is already in use.
void	update(XInfo xInfo, java.util.List<Pair<UserManager.UpdateField,java.lang.Object>> values)

Methods inherited from class org.assistments.service.manager.content.impl.ManagerHelperImpl

createExternalReferenceFor

Methods inherited from class java.lang.Object

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

Field Detail

classType

public static final java.lang.String classType

Constructor Detail

UserManagerImpl

public UserManagerImpl()

Method Detail

reserveLoginName

public java.util.UUID reserveLoginName(java.lang.String loginName)
                                throws AlreadyExistsException

Description copied from interface: UserManager

Returns whether a login name is already in use. Login names are case insensitive.

If the name is available, reserves the name for ReservedNameList.RESERVE_SECONDS_DEFAULT seconds.

Specified by:

reserveLoginName in interface UserManager

Parameters:

loginName - Login name to check.

Returns:

If loginName is available, returns a reservation in the form of a UUID; otherwise returns null.

Throws:

AlreadyExistsException - loginName is already in use or reserved.

authenticate

public AuthenticationData authenticate(java.lang.String loginName,
                                       java.lang.String password,
                                       boolean rememberMe)
                                throws AuthenticationException,
                                       java.lang.IllegalArgumentException,
                                       NotFoundException

Description copied from interface: UserManager

Authenticates the provided credentials in the context of the current partner reference

Specified by:

authenticate in interface UserManager

Parameters:

loginName - User's login name

password - User's password

rememberMe - true when applicable, create a cookie for this user; otherwise false

Returns:

The authentication data for this user, partner reference pair

Throws:

AuthenticationException

java.lang.IllegalArgumentException

NotFoundException

getJoinedStatus

public Pair<UserManager.UserJoinStatus,User> getJoinedStatus(java.lang.String loginName)

Description copied from interface: UserManager

Returns whether a user exists and if so whether the user belongs to the current partner reference

Specified by:

getJoinedStatus in interface UserManager

Parameters:

loginName - User's login name

Returns:

A UserJoinStatus and, if the user exists

getJoinedStatus

public Pair<UserManager.UserJoinStatus,User> getJoinedStatus(java.lang.String partnerRef,
                                                             java.lang.String loginName)

Specified by:

getJoinedStatus in interface UserManager

joinApplication

public User joinApplication()
                     throws NotFoundException,
                            AuthenticationException

Description copied from interface: UserManager

Connects the currently authenticated user with the running partner application or service.

Specified by:

joinApplication in interface UserManager

Returns:

Throws:

NotFoundException

AuthenticationException

leaveApplication

public User leaveApplication()
                      throws NotFoundException,
                             AuthenticationException

Description copied from interface: UserManager

Disconnects the currently authenticated user with the running partner application or service.

Specified by:

leaveApplication in interface UserManager

Returns:

Throws:

NotFoundException

AuthenticationException

joinApplication

public User joinApplication(java.lang.String loginName,
                            java.lang.String password)
                     throws NotFoundException,
                            AuthenticationException,
                            AlreadyExistsException,
                            java.lang.IllegalArgumentException

Description copied from interface: UserManager

Connects a user with the running partner application or service.

Specified by:

joinApplication in interface UserManager

Parameters:

loginName - User's login name

password - User's password

Returns:

A User object containing the xinfo for the current User, Partner pair

Throws:

NotFoundException

AuthenticationException

AlreadyExistsException

java.lang.IllegalArgumentException

leaveApplication

public User leaveApplication(java.lang.String loginName,
                             java.lang.String password)
                      throws NotFoundException,
                             AuthenticationException,
                             AlreadyExistsException,
                             java.lang.IllegalArgumentException

Specified by:

leaveApplication in interface UserManager

Throws:

NotFoundException

AuthenticationException

AlreadyExistsException

java.lang.IllegalArgumentException

joinApplication

public User joinApplication(java.lang.String partnerRef,
                            java.lang.String loginName,
                            java.lang.String password)
                     throws NotFoundException,
                            AuthenticationException,
                            AlreadyExistsException,
                            java.lang.IllegalArgumentException

Description copied from interface: UserManager

Connects a user with the specified partner application or service.

Note: For use only by Service Administrators.

Specified by:

joinApplication in interface UserManager

loginName - User's login name

password - User's password

Returns:

A User object containing the xinfo for the current User, Partner pair

Throws:

NotFoundException

AuthenticationException

AlreadyExistsException

java.lang.IllegalArgumentException

leaveApplication

public User leaveApplication(java.lang.String partnerRef,
                             java.lang.String loginName,
                             java.lang.String password)
                      throws NotFoundException,
                             AuthenticationException,
                             AlreadyExistsException,
                             java.lang.IllegalArgumentException

Specified by:

leaveApplication in interface UserManager

Throws:

NotFoundException

AuthenticationException

AlreadyExistsException

java.lang.IllegalArgumentException

persist

public User persist(UserBuilder ub)
             throws AlreadyExistsException,
                    NotFoundException

Description copied from interface: UserManager

Persists a User object, creating an external reference linking the user to the current partner reference.

Specified by:

persist in interface UserManager

Parameters:

ub - Contains the data necessary for creating a new user.

The minimal data necessary:

• login name
• user type: Principal or Proxy
• user is active (enabled)

Returns:

user updated with the new user's xinfo

Throws:

AlreadyExistsException

NotFoundException

persist

public User persist(UserBuilder ub,
                    java.util.UUID reservation)
             throws AlreadyExistsException,
                    NotFoundException

Description copied from interface: UserManager

Persists a User object, creating an external reference linking the user to the current partner reference.

Specified by:

persist in interface UserManager

Parameters:

ub - Contains the data necessary for creating a new user. See UserManager.persist(UserBuilder).

reservation - A reservation for a login name returned from UserManager.reserveLoginName(String).

Returns:

user updated with the new user's xinfo

Throws:

AlreadyExistsException

NotFoundException

getUser

public User getUser(XInfo xinfo)
             throws NotFoundException

Description copied from interface: UserManager

Returns the User represented by the specified external reference information in the context of the current partner reference.

Specified by:

getUser in interface UserManager

Parameters:

xinfo - External reference information

Returns:

The User object

Throws:

NotFoundException

getUser

public User getUser(java.lang.String accessToken)
             throws NotFoundException

Description copied from interface: UserManager

Returns the User associated with an access token.

Specified by:

getUser in interface UserManager

Parameters:

accessToken - Access token

Returns:

The User object

Throws:

NotFoundException - If the access token does not exist.

findByLogin

public User findByLogin(java.lang.String loginName)
                 throws NotFoundException

Description copied from interface: UserManager

Returns the User with the provided login name in the context of the current partner reference.

Specified by:

findByLogin in interface UserManager

Parameters:

loginName - The user's login name

Throws:

NotFoundException - No user is found with that login name.

findByLogin

public User findByLogin(java.lang.String partnerRef,
                        java.lang.String loginName)
                 throws NotFoundException

Description copied from interface: UserManager

Returns the User with the provided login name in the context of a partner reference.

Note: For use only by Service Administrators.

Specified by:

findByLogin in interface UserManager

Parameters:

partnerRef - Partner reference

loginName - The user's login name

Throws:

NotFoundException - No user is found with that login name.

findJoinedApplications

public java.util.List<java.lang.String> findJoinedApplications(java.lang.String loginName)
                                                        throws NotFoundException

Description copied from interface: UserManager

Returns the list of partner references a user has joined.

Specified by:

findJoinedApplications in interface UserManager

Parameters:

loginName - User's login name

Returns:

List of partner references the user belongs to.

Throws:

NotFoundException

update

public void update(XInfo xInfo,
                   java.util.List<Pair<UserManager.UpdateField,java.lang.Object>> values)
            throws ForbiddenException,
                   NotFoundException

Specified by:

update in interface UserManager

Throws:

ForbiddenException

NotFoundException

changePassword

public void changePassword(XInfo xinfo,
                           java.lang.String newPassword)
                    throws NotFoundException

Specified by:

changePassword in interface UserManager

Throws:

NotFoundException

logout

public void logout()

Specified by:

logout in interface UserManager