Interface OwnerBioMatcher

All Superinterfaces:

BioMatcher

public interface OwnerBioMatcher
extends BioMatcher

The OwnerBioMatcher interface should be implemented by the applet which owns the BioMatcher. It extends the BioMatcher interface and adds functionality to enroll one or more Biometric Template Data containers.

Since:

3.0.5

Field Summary

Fields inherited from interface BioMatcher

MATCH_NEEDS_MORE_DATA, MINIMUM_SUCCESSFUL_MATCH_SCORE

Modifier and Type	Field	Description
static final short	MATCH_NEEDS_MORE_DATA	This negative score value indicates that more data are needed to continue the matching session.
static final short	MINIMUM_SUCCESSFUL_MATCH_SCORE	The minimum successful matching score.

Method Summary

Modifier and Type	Method	Description
OwnerBioTemplateData	getBioTemplateData(short index)	Gets the OwnerBioTemplateData enrolled at the specified index.
short	getIndexOfLastMatchingBioTemplateData()	Gets the index of the last matching BioTemplateData.
void	putBioTemplateData(short index, BioTemplateData templateData)	Enrolls the provided BioTemplateData 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 BioMatcher

getBioType, getMaxNbOfBioTemplateData, getTriesRemaining, getVersion, initMatch, isInitialized, isValidated, match, reset

Modifier and Type	Method	Description
byte	getBioType()	Gets the biometric type.
short	getMaxNbOfBioTemplateData()	Gets the maximum number of BioTemplateData that can be enrolled in this BioMatcher.
byte	getTriesRemaining()	Gets the number of times remaining that an incorrect candidate can be presented before the BioMatcher is blocked.
short	getVersion(byte[] dest, short offset)	Gets the matching algorithm version and ID.
short	initMatch(byte[] candidate, short offset, short length)	Initialize or re-initialize a biometric matching session.
boolean	isInitialized()	Indicates whether this BioMatcher has been loaded with at least one BioTemplateData and is ready for matching functions.
boolean	isValidated()	Indicates whether a matching session was successfully since the last card reset or last call to BioMatcher.reset().
short	match(byte[] candidate, short offset, short length)	Continues a biometric matching session.
void	reset()	Resets the validated flag associated with this BioMatcher.

Method Details

putBioTemplateData

void putBioTemplateData(short index,
 BioTemplateData templateData)
                 throws Bio1toNException,
SecurityException

Enrolls the provided BioTemplateData at the specified index. The provided BioTemplateData must be loaded/initialized.

This method has to be called several times to add all the required BioTemplateData for 1 to N matching

If 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 a null reference for the BioTemplateData, the former BioTemplateData is removed. When OwnerBioTemplateData are already enrolled with a OwnerBioMatcher modifying its data will impact the OwnerBioMatcher (stored as reference).

Note: indexing starts at value « 1 » (« 0 » is an invalid value).

Parameters:

index - the index where the BioTemplateData must be added.

templateData - the BioTemplateData to enroll.

Throws:

Bio1toNException - with the following reason codes:

• Bio1toNException.ILLEGAL_VALUE if the offset is invalid.
• Bio1toNException.NO_BIO_TEMPLATE_ENROLLED if the provided BioTemplateData is uninitialized.
• Bio1toNException.MISMATCHED_BIO_TYPE if the type of the provided BioTemplateData does not match that of this BioMatcher.

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 the newTryLimit parameter is less than 1.

getIndexOfLastMatchingBioTemplateData

short getIndexOfLastMatchingBioTemplateData()

Gets the index of the last matching BioTemplateData.

Note: indexing starts at value « 1 » (« 0 » is an invalid value).

Specified by:

getIndexOfLastMatchingBioTemplateData in interface BioMatcher

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 the OwnerBioTemplateData enrolled at the specified index. This method is used to retrieve the 'orginal' OwnerBioTemplateData in order to change its data using the init, update, doFinal methods.

Note: indexing starts at value « 1 » (« 0 » is an invalid value).

Specified by:

getBioTemplateData in interface BioMatcher

Parameters:

index - the index of the OwnerBioTemplateData to retrieve.

Returns:

null if no OwnerBioTemplateData is available at the specified index.