ESET Secure Authentication SDK documentation
 All Classes Functions Variables
Public Member Functions | List of all members
com.eset.secureauthentication.sdk.TwoFactorAuthenticator Class Reference
Inheritance diagram for com.eset.secureauthentication.sdk.TwoFactorAuthenticator:
com.eset.secureauthentication.sdk.ITwoFactorAuthenticator

Public Member Functions

 TwoFactorAuthenticator (TwoFactorConfiguration configuration) throws InternalTwoFactorException
 
TwoFactorUser getUser (String username) throws UserNotFoundException, InternalTwoFactorException
 
TwoFactorUser createUser (String username, String mobileNumber)
 
PreAuthenticateResult preAuthenticate (String username) throws Exception
 
AuthenticateResult authenticate (String username, String otp) throws Exception
 

Detailed Description

Class that handles authentication and loading or creating of 2FA users.

Constructor & Destructor Documentation

com.eset.secureauthentication.sdk.TwoFactorAuthenticator.TwoFactorAuthenticator ( TwoFactorConfiguration  configuration) throws InternalTwoFactorException
inline

Construct a new com.eset.secureauthentication.sdk.TwoFactorAuthenticator instance.

Parameters
configurationconfiguration
Exceptions
InternalTwoFactorException

Member Function Documentation

AuthenticateResult com.eset.secureauthentication.sdk.TwoFactorAuthenticator.authenticate ( String  username,
String  otp 
) throws Exception
inline

Authenticate an OTP for a user.

Parameters
usernamethe ID of the user
otpthe OTP to authenticate
Returns
com.eset.secureauthentication.sdk.results.AuthenticateResult
Exceptions
Exception

Implements com.eset.secureauthentication.sdk.ITwoFactorAuthenticator.

TwoFactorUser com.eset.secureauthentication.sdk.TwoFactorAuthenticator.createUser ( String  username,
String  mobileNumber 
)
inline

Create a new two-factor user.

Parameters
usernamethe ID of the user
mobileNumberthe mobile number of the user
Returns
com.eset.secureauthentication.sdk.TwoFactorUser

Implements com.eset.secureauthentication.sdk.ITwoFactorAuthenticator.

TwoFactorUser com.eset.secureauthentication.sdk.TwoFactorAuthenticator.getUser ( String  username) throws UserNotFoundException, InternalTwoFactorException
inline

Load an existing two-factor user.

Parameters
usernamethe ID of the user
Returns
com.eset.secureauthentication.sdk.TwoFactorUser
Exceptions
UserNotFoundException
InternalTwoFactorException

Implements com.eset.secureauthentication.sdk.ITwoFactorAuthenticator.

PreAuthenticateResult com.eset.secureauthentication.sdk.TwoFactorAuthenticator.preAuthenticate ( String  username) throws Exception
inline

Begin 2FA process. This will sent a text message OTP if required.

Parameters
usernamethe ID of the user
Returns
com.eset.secureauthentication.sdk.results.PreAuthenticateResult
Exceptions
Exception

Implements com.eset.secureauthentication.sdk.ITwoFactorAuthenticator.


The documentation for this class was generated from the following file: