IMFAAuthenticationManagerSPI

All Known Subinterfaces:

IAuthenticationManagerSPI

All Known Implementing Classes:

AuthenticationManager
```
public interface IMFAAuthenticationManagerSPI
```
Interface to expose the MFA authentication actions.

Since:

16.1.0

Version:

$Revision$ $Date$

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`clearExpiredMFATokens()`	Clears expired MFATokens. Requires a valid `SessionConfig` and an active `ITransaction`.
`IMFATokenSendResult`	`sendMFATokenEmail(java.lang.String userLogin)`	Sends an email with a token to be used for authentication. Returns the created token result. Requires a valid `SessionConfig` and an active `ITransaction`.

- Method Detail
  - sendMFATokenEmail
```
IMFATokenSendResult sendMFATokenEmail(java.lang.String userLogin)
                               throws PortalException
```
    Sends an email with a token to be used for authentication.
    Returns the created token result.
    Requires a valid SessionConfig and an active ITransaction.
    
    Parameters:
    
    userLogin - the user login
    
    Returns:
    
    the created token result
    
    Throws:
    
    java.lang.NullPointerException - if userLogin is null or empty
    
    java.lang.NullPointerException - if there's no current transaction or it is not active
    
    java.lang.NullPointerException - if there's no session
    
    java.lang.IllegalStateException - if the global MFA configuration is disabled
    
    PortalException - if some error occurs
    
    Since:
    
    16.1.0
  - clearExpiredMFATokens
```
void clearExpiredMFATokens()
                    throws PortalException
```
    Clears expired MFATokens.
    Requires a valid SessionConfig and an active ITransaction.
    
    Throws:
    
    java.lang.NullPointerException - if there's no current transaction or it is not active
    
    java.lang.NullPointerException - if there's no session
    
    java.lang.IllegalStateException - if the global MFA configuration is disabled
    
    PortalException - if some error occurs
    
    Since:
    
    16.1.0