com.ebasetech.ufs.security.authentication

Interface UserManager

public interface UserManager

Implementations of this interface supply the function of User Manager to an Ebase system.

Method Summary

Modifier and Type	Method and Description
boolean	authenticate(java.lang.String userId, java.lang.String password) Answers whether the userid/password combination is valid
void	changePassword(java.lang.String userId, java.lang.String newPassword) Change a password to the specified new value
void	completeSubject(javax.security.auth.Subject subject, java.lang.String userId) Returns a Subject object containing a number of Principal objects as follows: - UserPrincipal representing the userid - RolePrincipal for each role associated with the user
void	initialise(com.ebasetech.ufs.kernel.IUFSServletContextProxy proxy) Called at system start up to initialise any required resources
void	logout(java.lang.String userId) Called to indicate that the user is no longer connected to the system and any resources can therefore be released.
boolean	supportsChangePassword() Answers the question whether the implementation supports changing of passwords

Method Detail

authenticate

boolean authenticate(java.lang.String userId,
                     java.lang.String password)
              throws com.ebasetech.ufs.security.authentication.AuthenticationException

Answers whether the userid/password combination is valid

Throws:

AuthenticationException - if an error occurs calling the backend user registry system

completeSubject

void completeSubject(javax.security.auth.Subject subject,
                     java.lang.String userId)
              throws com.ebasetech.ufs.security.authentication.AuthenticationException

Returns a Subject object containing a number of Principal objects as follows:
- UserPrincipal representing the userid
- RolePrincipal for each role associated with the user

Throws:

AuthenticationException - if an error occurs calling the backend user registry system

logout

void logout(java.lang.String userId)

Called to indicate that the user is no longer connected to the system and any resources can therefore be released.

initialise

void initialise(com.ebasetech.ufs.kernel.IUFSServletContextProxy proxy)

Called at system start up to initialise any required resources

supportsChangePassword

boolean supportsChangePassword()

Answers the question whether the implementation supports changing of passwords

changePassword

void changePassword(java.lang.String userId,
                    java.lang.String newPassword)
             throws com.ebasetech.ufs.security.authentication.AuthenticationException

Change a password to the specified new value

Throws:

AuthenticationException - if an error occurs calling the backend user registry system