AuthenticationProvider

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

```
public interface AuthenticationProvider
```
AuthenticationProvider is an interface for authenticating a user using a specific implementation of a specific authentication mechanism. A class implementing this interface may support the SHA password authentication mechanism for example.

See Also:

Credentials

- Method Summary
  
  All Methods Instance Methods Abstract Methods
  Modifier and Type Method and Description
  
  SystemUser authenticate(Credentials userCredentials)
  Authenticates a user with the given Credentials.

- Method Detail
  - authenticate
```
SystemUser authenticate(Credentials userCredentials)
                 throws AuthenticationFailedException,
                        ConfigurationException
```
    Authenticates a user with the given Credentials. The success or failure of the authentication and the reason for failure (if any) is returned to the caller.
    
    Parameters:
    
    userCredentials - the user's credentials to be authenticated.
    
    Returns:
    
    SystemUser object representing authenticated user
    
    Throws:
    
    AuthenticationFailedException - thrown if the authentication attempt failed to invalid user credentials.
    
    ConfigurationException - thrown if the required credentials are not provided or the provided credentials are malformed.