com.hidglobal.ia.service.protectionpolicy.BioPasswordPolicy Interface Reference

Protection policy with authentication with biometrics or password. More...

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
Object	getAuthenticationCallback () throws InternalException
int	getAuthorizedAuthenticator ()
BioAuthenticationState	getBioAuthenticationState () throws InternalException
void	resetBiometricPrompt ()
void	setBiometricPrompt (FragmentActivity fragmentActivity, 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, InvalidParameterException
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 ()
boolean	isSequenceAllowed ()
void	verifyPassword (char[] password) throws InternalException, UnsupportedDeviceException, LostCredentialsException, AuthenticationException, PasswordExpiredException, FingerprintAuthenticationRequiredException, FingerprintNotEnrolledException, PasswordRequiredException, InvalidParameterException
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.

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

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.

getAuthorizedAuthenticator()

int com.hidglobal.ia.service.protectionpolicy.BioPasswordPolicy.getAuthorizedAuthenticator

(

)

Return the minimum authorized biometric authenticator class according to provisioning rule :

• BIOMETRIC_STRONG
• BIOMETRIC_WEAK

Returns

the minimum authorized biometric authenticator class according to provisioning rule.

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.

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	(	FragmentActivity	fragmentActivity,
		AuthenticationCallback	authCallback,
		PromptInfo	promptInfo
	)

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

Parameters

fragmentActivity	Application fragmentActivity 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