dmv.spring.demo.model.repository

Interface CredentialsRepository

All Known Implementing Classes:

CredentialsRepositoryJDBC

public interface CredentialsRepository

This repository specifically aims operations upon User Credentials. The main purpose of this interface is to describe common Credential related operations: getting or updating user's password and email address (unique identifier).

Author:

dmv

Method Summary

Modifier and Type	Method and Description
void	changeEmail(User user, String newEmail) Change existing user's email address.
void	changePassword(User user, String newPassword) Change existing user's password with the new one.
User	getCredentials(String email) Find user by email address and return all details, including password.

Method Detail

getCredentials

User getCredentials(String email)

Find user by email address and return all details, including password. This is for authentication purposes.

Parameters:

email - User's identifier, unique email address

Returns:

User with password field

Throws:

EntityDoesNotExistException - if user can't be found

changePassword

void changePassword(User user,
                    String newPassword)

Change existing user's password with the new one. Provided User object must contain correct existing password, it will be checked first. This method returns nothing on success or throws an exception on failure.

This method won't generate new password in case if given is null or empty - the exception will be thrown instead.

Parameters:

user - User with existing password

newPassword - A new password to be set

Throws:

EntityDoesNotExistException - if user can't be found

IllegalArgumentException - if provided user does not have correct details: whether email or id or password is absent, or given password is wrong for the user. If newPassword is null or empty.

changeEmail

void changeEmail(User user,
                 String newEmail)

Change existing user's email address. New email address supposed to be unique. This method returns nothing on success or throws an exception on failure.

Parameters:

user - Existing user

newEmail - New email address

Throws:

EntityAlreadyExistsException - if given email already exists

EntityDoesNotExistException - if user can't be found

IllegalArgumentException - if provided user does not have correct details: whether email or id is absent, or the new email is null or empty