UserRepository

All Known Implementing Classes:

UserRepositoryJDBC
```
public interface UserRepository
```
CRUD operations for User entity. For all methods where receiving the User object as a parameter user id field is mandatory, otherwise that user can't be serviced.

Author:

dmv

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`EMAIL_MIN` Logically, correct email address can't contain less than 5 characters.
`static int`	`LONG_MAX` Maximal long field (like `last name`) length - 70 characters
`static int`	`NOT_EMPTY` Minimal string length is just not empty - 1 character
`static int`	`SHORT_MAX` Maximal short field (like `middle name`) length - 45 characters

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`User`	`create(User user)` Store new user on persistence layer.
`void`	`delete(User user)` Delete existing user (found by id) from persistence layer
`void`	`deleteById(Long id)` Delete existing user (found by id) from persistence layer
`User`	`findByEmail(String email)` Find user by e-mail address.
`User`	`findById(Long id)` Find user by its unique identifier.
`User`	`update(User user)` Update existing user (found by id) with given user details (password and email fields are omitted, these are different operations).

- Field Detail
  - EMAIL_MIN
```
static final int EMAIL_MIN
```
    Logically, correct email address can't contain less than 5 characters.
    
    See Also:
    
    Constant Field Values
  - NOT_EMPTY
```
static final int NOT_EMPTY
```
    Minimal string length is just not empty - 1 character
    
    See Also:
    
    Constant Field Values
  - LONG_MAX
```
static final int LONG_MAX
```
    Maximal long field (like last name) length - 70 characters
    
    See Also:
    
    Constant Field Values
  - SHORT_MAX
```
static final int SHORT_MAX
```
    Maximal short field (like middle name) length - 45 characters
    
    See Also:
    
    Constant Field Values
- Method Detail
  - findById
```
User findById(Long id)
```
    Find user by its unique identifier. Will return existing user or throw an exception.
    
    Parameters:
    
    id - User's id
    
    Returns:
    
    User with given id
    
    Throws:
    
    IllegalArgumentException - if argument is null
    
    EntityDoesNotExistException - if user with the id can't be found
    
    AccessDataBaseException - if operation was unsuccessful due to internal error
  - findByEmail
```
User findByEmail(String email)
```
    Find user by e-mail address. Will return existing user or throw an exception.
    
    Parameters:
    
    email - email address
    
    Returns:
    
    User with given address
    
    Throws:
    
    IllegalArgumentException - if argument is null or empty
    
    EntityDoesNotExistException - if user with the email can't be found
    
    AccessDataBaseException - if operation was unsuccessful due to internal error
  - create
```
User create(User user)
```
    Store new user on persistence layer. Id will be generated and returned.
    User constraints: fields 'email', 'first name' and 'last name' must be provided; 'email' must be unique. If password was not given it will be generated and returned with the created object, otherwise password field will be null (for safety reasons).
    For user's roles the 'shortName' parameter is needed. If it is absent or the role with given name does not exist in database the IllegalArgumentException will be thrown.
    
    Parameters:
    
    user - A new user to persist
    
    Returns:
    
    persisted user on success
    
    Throws:
    
    IllegalArgumentException - if user or its id is null or user has incomplete or wrong information
    
    EntityAlreadyExistsException - if user with the same email already exists
    
    AccessDataBaseException - if operation was unsuccessful due to internal error
  - update
```
User update(User user)
```
    Update existing user (found by id) with given user details (password and email fields are omitted, these are different operations).
    For user's roles the 'shortName' parameter is needed. If it is absent or the role with given name does not exist in database the IllegalArgumentException will be thrown.
    
    Parameters:
    
    user - An existing user with new details
    
    Returns:
    
    Update user (without a password)
    
    Throws:
    
    IllegalArgumentException - if user or its id is null or user has incomplete or wrong information
    
    EntityDoesNotExistException - if user can't be found
    
    AccessDataBaseException - if operation was unsuccessful due to internal error
  - delete
```
void delete(User user)
```
    Delete existing user (found by id) from persistence layer
    
    Parameters:
    
    user - A user to be removed
    
    Throws:
    
    IllegalArgumentException - if user or its id is null
    
    EntityDoesNotExistException - if user can't be found
    
    AccessDataBaseException - if operation was unsuccessful due to internal error
  - deleteById
```
void deleteById(Long id)
```
    Delete existing user (found by id) from persistence layer
    
    Parameters:
    
    id - An id of user that needs to be removed
    
    Throws:
    
    IllegalArgumentException - if id is null
    
    EntityDoesNotExistException - if user can't be found
    
    AccessDataBaseException - if operation was unsuccessful due to internal error

Interface UserRepository

Field Summary

Method Summary

Field Detail

EMAIL_MIN

NOT_EMPTY

LONG_MAX

SHORT_MAX

Method Detail

findById

findByEmail

create

update

delete

deleteById