org.assistments.service.manager.core

Interface UserManager

All Known Implementing Classes:

UserManagerImpl

public interface UserManager

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	UserManager.AuthType
static class	UserManager.UpdateField
static class	UserManager.UserJoinStatus Specifies the state of a user based on their login name

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	HIDE_PASSWORD
static java.lang.String	INVALID_CREDENTIALS_MSG

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)

Field Detail

HIDE_PASSWORD

static final java.lang.String HIDE_PASSWORD

See Also:

Constant Field Values

INVALID_CREDENTIALS_MSG

static final java.lang.String INVALID_CREDENTIALS_MSG

See Also:

Constant Field Values

Method Detail

reserveLoginName

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

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.

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.

joinApplication

User joinApplication()
              throws NotFoundException,
                     AuthenticationException

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

Returns:

Throws:

NotFoundException

AuthenticationException

leaveApplication

User leaveApplication()
               throws NotFoundException,
                      AuthenticationException

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

Returns:

Throws:

NotFoundException

AuthenticationException

joinApplication

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

Connects a user with the running partner application or service.

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

InvalidPartnerException

leaveApplication

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

Throws:

NotFoundException

AuthenticationException

AlreadyExistsException

java.lang.IllegalArgumentException

joinApplication

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

Connects a user with the specified partner application or service.

Note: For use only by Service Administrators.

Parameters:

appRef - Partner reference

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

InvalidPartnerException

leaveApplication

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

Throws:

NotFoundException

AuthenticationException

AlreadyExistsException

java.lang.IllegalArgumentException

persist

User persist(UserBuilder ub)
      throws AlreadyExistsException,
             NotFoundException

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

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

InvalidPartnerException

NotFoundException

persist

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

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

Parameters:

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

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

Returns:

user updated with the new user's xinfo

Throws:

AlreadyExistsException

InvalidPartnerException

NotFoundException

authenticate

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

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

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

InvalidPartnerException

getUser

User getUser(XInfo xinfo)
      throws NotFoundException

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

Parameters:

xinfo - External reference information

Returns:

The User object

Throws:

NotFoundException

InvalidPartnerException

getUser

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

Returns the User associated with an access token.

Parameters:

accessToken - Access token

Returns:

The User object

Throws:

NotFoundException - If the access token does not exist.

findByLogin

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

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

Parameters:

loginName - The user's login name

Throws:

NotFoundException - No user is found with that login name.

findByLogin

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

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

Note: For use only by Service Administrators.

Parameters:

partnerRef - Partner reference

loginName - The user's login name

Throws:

NotFoundException - No user is found with that login name.

InvalidPartnerException

findJoinedApplications

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

Returns the list of partner references a user has joined.

Parameters:

loginName - User's login name

Returns:

List of partner references the user belongs to.

Throws:

NotFoundException

getJoinedStatus

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

Parameters:

loginName - User's login name

Returns:

A UserJoinStatus and, if the user exists

getJoinedStatus

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

update

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

Throws:

ForbiddenException

NotFoundException

changePassword

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

Throws:

NotFoundException

logout

void logout()