Authenticator

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

All Known Implementing Classes:

AuthenticationAuthority, SystemAuthenticationAuthority
```
public interface Authenticator
```
Authenticator is an interface for authenticating a user given a set of user credentials.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`KEY` Constant that holds the name of the environment property for specifying the authenticating user's key, such as a password, certificate, etc..
`static java.lang.String`	`PRINCIPAL` Constant that holds the name of the environment property for specifying the authenticating user's identifier or name.
`static java.lang.String`	`TENANT` Constant that holds the name of the environment property for specifying the authenticating user's tenant DN.

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.

- Field Detail
  - PRINCIPAL
```
static final java.lang.String PRINCIPAL
```
    Constant that holds the name of the environment property for specifying the authenticating user's identifier or name.
    
    See Also:
    
    Constant Field Values
  - KEY
```
static final java.lang.String KEY
```
    Constant that holds the name of the environment property for specifying the authenticating user's key, such as a password, certificate, etc..
    
    See Also:
    
    Constant Field Values
  - TENANT
```
static final java.lang.String TENANT
```
    Constant that holds the name of the environment property for specifying the authenticating user's tenant DN.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - authenticate
```
SystemUser authenticate(Credentials userCredentials)
                 throws AuthenticationFailedException,
                        ConfigurationException
```
    Authenticates a user with the given Credentials. If the user's credentials are invalid, an AuthenticationFailureException is thrown.
    
    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.