RestUserHandler (acc 11.2.5 API)

All Known Implementing Classes:

RestUserHandlerImpl
```
public interface RestUserHandler
```
Basic user handler interface to control access to various routes. N.B. new implementations may be injected through the RestServer factory.

Author:

rstein

See Also:

RestServer.setUserHandler(RestUserHandler)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`boolean`	`authenticate(java.lang.String username, java.lang.String password)`	Authenticates user against given back-end.
`java.lang.Iterable<java.lang.String>`	`getAllUserNames()`
`RestUser`	`getUserByUsername(java.lang.String username)`
`java.util.Set<io.javalin.core.security.Role>`	`getUserRolesByUsername(java.lang.String username)`
`boolean`	`setPassword(java.lang.String userName, java.lang.String oldPassword, java.lang.String newPassword)`	Sets new user password.

- Method Detail
  - authenticate
```
boolean authenticate(java.lang.String username,
                     java.lang.String password)
```
    Authenticates user against given back-end.
    
    Parameters:
    
    username - the user name
    
    password - the secret password
    
    Returns:
    
    true if successful
  - getAllUserNames
```
java.lang.Iterable<java.lang.String> getAllUserNames()
```
  - getUserByUsername
```
RestUser getUserByUsername(java.lang.String username)
```
  - getUserRolesByUsername
```
java.util.Set<io.javalin.core.security.Role> getUserRolesByUsername(java.lang.String username)
```
  - setPassword
```
boolean setPassword(java.lang.String userName,
                    java.lang.String oldPassword,
                    java.lang.String newPassword)
             throws java.lang.SecurityException
```
    Sets new user password. N.B. Implementation may be implemented or omitted based on the specific back-end.
    
    Parameters:
    
    userName - existing
    
    oldPassword - to verify
    
    newPassword - to set
    
    Returns:
    
    true if successful
    
    Throws:
    
    java.lang.SecurityException - if underlying implementation does not allow to change the password.