Interface OwnerBioTemplate

All Superinterfaces:

BioTemplate

public interface OwnerBioTemplate
extends BioTemplate

The OwnerBioTemplate interface should be implemented by the applet which owns the biometric template. It extends the BioTemplate interface and adds functionality to enroll a reference template.

Since:

2.2.2

Field Summary

Fields inherited from interface BioTemplate

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
void	clear()	Clears the template and set its initialized state to false i.e.
void	doFinal()	Finalizes the enrollment of a reference template.
void	init(byte[] bArray, short offset, short length)	Initializes the enrollment of a reference template.
void	resetUnblockAndSetTryLimit(byte newTryLimit)	Resets the validated flag, unblocks the reference, updates the try limit value and resets the try counter to the try limit value.
void	update(byte[] bArray, short offset, short length)	Continues the enrollment of a reference template.

Methods inherited from interface BioTemplate

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

Modifier and Type	Method	Description
byte	getBioType()	Get the biometric type.
short	getPublicTemplateData(short publicOffset, byte[] dest, short destOffset, short length)	Get public part of the reference template.
byte	getTriesRemaining()	Returns the number of times remaining that an incorrect candidate template can be presented before the reference template is blocked.
short	getVersion(byte[] dest, short offset)	Get the matching algorithm version and ID.
short	initMatch(byte[] candidate, short offset, short length)	Initialize or re-initialize a biometric matching session.
boolean	isInitialized()	Returns true if the reference template is completely loaded and ready for matching functions.
boolean	isValidated()	Returns true if the template has been successfully checked since the last card reset or last call to reset().
short	match(byte[] candidate, short offset, short length)	Continues a biometric matching session.
void	reset()	Resets the validated flag associated with the reference template.

Method Details

init

void init(byte[] bArray,
 short offset,
 short length)
   throws BioException

Initializes the enrollment of a reference template. This method is also used to update a reference template. It resets the validated flag and, in the update case, uninitializes the previous reference.

Notes:

• A correct enrollment sequence is : init, [update], doFinal. Calling init and doFinal is mandatory, calling update is optional.
• The template format verification may occur during any step of the enrollment sequence or may only be performed when fully received in doFinal call.

Parameters:

bArray - - byte array containing the data of the template

offset - - starting offset in the bArray

length - - byte length of the template data in the bArray

Throws:

BioException - with the following reason codes:

• BioException.INVALID_DATA if the submitted template data does not have the required format.

update

void update(byte[] bArray,
 short offset,
 short length)
     throws BioException

Continues the enrollment of a reference template. This method should only be used if all the input data required for enrollment is not available in one byte array. It can be called several times.

Notes:

• A correct enrollment sequence is : init, [update], doFinal. Calling init and doFinal is mandatory, calling update is optional.
• The template format verification may occur during any step of the enrollment sequence or may only be performed when fully received in doFinal call.

Parameters:

bArray - - byte array containing the data of the template

offset - - starting offset in the bArray

length - - byte length of the template data in the bArray

Throws:

BioException - with the following reason codes:

• BioException.ILLEGAL_USE if the reference is already initialized or the current enrollment state doesn't expect this method.
• BioException.INVALID_DATA if the submitted template data does not have the required format.

doFinal

void doFinal()
      throws BioException

Finalizes the enrollment of a reference template. Final action of enrollment is to designate a reference template as being complete and ready for use (marks the reference as initialized, resets the try counter and unblocks the reference). This routine may also include some error checking prior to the validation of reference template as ready for use.

Notes:

• A correct enrollment sequence is : init, [update], doFinal. Calling init and doFinal is mandatory, calling update is optional.
• The template format verification may occur during any step of the enrollment sequence or may only be performed when fully received in doFinal call.

Throws:

BioException - with the following reason codes:

• BioException.ILLEGAL_USE if the reference is already initialized or the current enrollment state doesn't expect this method.
• BioException.INVALID_DATA if the submitted template data does not have the required format.

resetUnblockAndSetTryLimit

void resetUnblockAndSetTryLimit(byte newTryLimit)
                         throws BioException

Resets the validated flag, unblocks the reference, updates the try limit value and resets the try counter to the try limit value.

Parameters:

newTryLimit - - the number of tries allowed before the reference is blocked. newTryLimit must be at least 1.

Throws:

BioException - with the following reason codes:

• BioException.ILLEGAL_VALUE if the newTryLimit parameter is less than 1.

clear

void clear()

Clears the template and set its initialized state to false i.e. isInitialized() must return false.

Since:

3.2