Package javacardx.biometry
Interface OwnerBioTemplate
-
- All Superinterfaces:
BioTemplate
public interface OwnerBioTemplate extends BioTemplate
TheOwnerBioTemplate
interface should be implemented by the applet which owns the biometric template. It extends theBioTemplate
interface and adds functionality to enroll a reference template.- Since:
- 2.2.2
-
-
Field Summary
-
Fields inherited from interface javacardx.biometry.BioTemplate
MATCH_NEEDS_MORE_DATA, MINIMUM_SUCCESSFUL_MATCH_SCORE
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description 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 javacardx.biometry.BioTemplate
getBioType, getPublicTemplateData, getTriesRemaining, getVersion, initMatch, isInitialized, isValidated, match, reset
-
-
-
-
Method Detail
-
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
. Callinginit
anddoFinal
is mandatory, callingupdate
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 templateoffset
- - starting offset in thebArray
length
- - byte length of the template data in thebArray
- Throws:
BioException
- with the following reason codes:BioException.INVALID_DATA
if the submitted template data does not have the required format.
- A correct
enrollment sequence is :
-
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
. Callinginit
anddoFinal
is mandatory, callingupdate
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 templateoffset
- - starting offset in thebArray
length
- - byte length of the template data in thebArray
- 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.
- A correct
enrollment sequence is :
-
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
. Callinginit
anddoFinal
is mandatory, callingupdate
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.
- A correct
enrollment sequence is :
-
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 thenewTryLimit
parameter is less than 1.
-
-