Inheritance diagram for com.hidglobal.ia.service.protectionpolicy.BioPasswordPolicy:

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

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

void	enableFingerprintManager (Object authenticationCallback, Object cancellationSignal) throws InternalException

Object	getAuthenticationCallback () throws InternalException

BioAuthenticationState	getBioAuthenticationState () throws InternalException

Object	getCancellationSignal () throws InternalException

void	resetBiometricPrompt ()

void	setBiometricPrompt (Activity activity, AuthenticationCallback authCallback, PromptInfo promptInfo)

void	setBiometricPrompt (Fragment fragment, AuthenticationCallback authCallback, PromptInfo promptInfo)

Public Member Functions inherited from com.hidglobal.ia.service.protectionpolicy.PasswordPolicy
boolean	changePassword (char[] oldpwdvalue, char[] newpwdvalue) throws AuthenticationException, PasswordNotYetUpdatableException, InvalidPasswordException, LostCredentialsException, InternalException, FingerprintAuthenticationRequiredException, UnsupportedDeviceException, FingerprintNotEnrolledException, PasswordRequiredException

int	getCacheTimeout ()

long	getCurrentAge ()

int	getMaxAge ()

int	getMaxAlpha ()

int	getMaxHistory ()

int	getMaxLength ()

int	getMaxLowerCase ()

int	getMaxNonAlpha ()

int	getMaxNumeric ()

int	getMaxUpperCase ()

int	getMinAge ()

int	getMinAlpha ()

int	getMinLength ()

int	getMinLowerCase ()

int	getMinNonAlpha ()

int	getMinNumeric ()

int	getMinUpperCase ()

boolean	isCacheEnabled ()

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

Public Member Functions inherited from com.hidglobal.ia.service.protectionpolicy.ProtectionPolicy
ProtectionPolicyId	getId ()

LockPolicy	getLockPolicy ()

String	getType ()

Detailed Description

Protection policy with authentication with biometrics or password.

Member Function Documentation

◆ disableBioAuthentication()

void com.hidglobal.ia.service.protectionpolicy.BioPasswordPolicy.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)

Exceptions

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).

◆ enableBioAuthentication()

void com.hidglobal.ia.service.protectionpolicy.BioPasswordPolicy.enableBioAuthentication ( char [] password ) throws UnsupportedDeviceException,FingerprintNotEnrolledException,FingerprintAuthenticationRequiredException, InternalException, LostCredentialsException, AuthenticationException, PasswordExpiredException

Enables authentication with biometrics.

Parameters

password the password of this policy.

Exceptions

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).

◆ enableFingerprintManager()

void com.hidglobal.ia.service.protectionpolicy.BioPasswordPolicy.enableFingerprintManager	(	Object	authenticationCallback,
		Object	cancellationSignal
	)		throws InternalException

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

Parameters

authenticationCallback	Instance of FingerprintManager.AuthenticationCallback
cancellationSignal	Instance of android.os.CancellationSignal

Exceptions

InternalException if an unexpected error occurred.

Deprecated:: This method is no longer recommended. Use setBiometricPrompt(android.app.Activity, androidx.biometric.BiometricPrompt.AuthenticationCallback, androidx.biometric.BiometricPrompt.PromptInfo).

◆ getAuthenticationCallback()

Object com.hidglobal.ia.service.protectionpolicy.BioPasswordPolicy.getAuthenticationCallback ( ) throws InternalException

Android specific. Returns the AuthenticationCallback.

Returns: the AuthenticationCallback

Exceptions

InternalException if an unexpected error occurred.

◆ getBioAuthenticationState()

BioAuthenticationState com.hidglobal.ia.service.protectionpolicy.BioPasswordPolicy.getBioAuthenticationState ( ) throws InternalException

Returns the current working state of authentication with biometrics.

Returns: the current working state of authentication with biometrics

Exceptions

InternalException if an unexpected error occurred.

◆ getCancellationSignal()

Object com.hidglobal.ia.service.protectionpolicy.BioPasswordPolicy.getCancellationSignal ( ) throws InternalException

Deprecated. Android specific. Returns the CancellationSignal.

Returns: the FingerprintManager. CancellationSignal instance set with enableFingerprintManager

Exceptions

InternalException if an unexpected error occurred.

Deprecated:: This method is no longer recommended. Use setBiometricPrompt(android.app.Activity, androidx.biometric.BiometricPrompt.AuthenticationCallback, androidx.biometric.BiometricPrompt.PromptInfo).

◆ resetBiometricPrompt()

void com.hidglobal.ia.service.protectionpolicy.BioPasswordPolicy.resetBiometricPrompt ( )

Removes the stored BiometricPrompt and BiometricInfo objects.

◆ setBiometricPrompt() [1/2]

void com.hidglobal.ia.service.protectionpolicy.BioPasswordPolicy.setBiometricPrompt	(	Activity	activity,
		AuthenticationCallback	authCallback,
		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() [2/2]

void com.hidglobal.ia.service.protectionpolicy.BioPasswordPolicy.setBiometricPrompt	(	Fragment	fragment,
		AuthenticationCallback	authCallback,
		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

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

BioPasswordPolicy.java

Public Member Functions

Detailed Description

Member Function Documentation

◆ disableBioAuthentication()

◆ enableBioAuthentication()

◆ enableFingerprintManager()

◆ getAuthenticationCallback()

◆ getBioAuthenticationState()

◆ getCancellationSignal()

◆ resetBiometricPrompt()

◆ setBiometricPrompt() [1/2]

◆ setBiometricPrompt() [2/2]