com.hidglobal.ia.service.protectionpolicy

Interface BioPasswordPolicy

All Superinterfaces:

PasswordPolicy, ProtectionPolicy

public interface BioPasswordPolicy
extends PasswordPolicy

Protection policy with authentication with biometrics or password.

Nested Class Summary

Nested classes/interfaces inherited from interface com.hidglobal.ia.service.protectionpolicy.ProtectionPolicy

ProtectionPolicy.PolicyType

Method Summary

Modifier and Type	Method and Description
void	disableBioAuthentication() Deletes the internally stored password used for external biometric authentication.
void	enableBioAuthentication(char[] password) Enables authentication with biometrics.
void	enableFingerprintManager(Object authenticationCallback, Object cancellationSignal) Deprecated. Use setBiometricPrompt(android.app.Activity, androidx.biometric.BiometricPrompt.AuthenticationCallback, androidx.biometric.BiometricPrompt.PromptInfo).
Object	getAuthenticationCallback() Android specific.
BioAuthenticationState	getBioAuthenticationState() Returns the current working state of authentication with biometrics.
Object	getCancellationSignal() Deprecated.
void	resetBiometricPrompt() Removes the stored BiometricPrompt and BiometricInfo objects.
void	setBiometricPrompt(android.app.Activity activity, androidx.biometric.BiometricPrompt.AuthenticationCallback authCallback, androidx.biometric.BiometricPrompt.PromptInfo promptInfo) Android specific.
void	setBiometricPrompt(androidx.fragment.app.Fragment fragment, androidx.biometric.BiometricPrompt.AuthenticationCallback authCallback, androidx.biometric.BiometricPrompt.PromptInfo promptInfo) Android specific.

Methods inherited from interface com.hidglobal.ia.service.protectionpolicy.PasswordPolicy

changePassword, getCacheTimeout, getCurrentAge, getMaxAge, getMaxAlpha, getMaxHistory, getMaxLength, getMaxLowerCase, getMaxNonAlpha, getMaxNumeric, getMaxUpperCase, getMinAge, getMinAlpha, getMinLength, getMinLowerCase, getMinNonAlpha, getMinNumeric, getMinUpperCase, isCacheEnabled, verifyPassword

Methods inherited from interface com.hidglobal.ia.service.protectionpolicy.ProtectionPolicy

getId, getLockPolicy, getType

Method Detail

enableBioAuthentication

void enableBioAuthentication(char[] password)
                      throws UnsupportedDeviceException,
                             FingerprintNotEnrolledException,
                             FingerprintAuthenticationRequiredException,
                             InternalException,
                             LostCredentialsException,
                             AuthenticationException,
                             PasswordExpiredException

Enables authentication with biometrics.

Parameters:

password - the password of this policy.

Throws:

UnsupportedDeviceException - if device is not supported by policy.

FingerprintNotEnrolledException - if fingerprint enrollment is required.

FingerprintAuthenticationRequiredException - if fingerprint authentication is required by policy.

InternalException - if an unexpected error occurred.

LostCredentialsException - if provisioning key data has been corrupted or lost.

AuthenticationException - if password is incorrect.

PasswordExpiredException - if expired password is given (changePassword required).

getBioAuthenticationState

BioAuthenticationState getBioAuthenticationState()
                                          throws InternalException

Returns the current working state of authentication with biometrics.

Returns:

the current working state of authentication with biometrics

Throws:

InternalException - if an unexpected error occurred.

enableFingerprintManager

void enableFingerprintManager(Object authenticationCallback,
                              Object cancellationSignal)
                       throws InternalException

Deprecated. Use setBiometricPrompt(android.app.Activity, androidx.biometric.BiometricPrompt.AuthenticationCallback, androidx.biometric.BiometricPrompt.PromptInfo).

Android specific. Enables usage of android.hardware.fingerprint.FingerprintManager API.

Parameters:

authenticationCallback - Instance of FingerprintManager.AuthenticationCallback

cancellationSignal - Instance of android.os.CancellationSignal

Throws:

InternalException - if an unexpected error occurred.

getAuthenticationCallback

Object getAuthenticationCallback()
                          throws InternalException

Android specific. Returns the AuthenticationCallback.

Returns:

the AuthenticationCallback

Throws:

InternalException - if an unexpected error occurred.

getCancellationSignal

Object getCancellationSignal()
                      throws InternalException

Deprecated.

Android specific. Returns the CancellationSignal.

Returns:

the FingerprintManager. CancellationSignal instance set with enableFingerprintManager

Throws:

InternalException - if an unexpected error occurred.

setBiometricPrompt

void setBiometricPrompt(android.app.Activity activity,
                        androidx.biometric.BiometricPrompt.AuthenticationCallback authCallback,
                        androidx.biometric.BiometricPrompt.PromptInfo promptInfo)

Android specific. Passes the AndroidX Biometrics objects to the SDK to enable biometrics support.

Parameters:

activity - Application activity instance

authCallback - Instance of BiometricPrompt.AuthenticationCallback

promptInfo - Instance of dialog structure BiometricPrompt.PromptInfo

setBiometricPrompt

void setBiometricPrompt(androidx.fragment.app.Fragment fragment,
                        androidx.biometric.BiometricPrompt.AuthenticationCallback authCallback,
                        androidx.biometric.BiometricPrompt.PromptInfo promptInfo)

Android specific. Passes the AndroidX Biometrics objects to the SDK to enable biometrics support.

Parameters:

fragment - Application fragment instance

authCallback - Instance of BiometricPrompt.AuthenticationCallback

promptInfo - Instance of dialog structure BiometricPrompt.PromptInfo

resetBiometricPrompt

void resetBiometricPrompt()

Removes the stored BiometricPrompt and BiometricInfo objects.

disableBioAuthentication

void disableBioAuthentication()
                       throws UnsupportedDeviceException,
                              FingerprintNotEnrolledException,
                              FingerprintAuthenticationRequiredException,
                              InternalException,
                              LostCredentialsException,
                              AuthenticationException,
                              PasswordExpiredException

Deletes the internally stored password used for external biometric authentication. Note: Convenience method which is equivalent to calling enableBioAuthentication(null)

Throws:

UnsupportedDeviceException - if device is not supported by policy.

FingerprintNotEnrolledException - if fingerprint enrollment is required.

FingerprintAuthenticationRequiredException - if fingerprint authentication is required by policy.

InternalException - if an unexpected error occurred.

LostCredentialsException - if provisioning key data has been corrupted or lost.

AuthenticationException - if password is incorrect.

PasswordExpiredException - if expired password is given (changePassword required).