com.eset.secureauthentication.sdk.TwoFactorUser Class Reference

Inheritance diagram for com.eset.secureauthentication.sdk.TwoFactorUser:

Public Member Functions
	TwoFactorUser (IUserStorage userStorage, IAuditor auditor, IUser user, boolean hasChanges)
	TwoFactorUser (IUserStorage userStorage, IAuditor auditor, IUser user)
String	getUserId ()
String	getMobileNumber ()
void	setMobileNumber (String mobileNumber)
boolean	getIsLocked ()
Date	getLastSuccess ()
Date	getLastFailure ()
int	getConsecutiveFailures ()
CredentialTypes	getCredentialType ()
void	deprovisionTwoFactor () throws InternalTwoFactorException, InvalidApiCredentialsException, ProvisioningCommunicationException, VersionNotSupportedException, LicenseExceededException
void	unlock ()
ProvisionMobileAppResult	provisionMobileApp (boolean allowTransitioning) throws InternalTwoFactorException, ProvisioningCommunicationException, VersionNotSupportedException, InvalidApiCredentialsException, LicenseExceededException
ProvisionMobileAppResult	provisionMobileApp () throws ProvisioningCommunicationException, InternalTwoFactorException, VersionNotSupportedException, InvalidApiCredentialsException, LicenseExceededException
void	sendMobileAppProvisioningTextMessage (ProvisionMobileAppResult provisionResult) throws InsufficientTextMessageCreditsException, ProvisioningCommunicationException, InternalTwoFactorException, VersionNotSupportedException, InvalidApiCredentialsException
void	provisionTextMessage (boolean allowTransitioning) throws InternalTwoFactorException, InvalidApiCredentialsException, ProvisioningCommunicationException, VersionNotSupportedException, LicenseExceededException
void	provisionTextMessage () throws VersionNotSupportedException, InvalidApiCredentialsException, InternalTwoFactorException, ProvisioningCommunicationException, LicenseExceededException
boolean	getHasChanges ()
void	save () throws InternalTwoFactorException

Detailed Description

Class that handles all 2FA management options for a user.

Member Function Documentation

void com.eset.secureauthentication.sdk.TwoFactorUser.deprovisionTwoFactor ( ) throws InternalTwoFactorException, InvalidApiCredentialsException, ProvisioningCommunicationException, VersionNotSupportedException, LicenseExceededException

inline

Disable 2FA for user.

Implements com.eset.secureauthentication.sdk.ITwoFactorUser.

int com.eset.secureauthentication.sdk.TwoFactorUser.getConsecutiveFailures ( )

inline

Returns

the number of consecutive authentication failures

Implements com.eset.secureauthentication.sdk.ITwoFactorUser.

CredentialTypes com.eset.secureauthentication.sdk.TwoFactorUser.getCredentialType ( )

inline

Returns

the 2FA credential type that the user has enabled, of enum type com.eset.secureauthentication.sdk.CredentialTypes

Implements com.eset.secureauthentication.sdk.ITwoFactorUser.

boolean com.eset.secureauthentication.sdk.TwoFactorUser.getHasChanges ( )

inline

Returns

true if the user object has unsaved changes

Implements com.eset.secureauthentication.sdk.ITwoFactorUser.

boolean com.eset.secureauthentication.sdk.TwoFactorUser.getIsLocked ( )

inline

Returns

true if the user is locked, false if the user is not locked

Implements com.eset.secureauthentication.sdk.ITwoFactorUser.

Date com.eset.secureauthentication.sdk.TwoFactorUser.getLastFailure ( )

inline

Returns

the java.util.Date of the last failed authentication

Implements com.eset.secureauthentication.sdk.ITwoFactorUser.

Date com.eset.secureauthentication.sdk.TwoFactorUser.getLastSuccess ( )

inline

Returns

the java.util.Date of the last successful authentication

Implements com.eset.secureauthentication.sdk.ITwoFactorUser.

String com.eset.secureauthentication.sdk.TwoFactorUser.getMobileNumber ( )

inline

Get mobile number of user.

Returns

the mobile number of the user

Implements com.eset.secureauthentication.sdk.ITwoFactorUser.

