com.gemalto.idp.mobile.authentication

Interface Authenticatable

All Known Subinterfaces:

CapToken, DualSeedOathToken, DualSeedSoftOathToken, OathToken, SoftCapToken, SoftOathToken, SoftVicToken, Token, VicToken

public interface Authenticatable

Authenticatable interface. Authenticatable refers to some asset which could be authenticated with multi-authentication modes once configured.

Since:

4.0

Method Summary

Modifier and Type	Method and Description
void	activateAuthMode(AuthMode mode, AuthInput authInput) Activate an authentication mode for the authenticatable.
void	deactivateAuthMode(AuthMode authMode) Deactivate an authentication mode.
java.util.Set<AuthMode>	getActivatedModes() Get the list of authentication modes that have been activated for this authenticatable.
java.lang.String	getUUID() Get the UUID of an Authenticatable object.
boolean	isAuthModeActive(AuthMode mode) Check if a mode has already been activated for this authenticatable.
boolean	isMultiAuthModeEnabled() Check if multi authentication mode has been enabled.

Method Detail

getUUID

java.lang.String getUUID()
                  throws IdpException

Get the UUID of an Authenticatable object.

Returns:

String value of UUID.

Throws:

IdpException - this is generic exception, you can directly catch this exception or catch each specific exception below.

IdpStorageException - when database doesn't exist

PasswordManagerException - when the functionality is protected by passwordManager but is not logged in

DeviceFingerprintException - when a device fingerprint operation failed.

activateAuthMode

void activateAuthMode(AuthMode mode,
                      AuthInput authInput)
               throws IdpException

Activate an authentication mode for the authenticatable.

Parameters:

mode - new mode of authentication to be activated.

authInput - input used for activation.

Throws:

IdpException - this is generic exception, you can directly catch this exception or catch each specific exception below.

IdpStorageException - when database doesn't exist

PasswordManagerException - when the functionality is protected by passwordManager but is not logged in

DeviceFingerprintException - when a device fingerprint operation failed.

IdpAuthException - when the authentication mode operation failed.

java.lang.IllegalStateException - if token is failsafe or token has already been migrated.

isMultiAuthModeEnabled

boolean isMultiAuthModeEnabled()
                        throws IdpException

Check if multi authentication mode has been enabled. This function will return true if the authenticatable has been migrated to support multi auth modes. After migration, this function will return true even when only one mode is activated.

Returns:

if multi authentication mode has been enabled.

Throws:

IdpException - this is generic exception, you can directly catch this exception or catch each specific exception below.

IdpStorageException - when database doesn't exist

PasswordManagerException - when the functionality is protected by passwordManager but is not logged in

DeviceFingerprintException - when a device fingerprint operation failed.

deactivateAuthMode

void deactivateAuthMode(AuthMode authMode)
                 throws IdpException

Deactivate an authentication mode.

Parameters:

authMode - the mode to be deactivated.

Throws:

IdpException - this is generic exception, you can directly catch this exception or catch each specific exception below.

IdpStorageException - when database doesn't exist

PasswordManagerException - when the functionality is protected by passwordManager but is not logged in

DeviceFingerprintException - when a device fingerprint operation failed.

IdpAuthException - when the authentication mode operation failed.

getActivatedModes

java.util.Set<AuthMode> getActivatedModes()
                                   throws IdpException

Get the list of authentication modes that have been activated for this authenticatable.

Returns:

a set of activated authentication modes.

Throws:

IdpException - this is generic exception, you can directly catch this exception or catch each specific exception below.

IdpStorageException - when database doesn't exist

PasswordManagerException - when the functionality is protected by passwordManager but is not logged in

DeviceFingerprintException - when a device fingerprint operation failed.

isAuthModeActive

boolean isAuthModeActive(AuthMode mode)
                  throws IdpException

Check if a mode has already been activated for this authenticatable.

Parameters:

mode - the authentication mode to be check.

Returns:

is a mode has been activated.

Throws:

IdpException - this is generic exception, you can directly catch this exception or catch each specific exception below.

IdpStorageException - when database doesn't exist

PasswordManagerException - when the functionality is protected by passwordManager but is not logged in

DeviceFingerprintException - when a device fingerprint operation failed.