**javacardx.biometry** 
 ====Interface OwnerBioTemplate  ====

**All Superinterfaces:** [[javacard:java-card-api:BioTemplate|BioTemplate]]  
 



 ----

  *[[javacard:java-card-api:biotemplate|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 javacardx.biometry.BioTemplate ^ 
| [[javacard:java-card-api:BioTemplate#MATCH_NEEDS_MORE_DATA|MATCH_NEEDS_MORE_DATA]] , [[javacard:java-card-api:BioTemplate#MINIMUM_SUCCESSFUL_MATCH_SCORE|MINIMUM_SUCCESSFUL_MATCH_SCORE]]  |

 




^ Method Summary ^^ 
| ** void** | **[[javacard:java-card-api:OwnerBioTemplate#doFinal()|doFinal]] **()          Finalizes the enrollment of a reference template. |
| ** void** | **[[javacard:java-card-api:OwnerBioTemplate#init(byte[], short, short)|init]] **(byte[] bArray,short offset,short length)          Initializes the enrollment of a reference template. |
| ** void** | **[[javacard:java-card-api:OwnerBioTemplate#resetUnblockAndSetTryLimit(byte)|resetUnblockAndSetTryLimit]] **(byte newTryLimit)          Resets the validated flag, unblocks the reference, updates the try limitvalue and resets the try counter to the try limit value. |
| ** void** | **[[javacard:java-card-api:OwnerBioTemplate#update(byte[], short, short)|update]] **(byte[] bArray,short offset,short length)          Continues the enrollment of a reference template. |

 

^ Methods inherited from interface javacardx.biometry.BioTemplate ^ 
| [[javacard:java-card-api:BioTemplate#getBioType()|getBioType]] , [[javacard:java-card-api:BioTemplate#getPublicTemplateData(short, byte[], short, short)|getPublicTemplateData]] , [[javacard:java-card-api:BioTemplate#getTriesRemaining()|getTriesRemaining]] , [[javacard:java-card-api:BioTemplate#getVersion(byte[], short)|getVersion]] , [[javacard:java-card-api:BioTemplate#initMatch(byte[], short, short)|initMatch]] , [[javacard:java-card-api:BioTemplate#isInitialized()|isInitialized]] , [[javacard:java-card-api:BioTemplate#isValidated()|isValidated]] , [[javacard:java-card-api:BioTemplate#match(byte[], short, short)|match]] , [[javacard:java-card-api:BioTemplate#reset()|reset]]  |

 






^ Method Detail ^ 



 === init === 
void **init**(byte[] bArray,
short offset,
short length)
throws [[javacard:java-card-api:BioException|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.
 Note:
  A correct enrollment sequence is : init,[update],doFinal.
 Calling init and doFinal is mandatory, calling update 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:**
[[javacard:java-card-api:BioException|BioException]]  - with the following reason codes:
 \\ 
 
  *BioException.INVALID_DATA if the submitted template data doesnot have the required format. 
 \\   
 

 
 



 ----


 === update === 
void **update**(byte[] bArray,
short offset,
short length)
throws [[javacard:java-card-api:BioException|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.
 Note:
  A correct enrollment sequence is : init,[update],doFinal.
 Calling init and doFinal is mandatory,
 calling update 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:**
[[javacard:java-card-api:BioException|BioException]]  - with the following reason codes:
 \\ 
 
  *BioException.ILLEGAL_USE if the reference is already initializedor the current enrollment state doesn't expect this method. 
 \\ 
  *BioException.INVALID_DATA if the submitted template data doesnot have the required format. 
 \\   
 

 
 



 ----


 === doFinal === 
void **doFinal**()
throws [[javacard:java-card-api:BioException|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.
 Note:
  A correct enrollment sequence is : init,[update],doFinal.
 Calling init and doFinal is mandatory,
 calling update is optional.

 
 


 
 



**Throws:**
[[javacard:java-card-api:BioException|BioException]]  - with the following reason codes:
 \\ 
 
  *BioException.ILLEGAL_USE if the reference is already initializedor the current enrollment state doesn't expect this method. 
 \\ 
  *BioException.INVALID_DATA if the submitted template data doesnot have the required format. 
 \\   
 

 
 



 ----


 === resetUnblockAndSetTryLimit === 
void **resetUnblockAndSetTryLimit**(byte newTryLimit)
throws [[javacard:java-card-api:BioException|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:**
[[javacard:java-card-api:BioException|BioException]]  - with the following reason codes:
 \\ 
 
  *BioException.ILLEGAL_VALUE if the newTryLimit parameter is lessthan 1. 
 \\