org.javacardforum.javacard.biometry
Interface OwnerBioTemplate

All Superinterfaces:

BioTemplate

public interface OwnerBioTemplate

extends BioTemplate

The OwnerBioTemplate interface provides the ability to enrol a reference template and thus owner functionality.

See Also:

BioBuilder, BioTemplate

Field Summary

Fields inherited from interface org.javacardforum.javacard.biometry.BioTemplate

MATCH_NEEDS_MORE_DATA, MINIMUM_SUCCESSFUL_MATCH_SCORE

Method Summary

void	doFinal() Finalizes the enrolment of a reference template.
void	init(byte[] bArray, short offset, short length) Initializes the enrolment 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 enrolment of a reference template.

Methods inherited from interface org.javacardforum.javacard.biometry.BioTemplate

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

Method Detail

init

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

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

Note:

• A correct enrolment sequence is: init(byte[], short, short)-[update(byte[], short, short)]-doFinal(). Calling init(byte[], short, short) and doFinal() is mandatory, calling update(byte[], short, short) is optional.

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 reason BioException.INVALID_DATA if the submitted candidate template data does not have the required format.

update

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

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

Note:

• A correct enrolment sequence is: init(byte[], short, short)-[update(byte[], short, short)]-doFinal(). Calling init(byte[], short, short) and doFinal() is mandatory, calling update(byte[], short, short) is optional.

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 reason BioException.ILLEGAL_USE if the reference is already initialized or the current enrolment state doesn't expect this method.

doFinal

public void doFinal()
             throws BioException

Finalizes the enrolment 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.

Note:

• A correct enrolment sequence is: init(byte[], short, short)-[update(byte[], short, short)]-doFinal(). Calling init(byte[], short, short) and doFinal() is mandatory, calling update(byte[], short, short) is optional.

Throws:

BioException - with reason BioException.ILLEGAL_USE if the reference is already initialized or the current enrolment state doesn't expect this method.

BioException - with reason BioException.INVALID_DATA if the submitted candidate template data does not have the required format.

resetUnblockAndSetTryLimit

public 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. Must be >= 1.

Throws:

BioException - with reason BioException.ILLEGAL_USE if newTryLimit parameter is less than 1.