public interface BioTemplate
Modifier and Type | Field and Description |
---|---|
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.
|
Modifier and Type | Method and 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.
|
static final short MINIMUM_SUCCESSFUL_MATCH_SCORE
static final short MATCH_NEEDS_MORE_DATA
boolean isInitialized()
initMatch
).boolean isValidated()
reset()
.
In addition to returning a boolean
result, platform-implementations of this method set the
result in an internal state which can be rechecked using assertion methods
of the SensitiveResult
class,
if supported by the platform.void reset()
byte getTriesRemaining()
byte
result, platform-implementations of this method set the
result in an internal state which can be rechecked using assertion methods
of the SensitiveResult
class,
if supported by the platform.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.
short
result, platform-implementations of this method set the
result in an internal state which can be rechecked using assertion methods
of the SensitiveResult
class,
if supported by the platform.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.
short
result, platform-implementations of this method set the
result in an internal state which can be rechecked using assertion methods
of the SensitiveResult
class,
if supported by the platform.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.
Copyright © 1998, 2015, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms