EmailAuthenticator (logicaldoc-enterprise 8.8.2 API)

java.lang.Object
- com.logicaldoc.enterprise.security.twofactorsauth.AbstractSecondFactorAuthenticator
- - com.logicaldoc.enterprise.security.twofactorsauth.EmailAuthenticator

All Implemented Interfaces:

SecondFactorAuthenticator
```
public class EmailAuthenticator
extends AbstractSecondFactorAuthenticator
```
Implements the second factor using a login key sent by email

Since:

8.7.2

Author:

Marco Meschieri - LogicalDOC

Constructor Summary

Constructors
Constructor Description

EmailAuthenticator()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`authenticate(com.logicaldoc.core.security.User user, String key)`	Authenticates the given user
`String`	`generateKey(com.logicaldoc.core.security.User user)`	A generic implementation that does do nothing.

Methods inherited from class com.logicaldoc.enterprise.security.twofactorsauth.AbstractSecondFactorAuthenticator
isEnabledForUser

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - EmailAuthenticator
```
public EmailAuthenticator()
```
- Method Detail
  - authenticate
```
public void authenticate(com.logicaldoc.core.security.User user,
                         String key)
                  throws com.logicaldoc.core.security.authentication.AuthenticationException
```
    Description copied from interface: SecondFactorAuthenticator
    
    Authenticates the given user
    
    Parameters:
    
    user - The user to check
    
    key - The key inputed by the user
    
    Throws:
    
    com.logicaldoc.core.security.authentication.AuthenticationException - the user was not authenticated
  - generateKey
```
public String generateKey(com.logicaldoc.core.security.User user)
```
    Description copied from class: AbstractSecondFactorAuthenticator
    
    A generic implementation that does do nothing. Concrete implementations should put here a call to the authentication framework to send the user a key he will have to put in the login screen
    
    Specified by:
    
    generateKey in interface SecondFactorAuthenticator
    
    Overrides:
    
    generateKey in class AbstractSecondFactorAuthenticator
    
    Parameters:
    
    user - The user that will try to authenticate
    
    Returns:
    
    the result of the key generation, it may be a transaction id