String com.eset.secureauthentication.sdk.TwoFactorUser.getUserId ( )

inline

Get ID of user.

Returns

the ID of the user

Implements com.eset.secureauthentication.sdk.ITwoFactorUser.

ProvisionMobileAppResult com.eset.secureauthentication.sdk.TwoFactorUser.provisionMobileApp ( boolean  allowTransitioning ) throws InternalTwoFactorException, ProvisioningCommunicationException, VersionNotSupportedException, InvalidApiCredentialsException, LicenseExceededException

inline

Provision a user for mobile app OTPs.

Parameters

allowTransitioning

true if the user can enter a transitioning state (from text message OTPs)

Returns

com.eset.secureauthentication.sdk.results.ProvisionMobileAppResult

Exceptions

InternalTwoFactorException
ProvisioningCommunicationException
VersionNotSupportedException
InvalidApiCredentialsException

Implements com.eset.secureauthentication.sdk.ITwoFactorUser.

ProvisionMobileAppResult com.eset.secureauthentication.sdk.TwoFactorUser.provisionMobileApp ( ) throws ProvisioningCommunicationException, InternalTwoFactorException, VersionNotSupportedException, InvalidApiCredentialsException, LicenseExceededException

inline

Provision a user for mobile app OTPs, while allowing transitioning. Overload provisionMobileApp(boolean).

Returns

com.eset.secureauthentication.sdk.results.ProvisionMobileAppResult

Exceptions

InternalTwoFactorException
ProvisioningCommunicationException
VersionNotSupportedException
InvalidApiCredentialsException

Implements com.eset.secureauthentication.sdk.ITwoFactorUser.

void com.eset.secureauthentication.sdk.TwoFactorUser.provisionTextMessage ( boolean  allowTransitioning ) throws InternalTwoFactorException, InvalidApiCredentialsException, ProvisioningCommunicationException, VersionNotSupportedException, LicenseExceededException

inline

Provision a user for text message OTPs.

Parameters

allowTransitioning

true if the user can enter a transitioning state (from mobile app OTPs)

Implements com.eset.secureauthentication.sdk.ITwoFactorUser.

void com.eset.secureauthentication.sdk.TwoFactorUser.provisionTextMessage ( ) throws VersionNotSupportedException, InvalidApiCredentialsException, InternalTwoFactorException, ProvisioningCommunicationException, LicenseExceededException

inline

Provision a user for text message OTPs, while allowing transitioning. Overload of provisionTextMessage(boolean).

Implements com.eset.secureauthentication.sdk.ITwoFactorUser.

void com.eset.secureauthentication.sdk.TwoFactorUser.save ( ) throws InternalTwoFactorException

inline

Save any unsaved changes to the user object.

Exceptions

InternalTwoFactorException

Implements com.eset.secureauthentication.sdk.ITwoFactorUser.

void com.eset.secureauthentication.sdk.TwoFactorUser.sendMobileAppProvisioningTextMessage ( ProvisionMobileAppResult  provisionResult ) throws InsufficientTextMessageCreditsException, ProvisioningCommunicationException, InternalTwoFactorException, VersionNotSupportedException, InvalidApiCredentialsException

inline

Send text message containing mobile app installation URL to user.

Parameters

provisionResult

com.eset.secureauthentication.sdk.results.ProvisionMobileAppResult object returned from provisionMobileApp(boolean) or provisionMobileApp()

Exceptions

InsufficientTextMessageCreditsException
ProvisioningCommunicationException
InternalTwoFactorException
VersionNotSupportedException
InvalidApiCredentialsException

Implements com.eset.secureauthentication.sdk.ITwoFactorUser.

void com.eset.secureauthentication.sdk.TwoFactorUser.setMobileNumber ( String  mobileNumber )

inline

Set mobile number of user.

Parameters

mobileNumber

value to set mobile number of user to

Implements com.eset.secureauthentication.sdk.ITwoFactorUser.

void com.eset.secureauthentication.sdk.TwoFactorUser.unlock ( )

inline

Unlock the user.

Implements com.eset.secureauthentication.sdk.ITwoFactorUser.

---

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

• sdklib/src/main/java/com/eset/secureauthentication/sdk/TwoFactorUser.java