|
Java Card v2.2.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface BioTemplate
The BioTemplate interface is the base interface for all biometric templates. It provides the user interface for accessing biometric functionality.
Field Summary | |
---|---|
static short |
MATCH_NEEDS_MORE_DATA
This negative score value indicates that more data are needed to continue the matching session. |
static short |
MINIMUM_SUCCESSFUL_MATCH_SCORE
The minimum successful matching score. |
Method Summary | |
---|---|
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. |
Field Detail |
---|
static final short MINIMUM_SUCCESSFUL_MATCH_SCORE
static final short MATCH_NEEDS_MORE_DATA
Method Detail |
---|
boolean isInitialized()
initMatch
).
boolean isValidated()
reset()
.
void reset()
byte getTriesRemaining()
BioException
- with the following reason codes:BioException.NO_TEMPLATES_ENROLLED
if the reference template is
uninitialized.
byte getBioType()
BioBuilder
.
short getVersion(byte[] dest, short offset)
dest
- destination byte array.offset
- starting offset within the destination byte array.
short getPublicTemplateData(short publicOffset, byte[] dest, short destOffset, short length) throws BioException
publicOffset
- starting offset within the public data.dest
- destination byte array.destOffset
- starting offset within the destination byte array.length
- maximum length in bytes of the requested data.
BioException
- with the following reason codes:BioException.NO_TEMPLATES_ENROLLED
if the reference template is
uninitialized.
short initMatch(byte[] candidate, short offset, short length) throws BioException
match
method has to be called to continue the matching session.If the reference is blocked, no matching session starts and this method returns 0. Notes:
initMatch
,[match
].
Calling initMatch
is mandatory, calling match
is optional.
initMatch
makes the current session to fail and starts a new matching
session.
candidate
- - the data or part of the data of the candidate
template.offset
- - starting offset into the candidate array where the
candidate data is to be found.length
- - number of bytes to be taken from the candidate array.
BioException
- with the following reason codes:BioException.INVALID_DATA
if the submitted candidate template
data does not have the required format.
BioException.NO_TEMPLATES_ENROLLED
if the reference template is
uninitialized.
short match(byte[] candidate, short offset, short length) throws BioException
match
method has to be called to continue the matching session.initMatch
,[match
].
Calling initMatch
is mandatory, calling match
is optional.
candidate
- - the data or part of the data of the candidate
template.offset
- - starting offset into the candidate array where the
candidate data is to be found.length
- - number of bytes to be taken from the candidate array.
BioException
- with the following reason codes:BioException.ILLEGAL_USE
if used outside a matching session.
BioException.INVALID_DATA
if the submitted candidate template
data does not have the required format.
BioException.NO_TEMPLATES_ENROLLED
if the reference template is
uninitialized.
|
Java Card v2.2.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |