com.cs.software.api

Interface AuthenticationIntf

public interface AuthenticationIntf

AuthenticationInterface An interface for authentication. This interface is designed to abstract the actual implementation of authentication.

Author:

Steve Crombie

Method Summary

Modifier and Type	Method and Description
void	changeEmail(String aLoginId, String aNewEmail) Change the email address of a logged in user.
void	changeFromTemporaryPassword(PasswordRequestIntf aPasswordRequest) Change the user's password from a temporary password to a new (permanent) password.
void	changePassword(PasswordRequestIntf aPasswordRequest) Change the password for a logged in user.
void	createNewUser(UserIntf anUserIntf) Create a new user.
void	deleteUser(String aLoginId, String aPassword) Delete a user.
UserIntf	findUserByEmailAddr(String anEmail) Find a user by email address.
void	forgotPassword(String aLoginId) Support for resetting the user's password in the event that it was forgotten.
UserIntf	getUserInfo(String aLoginId) Get the information associated with the user.
boolean	hasUser(String aLoginId) Determine whether a user with userName exists in the login database.
void	resetPassword(PasswordRequestIntf aResetRequest) Reset a user's password using an authentication code.
void	updateUserAttributes(UserIntf anUserIntf) Update selected user attributes.
UserIntf	userLogin(String aLoginId, String aPassword) Log a user into the system
void	userLogout(String aLoginId) Log the user out.
Map<String,Object>	validateJwtToken(String token)

Method Detail

createNewUser

void createNewUser(UserIntf anUserIntf)
            throws Exception

Create a new user.

Parameters:

anUserIntf - user

Throws:

Exception - ex

deleteUser

void deleteUser(String aLoginId,
                String aPassword)
         throws Exception

Delete a user. Since deleting a user can be a "big deal" a password is required.

Parameters:

aLoginId - login

aPassword - pass

Throws:

Exception - ex

findUserByEmailAddr

UserIntf findUserByEmailAddr(String anEmail)
                      throws Exception

Find a user by email address.

Parameters:

anEmail - email

Returns:

user

Throws:

Exception - ex

updateUserAttributes

void updateUserAttributes(UserIntf anUserIntf)
                   throws Exception

Update selected user attributes.

Parameters:

anUserIntf - user

Throws:

Exception - ex

userLogin

UserIntf userLogin(String aLoginId,
                   String aPassword)
            throws Exception

Log a user into the system

Parameters:

aLoginId - login

aPassword - pass

Returns:

a LoginInfo object may include special context information.

Throws:

Exception - ex

userLogout

void userLogout(String aLoginId)
         throws Exception

Log the user out.

Parameters:

aLoginId - login

Throws:

Exception - ex

changeFromTemporaryPassword

void changeFromTemporaryPassword(PasswordRequestIntf aPasswordRequest)
                          throws Exception

Change the user's password from a temporary password to a new (permanent) password.

Parameters:

aPasswordRequest - pass

Throws:

Exception - ex

forgotPassword

void forgotPassword(String aLoginId)
             throws Exception

Support for resetting the user's password in the event that it was forgotten.

Parameters:

aLoginId - login

Throws:

Exception - ex

getUserInfo

UserIntf getUserInfo(String aLoginId)
              throws Exception

Get the information associated with the user.

Parameters:

aLoginId - the name of the user

Returns:

a UserInfo object if the information could be retrieved, null otherwise.

Throws:

Exception - ex

hasUser

boolean hasUser(String aLoginId)
         throws Exception

Determine whether a user with userName exists in the login database.

Parameters:

aLoginId - login

Returns:

true if the user exists, false otherwise.

Throws:

Exception - ex

resetPassword

void resetPassword(PasswordRequestIntf aResetRequest)
            throws Exception

Reset a user's password using an authentication code.

Parameters:

aResetRequest - reset

Throws:

Exception - ex

changePassword

void changePassword(PasswordRequestIntf aPasswordRequest)
             throws Exception

Change the password for a logged in user. Unlike the forgotten password logic, this does not require an authentication code.

Parameters:

aPasswordRequest - pass

Throws:

Exception - ex

changeEmail

void changeEmail(String aLoginId,
                 String aNewEmail)
          throws Exception

Change the email address of a logged in user.

Parameters:

aLoginId - login

aNewEmail - email

Throws:

Exception - ex

validateJwtToken

Map<String,Object> validateJwtToken(String token)
                             throws Exception

Throws:

Exception