Package javacardx.biometry1toN
Interface OwnerBioMatcher
-
- All Superinterfaces:
BioMatcher
public interface OwnerBioMatcher extends BioMatcher
TheOwnerBioMatcher
interface should be implemented by the applet which owns theBioMatcher
. It extends theBioMatcher
interface and adds functionality to enroll one or more Biometric Template Data containers.- Since:
- 3.0.5
-
-
Field Summary
-
Fields inherited from interface javacardx.biometry1toN.BioMatcher
MATCH_NEEDS_MORE_DATA, MINIMUM_SUCCESSFUL_MATCH_SCORE
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description OwnerBioTemplateData
getBioTemplateData(short index)
Gets theOwnerBioTemplateData
enrolled at the specified index.short
getIndexOfLastMatchingBioTemplateData()
Gets the index of the last matchingBioTemplateData
.void
putBioTemplateData(short index, BioTemplateData templateData)
Enrolls the providedBioTemplateData
at the specified index.void
resetUnblockAndSetTryLimit(byte newTryLimit)
Resets the validated flag, unblocks and updates the try limit value and resets the try counter to the try limit value.-
Methods inherited from interface javacardx.biometry1toN.BioMatcher
getBioType, getMaxNbOfBioTemplateData, getTriesRemaining, getVersion, initMatch, isInitialized, isValidated, match, reset
-
-
-
-
Method Detail
-
putBioTemplateData
void putBioTemplateData(short index, BioTemplateData templateData) throws Bio1toNException, SecurityException
Enrolls the providedBioTemplateData
at the specified index. The providedBioTemplateData
must be loaded/initialized.This method has to be called several times to add all the required
BioTemplateData
for 1 to N matchingIf the method is called with the same index several times, the former
BioTemplateData
added to that index is replaced by the new one. If the method is called with anull
reference for theBioTemplateData
, the formerBioTemplateData
is removed. WhenOwnerBioTemplateData
are already enrolled with aOwnerBioMatcher
modifying its data will impact theOwnerBioMatcher
(stored as reference).- Parameters:
index
- the index where theBioTemplateData
must be added.templateData
- theBioTemplateData
to enroll.- Throws:
Bio1toNException
- with the following reason codes:Bio1toNException.ILLEGAL_VALUE
if the offset is invalid.Bio1toNException.NO_BIO_TEMPLATE_ENROLLED
if the providedBioTemplateData
is uninitialized.Bio1toNException.MISMATCHED_BIO_TYPE
if the type of the providedBioTemplateData
does not match that of thisBioMatcher
.
SecurityException
- if the reference template is not own by the caller.
-
resetUnblockAndSetTryLimit
void resetUnblockAndSetTryLimit(byte newTryLimit) throws Bio1toNException
Resets the validated flag, unblocks and updates the try limit value and resets the try counter to the try limit value.- Parameters:
newTryLimit
- the number of tries allowed before the 1toN template is blocked.newTryLimit
must be at least 1.- Throws:
Bio1toNException
- with the following reason codes:Bio1toNException.ILLEGAL_VALUE
if thenewTryLimit
parameter is less than 1.
-
getIndexOfLastMatchingBioTemplateData
short getIndexOfLastMatchingBioTemplateData()
Gets the index of the last matchingBioTemplateData
.- Specified by:
getIndexOfLastMatchingBioTemplateData
in interfaceBioMatcher
- Returns:
- the index of the last matching
BioTemplateData
. - Throws:
Bio1toNException
- with the following reason codes:Bio1toNException.ILLEGAL_USE
if no match was performed since last reset.
-
getBioTemplateData
OwnerBioTemplateData getBioTemplateData(short index)
Gets theOwnerBioTemplateData
enrolled at the specified index. This method is used to retrieve the 'orginal'OwnerBioTemplateData
in order to change its data using theinit
,update
,doFinal
methods.- Specified by:
getBioTemplateData
in interfaceBioMatcher
- Parameters:
index
- the index of theOwnerBioTemplateData
to retrieve.- Returns:
null
if noOwnerBioTemplateData
is available at the specified index.
-
-